Resources

There is a WADL document available that describes the resources API.

name path methods description
AccuroSettingsEndpoint
  • /v1/accuro-settings
  • GET
AccuroUserEndpoint
  • /v1/users
  • /v1/users/{userId}
  • POST
  • PUT
This AccuroUserEndpoint collection is designed to expose Accuro user endpoints.
ApiVersionEndpoint
  • /v1/api-version
  • GET
This endpoint is designed to retrieve and display the current version of the Accuro API build. Requires client, provider, or patient level authorization.
AppointmentHistoryEndpoint
  • /v1/provider-portal/scheduler/appointments/history
  • /v1/provider-portal/scheduler/appointments/{appointmentId}/history
  • GET
  • GET
This AppointmentHistoryEndpoint collection is designed to expose the Appointment History DTO and related public endpoints. Requires provider level authorization.
AppointmentMaterialsEndpoint
  • /v1/materials/appointments/{appointmentId}
  • GET
This AppointmentMaterialsEndpoint collection is designed to expose materials related to appointments.
AppointmentMaterialsEndpointV2
  • /v2/materials/appointments
  • /v2/materials/appointments/{appointmentId}
  • GET
  • GET
This is the 2nd version of the collection designed to expose materials related to appointments.
AuthorizedClientsEndpoint
  • /v1/authorized-clients
  • /v1/authorized-clients/{id}
  • GET POST
  • DELETE GET
This AuthorizedClientsEndpoint collection is designed to expose api authorized clients endpoints.
BillProcedureEndpoint
  • /v1/provider-portal/appointments/{appointmentId}/billprocedures
  • GET
This BillProcedureEndpoint collection is designed to retrieve the authorized providers billing procedure information. Requires provider level authorization.
ChangeOfficeEndpoint
  • /v1/provider-portal/current-office
  • PUT
This endpoint is use to change the current office associated with an access token so that subsequent API calls with that access token will operate as if they are for the specified office.
ConsultPriorityEndpoint
  • /v1/provider-portal/waitlist-consult-priorities
  • /v1/provider-portal/waitlist-consult-priorities/{priorityId}
  • GET
  • GET
This endpoint collection is designed to retrieve consult priorities information.
ConsultStatusEndpoint
  • /v1/provider-portal/waitlist-consult-statuses
  • /v1/provider-portal/waitlist-consult-statuses/{statusId}
  • GET
  • GET
This ConsultStatusEndpoint collection is designed to expose the waitlist consult statuses. Requires provider level authorization.
ContactEndpoint
  • /v1/contacts
  • /v1/contacts/search
  • /v1/contacts/{contactId}
  • /v1/contacts/{contactId}/external-contact-identifiers
  • /v1/contacts/{contactId}/external-contact-identifiers/{systemIdentifier}
  • POST
  • GET
  • GET
  • GET POST
  • GET
This ContactEndpoint is designed to retrieve contact information for Contacts and Pharmacies.

Contact and Pharmacy are part of address book feature in Accuro. The AddressContactType determines whether it is Contact or Pharmacy.

ConversationContactEndpoint
  • /v1/provider-portal/conversation-contacts
  • /v1/provider-portal/conversation-contacts/{contactId}
  • /v1/provider-portal/conversation-contacts/{contactId}/users
  • /v1/provider-portal/conversation-contacts/{contactId}/users/{userId}
  • GET POST
  • GET
  • GET
  • PUT
This endpoint collection is designed to create/retrieve conversation contact.
ConversationEndpoint
  • /v1/provider-portal/conversations
  • /v1/provider-portal/conversations/{id}
  • /v1/provider-portal/conversations/{conversationId}/external-patients
  • /v1/provider-portal/conversations/{conversationId}/messages
  • /v1/provider-portal/conversations/{id}/archive
  • /v1/provider-portal/conversations/{id}/participants
  • /v1/provider-portal/conversations/{id}/unarchive
  • /v1/provider-portal/conversations/{conversationId}/external-patients/{externalPatientId}
  • /v1/provider-portal/conversations/{conversationId}/medications/{prescriptionMedicationId}
  • /v1/provider-portal/conversations/{conversationId}/messages/{messageId}
  • /v1/provider-portal/conversations/{conversationId}/patients/{patientId}
  • /v1/provider-portal/conversations/{conversationId}/task-groups/{taskGroupUuid}
  • /v1/provider-portal/conversations/{conversationId}/messages/{messageId}/attachments
  • /v1/provider-portal/conversations/{conversationId}/messages/{messageId}/statuses
  • /v1/provider-portal/conversations/{conversationId}/messages/{messageId}/attachments/{attachmentId}
  • /v1/provider-portal/conversations/{conversationId}/messages/{messageId}/attachments/{attachmentId}/contents
  • GET POST
  • DELETE GET
  • GET
  • POST
  • PUT
  • GET POST PUT
  • PUT
  • PUT
  • PUT
  • DELETE GET
  • PUT
  • PUT
  • POST
  • GET PUT
  • GET
  • GET POST
