Document Type - Order

The Document Type - Order feature allows users to add, edit, remove, or retrieve a list of order documents for the practice or a specific patient.

The Order Subscription feature will allow the user to add, retrieve, and delete changes made to an order. The user will need to subscribe. For more information about subscriptions, please refer Changed Data Subscriptions.

Order (Already Signed)
A document showing a test, other diagnostic service, or referral that the patient requires as part of their medical care, signed by the athenahealth provider. These documents represent orders placed outside of athenaClinicals (e.g., prescription note pad, lab requisition form).  By default, order documents are created in a closed status. 

Note: Subclassification is not available for this document class.

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit

Get order document's action note

GET
/v1/{practiceid}/documents/order/{orderid}/actions
Retrieves action note information of a specific order
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
orderid integer orderid
limit integer Number of entries to return (default 1500, max 5000)
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
actionnote string The action notes that are attached to the document.
assignedto string This field will describe who was assigned this document during this document action.
createdby string The username of the person that created this document action.
createddatetime string The datetime this action note was created.
patientid integer The patient ID this document is tied to.
priority integer Priority given for this document action.
status string Status given for this document action.
Example Code

Add order document action note

POST
/v1/{practiceid}/documents/order/{orderid}/actions
Creates an action note for a specific order
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
orderid integer orderid
Content-Type string Content type of the payload

Output Parameters

Expand all
errormessage string If there was an error with this call and SUCCESS is set to false, this field may provide additional information.
newdocumentid string The document ID of newly created document as a result of action of Deny-New Prescription To Follow (DNTF).
success string Returns true if the update was a success.
versiontoken string A token representing the current state of this document. Will only be set if VERSIONTOKEN was originally sent to the endpoint.
Example Code

Get outstanding orders

GET
/v1/{practiceid}/orders/outstanding
BETA: Retrieves the list of patient's orders whose dates are as of today or earlier.
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
showdeclinedorders boolean If set, include orders that were declined
departmentid integer The athenaNet department ID.
patientid integer The athena patient ID.
encounterid integer The ID for the clinical encounter the outstanding order was created in or the ID of the clinical encounter that the order will be performed in.
limit integer Number of entries to return (default 1500, max 5000)
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
assigneduser string The username of the user who this order task is currently assigned to for further processing as needed.
class string The document class of this order: ORDER (for labs, imaging, consult (referral), procedure, and other), SURGERY, DME, and VACCINE.
classdescription string The human-readable description of this document class
clinicalproviderid integer ID of the recipient for the order.
clinicalprovidername string Name of the recipient for the order.
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.
createdencounterid integer The ID for the clinical encounter the outstanding order was created in.
dateordered string The timestamp when the order was created. Returned in mm/dd/yyyy hh:mi AM/PM format
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.
departmentid integer The athenaNet department ID.
description string Brief description for this order.
documentationonly string If true, this order is here just as a record, and does not need to actually go out.
documentid integer The linked document for this order.
encounterid integer The ID of the clinical encounter that the order will be performed in.
name string Name of the order.
orderingprovider string The username of the ordering provider, which is different than the ordering user - who may be an intake nurse for example.
performdate string The date when the order was performed.
priority integer Priority of the order.
status string The status of the order document. New orders start in REVIEW status and Open Orders include Review, Pending, Administer, Submit, Submitted, Perform, Followup, Dispense, Schedule, Scheduled, and Athena Error.
Example Code

Get list of patient's orders

GET
/v1/{practiceid}/patients/{patientid}/documents/order
Retrieves a list of order documents for a specific patient
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
patientid integer patientid
showdeleted boolean By default, deleted documents are not listed. Set to list these.
status string The status of the task to filter document results.
startdate string An optional filter to specify the start of the documents search date range (MM/DD/YYYY). Inclusive.
encounterid integer Show only documents attached to this encounter.
documentsubclass string The document subclass to filter document results.
showdeclinedorders boolean If set, include orders that were declined
documentclass string The class(es) of document(s) comma separated.
enddate string An optional filter to specify the end of the documents search date range (MM/DD/YYYY). Inclusive.
departmentid integer The athenaNet department id.
limit integer Number of entries to return (default 1500, max 5000)
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
appointmentid integer The appointment ID for this document
assignedto string Person the document is assigned to
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
documentclass string Class of document
documentdate string Date/time the observation was taken
documentdescription string Description of the document type
documentroute string Explains method by which the document was entered into the AthenaNet (INTERFACE (digital), FAX, etc.)
documentsource string Explains where this document originated.
documentsubclass string Specific type of document
documenttypeid integer The ID of the description for this 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.
facilityid integer The ID of the clinical provider associated with this clinical document. Clinical providers are a master list of providers throughout the country. These include providers as well as radiology centers, labs and pharmacies.
facilityordercode object Facility specific coding for the type of order
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
orderid integer Order document id
ordertype string Order type group name
priority string Document priority, when available. 1 is high, 2 is normal. Some labs use other numbers or characters that are lab-specific.
providerid integer Provider ID for this document
status string Status of the document
subject string Subject of the document
tietoorderid integer Order ID of the order this document is tied to, if any
Example Code

