Order - Prescription

The Order - Prescription allows the user to create a new prescription order. The medication order (prescribed, administered, or dispensed) is attached to a particular diagnosis. We do not allow the ordering of compound or unlisted medications via the API. If you provide an unstructured sig, the structured sig elements will be ignored. The route the prescription will take (electronic, fax, paper, or manual) will depend on the pharmacy selected, whether the medication is a controlled substance, and the state the practice is in.

The Order - Prescription Dosage Reference allows the user to view the list of dosage units configured in the system.

The Order - Prescription Frequency Reference allows the user to view the list frequencies of dosage configured in the system.

The Order - Prescription Orderable Reference allows the user to retrieve and view the list medications configured in the system.

The Order - Prescription Total Quantity Units Reference allows the user to retrieve and view the list of types of medication quantities configured in the system.

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

Endpoints

Create new prescription order for given encounter
POST
/v1/{practiceid}/chart/encounter/{encounterid}/orders/prescription

Create new prescription order record for a specific encounter

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

❙ Request Body

Expand all
additionalinstructions string Sig field. Additional modifiers for when to take the medication.
administernote string An additional note to the provider or staff for administration.
diagnosissnomedcode integer The SNOMED code for diagnosis this order is for.
dispenseaswritten string Whether the prescription should be marked as dispense as written (i.e., no substitutions without consulting the doctor).
dosagequantity number Sig field. The numerical amount of medication to take.
dosagequantityunit string Sig field. The unit of the dosage quantity, and required if that is passed in. Get the list of available values from /reference/order/prescription/dosagequantityunits. Most values are not valid for each individual medication.
duration number Sig field. The numerical amount of days to take this medication for.
externalnote string An additional note to the patient.
facilityid integer The athena ID of the pharmacy you want to send the prescription to. Defaults to the patient default pharmacy. You can use this or the pharmacy NCPDP ID but not both. Get a localized list using /chart/configuration/facilities.
frequency string Sig field. How often to take doses of the medication. Get the list of available values from /reference/order/prescription/frequencies.
ndc string The NDC of the medication to order. You may use this instead of ordertypeid
numrefillsallowed integer The number of refills allowed for this prescription. Defaults to 0.
orderingmode string Selects whether you wish to prescribe, administer, or dispense this medication.
ordertypeid integer The athena ID of the medication to order. Must be an orderable medication. We currently do not support adding of compound or unlisted medicaitons. Get the IDs using /reference/order/prescription. You may use this, an NDC, or a RxNormID.
pharmacyncpdpid string The NCPDP ID of the pharmacy you want to send the prescription to. You can use this instead of the facilityid, but not both.
pharmacynote string A note to send to the pharmacy.
providernote string An internal note for the provider or staff.
rxnormid string The RxNormID of the medication to order. You may use this instead of ordertypeid. If the RxNormID maps to more than one possible orderable medication, it will be rejected.
totalquantity number The total amount of medication to be prescribed. It should match the total amount needed as described in the sig.
totalquantityunit string The unit of the total quantity, and required if that is passed in. Get the list of available values from /reference/order/prescription/totalquantityunits. Most values are not valid for each individual medication.
unstructuredsig string The unstructured sig. If this field is set please leave all other sig fields blank.

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 units for dosage quantities
GET
/v1/{practiceid}/reference/order/prescription/dosagequantityunits

Retrieves a list of dosage units configured in the system

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

Output Parameters

Expand all
quantityunit string The unit for individual dosage and total quantities.
Example Code
Get list of dosage frequencies
GET
/v1/{practiceid}/reference/order/prescription/frequencies

Retrieves a list of dosage frequencies configured in the system

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

Output Parameters

Expand all
frequency string dosage frequency
Example Code
Get list of orderable medication
GET
/v1/{practiceid}/reference/order/prescription

Retrieves a list of medications configured in the system

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
searchvalue string A term to search for. Must be at least 2 characters

Output Parameters

Expand all
name string The name of the order
ordertypeid integer The athena ID of the type of order
Example Code
Get list of orderable total quantities for medications
GET
/v1/{practiceid}/reference/order/prescription/totalquantityunits

Retrieves a list of type of medications quantities configured in the system

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

Output Parameters

Expand all
quantityunit string The unit for individual dosage and total quantities.
Example Code