Metadata

APIDescription
GET Metadata/UIMetadata?screenName={screenName}

No documentation available.

GET Metadata/UIMetadata/{apiKey}?screenName={screenName}

No documentation available.

GET Metadata/UIMetadataDocType

No documentation available.

GET Metadata/UIMetadataDocType/{apiKey}

No documentation available.

Document

Pulls a list of Documents for a given patient.

APIDescription
GET Documents/DocumentTypes

Receives a list of EHR document types for the specified customer.

GET Documents/DocumentTypes/{apiKey}

Receives a list of EHR document types for the specified customer.

GET Documents/UnsignedEHRDocumentsGet

Receives a list of unsigned documents for the current iScribe app user.

GET Documents/UnsignedEHRDocumentsGet/{apiKey}

Receives a list of unsigned documents for the current iScribe app user.

GET Documents/UnsignedTranscriptions

Get all unsigned Transcriptions for the user

GET Documents/UnsignedTranscriptions/{apiKey}

Get all unsigned Transcriptions for the user

GET Documents/UnsignedDocumentCounts

Receives a list of unsigned documents by type and their counts for the current iScribe app user.

GET Documents/UnsignedDocumentCounts/{apiKey}

Receives a list of unsigned documents by type and their counts for the current iScribe app user.

POST Documents/DocumentList

Gets a list of documents based on a patient.

POST Documents/DocumentList/{apiKey}

Gets a list of documents based on a patient.

POST Documents/DocumentGet

Gets a single document based on the ID and Sequence number.

POST Documents/DocumentGet/{apiKey}

Gets a single document based on the ID and Sequence number.

GET Documents/DocumentFile?url={url}&fileFormat={fileFormat}

Gets a document file based on the url

POST Documents/DocumentTypeSearch

Gets a list of doc types based on a string.

POST Documents/DocumentTypeSearch/{apiKey}

Gets a list of doc types based on a string.

POST Documents/DocumentImportChart

No documentation available.

POST Documents/v2/DocumentImportChart

Obsolete: use Documents/DocumentImportChart instead.

POST Documents/v2/DocumentImportChart/{apiKey}

Obsolete: use Documents/DocumentImportChart instead.

POST Documents/DocumentListSearch

No documentation available.

POST Documents/DocumentListSearch/{apiKey}

No documentation available.

POST Documents/DocumentDetailsGet

Gets a single document based on the ID and Sequence number.

POST Documents/DocumentDetailsGet/{apiKey}

Gets a single document based on the ID and Sequence number.

GET Documents/DocumentSections?documentId={documentId}&sequenceNumber={sequenceNumber}

Gets a list of avaliable sections for a document

GET Documents/DocumentSections/{apiKey}?documentId={documentId}&sequenceNumber={sequenceNumber}

Gets a list of avaliable sections for a document

GET Documents/PrescriptionDetails?patientId={patientId}&prescriptionId={prescriptionId}

Gets the details for a prescription

GET Documents/PrescriptionDetails/{apiKey}?patientId={patientId}&prescriptionId={prescriptionId}

Gets the details for a prescription

ProcedureDocumentation

APIDescription
POST ProcedureDocumentation/Save

Add, update, or delete Procedure Documentations for an Encounter

Auth

Provides authentication to the iScribe API.

APIDescription
POST Auth/Login

Validates the client and returns an API key to make other authenticated calls.

GET Auth/EchoTest?apiKey={apiKey}

No documentation available.

POST Auth/UpdatePassword/{apiKey}

Performs a change password action using Azure Multi Factor Authentication.

POST Auth/v2/UpdatePassword

No documentation available.

POST Auth/v2/UpdatePassword/{apiKey}

Performs a change password action using Azure Multi Factor Authentication via email.

POST Auth/ForgotPassword

Performs a forgot password action using Azure Multi Factor Authentication.

POST Auth/v2/ForgotPassword

Performs a forgot password action using Azure Multi Factor Authentication via email.

POST Auth/UpdateInitialPassword

No documentation available.

General

Contains a collection general calls to the EHR.

APIDescription
POST General/CareProviderSearch

Returns a list of care providers based on the search request