Get patient's order document

GET
/v1/{practiceid}/patients/{patientid}/documents/order/{orderid}
Retrieves a specific order of the patient
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
patientid integer patientid
orderid integer orderid
showquestions boolean BETA FIELD: Some order types like labs and imaging orders have additional pertinant information in a question/answer format. Setting this will return that data.

Output Parameters

Expand all
actionnote string The most recent action note for a document
appointmentid integer The appointment ID for this document
approveddate string The date this document was approved
assignedto string Person the document is assigned to
cclist array The list of order document carbon-copy providers.
clinicalproviderid integer The ID of the clinical provider associated with this clinical document. Clinical providers are a master list of providers throughout the country. These include providers as well as radiology centers, labs and pharmacies.
clinicalprovidername string The Name of the clinical provider associated with this clinical document. Clinical providers are a master list of providers throughout the country. These include providers as well as radiology centers, labs and pharmacies.
createddate string Date the document was created. Please use createddatetime instead.
createddatetime string Date/Time (ISO 8601) the document was created
createduser string The user who created this document.
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
diagnosislist array Diagnoses for this document
documentclass string Class of document
documentdescription string Description of the document type
documentroute string Explains method by which the document was entered into the AthenaNet (INTERFACE (digital), FAX, etc.)
documentsource string Explains where this document originated.
documentsubclass string Specific type of document
documenttype string The description for this document
documenttypeid integer The ID of the description for this 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.
facilityid integer The ID of the clinical provider associated with this clinical document. Clinical providers are a master list of providers throughout the country. These include providers as well as radiology centers, labs and pharmacies.
facilityordercode object Facility specific coding for the type of order
hassummarycare string If true, document has a summary care record.
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
lastmodifieduser string The user who last modified this document.
observationdate string
observationdatetime string Date/time (ISO 8601) the observation was taken
orderid integer Order document id
ordertype string Order type group name
outofnetworkreferralreasonid integer ID of the out of network referral reason.
pages array An array of image pages associated with this document.
patientcaseid string The patient case id
performdate string Date the order was performed.
priority string Document priority, when available. 1 is high, 2 is normal. Some labs use other numbers or characters that are lab-specific.
providerid integer Provider ID for this document
questions array BETA FIELD: The custom list of questions and answers associated with this order. This list will vary by practice.
receivernote string The external note sent to the receiving facility
referralattachments array Set of referral attachments on an order.
specimencollectedby string The username of the individual who took the specimen
specimencollectiondatetime string Date/time (ISO 8601) of the specimen collection
specimencollectionsite string Options are ExternalLab, Office, Home, AddOn
specimennotes string Note included with the specimen
specimensourceid integer The internal ID of the site (on the patient) where the specimen was taken. Deprecated. Use SPECIMENSOURCENAME
specimensourcename string The site (on the patient) where the specimen was taken
standingorderdurationdays integer Duration of the standing order
standingorderfrequencydays integer Frequency at which the order repeats
standingorderstartdate string Start date of the standing order
status string Status of the document
subject string Subject of the document
submitter string Submitter of a document.
summarycaredocumentid integer ID of the summary care document.
tiedtodocuments array All documents that are tied to this order
tietoorderid integer Order ID of the order this document is tied to, if any
Example Code

Mark patient's order document as deleted

DELETE
/v1/{practiceid}/patients/{patientid}/documents/order/{orderid}
Deletes the record of a specified order
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
patientid integer patientid
orderid integer orderid

