Order Creation

Users can create orders through the API for open encounters in athenaNet. Once an order is created via API, the provider must still review and sign the order in athenaNet prior to submission. 

The following order types are supported for order creation:

  • Prescription
  • Imaging
  • Lab
  • DME
  • Vaccine
  • Patient Information

Ordering in athenaNet

The API supports creating orders inside the context of an appointment/encounter AND outside the context of an appointment/encounter (new order group). 

Orders Inside Appointments/Encounters: To create an order via API, providers will start by going through their normal exam workflow with a patient and enter a diagnosis in athenaNet. Once a diagnosis is added to an encounter, that encounter must be saved before you can retrieve the diagnosis for use in an API call.  Diagnoses could alternatively be added using the API. The order APIs may then be used to create orders within that encounter. Each order must be created using the corresponding diagnosis code to mitigate billing errors after the exam.  

New Order Groups: To create an order outside of an appointment/encounter, first use POST /chart/{patientid}/ordergroups to create a special type of encounter known as an "Orders Only" Encounter. The encounterid will be returned in the response of POST /chart/{patientid}/ordergroups. Diagnoses and then orders may be added to this encounterid using the normal encounter order workflow.

Creating Orders

When creating orders in athenaNet, only one order may be made per API call.  Each order API has input fields for order creation that apply to that specific order type.  There are minimum required fields for entry for all orders, which are EncounterID, DiagnosisSNOMEDCode and an Order Type ID.

DME, Imaging, Vaccine and Patient Information orders can be created by providing an athena OrderTypeID.  Prescription orders can be created providing either an athena OrderTypeID, an RxNormID, or an NDC (National Drug Code).  Lab orders can be created providing either an athena OrderTypeID or a LOINC (Logical Observation Identifiers Names and Codes).  To find athena Order TypeIDs that can be used for order creation, see “Finding Required Fields” below. If one of the three required fields from above is not entered into the call, the call will fail.

Note that 'document id' and 'order id' refer to the same object, and are used interchangeably. 

For each call there are also a number of other optional fields that may be entered during order creation.  These optional fields will aid the provider in completing the order in athenanet. Examples of these fields are Note to Provider, FacilityID for the location where service is to be provided or structured sig for a prescription order.  If optional fields are not provided, some will be automatically populated based on the information listed in the Default Values section below. .  As a final step, the provider will need to review the created order(s) and enter in any outstanding information required to sign the order in athenaNet.   

The following are the calls for order creation:

Finding Required Fields

You may use GET /chart/encounter/{encountered}/diagnoses to find the DiagnosisSNOMEDCode(s) for an encounter.

Each order type has its own GET /reference/order/*ordertype* call which can be used to find the proper athenaNet OrderTypeID.  You must provide at least two characters to search for an order type in all API calls.

The following are those API calls:

Prescription Orders

Prescriptions can be created by either providing an unstructured sig or by providing the necessary fields to create a structured sig. You cannot provide an unstructured sig along with structured sig data elements.  If you provide a structured sig, we allow you to order specifically with precise dosing, frequency and total quantity units.  The following calls are available to provide the different values that can be input.

Vaccine Orders

Total quantity units can also be input for Vaccines and found through the following call:

Missing content item.

Referral Orders

Creates a referral order for a patient within their current encounter. EncounterIDDiagnosisSnomedCode, and OrderTypeID are required. You may also send a facilitynote to the specified facilityid to which the referral is going. In addition, the referral can be sent as a high priority and a futuresubmitdate can be selected.

Additional information that can be included, similar to the experience in athenaNet, includes notetopatient, providernote, reasonforreferral, procedurecode, and startdate.


Getting Order Type Ids for Referral Orders

You can retrieve a context’s list of order type Ids via:

This returns a list of order types and their corresponding Ids. An order type Id is required for the submission of a referral.


Default Values

If you do not provide all the fields required when creating an order, athenaNet will default certain values for that order.

  • For Prescription orders, the Ordering Mode defaults to Prescribe.
  • For Vaccine orders, the Ordering Mode defaults to Administer.
  • For Vaccines, if selecting an ordering mode of “Declined”, Declined Date is set to Today and Declined Reason is set to Patient decision.
  • For DME orders, the Ordering Mode defaults to Prescribe.
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others

On this Page