POST General/CareProviderSearch/{apiKey}

Returns a list of care providers based on the search request

GET General/Ping

Ping test response

GET General/FeatureFlags

No documentation available.

GET General/FeatureFlags/{apiKey}

No documentation available.

POST General/SendFile

No documentation available.

POST General/SendLogs

No documentation available.

POST General/SendLogs/{apiKey}

No documentation available.

GET General/GetVersionInfo

Gets the latest version number (major/minor/revision) and internal build number for the iScribe app.

User

Contains a collection user specific calls to the EHR.

APIDescription
POST User/Search

Gets a list of EHR Users and User groups

POST User/Search/{apiKey}

Gets a list of EHR Users and User groups

POST User/GetUserSettings

No documentation available.

POST User/GetUserSettings/{apiKey}

No documentation available.

GET User/Departments?pageSize={pageSize}&pageStart={pageStart}

No documentation available.

GET User/Departments/{apiKey}?pageSize={pageSize}&pageStart={pageStart}

No documentation available.

PATCH User/UserSetting

No documentation available.

PATCH User/UserSetting/{apiKey}

No documentation available.

PATCH User/EhrUserSettings

No documentation available.

PATCH User/EhrUserSettings/{apiKey}

No documentation available.

POST User/ValidateEhrLogin

No documentation available.

POST User/ValidateEhrLogin/{apiKey}

No documentation available.

GET User/TextMacros

No documentation available.

Patient

APIDescription
GET Fhir/Patient/{apiKey}?id={id}

No documentation available.

Template

Contains the calls to get and track providers template usage.

APIDescription
GET Template/Template/{apiKey}?ehrTemplateId={ehrTemplateId}&templateName={templateName}

OBSOLETE: Use v2/Template going forward Gets the requested template object.

GET Template/Template?ehrTemplateId={ehrTemplateId}&templateName={templateName}

OBSOLETE: Use v2/Template going forward Gets the requested template object.

GET Template/v2/Template?ehrTemplateId={ehrTemplateId}&templateName={templateName}&templateType={templateType}&documentId={documentId}

Gets the requested template object.

GET Template/v2/Template/{apiKey}?ehrTemplateId={ehrTemplateId}&templateName={templateName}&templateType={templateType}&documentId={documentId}

Gets the requested template object.

POST Template/v3/Template

Gets the requested template object.

GET Template/TemplateListMostUsedByUser?pageSize={pageSize}&pageStart={pageStart}&documentType={documentType}&documentId={documentId}&templateType={templateType}&ehrUsername={ehrUsername}&ehrPassword={ehrPassword}&patientAge={patientAge}&patientGender={patientGender}

Gets a list of template ID's for a specific user, ordered by templates used the most.

GET Template/TemplateListMostUsedByUser/{apiKey}?pageSize={pageSize}&pageStart={pageStart}&documentType={documentType}&documentId={documentId}&templateType={templateType}

Gets a list of template ID's for a specific user, ordered by templates used the most.

GET Template/Templates?templateName={templateName}&pageSize={pageSize}&pageStart={pageStart}&documentType={documentType}&templateType={templateType}&documentId={documentId}

Gets a list of templates.

POST Template/v2/Templates

No documentation available.

GET Template/Templates/{apiKey}?templateName={templateName}&pageSize={pageSize}&pageStart={pageStart}&documentType={documentType}&templateType={templateType}&documentId={documentId}

Gets a list of templates.

GET Template/TemplateListMostRecentByUser/{apiKey}?pageSize={pageSize}&pageStart={pageStart}&documentType={documentType}

NOT CURRENTLY USED. Consider Deprecating this endpoint - Gets a list of template ID's for a specific user, ordered by templates used most recently.

POST Template/TemplateAddIncrement

Creates a new Template record in iScribeRecord.Template and sets the counter/last selected date. If template is already stored for current user it just increments the counter and last selected date.

POST Template/TemplateAddIncrement/{apiKey}

Creates a new Template record in iScribeRecord.Template and sets the counter/last selected date. If template is already stored for current user it just increments the counter and last selected date.

POST Template/ProcedureDocumentations

Gets a list of procedure documetation section templates.