Output Parameters

Expand all
errormessage string If the operation failed, this will contain an error message.
orderid integer The document ID of the new or modified document.
success string Returns true/false if the operation was successful.
Example Code

Get page from patient's order document

GET
/v1/{practiceid}/patients/{patientid}/documents/order/{orderid}/pages/{pageid}
Retrieves a specific page from the specific order document of the patient
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
pageid integer pageid
patientid integer patientid
orderid integer orderid
filesize string The file size of the document being requested.

Output Parameters

Expand all
attachment string The image of the page in jpeg format.
Example Code

Adds signed order documents to patient's chart

POST
/v1/{practiceid}/patients/{patientid}/documents/signedorder
Create a record of a signed order to a patient. Note: This feature is does not allow to create prescription and vaccine orders.
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
patientid integer patientid
Content-Type string Content type of the payload

Output Parameters

Expand all
errormessage string If the operation failed, this will contain an error message.
orderid integer The document ID of the new or modified document.
success string Returns true/false if the operation was successful.
Example Code

Get list of order change events to which you can subscribe

GET
/v1/{practiceid}/orders/changed/subscription/events
Retrieve list of all events that can be input for this subscription.
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid

Output Parameters

Expand all
departmentids array List of Departmentids subscribed
status string Will return one of following statuses: ACTIVE, INACTIVE, or PARTIAL. The PARTIAL status means that not all events are subscribed to. In the event of a problem, UNKNOWN may be returned.
subscriptions array List of events you are subscribed to.
Example Code

Subscribe to all/specific change events for orders

POST
/v1/{practiceid}/orders/changed/subscription
Subscribes for changed order events
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
Content-Type string Content type of the payload

Output Parameters

Expand all
success string Returns if the call to manipulate subscriptions for orders was successful.
Example Code

Get list of order change subscription(s)

GET
/v1/{practiceid}/orders/changed/subscription
Retrieves list of events applicable for orders
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid

Output Parameters

Expand all
departmentids array List of Departmentids subscribed
status string Will return one of following statuses: ACTIVE, INACTIVE, or PARTIAL. The PARTIAL status means that not all events are subscribed to. In the event of a problem, UNKNOWN may be returned.
subscriptions array List of events you are subscribed to.
Example Code

Get list of changes in orders based on subscription

GET
/v1/{practiceid}/orders/changed
Retrieves list of records of modified order
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
leaveunprocessed boolean For testing purposes, do not mark records as processed
clinicalproviderid integer The clinical provider ID.
departmentid array Department ID. Multiple departments are allowed, either comma separated or with multiple values.
showprocessedenddatetime string See showprocessedstartdatetime
ordertype string Filters the type of order that will be returned.
showprocessedstartdatetime string Show already processed changes. This will show changes that you previously retrieved at some point after this datetime mm/dd/yyyy hh24:mi:ss (Eastern). Can be used to refetch data if there was an error, such as a timeout, and records are marked as already retrieved. This is intended to be used with showprocessedenddatetime and for a short period of time only. Also note that all messages will eventually be deleted.
limit integer Number of entries to return (default 1000, max 5000)Please note that this endpoint has a different default than normal.
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
administeryn string True if the order is marked as administered.
approvedby string The user who approved this order. Blank if the order has not been approved.
approvedtimestamp string The timestamp when this order was approved. Blank if the order has not been approved.
assigneduser string User this order is assigned to.
class string The document class of this order.
classdescription string A description of the document class for this order.
clinicalordertypeid integer The athena ID for this type of order. Can be used to create another order of this type.
clinicalproviderordertypeid integer The Unique ID for the type of order referred to by a clinical provider. A clinical provider here refers to a facility.
dateordered string Timestamp for when this order was created.
deniedby string The user who denied this order. Blank if the order has not been denied.
deniedtimestamp string The timestamp when this order was denied. Blank if the order has not been denied.
departmentid integer The ID of the department this order is associated with.
description string A description of this document.
documentationonly string A boolean field describing if this order is documentation only.
documentid integer The id of this order.
encounterid integer The ID of the clinical encounter this order is associated with.
externalnote string Note to the provider.
ordergenusname string It represents a class of vaccine.
orderingprovider string The username of the provider who created the order.
outofnetworkreason string Out of network reason
patientid integer The ID of the patient this order is associated with.
status string Current status of the order.
Example Code

