List medication administrations

get/v1/medication-administrations

Returns a page of medication administrations. Filters combine with AND. Use next_cursor to fetch the next page.

Authorization

Authorization: Bearer ak_...requiredscope: read

An AveeCare API key created in Settings → API Keys. A read or read + write key can call this endpoint. About authentication

Query parameters

limit
integerdefault: 25min 1max 100

Number of objects to return, from 1 to 100.

cursor
string

The next_cursor from the previous page. Send the same filters with it.

patient_id
string

Only return doses for this patient.

medication_id
string

Only return doses of this medication.

scheduled_date
string · date

Only return doses due on this date.

created_after
string · date-time

Only return objects created after this time (exclusive). ISO 8601 with a time zone.

created_before
string · date-time

Only return objects created before this time (exclusive). ISO 8601 with a time zone.

updated_after
string · date-time

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.

updated_before
string · date-time

Only return objects last changed before this time (exclusive). ISO 8601 with a time zone.

Response

200

A page of results.

object
string

Always list.

data
array of objects

The medication administrations on this page.

Show item attributesHide item attributes(17)
object
stringrequiredread-only

String representing the object's type. Always medication_administration.

id
stringrequiredread-only

Unique identifier of the medication administration.

medicationId
string | nullrequiredread-onlymax length 64

The medication this dose was for.

patientId
string | nullrequiredread-onlymax length 64

The patient.

visitId
string | nullrequiredread-onlymax length 64

The visit during which the dose was recorded.

scheduledDate
string · date | nullrequiredread-only

Date the dose was due.

scheduledSlot
string | nullrequiredread-onlymax length 2000

Time slot the dose was due, as HH:MM.

status
string | nullrequiredread-only

What happened to the dose.

One ofGivenRefusedHeldMissedSelfAdministerednull
administeredAt
string · date-time | nullrequiredread-only

When the dose was given.

administeredByName
string | nullrequiredread-onlymax length 2000

Who gave or recorded the dose.

reasonText
string | nullrequiredread-onlymax length 20000

Why the dose was refused, held or missed.

note
string | nullrequiredread-onlymax length 20000

Note recorded with the dose.

witnessName
string | nullrequiredread-onlymax length 2000

Witness, for medications that require one.

prnReason
string | nullrequiredread-onlymax length 2000

For as-needed doses, why it was given.

amended
boolean | nullrequiredread-only

Whether this entry was later corrected.

createdAt
string · date-time | nullrequiredread-only

When the medication administration was created.

updatedAt
string · date-time | nullrequiredread-only

When the medication administration was last changed.

next_cursor
string | null

Pass as cursor to fetch the next page. null on the last page.

has_more
boolean

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

StatusCodeMeaning
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.