POST Template/ProcedureDocumentation

Gets a procedure documentation template.

Transcription

APIDescription
POST Transcription/GetAvailableTranscriptions

No documentation available.

POST Transcription/SubmitJobToMModal

No documentation available.

Scheduling

Contains the calls to get information about the provider's schedule.

APIDescription
GET Scheduling/v2/Schedule/{pageSize}/{pageStart}/{filterId}?startDate={startDate}&endDate={endDate}&filterResource={filterResource}&pageDateTime={pageDateTime}&direction={direction}&did[0]={did[0]}&did[1]={did[1]}&pid[0]={pid[0]}&pid[1]={pid[1]}

Receives a list of appointments between the start and end date.

GET Scheduling/v2/Schedule/{apiKey}/{pageSize}/{pageStart}/{filterId}?startDate={startDate}&endDate={endDate}&filterResource={filterResource}&pageDateTime={pageDateTime}&direction={direction}&did[0]={did[0]}&did[1]={did[1]}&pid[0]={pid[0]}&pid[1]={pid[1]}

Receives a list of appointments between the start and end date.

GET Scheduling/Schedule/{apiKey}/{pageSize}/{pageStart}/{filterId}?startDate={startDate}&endDate={endDate}&filterResource={filterResource}&pageDateTime={pageDateTime}&direction={direction}&did[0]={did[0]}&did[1]={did[1]}&pid[0]={pid[0]}&pid[1]={pid[1]}

[OBSOLETE: New version of this endpoint is: GET /Scheduling/v2/Schedule] Receives a list of appointments between the start and end date.

GET Scheduling/Schedule/{pageSize}/{pageStart}/{filterId}?startDate={startDate}&endDate={endDate}&filterResource={filterResource}&pageDateTime={pageDateTime}&direction={direction}&did[0]={did[0]}&did[1]={did[1]}&pid[0]={pid[0]}&pid[1]={pid[1]}

[OBSOLETE: New version of this endpoint is: GET /Scheduling/v2/Schedule] Receives a list of appointments between the start and end date.

POST Scheduling/PatientListFiltersGet

Returns a list of PatientList filters

POST Scheduling/PatientListFiltersGet/{apiKey}

Returns a list of PatientList filters

GET Scheduling/TotalAppointmentCountByDate?startDate={startDate}&endDate={endDate}&filterId={filterId}&filterResource={filterResource}&did[0]={did[0]}&did[1]={did[1]}&pid[0]={pid[0]}&pid[1]={pid[1]}

No documentation available.

Clinical

APIDescription
POST Clinical/HistoryItemSearch

Gets a list of documents based on a patient.

POST Clinical/HistoryItemSearch/{apiKey}

No documentation available.

POST Clinical/SearchProblems

Searches for problems

POST Clinical/SearchProblems/{apiKey}

Searches for problems

POST Clinical/AllergyUpdate

No documentation available.

POST Clinical/AllergyUpdate/{apiKey}

No documentation available.

POST Clinical/FamilyMedicalUpdate

Allows users to add, update, or remove a past surgical history item or problem

POST Clinical/FamilyMedicalUpdate/{apiKey}

Allows users to add, update, or remove a past surgical history item or problem

POST Clinical/PastMedicalUpdate

Allows user to add,update, or remove a past medical history item or problem

POST Clinical/PastMedicalUpdate/{apiKey}

Allows user to add,update, or remove a past medical history item or problem

POST Clinical/PastSurgicalUpdate

Allows users to add, update, or remove a past surgical history item or problem

POST Clinical/PastSurgicalUpdate/{apiKey}

Allows users to add, update, or remove a past surgical history item or problem

POST Clinical/SocialHistoryUpdate

Allows users to add, update, or remove a past social history item or problem.

POST Clinical/SocialHistoryUpdate/{apiKey}

Allows users to add, update, or remove a past social history item or problem.

POST Clinical/PFSHUpdate

Updates the PFSH items in batch if the user cancels a document save request.

POST Clinical/PFSHUpdate/{apiKey}

Updates the PFSH items in batch if the user cancels a document save request.

POST Clinical/DocumentSketchPadAppend

