List medications
/v1/medicationsReturns a page of medications. Filters combine with AND. Use next_cursor to fetch the next page.
Query parameters
Number of objects to return, from 1 to 100.
The next_cursor from the previous page. Send the same filters with it.
Only return medications of this patient.
Only return medications with this status.
ActiveOnHoldDiscontinuedOnly return objects created after this time (exclusive). ISO 8601 with a time zone.
Only return objects created before this time (exclusive). ISO 8601 with a time zone.
Only return objects last changed after this time (exclusive). ISO 8601 with a time zone. Use it for incremental sync: pass the newest updatedAt you already have.
Only return objects last changed before this time (exclusive). ISO 8601 with a time zone.
Response
200A page of results.
Always list.
The medications on this page.
Show item attributesHide item attributes(27)
String representing the object's type. Always medication.
Unique identifier of the medication.
The patient who takes this medication.
Drug name, without the strength.
Strength per dose unit.
Dose form.
How it is taken.
Directions as written on the prescription.
What the medication is for.
Scheduled for regular doses, PRN for as-needed.
ScheduledPRNnullFor as-needed medications, when to give it.
For as-needed medications, the most doses allowed in a day.
For as-needed medications, the minimum hours between doses.
Date the patient started the medication.
Whether the medication is currently given.
ActiveOnHoldDiscontinuednullDate the medication was stopped.
Why the medication was stopped.
Prescribing clinician.
Prescriber's phone number.
Pharmacy that fills the prescription.
Pharmacy phone number.
Whether a second person must witness each dose.
Doses currently on hand.
Refills left on the prescription.
Other notes.
When the medication was created.
When the medication was last changed.
Pass as cursor to fetch the next page. null on the last page.
Whether another page exists.
Response headers
Request-IdstringUnique ID of this request. Quote it when contacting support.RateLimit-LimitintegerRequests allowed in the current window.RateLimit-RemainingintegerRequests left in the current window.RateLimit-ResetintegerSeconds until the window resets.Errors
| Status | Code | Meaning |
|---|---|---|
| 400 | n/a | The request was malformed, a value was invalid, or it contained an unknown field (invalid_request, unknown_field). |
| 401 | n/a | The API key is missing, malformed, expired or revoked (unauthorized). |
| 403 | n/a | The key is read-only (insufficient_scope), or its user's role cannot do this (forbidden). |
| 429 | n/a | Too many requests (rate_limited). Wait for Retry-After seconds. |
| 500 | n/a | Something went wrong on our side (internal_error). Retry, and quote the request ID if it persists. |
Every error uses the same body. See Errors for the full list of codes.