Order - Vaccine

Order - Vaccines allows the user to order a vaccine (prescribed, administered, or declined) and attach it to a particular diagnosis. Order - Vaccine Declined Reasons Reference allows the user to retrieve and view the reasons configured in the system to decline a vaccinetypes of referrals configured in the system. Order - Vaccine Orderable Reference allows the user to Order a vaccine (prescribed, administered, or declined) and attach it to a particular diagnosis. Order - Vaccine Total Quantity Units Reference allows the user to retrieve and view the list of type of medications quantities configured in the system.

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

Endpoints

Create new vaccine order
POST
/v1/{practiceid}/chart/encounter/{encounterid}/orders/vaccine

Create a new vaccine order record 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
Content-Type string Content type of the payload

❙ Request Body

Expand all
administernote string An additional note to the provider or staff for administration.
declineddate string The date on which the patient declined the vaccine. Required if the declined reason is passed in.
declinedreason integer To get a list of decline reasons for this input, call "GET /reference/order/vaccine/declinedreasons"
diagnosissnomedcode integer The SNOMED code for diagnosis this order is for.
dispenseaswritten boolean Whether the vaccine prescription should be marked as dispense as written (i.e., no substitutions without consulting the doctor).
facilityid string The athena id of the pharmacy you want to send the vaccine prescription to. Defaults to the patient default pharmacy. Get a localized list using /chart/configuration/facilities.
ndc string The National Drug Code for the vaccine.
numrefillsallowed integer The number of refills allowed for this vaccine prescription. Defaults to 0.
orderingmode string Selects whether you wish to prescribe, administer, or decline this vaccine.
ordertypeid integer The athena ID of the vaccine to order. Must be an orderable vaccine. Get the IDs using /reference/order/vaccine
performondate string The date on which the Vaccine was administered.
pharmacynote string A note to send to the pharmacy.
providernote string An internal note for the provider or staff.
totalquantity number The total amount of vaccine to be prescribed.
totalquantityunit string The unit of the total quantity, and required if that is passed in. Get the list of available values from /reference/order/vaccine/totalquantityunits. Most values are not valid for each individual vaccine.
unstructuredsig string The unstructured sig.

Output Parameters

Expand all
documentid integer The ID of the document created.
errormessage string If the operation failed, this will contain any error messages.
success string Whether the operation was successful.
Example Code
Get list of orderable vaccines
GET
/v1/{practiceid}/reference/order/vaccine

Retrieves a list of orderable vaccines

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
cvx string The CVX code of the vaccine. Matching vaccines will be returned. A list of CVX codes can be retrieved at https://www2a.cdc.gov/vaccines/iis/iisstandards/vaccines.asp?rpt=vg

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 vaccine decline reasons
GET
/v1/{practiceid}/reference/order/vaccine/declinedreasons

Retrieves a list of configured vaccine declined reasons

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
showinactive boolean Include deactivated declined reasons
limit integer Number of entries to return (default 1000, max 1000)Please note that this endpoint has a different default and max than normal.
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
active string Indicates whether the declined reason is currently active and may be used for creating new orders
declinedreason string The reason that the patient declined the vaccine. Required if the declined date is passed in. Defaults to "Patient decision".
declinedreasonid string The declined reason ID.
Example Code
Get list of orderable total quantities for vaccine
GET
/v1/{practiceid}/reference/order/vaccine/totalquantityunits

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

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
quantityunit string The unit for individual dosage and total quantities.
Example Code