Appends a Clinical Document SketchPad.

POST Clinical/DocumentSketchPadAppend/{apiKey}

Appends a Clinical Document SketchPad.

POST Clinical/DocumentCheckOut

Allows a user to check out a document.

POST Clinical/DocumentCheckOut/{apiKey}

Allows a user to check out a document.

POST Clinical/DocumentCheckin

Allows a user to checkin a document.

POST Clinical/DocumentCheckin/{apiKey}

Allows a user to checkin a document.

POST Clinical/ClinicalDocumentSectionListGet

Gets a list of clinical sections from the document type ID.

POST Clinical/ClinicalDocumentSectionListGet/{apiKey}

Gets a list of clinical sections from the document type ID.

POST Clinical/IMOProblemSearch

Searches for a problem in IMO.

POST Clinical/IMOProblemSearch/{apiKey}

Searches for a problem in IMO.

POST Clinical/IMOProblemItemSearch

Searches for a problem in IMO.

POST Clinical/IMOProblemItemSearch/{apiKey}

Searches for a problem in IMO.

POST Clinical/IMOProblemDetail

Searches for a problem in IMO.

POST Clinical/IMOProblemDetail/{apiKey}

Searches for a problem in IMO.

GET Clinical/OrderSearch?SearchPhrase={SearchPhrase}&PageSize={PageSize}&CurrentPage={CurrentPage}&EncounterID={EncounterID}&SNOMEDCode={SNOMEDCode}

Searches for an Order.

GET Clinical/OrderSearch/{ApiKey}?SearchPhrase={SearchPhrase}&PageSize={PageSize}&CurrentPage={CurrentPage}&EncounterID={EncounterID}&SNOMEDCode={SNOMEDCode}

Searches for an Order.

GET Clinical/OrderSets

Get ordersets for a user/practice

GET Clinical/OrderSets/{apiKey}

Get ordersets for a user/practice

GET Clinical/OrderSetDetails?OrderSetID={OrderSetID}

Gets the details for a supplied orderset

GET Clinical/OrderSetDetails/{apiKey}?OrderSetID={OrderSetID}

Gets the details for a supplied orderset

POST Clinical/IMOProcedureDetail

Searches for a procedure in IMO.

POST Clinical/IMOProcedureDetail/{apiKey}

Searches for a procedure in IMO.

POST Clinical/EMCodeSearch

Searches for an E&M code based on a code or description.

POST Clinical/EMCodeSearch/{apiKey}

Searches for an E&M code based on a code or description.

GET Clinical/FavoriteHistoryItems?section={section}

Gets a list a history item with the add frequency as the HistoryCount.

GET Clinical/FavoriteHistoryItems/{apiKey}?section={section}

Gets a list a history item with the add frequency as the HistoryCount.

POST Clinical/PhysicalExamTypeListGet

Returns a list of exam types.

POST Clinical/PhysicalExamTypeListGet/{apiKey}

Returns a list of exam types.

POST Clinical/PhysicalExamTypeDetailsGet

Returns the details of a physical exam.

POST Clinical/PhysicalExamTypeDetailsGet/{apiKey}

Returns the details of a physical exam.

POST Clinical/DocumentSave

Allows users to add a new document.

POST Clinical/DocumentSave/{apiKey}

Allows users to add a new document.

POST Clinical/DocumentSign

Allows users to sign a document.

POST Clinical/DocumentSign/{apiKey}

Allows users to sign a document.

POST Clinical/DocumentSaveStatuses

Pulls document save statuses for appointments

POST Clinical/DocumentSignAll

Allows users to sign all documents.

POST Clinical/DocumentSignAll/{apiKey}

Allows users to sign all documents.

GET Clinical/FavoriteDiagnosis

Gets a list of diagnose with the add frequency as the HistoryCount

GET Clinical/FavoriteDiagnosis/{apiKey}

Gets a list of diagnose with the add frequency as the HistoryCount

GET Clinical/FavoriteOrders

Gets a list of favorite orders

GET Clinical/FavoriteOrders/{apiKey}

Gets a list of favorite orders

POST Clinical/EhrOrderSearchGet

Allows users to search for favorite orders.