This ConversationsEndpoint collection is designed to expose the conversation endpoints. Requires provider level authorization.
ConversationUnMatchedPatientEndpoint
  • /v1/provider-portal/unmatched-patients
  • /v1/provider-portal/unmatched-patients/{id}
  • POST
  • GET
This ConversationUnMatchedPatientsEndpoint collection is designed to expose the conversation unmatched patients endpoints. Requires provider level authorization.
CopyUserPermissionsEndpoint
  • /v1/users/{userId}/copy-user-permissions
  • PUT
CopyUserPreferenceEndpoint
  • /v1/users/{userId}/copy-user-preferences
  • PUT
CustomPropertiesEndpoint
  • /v1/provider-portal/custom-properties
  • GET
This CustomPropertiesEndpoint is designed to retrieve custom fields information.
DemographicsEndpoint
  • /v1/patient-portal/demographics
  • GET PUT
This DemographicsEndpoint collection is designed to expose the Demographics DTO and related patient-level endpoints. Requires patient level authorization.
DetailsEndpoint
  • /v1/details
  • GET

This endpoint collection is designed to expose a user's Details.

Requires provider or patient level authorization. This end point will return nothing if authenticated with a client_credentials grant (as there is no authenticated user).

Any end points in this collection are purely for testing purposes, and may contain breaking changes between any API versions.

DiagnosisStatusEndpoint
  • /v1/provider-portal/diagnosis-statuses
  • /v1/provider-portal/diagnosis-statuses/{statusId}
  • GET
  • GET
This endpoint collection is designed to retrieve Diagnosis Status information.
DispenseNotificationEndpoint
  • /v1/provider-portal/dispense-notifications
  • /v1/provider-portal/dispense-notifications/{id}
  • GET POST
  • DELETE GET PUT
This DispenseNotificationEndpoint is designed to expose DispenseNotificationDto endpoints.
DocumentEndpoint
  • /v1/patient-portal/documents
  • /v1/patient-portal/documents/folders
  • /v1/patient-portal/documents/{documentId}
  • GET
  • GET
  • GET
This PatientDocumentEndpoint collection is designed to expose the Document DTO and related public endpoints. Patient level authorization.
DocumentEndpoint
  • /v1/provider-portal/documents
  • /v1/provider-portal/documents/file-types
  • /v1/provider-portal/documents/{documentId}/reviews
  • POST
  • GET
  • GET
This DocumentEndpoint collection is designed to expose DocumentDto and related public endpoints. Provider level authorization is required.
EprescribeCancelResponseEndpoint
  • /v1/provider-portal/erx-cancel-requests/{cancelRequestId}/responses
  • GET POST
This EprescribeCancelResponseEndpoint collection is designed to expose the Eprescribe cancel response endpoints. Requires provider level authorization or client credentials grant with QHR first party scope.
EprescribeJobEndpoint
  • /v1/provider-portal/erx-jobs
  • /v1/provider-portal/erx-jobs/{jobId}
  • /v1/provider-portal/erx-jobs/{id}/histories
  • /v1/provider-portal/erx-jobs/{jobId}/histories
  • /v1/provider-portal/erx-jobs/{jobId}/prescriptions
  • /v1/provider-portal/erx-jobs/{jobId}/histories/{id}
  • /v1/provider-portal/erx-jobs/{jobId}/prescriptions/{id}
  • GET POST
  • DELETE GET PUT
  • GET
  • POST
  • GET
  • GET
  • PUT
Endpoints for Eprescribe job.
EprescribeJobOutcomeEndpoint
  • /v1/provider-portal/erx-job-outcomes
  • /v1/provider-portal/erx-job-outcomes/{outcomeId}
  • POST
  • GET
Endpoints for Eprescribe job outcome.
EprescribeJobTaskEndpoint
  • /v1/provider-portal/erx-jobs/{jobId}/tasks
  • /v1/provider-portal/erx-jobs/{jobId}/tasks/{id}
  • GET POST
  • DELETE GET PUT
This EprescribeJobTaskEndpoint is designed to expose EprescribeJobTaskDto endpoints.
EprescribeJobTypeEndpoint
  • /v1/provider-portal/erx-job-types
  • /v1/provider-portal/erx-job-types/{id}
  • GET POST
  • DELETE
End point for retrieving all the Eprescribe Job types.
EprescribeOrderStatusEndpoint
  • /v1/provider-portal/eprescribe-order-statuses
  • GET POST
Endpoints for Eprescribe order status.
EprescribeOutcomeCodeEndpoint
  • /v1/provider-portal/erx-outcome-codes
  • GET
Endpoints for Eprescribe Outcome Code.
EprescribeTaskEndpoint
  • /v1/provider-portal/erx-job-tasks/{id}
  • GET
