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 What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
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 What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Try in Postman

Input Parameters

Expand all
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 What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Try in Postman

Input Parameters

Expand all

Output Parameters

Expand all
Example Code
Get list of patient's orders

Output Parameters

Expand all
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 What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Try in Postman

Input Parameters

Expand all

Output Parameters

Expand all
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 What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Try in Postman

Input Parameters

Expand all
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 What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Try in Postman

Input Parameters

Expand all
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 What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Try in Postman

Input Parameters

Expand all
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 What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Try in Postman

Input Parameters

Expand all
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 What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Try in Postman

Input Parameters

Expand all
Example Code
Get list of changes in orders based on subscription

Output Parameters

Expand all
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 What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Try in Postman

Input Parameters

Expand all
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 What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Try in Postman

Input Parameters

Expand all
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 What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Try in Postman

Input Parameters

Expand all
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 What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Try in Postman

Input Parameters

Expand all
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 What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Try in Postman

Input Parameters

Expand all

Output Parameters

Expand all
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 What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Try in Postman

Input Parameters

Expand all
Example Code