Medication data model
View field support, webhooks, and list parameters for each integration on the Supported Integrations page.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier for the medication order/prescription |
created_at | string (date-time) | No | When the medication record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | When the medication record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
patient_id | string | No | The patient the medication is for |
encounter_id | string | No | The encounter in which the medication was ordered |
practitioner_id | string | No | The practitioner who prescribed the medication |
name | string | No | Human-readable name of the medication |
codes | HealthcareCode[] | No | Codings for the medication (e.g. RxNorm) |
codes[].system | string | No | The code system URI (e.g. http://loinc.org, http://snomed.info/sct) |
codes[].code | string | No | The code within the system |
codes[].display | string | No | Human-readable display text for the code |
status | enum | No | Status of the medication order Values: DRAFT, ACTIVE, ON_HOLD, COMPLETED, STOPPED, CANCELLED, ENTERED_IN_ERROR, UNKNOWN, OTHER |
dosage | string | No | Free-text dosage instructions (e.g. "1 tablet by mouth twice daily") |
refill_count | number | No | Number of refills authorized |
authored_at | string (date-time) | No | When the medication was prescribed (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
start_at | string (date-time) | No | When the patient should start taking the medication (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
end_at | string (date-time) | No | When the patient should stop taking the medication (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
notes | string | No | Free-text notes about the medication |
metadata | HealthcareMetadata[] | No | |
metadata[].id | string | No | |
metadata[].value | object | No | |
metadata[].namespace | string | No | |
metadata[].format | enum | No | Values: TEXT, NUMBER, DATE, BOOLEAN, ARRAY, OBJECT |
metadata[].extra_data | object | No | |
metadata[].slug | string | No |
Are we missing anything? Let us know