This EprescribeTaskEndpoint is designed to expose EprescribeJobTaskDto endpoints that are not already covered by EprescribeJobTaskEndpoint. More specifically, these are endpoints that operate directly on the tasks themselves without relation to the job that the task is associated with.
ErxCancelRequestEndpoint
  • /v1/provider-portal/erx-cancel-requests
  • /v1/provider-portal/erx-cancel-requests/{localId}
  • GET POST
  • DELETE GET PUT
This ErxCancelRequestEndpoint collection is designed to expose the Eprescribe cancel requests endpoints. Requires provider level authorization or client credentials grant with QHR first party scope.
ExternalIdentitySystemEndpoint
  • /v1/external-id-systems
  • /v1/external-id-systems/{systemId}
  • GET POST
  • DELETE GET PUT
This ExternalIdentitySystemEndpoint is designed to create/retrieve external identity system records.
ExternalPatientEndpoint
  • /v1/provider-portal/external-patients
  • /v1/provider-portal/external-patients/{id}
  • GET POST
  • GET
This endpoint collection is designed to create/retrieve External Patient.
ExternalUserIdentityEndpoint
  • /v1/external-id-users
  • /v1/external-id-systems/{systemId}/external-id-users
  • /v1/external-id-systems/{systemId}/external-id-users/{externalUserId}
  • GET
  • POST
  • DELETE GET PUT
FeatureAccessEndpoint
  • /v1/security/users/{userId}/features
  • GET
FolderEndpoint
  • /v1/provider-portal/folders
  • /v1/provider-portal/folders/sub-folders
  • /v1/provider-portal/folders/{folderId}
  • /v1/provider-portal/folders/sub-folders/{subFolderId}
  • GET POST
  • GET POST
  • DELETE GET PUT
  • DELETE GET
This FolderEndpoint collection is designed to provide CRUD operations for document folders and sub-folders. Provider level authorization is required.
GenderEndpoint
  • /v1/genders
  • GET
This GenderEndpoint collection is designed to expose the Gender DTO and related public endpoints. Requires client, provider, or patient level authorization.
GeneratedLetterEndpoint
  • /v1/provider-portal/generated-letters
  • /v1/provider-portal/generated-letters/{id}
  • /v1/provider-portal/generated-letters/{id}/status
  • GET
  • GET
  • PUT
This GeneratedLetterEndpoint collection is designed to expose the generated letter and the related public endpoints. Requires provider level authorization.
HistoryRegularEndpoint
  • /v1/provider-portal/history-regular
  • /v1/provider-portal/history-regular/{historyRegularId}
  • GET
  • GET
HistoryTypeEndpoint
  • /v1/provider-portal/history-types
  • /v1/provider-portal/history-types/{typeId}
  • GET
  • GET
This HistoryTypeEndpoint collection is designed to retrieve history types and items for patient medical history.
InsurerEndpoint
  • /v1/provider-portal/insurers
  • /v1/provider-portal/insurers/{insurerId}
  • GET POST
  • GET
This InsurerEndpoint collection is designed to expose the Insurer DTO and related public endpoints. Requires provider level authorization.
LabLinkGroupEndpoint
  • /v1/provider-portal/lab-link-groups
  • /v1/provider-portal/lab-link-groups/{groupId}
  • GET POST
  • DELETE GET PUT
Endpoints to access Lab link groups.
LabTemplateEndpoint
  • /v1/labs/results
  • /v1/labs/sources
  • /v1/labs/tests
  • /v1/labs/results/{resultId}
  • /v1/labs/tests/{testId}
  • /v1/labs/tests/{testId}/results
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
This LabTemplateEndpoint collection is designed to expose the Lab Template objects and related public endpoints. Requires client, provider, or patient level authorization.
LabTemplateEndpoint
  • /v1/provider-portal/labs/results
  • /v1/provider-portal/labs/sources
  • /v1/provider-portal/labs/tests
  • /v1/provider-portal/labs/results/{resultId}
  • /v1/provider-portal/labs/tests/{testId}
  • /v1/provider-portal/labs/tests/{testId}/results
  • GET POST
  • GET
  • GET POST
  • GET PUT
  • GET PUT
  • DELETE GET PUT
This LabTemplateEndpoint collection is designed to expose the Lab Template DTO and related public endpoints. Requires provider level authorization.
LanguageEndpoint
  • /v1/enumerations/languages/official
  • /v1/enumerations/languages/spoken
  • GET
  • GET
This LanguageEndpoint collection is designed to expose the languages. Requires client, provider, or patient level authorization.
LetterEndpoint
  • /v1/provider-portal/letters
  • /v1/provider-portal/letters/types
  • PUT
  • GET
This LetterEndpoint collection is designed to expose the Letter DTO and related public endpoints. Requires provider level authorization.
LimitedUseCodeEndpoint
  • /v1/provider-portal/medications/limited-use-codes
  • GET
