Document Type - Appointment Request

The Document Type - Appointment Request feature allows an user to retrieves a list of appointment request for a specific patient.

Was this information helpful? Yes | No What went wrong? Incomplete or incorrect information | Irrelevant Content | Others

Endpoints

Get list of patient's appointment request documents
GET
/v1/{practiceid}/patients/{patientid}/documents/appointmentrequest

Retrieves a list of patients appointment request document

Was this information helpful? Yes | No What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
patientid integer patientid
showdeleted string By default, deleted documents are not listed. Set to list these.
status string The status of the task to filter document results.
departmentid integer The athenaNet department id.
encounterid integer Show only documents attached to this encounter.
documentsubclass string The document subclass to filter document results.
limit integer Number of entries to return (default 1500, max 5000)
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
appointmentid number The appointment ID for this document,
appointmentrequestid number The primary key for appointmentrequest class of documents
assignedto string Person the document is assigned to
clinicalproviderid number The clinical provider ID of the performing provider
contraindicationreason array List of codes indicating why the order was contraindicated (for vaccines only). If this field is not present, the order does not contain a contraindication reason.
createddate string Date the document was created. Please use createddatetime instead.
createddatetime string Date/Time (ISO 8601) the document was created
declinedreason array List of codes indicating why the order was not given. If this field is not present, the order was not declined. If the array is empty, no reason has been chosen.
declinedreasontext string The user-facing description of the reason the order was not given.
deleteddatetime string Date/time (ISO 8601) the document was deleted
departmentid string Department for the document
encounterid string Encounter ID
externalaccessionid string The external accession ID for this document. Format depends on the system the ID belongs to.
externalnote string External note for the patient
internalaccessionid string The internal accession ID for this document. Format depends on the system the ID belongs to.
internalnote string The 'Internal Note' attached to this document
lastmodifieddatetime string Date/time (ISO 8601) the document was last modified
observationdatetime string Date/time (ISO 8601) the observation was taken
priority number Document priority, when available.
providerid number Provider ID for this document
receivernote string External note sent to the receiving facility
status string Status of the document
subject string Subject of the document
tietoorderid number Order ID of the order this document is tied to, if any
Example Code