Order

The Order features allows the user to view and modify existing order action notes. Clinical Provider Order types (CPOTs) are orders specific to a particular practice or organization (the clinical provider). This features allows the user to retrieve all the records of CPOT or COT based on the practice configuration. The Imaging CPOT Reference are Imaging orders specific to a particular practice or organization. LAB CPOT Reference are Laboratory orders specific to a particular practice or organization. The Modifier Reference allows the user to retrieve and include non fee-affecting information to attach to the procedure code. Modifiers are appended with a comma after the procedure code (e.g. "99213,GT,26"). The Office Order Types Reference features allows the user to retrieve the list of office order types configured for this practice. These orders are rendered at the point of care. Point of care labs will trigger an in-encounter result entry when ordered.

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

Endpoints

Get list of orders for given encounter
GET
/v1/{practiceid}/chart/encounter/{encounterid}/orders

Retrieves a list of orders based on the diagnosis for a specific encounter

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
encounterid integer encounterid
showdeclinedorders boolean If set, include orders that were declined
allowdischargetype boolean If set, this will allow getting orders for a discharge encounter type.
showdiagnoseswithoutorders boolean If set, this will return diagnoses with empty orders lists.
showclinicalprovider boolean If set, this will show the information about the provider receiving the order.
showexternalcodes boolean If set, translate the order information to relevant external vocabularies, where available. Examples are medictions to RxNorm and NDC, vaccines to CVX and MVX, labs to LOINC, etc. Our mappings are not exhaustive.

Output Parameters

Expand all
diagnosis string The name of the diagnosis
diagnosisicd array The matching ICD9 or ICD10 codes for this diagnosis, where available.
diagnosissnomed integer The SNOMED code for this diagnosis. 0 means No Diagnosis.
orders array List of orders for this diagnosis.
Example Code
Create action note to selected order
POST
/v1/{practiceid}/chart/encounter/{encounterid}/orders/{orderid}/actions

Creates an action note for a specific existing 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
encounterid integer encounterid
orderid integer orderid
Content-Type string Content type of the payload

❙ Request Body

Expand all
actionnote string The action note to add to the order.

Output Parameters

Expand all
errormessage string If the operation failed, this will contain any error messages.
success string Whether the operation was successful or not.
Example Code
Deny specific order request with reasons
POST
/v1/{practiceid}/chart/encounter/{encounterid}/orders/{orderid}/deny

Declines an order request with specific reasoning

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
encounterid integer encounterid
orderid integer orderid
Content-Type string Content type of the payload

❙ Request Body

Expand all
denyreasonid integer The ID of the deny reason.
username string The username of the person/entity denying the order. Use this field to receive a proper error message when the user does not have adequate permission to deny the order. This is NOT used for authentication.

Output Parameters

Expand all
errormessage string If the operation failed, this will contain any error messages.
success string Whether the operation was successful.
Example Code
Get denial reasons for selected order
GET
/v1/{practiceid}/chart/encounter/{encounterid}/orders/{orderid}/deny

Retrieves the list of denial reasons for the 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
encounterid integer encounterid
orderid integer orderid
username string The username of the person/entity denying the order. Will return any denial reason that is valid for that user, or error if none exist. This is NOT used for authentication.

Output Parameters

Expand all
denyreason string A human readable description for this deny reason
denyreasonid integer The athena ID for this reason for denying the order.
Example Code
Revert order state to submit status
POST
/v1/{practiceid}/chart/encounter/{encounterid}/orders/{orderid}/returntosubmit

Changes the order status to "Submit" if they are currently in the SUBMITTED status

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
encounterid integer encounterid
orderid integer orderid
Content-Type string Content type of the payload

Output Parameters

Expand all
errormessage string If the operation failed, this will contain any error messages.
success string Whether the operation was successful.
Example Code
Submit order for given encounter
POST
/v1/{practiceid}/chart/encounter/{encounterid}/orders/{orderid}/submit

Changes the status of the order to Submit when the order is routed via ATHENAFAX, MANUALFAX, MANUALPRINT, and MANUALPHONE

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
encounterid integer encounterid
orderid integer orderid
Content-Type string Content type of the payload

❙ Request Body

Expand all
submitvia string The route to submit via (ATHENAFAX, MANUALFAX, MANUALPRINT, and MANUALPHONE are currently the only supported options)

Output Parameters

Expand all
errormessage string If the operation failed, this will contain any error messages.
success string Whether the operation was successful.
Example Code
Get list of outstanding orders for given encounter
GET
/v1/{practiceid}/chart/encounter/{encounterid}/orders/outstanding

Retrieves a list of orders for a specific encounter which are yet to be submitted

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
encounterid integer encounterid
showdeclinedorders boolean If set, include orders that were declined
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
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.
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.
name string Name of this order.
orderingprovider string The username of the ordering provider, which is different than the ordering user - who may be an intake nurse for example.
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
Retrieve some data regarding an order, including the list of documents attached to the order. Useful for finding attached letters, prescription renewal chains, and lab/imaging results.
GET
/v1/{practiceid}/chart/encounter/{encounterid}/orders/{orderid}

Some data regarding this order, including the list of documents attached to the order. Useful for finding attached letters, prescription renewal chains, and lab/imaging results. Note: This endpoint may rely on specific settings to be enabled in athenaNet Production to function properly that are not required in other environments. Please see <a href="https://docs.athenahealth.com/api/resources/best-practices-and-troubles… Rollout of APIs</a> for more information if you are experiencing issues.

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
encounterid integer encounterid
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.
showexternalcodes boolean If set, translate the order information to relevant external vocabularies, where available. Examples are medictions to RxNorm and NDC, vaccines to CVX and MVX, labs to LOINC, etc. Our mappings are not exhaustive.