End point for exposing limited use codes by DIN. Requires Provider level authorization.
LocationEndpoint
  • /v1/locations
  • GET
This LocationEndpoint collection is designed to expose the Location DTO and related public endpoints. Provides methods for returning location information. Requires client, provider, or patient level authorization.
MaskingEndpoint
  • /v1/provider-portal/patients/{patientId}/masks
  • /v1/provider-portal/patients/{patientId}/masks/{maskId}
  • /v1/provider-portal/patients/{patientId}/masks/{maskId}/authorizations
  • /v1/provider-portal/patients/{patientId}/masks/{maskId}/authorizations/{authorizationId}
  • GET POST
  • GET PUT
  • GET POST
  • DELETE GET PUT
This MaskingEndpoint collection is designed to expose the Patient masks and masks authorization endpoints. Requires provider level authorization.
NameSuffixesEndpoint
  • /v1/enumerations/name-suffixes
  • GET
This NameSuffixesEndpoint exposes all the default and custom name suffixes. Requires client, provider, or patient level authorization.
NoKnownAllergyEndpoint
  • /v1/provider-portal/patients/{patientId}/no-known-allergies
  • /v1/provider-portal/patients/{patientId}/no-known-allergies/{allergyId}
  • GET
  • GET
This NoKnownAllergyEndpoint is designed to retrieve no-known allergy information for a patient.
OfficeEndpoint
  • /v1/offices
  • GET
This OfficeEndpoint collection is designed to expose the Office DTO and related public endpoints. Requires client, provider, or patient level authorization.
PatientAlertFlagEndpoint
  • /v1/provider-portal/patients/flags
  • /v1/provider-portal/patients/flags/{flagId}
  • /v1/provider-portal/patients/{patientId}/flags
  • /v1/provider-portal/patients/{patientId}/flags/{flagId}
  • GET
  • GET
  • GET PUT
  • DELETE GET PUT
This PatientAlertFlagEndpoint collection is designed to expose the Patient Alert Flag Endpoints. Requires provider level authentication.
PatientAllergyEndpoint
  • /v1/provider-portal/patients/{patientId}/allergies
  • /v1/provider-portal/patients/{patientId}/allergies/{patientAllergyId}
  • /v1/provider-portal/patients/{patientId}/allergies/{patientAllergyId}/comments
  • /v1/provider-portal/patients/{patientId}/allergies/{patientAllergyId}/reactions
  • GET
  • GET
  • GET
  • GET
This PatientAllergyEndpoint is designed to retrieve information relating to patient allergies.
PatientChartLockEndpoint
  • /v1/provider-portal/patients/{patientId}/patient-chart-lock
  • /v1/provider-portal/patients/{patientId}/patient-chart-unlock
  • GET POST
  • POST
This PatientChartLockEndpoint is designed to expose PatientChartLockDto endpoints.
PatientDiagnosisEndpoint
  • /v1/provider-portal/patients/{patientId}/diagnoses
  • /v1/provider-portal/patients/{patientId}/diagnoses/{diagnosisId}
  • GET
  • GET
This PatientDiagnosisEndpoint is designed to retrieve diagnosis information for patients.
PatientDiagnosisHistoryEndpoint
  • /v1/provider-portal/patients/{patientId}/diagnoses/{diagnosisId}/histories
  • /v1/provider-portal/patients/{patientId}/diagnoses/{diagnosisId}/histories/{historyId}
  • GET
  • GET
This PatientDiagnosisHistoryEndpoint is designed to retrieve patient diagnosis history records.

Also, this endpoint represents item history of "History Of Problems" in Accuro.

Steps to retrieve this data from Accuro:

  1. Log into Accuro
  2. Click "EMR" on the left panel
  3. Click "Encounter Note" tab
  4. Go to "History Of Problems"
  5. Click Add or Edit button
  6. Select any diagnoses. If there is none then create one and edit it to generate a history record.
  7. Click History button

PatientDocumentEndpoint
  • /v1/provider-portal/patients/{patientId}/documents
  • /v1/provider-portal/patients/{patientId}/documents/folders
  • /v1/provider-portal/patients/{patientId}/documents/{documentId}
  • GET
  • GET
  • GET
This PatientDocumentEndpoint collection is designed to expose DocumentDto and related public endpoints. Provider level authorization.
PatientEndpoint
  • /v1/provider-portal/patients
  • /v1/provider-portal/patients/search
  • /v1/provider-portal/patients/{patientId}
  • /v1/provider-portal/patients/{patientId}/aliases
  • /v1/provider-portal/patients/{patientId}/custom-properties
  • /v1/provider-portal/patients/{patientId}/emails
  • /v1/provider-portal/patients/{patientId}/insurers
  • /v1/provider-portal/patients/{patientId}/phones
  • /v1/provider-portal/patients/{patientId}/profile-picture
  • /v1/provider-portal/patients/{patientId}/role-flags
  • /v1/provider-portal/patients/{patientId}/user-flags
  • POST
  • GET
  • GET PATCH PUT
  • DELETE GET POST PUT
  • GET PATCH PUT
  • DELETE GET POST PUT
  • GET PUT
  • DELETE GET POST PUT
  • GET POST
  • GET PUT
  • GET PUT