POST Clinical/EhrOrderSearchGet/{apiKey}

Allows users to search for favorite orders.

POST Clinical/EhrFavoriteConceptGet

Allows users to get favorite concepts.

POST Clinical/EhrFavoriteConceptGet/{apiKey}

Allows users to get favorite concepts.

POST Clinical/AddFavoriteDiagnosis

Allows users to add/update a favorite diagnosis.

POST Clinical/AddFavoriteDiagnosis/{apiKey}

Allows users to add/update a favorite diagnosis.

POST Clinical/FavoriteOrder

Allows users to add/update a favorite procedure.

POST Clinical/FavoriteOrder/{apiKey}

Allows users to add/update a favorite procedure.

GET Clinical/TaskListTypeGet

No documentation available.

GET Clinical/TaskListTypeGet/{apiKey}

No documentation available.

POST Clinical/RouteDocument

No documentation available.

POST Clinical/RouteDocument/{apiKey}

No documentation available.

GET Clinical/ROSAdmin

This operation pulls admin config data from the EHR for Review Of Systems.

GET Clinical/ROSAdmin/{apiKey}

This operation pulls admin config data from the EHR for Review Of Systems.

System

Contains a collection general calls to the EHR.

APIDescription
POST System/SendLogs

No documentation available.

POST System/IsVendorAuthorized

No documentation available.

GET System/GetAirMicVersion

No documentation available.

Medication

Gets information about specified medications

APIDescription
POST Medications/PrescriptionHistoryGet

Returns a list of prescriptions based on the patient. Exclude the MedIdList to get all prescription history.

POST Medications/PrescriptionHistoryGet/{apiKey}

Returns a list of prescriptions based on the patient. Exclude the MedIdList to get all prescription history.

POST Medications/Search

Searches for medications based on the patientId and a searchKey.

POST Medications/Search/{apiKey}

Searches for medications based on the patientId and a searchKey.

POST Medications/IndicationGet

Gets a list of Indicaitons based on the patientID and MNID

POST Medications/IndicationGet/{apiKey}

Gets a list of Indicaitons based on the patientID and MNID

POST Medications/DosageGet

Gets a Dosages based on the patientId, MNID and indicationCode.

POST Medications/DosageGet/{apiKey}

Gets a Dosages based on the patientId, MNID and indicationCode.

POST Medications/SigGet

Returns a list of Signas.

POST Medications/SigGet/{apiKey}

Returns a list of Signas.

POST Medications/Record

Records a patient medication. Minimum required fields: patientID, Medication.DrugNameId(MNID), Medication.MedicationName and Medication.DoseRoute.

POST Medications/Record/{apiKey}

Records a patient medication. Minimum required fields: patientID, Medication.DrugNameId(MNID), Medication.MedicationName and Medication.DoseRoute.

POST Medications/Prescribe

Prescibe a medication to a patient.

POST Medications/Prescribe/{apiKey}

Prescibe a medication to a patient.

POST Medications/Refill

No documentation available.

POST Medications/Refill/{apiKey}

No documentation available.

GET Medications/FavoriteMedications

Gets the favorite medications added by provider.

GET Medications/FavoriteMedications/{apiKey}

Gets the favorite medications added by provider.

POST Medications/PrescribeonBehalfUsersListGet

Gets a list of users that can be prescibed on behalf of.

POST Medications/PrescribeonBehalfUsersListGet/{apiKey}

Gets a list of users that can be prescibed on behalf of.

POST Medications/ProviderSupervisorGet

Get provider's supervisor info.

POST Medications/ProviderSupervisorGet/{apiKey}

Get provider's supervisor info.

POST Medications/DiscontinueMedication

Get provider's supervisor info.

POST Medications/DiscontinueMedication/{apiKey}

Get provider's supervisor info.

GET Medications/ActiveMedications?patientID={patientID}

Returns list of active patient medications.

GET Medications/ActiveMedications/{apiKey}?patientID={patientID}

Returns list of active patient medications.

GET Medications/HistoricalMedications?patientID={patientID}

Returns list of historical patient medications.

GET Medications/HistoricalMedications/{apiKey}?patientID={patientID}

Returns list of historical patient medications.

