Login
| API | Description |
|---|---|
| POST api/v1/login | Login to the server. |
External
| API | Description |
|---|---|
| GET api/v1/external/patients?IncludeInactive={IncludeInactive}&ExternalId={ExternalId}&FirstName={FirstName}&LastName={LastName}&BirthDate={BirthDate}&Gender={Gender}&MedicalRecordNumber={MedicalRecordNumber}&SocialSecurityNumber={SocialSecurityNumber}&SocialSecuritySerialNumber={SocialSecuritySerialNumber}&City={City}&State={State}&Zip={Zip} | Get a list of patients |
| GET api/v1/external/document-type-list | Get a list of all the active Document Types. |
| GET api/v1/external/message-urgency-list | Get a list of all the active Message Urgencies. |
| GET api/v1/external/prm-users?Username={Username}&ExternalId={ExternalId}&UserFirstName={UserFirstName}&UserLastName={UserLastName}&UserEmail={UserEmail} | Get a list of active PRM users, filtered by the data provided. |
| GET api/v1/external/usergroups | Get a list of user groups |
| GET api/v1/external/patient-demographics?PatientId={PatientId}&PatientLastName={PatientLastName}&PatientFirstName={PatientFirstName}&MedicalRecordNumber={MedicalRecordNumber}&SocialSecurityNumber={SocialSecurityNumber}&Birthdate={Birthdate} | Get a list of active Patients, filtered by the data provided. |
| GET api/v1/external/patient-date-of-service?PatientUid={PatientUid}&ProviderUid={ProviderUid}&StartDate={StartDate}&EndDate={EndDate}&isOpen={isOpen} | Get a list of the Visits and their corresponding Orders for a specific Patient. |
| POST api/v1/external/document-upload | Upload a document with corresponding xml metadata, and get a result containing the AttachmentGroupUid that it is in. |
| POST api/v1/external/document-upload-json | Upload a document with corresponding json metadata, and get a result containing a success message. |
| GET api/v1/external/log-location | Get the location of the Log file for the appserver. |
Superbill
| API | Description |
|---|---|
| GET api/v1/superbills?AccountId={AccountId}&PatientId={PatientId}&PatientCaseId={PatientCaseId}&AppointmentId={AppointmentId}&VisitId={VisitId}&SuperbillStatusId={SuperbillStatusId} | Returns a list of Superbills with given criteria |
| GET api/v1/superbill-status?name={name} | Gets a list of SuperbillStatuses |
| PUT api/v1/superbill-status | Updates SuperbillStatus |
PatientVisitAppointment
| API | Description |
|---|---|
| PUT api/v1/appointment-status?appointmentId={appointmentId}&appointmentStatusId={appointmentStatusId}&lastModifiedByUid={lastModifiedByUid}&lastModifiedDate={lastModifiedDate} | Updates appointment status given an appointment |
Ccds
| API | Description |
|---|---|
| GET api/v1/ccds/race?patientId={patientId} | Gets the patient’s race |
| GET api/v1/ccds/ethnicity?patientId={patientId} | Gets the patient’s ethnicity |
| GET api/v1/ccds/smokingstatus?patientId={patientId} | Gets the patient’s smoking status |
| GET api/v1/ccds/problems?patientId={patientId} | Gets the patient’s problems |
| GET api/v1/ccds/medicationallergies?patientId={patientId} | Gets the patient’s medicationallergies |
| GET api/v1/ccds/laboratorytests?patientId={patientId}&start={start}&end={end} | Gets the patient’s laboratory tests |
| GET api/v1/ccds/laboratoryvaluesresults?patientId={patientId}&start={start}&end={end} | Gets the patient’s laboratory values results |
| GET api/v1/ccds/vitalsigns?patientId={patientId}&start={start}&end={end} | Gets the patient’s vital signs |
| GET api/v1/ccds/careteammembers?patientId={patientId} | Gets the patient’s care team members |
| GET api/v1/ccds/immunizations?patientId={patientId}&start={start}&end={end} | Gets the patient’s immunizations |
| GET api/v1/ccds/uniquedeviceidentifiers?patientId={patientId} | Gets the patient’s unique device patientIds |
| GET api/v1/ccds/assessmentandplanoftreatment?patientId={patientId} | Gets the patient’s assessment and plan of treatment |
| GET api/v1/ccds/goals?patientId={patientId} | Gets the patient’s goals |
| GET api/v1/ccds/healthconcerns?patientId={patientId} | Gets the patient’s health concerns |
| GET api/v1/ccds/ccda?patientId={patientId}&visitId={visitId} | Gets the patient’s ccda or visit specific CCDA |
| GET api/v1/ccds/ccda?patientId={patientId}&start={start}&end={end} | Gets a patient’s CCDA’s within a range of dates (inclusive) |
| GET api/v1/ccds/ccda?patientId={patientId}&date={date} | Gets a patient’s CCDA for a specific date |
Fhir
| API | Description |
|---|---|
| POST api/v1/fhir/search | Allergy Intolerance resource |
| POST api/v1/fhir/allergyintolerance | Allergy Intolerance resource |
| GET api/v1/fhir/allergyintolerance | Gets a patient’s allergy intolerances based on patient={identifier} |
| POST api/v1/fhir/medicationstatement | Gets a patient’s medication statements based on a bundle request |
| GET api/v1/fhir/medication | Gets medication based on code={RXNORMCode}, patient={identifier} |
| POST api/v1/fhir/condition | Get’s a patients condition based on a bundle request |
| GET api/v1/fhir/condition | Gets a patient’s condition based on patient={identifier} |
| POST api/v1/fhir/observation | Observation resource |
| GET api/v1/fhir/observation | Gets obervations related to a patient based on patient={identifier}, category={vital-signs|smokingstatus|laboratory}, code={LOINC}}, date={date} Can query for multiple codes and can use date modifiers (i.e. gt, lt, ge, le) to search |
| GET api/v1/fhir/medicationstatement | Gets a patient’s medication statements based on patient={identifier}, patientId={Uid|ExternalID}, start={start of range (inclusive)}, end={end of range (inclusive)} |
| GET api/v1/ccds/medications | Gets a patient’s medication statements based on patient={identifier}, patientId={Uid|ExternalID}, start={start of range (inclusive)}, end={end of range (inclusive)} |
| GET api/v1/fhir/person | Gets a person based on address={address}, address-city={city}, address-state={state}, birthdate={date}, email={email}, phone={phone}, gender={gender}, name={name} |
| GET api/v1/fhir/patient | Gets a patient based on name={name}, family={name}, given={name}, identifier={identifier}, gender={gender}, birthdate={date} |
| GET api/v1/ccds/name | Gets a patient based on name={name}, family={name}, given={name}, identifier={identifier}, gender={gender}, birthdate={date} |
| GET api/v1/ccds/sex | Gets a patient based on name={name}, family={name}, given={name}, identifier={identifier}, gender={gender}, birthdate={date} |
| GET api/v1/ccds/dateofbirth | Gets a patient based on name={name}, family={name}, given={name}, identifier={identifier}, gender={gender}, birthdate={date} |
| GET api/v1/ccds/preferredlanguage | Gets a patient based on name={name}, family={name}, given={name}, identifier={identifier}, gender={gender}, birthdate={date} |
| POST api/v1/fhir/patient/$match | Returns a matched patient based on the patient request provided to the function |
| GET api/v1/fhir/patient/{id} | Gets a patient based on their external id |
| GET api/v1/fhir/practitioner | Gets a pracitioner based on active={boolean}, address={address}, address-city={city}, address-state={state}, email={email}, gender={gender}, given={given}, identifier={identifier}, name={name}, phone={phone} |
| GET api/v1/fhir/appointment | Gets appointments based on patient={identifier}, date={date} |
| GET api/v1/fhir/procedure | Gets procedures based on patient={identifier}, date={date} |
| GET api/v1/ccds/procedures | Gets procedures based on patient={identifier}, date={date} |
| GET api/v1/fhir/DocumentReference | Gets a document reference based on patient={personUid} |
| GET api/v1/fhir/Binary | Gets the binary content of a document using documentId={string}, requesterName={string}, requesterOrg={string} |
FacilityPortalLogin
| API | Description |
|---|---|
| POST api/facility/v1/login | Login to the server. |
Visit
| API | Description |
|---|---|
| PUT api/v1/visit-iscompleted | Sets the Visit.IsComplete status |
| POST api/v1/visit-comment | Updates VisitComment with corresponding VisitComment data |
| GET api/v1/visit-comment?visitCommentId={visitCommentId}&visitId={visitId} | Returns VisitComment for corresponding VisitCommentId |
| PUT api/v1/visit-comment | Updates VisitComment for corresponding VisitComment data |
| GET api/v1/visitcosign?VisitCoSignUid={VisitCoSignUid}&VisitUid={VisitUid}&CosignUid={CosignUid}&CompletedUid={CompletedUid}&CosignSignatureUid={CosignSignatureUid}&Inactive={Inactive}&ForwardDate={ForwardDate}&IsCompleted={IsCompleted}&IsApproved={IsApproved}&IsMessage={IsMessage}&LastModifiedByUid={LastModifiedByUid}&LastModifiedDate={LastModifiedDate}&AppointmentUid={AppointmentUid}&CurrentPage={CurrentPage}&PerPage={PerPage} | Updates VisitComment for corresponding VisitComment data |
| POST api/v1/visitcosign | Updates VisitComment for corresponding VisitComment data |
| PUT api/v1/visitcosign | Updates VisitComment for corresponding VisitComment data |