This PatientEndpoint collection is designed to expose the Patient DTO and related public endpoints. Requires provider level authorization.
PatientEndpointV2
  • /v2/provider-portal/patients
  • /v2/provider-portal/patients/search
  • /v2/provider-portal/patients/{patientId}
  • POST
  • GET
  • GET PATCH PUT
This PatientEndpointV2 collection is designed to expose the Patient DTO and related public endpoints. Requires provider level authorization.
PatientFlagsEndpoint
  • /v2/provider-portal/patients/{patientId}/role-flags
  • /v2/provider-portal/patients/{patientId}/user-flags
  • /v2/provider-portal/patients/{patientId}/role-flags/{roleId}
  • /v2/provider-portal/patients/{patientId}/user-flags/{userId}
  • GET POST PUT
  • GET POST PUT
  • DELETE
  • DELETE
This PatientFlagsEndpoint collection is designed to expose the Patient UserFlag and RoleFlags endpoints. Requires provider level authorization.
PatientHistoryEndpoint
  • /v1/provider-portal/patients/{patientId}/history-items
  • /v1/provider-portal/patients/{patientId}/history-items/{historyItemId}
  • GET
  • GET
These endpoints expose patient history bands. These are categorized into 4 different types: Regular, Free Text, URL and Tracking HistoryType's as an each distinctive history feature type. There can be multiple bands for each type. For example, type REGULAR has FamilyHistory/Lifestyle/SurgicalHistory. Each patient can have multiple records for each type which are being referred as Patient history item(s).

The patient history item(s) is/are represented by its corresponding Dto. Please refer each of them below
PatientHistoryRegularDto
PatientHistoryTextDto
PatientHistoryUrlDto
PatientHistoryTrackingDto

PatientHistoryItemHistoryEndpoint
  • /v1/provider-portal/patients/{patientId}/history-items/{historyItemId}/histories
  • /v1/provider-portal/patients/{patientId}/history-items/{historyItemId}/histories/{historyId}
  • GET
  • GET
These endpoints expose patient history item history records.

There are 4 types of patient history item as follows:

  • REGULAR
  • TRACKING
  • URL
  • FREE_TEXT
A specific type is required to retrieve the patient history item history records through these endpoints.

Also, Regular type has some built-in types as follow:

  • Family History
  • Life Style
  • Surgical History
So if you like to retrieve those band's histories should use the historyType query param as Regular

The result entities are varying depending on the provided history types. The results have a base entity as AbstractPatientHistoryItemHistoryDto. The different entities are as follows:

PatientImmunizationEndpoint
  • /v1/provider-portal/patients/{patientId}/immunizations
  • /v1/provider-portal/patients/{patientId}/immunizations/{immunizationId}
  • GET
  • GET
This PatientImmunizationEndpoint is designed to retrieve immunization information for patients.
PatientImmunizationScheduleEndpoint
  • /v1/provider-portal/patients/{patientId}/immunization-schedules
  • /v1/provider-portal/patients/{patientId}/immunization-schedules/{id}
  • GET
  • GET
This endpoint collection is designed to retrieve immunization schedule information for patients.
PatientLabsEndpoint
  • /v1/patient-portal/lab-groups
  • /v1/patient-portal/lab-groups/{groupId}
  • /v1/patient-portal/lab-groups/{baseGroupId}/history
  • /v1/patient-portal/lab-groups/{groupId}/observations
  • GET
  • GET
  • GET
  • GET
This PatientLabsEndpoint collection is designed to expose the Patient Labs DTO and related public endpoints. Requires patient level authorization.
PatientLabsEndpoint
  • /v1/provider-portal/patients/{patientId}/lab-groups
  • /v1/provider-portal/patients/{patientId}/lab-groups/{groupId}
  • /v1/provider-portal/patients/{patientId}/lab-groups/{baseGroupId}/history
  • /v1/provider-portal/patients/{patientId}/lab-groups/{groupId}/observations
  • /v1/provider-portal/patients/{patientId}/lab-groups/{groupId}/recipients
  • /v1/provider-portal/patients/{patientId}/lab-groups/{groupId}/reviews
  • /v1/provider-portal/patients/{patientId}/lab-groups/{groupId}/observations/{observationId}
  • GET POST
  • DELETE GET PUT
  • GET
  • GET POST
  • DELETE GET PUT
  • PUT
  • DELETE GET PUT