Logging

Contains a collection of API's used by the UI to log events, exceptions, etc.

APIDescription
POST Logging/LogException

Logs an exception to AppInsights.

POST Logging/LogException/{apiKey}

Logs an exception to AppInsights.

Dictation

Contains the calls to get information about appointments.

APIDescription
POST Dictation/v2/DictationSend

No documentation available.

POST Dictation/v2/DictationSend/{apiKey}

No documentation available.

POST Dictation/ReprocessDictation

Reprocesses a failed dictation.

POST Dictation/ReprocessDictation/{apiKey}

Reprocesses a failed dictation.

POST Dictation/DictationStatusGet

Receives the status of a transacribed speech document.

POST Dictation/DictationStatusGet/{apiKey}

Receives the status of a transacribed speech document.

POST Dictation/PatientDictationStatusGet

Receives the status of a transacribed speech documents for a patient.

POST Dictation/PatientDictationStatusGet/{apiKey}

Receives the status of a transacribed speech documents for a patient.

POST Dictation/UsersDictationStatusGet

Receives the status of a transacribed speech documents for a patient.

POST Dictation/UsersDictationStatusGet/{apiKey}

Receives the status of a transacribed speech documents for a patient.

POST Dictation/SubmitJob?fileName={fileName}&base64String={base64String}

Submits jobs directly to MModal

POST Dictation/SubmitJob/{apiKey}?fileName={fileName}&base64String={base64String}

Submits jobs directly to MModal

POST Dictation/DropOffEmulator

No documentation available.

POST Dictation/DropOffEmulator/{apiKey}

No documentation available.

Admin

APIDescription
GET Admin/RegisterExtensionProperty

No documentation available.

GET Admin/GetUserInfo?objectId={objectId}

No documentation available.

Billing

APIDescription
GET Billing/Modifiers

Get all Modifiers available to add to a Billing Service

GET Billing/ProcedureCodes?encounterId={encounterId}&searchTerm={searchTerm}

Search for procedure codes to add as a Billing Service for an encounter

POST Billing/DetailsGet

Get all Billing Services for an Encounter

POST Billing/DetailsSave

Add, update, or delete a Billing Service for an Encounter

Patients

Contains the calls to get information about patients.

APIDescription
POST Patients/Chart

Gets the patient details using the ID.

POST Patients/Chart/{apiKey}

Gets the patient details using the ID.

POST Patients/Search

Search for patients.

POST Patients/Search/{apiKey}

Search for patients.

POST Patients/UpdateDemographics

Updates the patient's demographics

POST Patients/UpdateDemographics/{apiKey}

Updates the patient's demographics

POST Patients/UpdateVitals

Allows user to add,update, or remove a patient vitals item.

POST Patients/UpdateVitals/{apiKey}

Allows user to add,update, or remove a patient vitals item.

POST Patients/v2/Create

Adds a new patient to the EHR

POST Patients/v2/Create/{apiKey}

Adds a new patient to the EHR

POST Patients/v2/PhotoAdd

Updates the a patient's photo.

POST Patients/v2/PhotoAdd/{apiKey}

Updates the a patient's photo.

POST Patients/PhotoAdd

Updates the a patient's photo.

POST Patients/PhotoAdd/{apiKey}

Updates the a patient's photo.

POST Patients/PatientFlag

Pull the patient balance

POST Patients/PatientFlag/{apiKey}

Pull the patient balance

GET Patients/Languages

Get list of languages

GET Patients/Languages/{apiKey}

Get list of languages

GET Patients/Races

Get list of races

GET Patients/Races/{apiKey}

Get list of races

GET Patients/Ethnicities

Get list of Ethnicities

GET Patients/Ethnicities/{apiKey}

Get list of Ethnicities

GET Patients/States

Get list of states

GET Patients/States/{apiKey}

Get list of states

GET Patients/Countries

Get list of countries

GET Patients/Countries/{apiKey}

Get list of countries

GET Patients/Genders

Get a list Genders

GET Patients/Genders/{apiKey}

Get a list Genders

GET Patients/Religions

Get list of religions.

GET Patients/Religions/{apiKey}

Get list of religions.