v1

latestOpenAPI 3.1.02026-07-24447622848.7 KB
Medications

Retrieve Medication

get/api/2.0/medications/{id}/

Path parameters

idinteger required

Response

allow_substitutionsboolean nullable
auth_refillsinteger nullable required

The number of refills, excluding this order, that the patient is authorized for.

chart_datestring date-time
created_datestring date-time nullable
days_supplyinteger nullable
deleted_datestring date-time nullable
directionsstring nullable

The directions for the medication order.

document_datestring date-time

The timestamp for when this prescription was first documented. Will be the same as the creation time unless this an historical data import.

documenting_personnelinteger nullable

Physician object required if is_doc_med is true when creating.

idinteger
is_doc_medboolean required

If the medication order is intended to document a med instead of draft a prescription. When it is true, the object will be automatically signed as a documented medication, otherwise the object will be created as a draft prescription.

last_modifiedstring date-time
medication_type'otc' | 'prescription' required
  • otc - otc
  • prescription - prescription
notesstring nullable

Any notes for the patient.

num_samplesstring nullable
order_type'New' | 'Refill' | 'DoseChange' required
  • New - New
  • Refill - Refill
  • DoseChange - Change
patientinteger required

The patient the medication order is for.

pharmacy_instructionsstring nullable

Any notes for the pharmacy.

practiceinteger required

The practice the medication order is for.

prescribing_physicianinteger required

The physician who is prescribing the medication.

qtystring decimal nullable required

The quantity of the medication.

send_rx_reminderboolean
show_in_chart_feedboolean
signed_byinteger nullable
signed_datestring date-time nullable
start_datestring date required

The date on which the prescription started or will start.