Unsubscribe to all/specific change events for orders

DELETE
/v1/{practiceid}/orders/changed/subscription
Delete a specific event which is no longer required
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
eventname string By default, you are unsubscribed from all possible events. If you only wish to unsubscribe from an individual event, pass the event name with this argument.

Output Parameters

Expand all
success string Returns if the call to manipulate subscriptions for orders was successful.
Example Code

Get list of signed off order change events to which you can subscribe

GET
/v1/{practiceid}/orders/signedoff/subscription/events
Retrieve list of all events that can be input for this subscription.
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid

Output Parameters

Expand all
departmentids array List of Departmentids subscribed
status string Will return one of following statuses: ACTIVE, INACTIVE, or PARTIAL. The PARTIAL status means that not all events are subscribed to. In the event of a problem, UNKNOWN may be returned.
subscriptions array List of events you are subscribed to.
Example Code

Subscribe to all/specific change events for signed off orders

POST
/v1/{practiceid}/orders/signedoff/subscription
Subscribes for changed orders signed off events
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
Content-Type string Content type of the payload

Output Parameters

Expand all
success string Returns if the call to manipulate subscriptions for orders was successful.
Example Code

Get list of signed off order change subscription(s)

GET
/v1/{practiceid}/orders/signedoff/subscription
Retrieves list of events applicable for signed orders
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid

Output Parameters

Expand all
departmentids array List of Departmentids subscribed
status string Will return one of following statuses: ACTIVE, INACTIVE, or PARTIAL. The PARTIAL status means that not all events are subscribed to. In the event of a problem, UNKNOWN may be returned.
subscriptions array List of events you are subscribed to.
Example Code

Get signed off orders

GET
/v1/{practiceid}/orders/signedoff
Retrieves a list of orders which are signed off by the provider. This API will need to be subscribed more information, please refer Changed Data Subscriptions
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
leaveunprocessed boolean For testing purposes, do not mark records as processed
clinicalproviderid integer The clinical provider ID.
departmentid array Department ID. Multiple departments are allowed, either comma separated or with multiple values.
showprocessedenddatetime string See showprocessedstartdatetime
ordertype string Filters the type of order that will be returned.
showprocessedstartdatetime string Show already processed changes. This will show changes that you previously retrieved at some point after this datetime mm/dd/yyyy hh24:mi:ss (Eastern). Can be used to refetch data if there was an error, such as a timeout, and records are marked as already retrieved. This is intended to be used with showprocessedenddatetime and for a short period of time only. Also note that all messages will eventually be deleted.
limit integer Number of entries to return (default 1000, max 5000)Please note that this endpoint has a different default than normal.
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
administeryn string True if the order is marked as administered.
approvedby string The user who approved this order. Blank if the order has not been approved.
approvedtimestamp string The timestamp when this order was approved. Blank if the order has not been approved.
assigneduser string User this order is assigned to.
class string The document class of this order.
classdescription string A description of the document class for this order.
clinicalordertypeid integer The athena ID for this type of order. Can be used to create another order of this type.
clinicalproviderordertypeid integer The Unique ID for the type of order referred to by a clinical provider. A clinical provider here refers to a facility.
dateordered string Timestamp for when this order was created.
deniedby string The user who denied this order. Blank if the order has not been denied.
deniedtimestamp string The timestamp when this order was denied. Blank if the order has not been denied.
departmentid integer The ID of the department this order is associated with.
description string A description of this document.
documentationonly string A boolean field describing if this order is documentation only.
documentid integer The id of this order.
encounterid integer The ID of the clinical encounter this order is associated with.
externalnote string Note to the provider.
ordergenusname string It represents a class of vaccine.
orderingprovider string The username of the provider who created the order.
outofnetworkreason string Out of network reason
patientid integer The ID of the patient this order is associated with.
status string Current status of the order.
Example Code

Unsubscribe to all/specific change events for signed off orders

DELETE
/v1/{practiceid}/orders/signedoff/subscription
Delete an specific event which is no longer required
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
eventname string By default, you are unsubscribed from all possible events. If you only wish to unsubscribe from an individual event, pass the event name with this argument.

Output Parameters

Expand all
success string Returns if the call to manipulate subscriptions for orders was successful.
Example Code