This PatientLabsEndpoint collection is designed to expose the Patient Labs DTO and related public endpoints. Requires provider level authorization. This controller is sub-resourced from PatientEndpoint. All endpoints in this controller are prefaced by: /patients/{patientId}/lab-groups
PatientMedicalSummaryEndpoint
  • /v1/provider-portal/patients/{patientId}/medical-summary
  • GET
This PatientMedicalSummaryEndpoint is designed to expose PatientMedicalSummaryDto endpoints. Requires Provider level authorization.
PatientPrescriptionEndpoint
  • /v1/provider-portal/patients/{patientId}/prescriptions
  • /v1/provider-portal/patients/{patientId}/prescriptions/{prescriptionId}
  • /v1/provider-portal/patients/{patientId}/prescriptions/{prescriptionId}/order-statuses
  • GET
  • GET
  • POST
This endpoint collection is designed to retrieve prescription information for patients.
PatientPrescriptionEndpointV2
  • /v2/provider-portal/patients/{patientId}/prescriptions
  • GET
This endpoint collection is designed to retrieve prescription information for patients.
PatientScheduledVaccinesEndpoint
  • /v1/provider-portal/patients/{patientId}/scheduled-vaccines
  • /v1/provider-portal/patients/{patientId}/immunization-schedules/{scheduleId}/scheduled-vaccines
  • GET
  • GET
This endpoint collection is designed to retrieve scheduled vaccine information for a patient.
PatientStatusEndpoint
  • /v1/provider-portal/patient-statuses
  • /v1/provider-portal/patient-statuses/{id}
  • GET POST
  • DELETE GET PUT
PermissionsEndpoint
  • /v1/accessible-providers
  • GET
This PermissionsEndpoint collection is designed to expose provider permissions endpoints.
PersonTitlesEndpoint
  • /v1/enumerations/person-titles
  • GET
This PersonTitlesEndpoint collection is designed to expose the person titles endpoints. Requires client, provider, or patient level authorization.
PhysicianMasterNumbersEndpoint
  • /v1/enumerations/physician-master-numbers
  • GET
This PhysicianMasterNumbersEndpoint retrieves list of all assigned physician master numbers. Requires client, provider, or patient level authorization.
PortalEndpoint
  • /v1/portal/token
  • POST
This PortalEndpoint collection is designed to expose the patient-level authentication grant.
PrescriptionEndpoint
  • /v1/provider-portal/prescriptions
  • GET
PrescriptionFavoriteEndpoint
  • /v1/provider-portal/prescription-favorites
  • /v1/provider-portal/prescription-favorites/{favoriteId}
  • /v1/provider-portal/prescription-favorites/{favoriteId}/prescriptions
  • /v1/provider-portal/prescription-favorites/{favoriteId}/prescriptions/{rxId}
  • GET
  • GET
  • GET
  • GET
This endpoint collection is designed to retrieve prescription favorite information. User can save many prescriptions under one favorite so PrescriptionFavoriteDto has the list of prescription id.

How to create new prescription favorite

  • Run Accuro
  • Log in
  • Select patient
  • Go to EMR
  • Go to Encounter Notes
  • Click Yellow Star symbol under Active/External Medication
  • Click Green Plus(+) symbol in the pop up panel
  • Type title
  • Click Green Plus(+) symbol to add prescription in the favorite

PrescriptionHistoryEndpoint
  • /v1/provider-portal/patients/{patientId}/prescriptions/histories
  • /v1/provider-portal/patients/{patientId}/prescriptions/{prescriptionId}/histories
  • /v1/provider-portal/patients/{patientId}/prescriptions/{prescriptionId}/histories/summaries
  • /v1/provider-portal/patients/{patientId}/prescriptions/{prescriptionId}/histories/{historyId}
  • GET
  • GET
  • GET
  • GET
This endpoint collection is designed to retrieve prescription history entry for patients.

Steps to retrieve this data from Accuro:

  1. Log into Accuro
  2. Click "EMR" on the left panel
  3. Click "Encounter Note" tab
  4. Create a record in "Active Medication"
  5. Click "Medication" tab on the top
  6. Right click over the prescription you may want to change
  7. Do "Edit" > "SIG" or "Change Status"
  8. Double click the prescription
  9. Click "Other" tab
  10. Find your edit on "Change History" tab

ProviderEndpoint
  • /v1/providers
  • /v1/providers/offices
  • /v1/providers/search
  • /v1/providers/specialties
  • /v1/providers/statuses
  • /v1/providers/types
  • /v1/providers/{providerId}
  • /v1/providers/offices/{officeId}
  • /v1/providers/{providerId}/identifiers
  • /v1/providers/{providerId}/offices
  • /v1/providers/{providerId}/specialties
  • GET POST
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • PUT
  • GET
This ProviderEndpoint collection is designed to expose the Provider DTO and related public endpoints. Requires client, provider, or patient level authorization.
ProviderLabsEndpoint
  • /v1/provider-portal/provider/{providerId}/lab-groups
  • GET