Output Parameters

Expand all
class string The primary class of this order -- PRESCRIPTION, VACCINE, LAB, IMAGING, PATIENTINFO, etc.
classdescription string The human-readable description of this document class, including sub class (prescription - new vs. prescription - renewal).
clinicalprovider string The name of the facility, person, or group that the order is being sent to.
clinicalproviderid integer The ID of the facility (facilityid), person, or group that the order is being sent to.
clinicalproviderordertype string The Name for the type of order referred to by a clinical provider (A clinical provider here refers to a facility).
clinicalproviderordertypeid integer The Unique ID for the type of order referred to by a clinical provider (A clinical provider here refers to a facility).
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.
createduser string The username of the person who created the order.
dateordered string The timestamp when the order 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.
departmentid integer Department ID of the Provider
description string A human readable description for this order
diagnosislist array List of Diagnosis related to this order.
documentationonly string If true, this order is here just as a record, and does not need to actually go out.
documents array The list of documents attached to this order. This can be letters, lab or imaging results, prescription renewals, etc.
externalcodes array When available, contains how this order maps to external vocabularies like LOINC, CVX, SNOMED, RXNORM, etc.
facilityordercode object Facility specific coding for the type of order
orderid integer The order (aka document) ID for this order.
orderingprovider string The username of the ordering provider, which is different than the ordering user -- who may be an intake nurse for example.
ordertype string The type of this order (Lab, Vaccine, etc.)
ordertypeid integer The athena ID for this type of order. Can be used to create another order of this type.
priority integer Priority of an order. 1 is high; 2 is normal.
providerid integer ID of the Provider
questions array BETA FIELD: The custom list of questions and answers associated with this order. This list will vary by practice.
specimencollectionsite string The location where a clinical specimen if any was collected.
status string The status the document is in (PEND, CLOSED, SUBMIT, SUBMITTED, etc).
Example Code
Get list of orderable concept (ordertype or CPOT)
GET
/v1/{practiceid}/configuration/ordertype

Retrieves a list of all orderable COTs and CPOTs

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
labfacilityid integer The athena ID of the lab facility that would be responsible for filling any lab orders. Get a localized list using /chart/configuration/facilities
imagingfacilityid integer The athena ID of the imaging facility that would be responsible for filling any imaging orders. Get a localized list using /chart/configuration/facilities
providerid integer The athena ID of the provider making the search.
searchterm string The term to search for.
limit integer The number of items returned from this endpoint, up to a maximum of 100.
snomedcode string The SNOMED code for a diagnosis. If this is passed in, the API will take the SNOMED code into account while determining which order types are more relevant. If this field is passed in, both the encounter id and the provider id must also be passed in, or the search query must be at least 2 characters long.
encounterid integer The athena ID of the encounter in which the order will be placed.

Output Parameters

Expand all
clinicalproviderordertypeid integer The athena ID describing the Clinical Provider Order Type matching the search string.
electronicordercode string The electronic order code that identifies the order in external systems.
facilityid integer The athena ID of the facility responsible for filling the order.
ordergenusname string The Order genus Name
ordertypegroupid integer The athena ID of the order type group under which the orderable falls (eg. 11 for LAB).
ordertypegroupname string The name of the order type group under which the orderable falls (eg. LAB).
ordertypeid integer The id of an order type which matches the search string.
ordertypename string The name of an orderable concept (ordertype or CPOT) which matches the search string.
Example Code
Get list of imaging studies for CPOT
GET
/v1/{practiceid}/reference/clinicalproviderordertype/imaging

Retrieves a list of imaging studies for CPOT

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
searchvalue string A term to search for. Must be at least 2 characters
facilityid integer The athena ID of the facility. Get a localized list using /chart/configuration/facilities.

Output Parameters

Expand all
clinicalproviderordertypeid integer The athena ID of the clinical provider order type
name string The name of the clinical provider order type
ordercode string The order code pertaining to the clinical provider
ordertypeid integer The athena ID of the type of order
Example Code
Get list of labs for CPOT
GET
/v1/{practiceid}/reference/clinicalproviderordertype/lab

Retrieves a list of laboratories for CPOT

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
searchvalue string A term to search for. Must be at least 2 characters
facilityid integer The athena ID of the facility. Get a localized list using /chart/configuration/facilities.

Output Parameters

Expand all
clinicalproviderordertypeid integer The athena ID of the clinical provider order type
name string The name of the clinical provider order type
ordercode string The order code pertaining to the clinical provider
ordertypeid integer The athena ID of the type of order
Example Code
Get list of non-fee affecting modifiers
GET
/v1/{practiceid}/encounter/configuration/modifiers

Gets a list of non-fee-affecting modifiers that can be attached to a service.

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
description string Description of the modifier.
modifierid integer ID of the modifier.
Example Code
Get List of Ordertypes
GET
/v1/{practiceid}/chart/configuration/officeordertypes

Retrieves a list of ordertypes configured for a Practice

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
clinicalordertypeid integer The athena ID for this order type
clinicalprovider string The name of the clinical provider / department handling this point of care order
clinicalproviderid integer The athena ID of the clinical provider / department handling this point of care order
departmentids string The list of departments that have this point of care order type configured
loinc string The LOINC code matching this order, if available
ordertype string The name of the order type
ordertypecategory string The type of order -- LAB, IMAGING, etc.
Example Code