There is a WADL document available that describes the resources API.
name | path | methods | description |
---|---|---|---|
AccuroSettingsEndpoint |
|
|
|
AccuroUserEndpoint |
|
|
This AccuroUserEndpoint collection is designed to expose Accuro user endpoints.
|
ApiVersionEndpoint |
|
|
This endpoint is designed to retrieve and display the current version of the Accuro API build. Requires client, provider, or patient level authorization. |
AppointmentHistoryEndpoint |
|
|
This AppointmentHistoryEndpoint collection is designed to expose the Appointment
History DTO and related public endpoints. Requires provider level authorization.
|
|
|
|
AppointmentMaterialsEndpoint collection is designed to expose materials related
to appointments. |
AppointmentMaterialsEndpointV2 |
|
|
This is the 2nd version of the collection designed to expose materials related to appointments. |
AuthorizedClientsEndpoint |
|
|
This AuthorizedClientsEndpoint collection is designed to expose api authorized
clients endpoints.
|
BillProcedureEndpoint |
|
|
This BillProcedureEndpoint collection is designed to retrieve the authorized
providers billing procedure information. Requires provider level authorization.
|
ChangeOfficeEndpoint |
|
|
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 |
|
|
This endpoint collection is designed to retrieve consult priorities information. |
ConsultStatusEndpoint |
|
|
This ConsultStatusEndpoint collection is designed to expose the waitlist consult
statuses. Requires provider level authorization.
|
ContactEndpoint |
|
|
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 |
|
|
This endpoint collection is designed to create/retrieve conversation contact. |
ConversationEndpoint |
|
|
This ConversationsEndpoint collection is designed to expose the conversation
endpoints. Requires provider level authorization.
|
ConversationUnMatchedPatientEndpoint |
|
|
This ConversationUnMatchedPatientsEndpoint collection is designed to expose the
conversation unmatched patients endpoints. Requires provider level authorization.
|
CopyUserPermissionsEndpoint |
|
|
|
CopyUserPreferenceEndpoint |
|
|
|
CustomPropertiesEndpoint |
|
|
This CustomPropertiesEndpoint is designed to retrieve custom fields information.
|
DemographicsEndpoint |
|
|
This DemographicsEndpoint collection is designed to expose the Demographics DTO and
related patient-level endpoints. Requires patient level authorization.
|
DetailsEndpoint |
|
|
This endpoint collection is designed to expose a user's 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 |
|
|
This endpoint collection is designed to retrieve Diagnosis Status information. |
DispenseNotificationEndpoint |
|
|
This DispenseNotificationEndpoint is designed to expose DispenseNotificationDto
endpoints.
|
DocumentEndpoint |
|
|
This PatientDocumentEndpoint collection is designed to expose the Document DTO and
related public endpoints. Patient level authorization.
|
DocumentEndpoint |
|
|
This DocumentEndpoint collection is designed to expose DocumentDto and
related public endpoints. Provider level authorization is required.
|
EprescribeCancelResponseEndpoint |
|
|
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 |
|
|
Endpoints for Eprescribe job. |
EprescribeJobOutcomeEndpoint |
|
|
Endpoints for Eprescribe job outcome. |
EprescribeJobTaskEndpoint |
|
|
This EprescribeJobTaskEndpoint is designed to expose EprescribeJobTaskDto
endpoints.
|
EprescribeJobTypeEndpoint |
|
|
End point for retrieving all the Eprescribe Job types. |
EprescribeOrderStatusEndpoint |
|
|
Endpoints for Eprescribe order status. |
EprescribeOutcomeCodeEndpoint |
|
|
Endpoints for Eprescribe Outcome Code. |
EprescribeTaskEndpoint |
|
|
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 |
|
|
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 |
|
|
This ExternalIdentitySystemEndpoint is designed to create/retrieve external identity
system records.
|
ExternalPatientEndpoint |
|
|
This endpoint collection is designed to create/retrieve External Patient. |
ExternalUserIdentityEndpoint |
|
|
|
FeatureAccessEndpoint |
|
|
|
FolderEndpoint |
|
|
This FolderEndpoint collection is designed to provide CRUD operations for document
folders and sub-folders. Provider level authorization is required.
|
GenderEndpoint |
|
|
This GenderEndpoint collection is designed to expose the Gender DTO and related
public endpoints. Requires client, provider, or patient level authorization.
|
GeneratedLetterEndpoint |
|
|
This GeneratedLetterEndpoint collection is designed to expose the generated letter
and the related public endpoints. Requires provider level authorization.
|
HistoryRegularEndpoint |
|
|
|
HistoryTypeEndpoint |
|
|
This HistoryTypeEndpoint collection is designed to retrieve history types and items for
patient medical history.
|
InsurerEndpoint |
|
|
This InsurerEndpoint collection is designed to expose the Insurer DTO and related
public endpoints. Requires provider level authorization.
|
LabLinkGroupEndpoint |
|
|
Endpoints to access Lab link groups. |
LabTemplateEndpoint |
|
|
This LabTemplateEndpoint collection is designed to expose the Lab Template objects
and related public endpoints. Requires client, provider, or patient level authorization.
|
LabTemplateEndpoint |
|
|
This LabTemplateEndpoint collection is designed to expose the Lab Template DTO and
related public endpoints. Requires provider level authorization.
|
LanguageEndpoint |
|
|
This LanguageEndpoint collection is designed to expose the languages. Requires
client, provider, or patient level authorization.
|
LetterEndpoint |
|
|
This LetterEndpoint collection is designed to expose the Letter DTO and related
public endpoints. Requires provider level authorization.
|
LimitedUseCodeEndpoint |
|
|
End point for exposing limited use codes by DIN. Requires Provider level authorization. |
LocationEndpoint |
|
|
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 |
|
|
This MaskingEndpoint collection is designed to expose the Patient masks and masks
authorization endpoints. Requires provider level authorization.
|
NameSuffixesEndpoint |
|
|
This NameSuffixesEndpoint exposes all the default and custom name suffixes. Requires
client, provider, or patient level authorization.
|
NoKnownAllergyEndpoint |
|
|
This NoKnownAllergyEndpoint is designed to retrieve no-known allergy information for a
patient.
|
OfficeEndpoint |
|
|
This OfficeEndpoint collection is designed to expose the Office DTO and related
public endpoints. Requires client, provider, or patient level authorization.
|
PatientAlertFlagEndpoint |
|
|
This PatientAlertFlagEndpoint collection is designed to expose the Patient Alert
Flag Endpoints. Requires provider level authentication.
|
PatientAllergyEndpoint |
|
|
This PatientAllergyEndpoint is designed to retrieve information relating to patient
allergies.
|
PatientChartLockEndpoint |
|
|
This PatientChartLockEndpoint is designed to expose PatientChartLockDto
endpoints.
|
PatientDiagnosisEndpoint |
|
|
This PatientDiagnosisEndpoint is designed to retrieve diagnosis information for patients.
|
PatientDiagnosisHistoryEndpoint |
|
|
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:
|
PatientDocumentEndpoint |
|
|
This PatientDocumentEndpoint collection is designed to expose DocumentDto
and related public endpoints. Provider level authorization.
|
PatientEndpoint |
|
|
This PatientEndpoint collection is designed to expose the Patient DTO and related
public endpoints. Requires provider level authorization.
|
PatientEndpointV2 |
|
|
This PatientEndpointV2 collection is designed to expose the Patient DTO and related
public endpoints. Requires provider level authorization.
|
PatientFlagsEndpoint |
|
|
This PatientFlagsEndpoint collection is designed to expose the Patient UserFlag and
RoleFlags endpoints. Requires provider level authorization.
|
PatientHistoryEndpoint |
|
|
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 |
PatientHistoryItemHistoryEndpoint |
|
|
These endpoints expose patient history item history records.
There are 4 types of patient history item as follows:
Also, Regular type has some built-in types as follow:
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 |
|
|
This PatientImmunizationEndpoint is designed to retrieve immunization information
for patients.
|
PatientImmunizationScheduleEndpoint |
|
|
This endpoint collection is designed to retrieve immunization schedule information for patients. |
PatientLabsEndpoint |
|
|
This PatientLabsEndpoint collection is designed to expose the Patient Labs DTO and
related public endpoints. Requires patient level authorization.
|
PatientLabsEndpoint |
|
|
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 |
|
|
This PatientMedicalSummaryEndpoint is designed to expose
PatientMedicalSummaryDto endpoints. Requires Provider level authorization.
|
PatientPrescriptionEndpoint |
|
|
This endpoint collection is designed to retrieve prescription information for patients. |
PatientPrescriptionEndpointV2 |
|
|
This endpoint collection is designed to retrieve prescription information for patients. |
PatientScheduledVaccinesEndpoint |
|
|
This endpoint collection is designed to retrieve scheduled vaccine information for a patient. |
PatientStatusEndpoint |
|
|
|
PermissionsEndpoint |
|
|
This PermissionsEndpoint collection is designed to expose provider permissions
endpoints.
|
PersonTitlesEndpoint |
|
|
This PersonTitlesEndpoint collection is designed to expose the person titles
endpoints. Requires client, provider, or patient level authorization.
|
PhysicianMasterNumbersEndpoint |
|
|
This PhysicianMasterNumbersEndpoint retrieves list of all assigned physician master
numbers. Requires client, provider, or patient level authorization.
|
PortalEndpoint |
|
|
This PortalEndpoint collection is designed to expose the patient-level
authentication grant.
|
PrescriptionEndpoint |
|
|
|
PrescriptionFavoriteEndpoint |
|
|
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
|
PrescriptionHistoryEndpoint |
|
|
This endpoint collection is designed to retrieve prescription history entry for patients.
Steps to retrieve this data from Accuro:
|
ProviderEndpoint |
|
|
This ProviderEndpoint collection is designed to expose the Provider DTO and related
public endpoints. Requires client, provider, or patient level authorization.
|
ProviderLabsEndpoint |
|
|
End points for retrieving patient lab data that is not scoped to a particular patient. |
ReferralOrderEndpoint |
|
|
This ReferralOrderEndpoint collection is designed to expose the ReferralOrderDto.
Referral Order Status(statusOrder) and Type(type) can be retrieved at:
|
RelationshipStatusEndpoint |
|
|
This RelationshipStatusEndpoint collection is designed to expose the Relationship
Status. Requires client, provider, or patient level authorization.
|
RenewalRequestEndpoint |
|
|
This RenewalRequestsEndpoint is designed to expose RenewalRequestDto endpoints.
Requires Provider level authorization.
|
RenewalRequestGroupsEndpoint |
|
|
End points for retrieving and creating renewal requests groups. |
RenewalRequestResponseEndpoint |
|
|
This RenewalRequestEndpoint is designed to expose RenewalRequestResponseDto
endpoints. Requires Provider level authorization.
|
RepliformReportableEndpoint |
|
|
This RepliformReportableEndpoint collection is designed to expose the
PatientRepliformReportable DTO and related public endpoints. Requires provider level
authorization.
|
RoleEndpoint |
|
|
This endpoint collection is designed to retrieve role information. |
ScheduleEndpoint |
|
|
This ScheduleEndpoint collection is designed to expose the Appointment DTO and
related patient-level endpoints. Requires patient level authorization.
|
ScheduleEndpoint |
|
|
This Scheduler for provider portal applications. When create/update/cancel/delete the appointment wait room entry will be updated according to the appointment as follow:
|
ScheduleEndpoint |
|
|
This ScheduleEndpoint collection is designed to expose Appointment Types, Reasons,
Statuses, and Priorities.
|
ScheduleEndpoint |
|
|
This ScheduleEndpoint collection is designed to expose Appointment Types, Reasons,
Statuses, Priorities and provider schedule calendar notes.
|
ScheduleRoomEndpoint |
|
|
|
SelectionListEndpoint |
|
|
This SelectionListEndpoint collection is designed to expose the list of the configurable
values.
|
SiteEndpoint |
|
|
This SiteEndpoint collection is designed to expose Appointment Sites.
|
SpadeDocumentEndpoint |
|
|
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 |
|
|
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 |
|
|
|
UserSecurityEndpoint |
|
|
This UserSecurityEndpoint collection is designed to expose the AccuroUser DTO and
related endpoints.
|
UserTaskEndpoint |
|
|
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 |
|
|
This endpoint collection is designed to retrieve vaccine information. |
WaitRoomEntryEndpoint |
|
|
This WaitRoomEntryEndpoint collection is designed to expose the WaitRoom DTO and
related public endpoints. Requires provider level authorization.
|
WaitlistAttachmentEndpoint |
|
|
This WaitlistAttachmentEndpoint is designed to create information relating to the
waitlist attachments.
|
WaitlistComplaintEndpoint |
|
|
This WaitlistComplaintEndpoint is designed to expose the waitlist complaints list.
|
WaitlistConsultTypeEndpoint |
|
|
This WaitlistSelectionListEndpoint is designed to expose the waitlist selection list.
|
WaitlistProviderEndpoint |
|
|
This WaitlistProviderEndpoint is designed to expose the waitlist providers.
Requires provider level authorization.
|
WaitlistRequestEndpoint |
|
|
This WaitlistRequestEndpoint collection is designed to expose the Waitlist Request
DTO. Requires provider level authorization.
|