End points for retrieving patient lab data that is not scoped to a particular patient.
ReferralOrderEndpoint
  • /v1/provider-portal/referral-orders
  • /v1/provider-portal/referral-orders/{id}
  • GET
  • GET PUT
This ReferralOrderEndpoint collection is designed to expose the ReferralOrderDto.

Referral Order Status(statusOrder) and Type(type) can be retrieved at:

  • Referral Order Status: /v1/provider-portal/selection-list/referral-statuses
  • Referral Order Type: /v1/provider-portal/selection-list/referral-types

RelationshipStatusEndpoint
  • /v1/enumerations/relationship-statuses
  • GET
This RelationshipStatusEndpoint collection is designed to expose the Relationship Status. Requires client, provider, or patient level authorization.
RenewalRequestEndpoint
  • /v1/provider-portal/renewal-requests
  • /v1/provider-portal/renewal-requests/{id}
  • POST
  • DELETE GET
This RenewalRequestsEndpoint is designed to expose RenewalRequestDto endpoints. Requires Provider level authorization.
RenewalRequestGroupsEndpoint
  • /v1/provider-portal/renewal-request-groups
  • /v1/provider-portal/renewal-request-groups/{id}
  • POST
  • GET PUT
End points for retrieving and creating renewal requests groups.
RenewalRequestResponseEndpoint
  • /v1/provider-portal/renewal-request-responses
  • /v1/provider-portal/renewal-request-responses/{responseId}
  • POST
  • GET
This RenewalRequestEndpoint is designed to expose RenewalRequestResponseDto endpoints. Requires Provider level authorization.
RepliformReportableEndpoint
  • /v1/provider-portal/patient-repliforms-reportables
  • GET
This RepliformReportableEndpoint collection is designed to expose the PatientRepliformReportable DTO and related public endpoints. Requires provider level authorization.
RoleEndpoint
  • /v1/provider-portal/roles
  • /v1/provider-portal/roles/{id}
  • GET
  • GET
This endpoint collection is designed to retrieve role information.
ScheduleEndpoint
  • /v1/patient-portal/scheduler/appointments
  • /v1/patient-portal/scheduler/appointments/{appointmentId}
  • GET
  • GET
This ScheduleEndpoint collection is designed to expose the Appointment DTO and related patient-level endpoints. Requires patient level authorization.
ScheduleEndpoint
  • /v1/provider-portal/scheduler/applied-availabilities
  • /v1/provider-portal/scheduler/applied-suggestions
  • /v1/provider-portal/scheduler/appointments
  • /v1/provider-portal/scheduler/availability-templates
  • /v1/provider-portal/scheduler/lock
  • /v1/provider-portal/scheduler/sites
  • /v1/provider-portal/scheduler/statuses
  • /v1/provider-portal/scheduler/suggestions
  • /v1/provider-portal/scheduler/appointments/billing_details
  • /v1/provider-portal/scheduler/appointments/{appointmentId}
  • /v1/provider-portal/scheduler/availability-templates/{templateId}
  • /v1/provider-portal/scheduler/reasons/{reasonId}
  • /v1/provider-portal/scheduler/statuses/{statusId}
  • /v1/provider-portal/scheduler/appointments/{appointmentId}/billing_details
  • /v1/provider-portal/scheduler/appointments/{appointmentId}/lock
  • /v1/provider-portal/scheduler/appointments/{appointmentId}/statuses
  • /v1/provider-portal/scheduler/providers/{providerId}/calendar-notes
  • /v1/provider-portal/scheduler/appointments/{appointmentId}/statuses/{statusId}
  • GET
  • GET
  • GET POST
  • GET
  • DELETE POST
  • GET
  • POST PUT
  • GET
  • POST
  • DELETE GET PUT
  • GET
  • PUT
  • PUT
  • GET
  • DELETE POST
  • GET
  • DELETE GET POST PUT
  • DELETE PUT

This ScheduleEndpoint collection is designed to expose the Appointment DTO and related public endpoints. Requires patient level authorization.

Scheduler for provider portal applications.

When create/update/cancel/delete the appointment wait room entry will be updated according to the appointment as follow:

  1. The wait room entry will be created if the appointment is created and the patient arrives
  2. The wait room entry will be created if the appointment is updated and the patient arrives
  3. The wait room entry will be deleted if the appointment is updated and the patient leave or does not arrive
  4. The wait room entry will be deleted if the appointment is cancelled or deleted
The appointment date must be today. If it is not the wait room entry it won't be created. Currently, API doesn't support to create wait room entry for the future appointment as Accuro does.

ScheduleEndpoint
  • /v1/provider-portal/scheduler/priorities
  • /v1/provider-portal/scheduler/reasons
  • /v1/provider-portal/scheduler/statuses
  • /v1/provider-portal/scheduler/types
  • GET
  • GET
  • GET
  • GET
This ScheduleEndpoint collection is designed to expose Appointment Types, Reasons, Statuses, and Priorities.
ScheduleEndpoint
  • /v1/scheduler/priorities
  • /v1/scheduler/reasons
  • /v1/scheduler/statuses
  • /v1/scheduler/types
  • GET
  • GET
  • GET
  • GET
This ScheduleEndpoint collection is designed to expose Appointment Types, Reasons, Statuses, Priorities and provider schedule calendar notes.
ScheduleRoomEndpoint
  • /v1/provider-portal/scheduler/schedule-rooms/{id}
  • /v1/provider-portal/scheduler/appointments/{appointmentId}/schedule-rooms
  • GET
  • GET
SelectionListEndpoint
  • /v1/provider-portal/selection-lists/address-types
  • /v1/provider-portal/selection-lists/chart-unlock-reasons
  • /v1/provider-portal/selection-lists/mask-removal-reasons
  • /v1/provider-portal/selection-lists/referral-statuses
  • /v1/provider-portal/selection-lists/referral-types
  • GET
  • GET
  • GET
  • GET
  • GET
This SelectionListEndpoint collection is designed to expose the list of the configurable values.
SiteEndpoint
  • /v1/sites
  • /v1/sites/{siteId}
  • GET
  • GET
This SiteEndpoint collection is designed to expose Appointment Sites.
SpadeDocumentEndpoint
  • /v1/spade/documents
  • POST
This SpadeDocumentEndpoint collection is designed to provide CRUD operations for spade documents for use with the spade workflow. Client credential authorization with scope of SPADE_DOCUMENT_WRITE is required.
SpadeFolderEndpoint
  • /v1/spade/folders
  • /v1/spade/folders/{folderId}
  • /v1/spade/folders/{folderId}/documents
  • GET POST
  • DELETE GET PUT
  • GET
This SpadeFolderEndpoint collection is designed to provide CRUD operations for spade folders for use with the spade workflow. Authorization of client credential is required.
UserInfoEndpoint
  • /v1/whoami
  • GET
UserSecurityEndpoint
  • /v1/users
  • /v1/users/{id}
  • GET
  • GET
This UserSecurityEndpoint collection is designed to expose the AccuroUser DTO and related endpoints.
UserTaskEndpoint
  • /v1/provider-portal/tasks
  • /v1/provider-portal/tasks/reasons
  • /v1/provider-portal/tasks/{taskId}
  • /v1/provider-portal/tasks/{taskId}/roles
  • /v1/provider-portal/tasks/{taskId}/users
  • GET POST
  • GET
  • DELETE GET PATCH PUT
  • POST
  • POST
This UserTaskEndpoint collection is designed to expose assigned tasks. These are tasks which are either assigned to, or created by the current logged in user or a role group they are in.
VaccineEndpoint
  • /v1/provider-portal/vaccines
  • /v1/provider-portal/vaccines/{vaccineId}
  • GET
  • GET
This endpoint collection is designed to retrieve vaccine information.
WaitRoomEntryEndpoint
  • /v1/provider-portal/wait-room-entries
  • /v1/provider-portal/wait-room-entries/{id}
  • /v1/provider-portal/wait-room-entries/{waitroomId}
  • /v1/provider-portal/wait-room-entries/{waitRoomId}/{patientLeft}
  • GET POST
  • GET
  • PUT
  • DELETE
This WaitRoomEntryEndpoint collection is designed to expose the WaitRoom DTO and related public endpoints. Requires provider level authorization.
WaitlistAttachmentEndpoint
  • /v1/provider-portal/waitlists/{waitlistId}/attachments
  • /v1/provider-portal/waitlists/{waitlistId}/attachments/{attachmentId}
  • DELETE GET POST
  • DELETE GET
This WaitlistAttachmentEndpoint is designed to create information relating to the waitlist attachments.
WaitlistComplaintEndpoint
  • /v1/provider-portal/waitlist-complaints
  • GET
This WaitlistComplaintEndpoint is designed to expose the waitlist complaints list.
WaitlistConsultTypeEndpoint
  • /v1/provider-portal/waitlist-consult-types
  • GET
This WaitlistSelectionListEndpoint is designed to expose the waitlist selection list.
WaitlistProviderEndpoint
  • /v1/provider-portal/waitlist-providers
  • /v1/provider-portal/waitlist-providers/{id}
  • GET
  • GET
This WaitlistProviderEndpoint is designed to expose the waitlist providers. Requires provider level authorization.
WaitlistRequestEndpoint
  • /v1/provider-portal/waitlists
  • /v1/provider-portal/waitlists/{id}
  • /v1/provider-portal/waitlists/{waitlistId}
  • GET POST
  • GET
  • PUT
This WaitlistRequestEndpoint collection is designed to expose the Waitlist Request DTO. Requires provider level authorization.