Retrieve a medication administration

get/v1/medication-administrations/{id}

Returns one medication administration by ID.

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

Path parameters

id
stringrequired

ID of the medication administration.

Response

200

The medication administration.

object
stringread-only

String representing the object's type. Always medication_administration.

id
stringread-only

Unique identifier of the medication administration.

medicationId
string | nullread-onlymax length 64

The medication this dose was for.

patientId
string | nullread-onlymax length 64

The patient.

visitId
string | nullread-onlymax length 64

The visit during which the dose was recorded.

scheduledDate
string · date | nullread-only

Date the dose was due.

scheduledSlot
string | nullread-onlymax length 2000

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

status
string | nullread-only

What happened to the dose.

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

When the dose was given.

administeredByName
string | nullread-onlymax length 2000

Who gave or recorded the dose.

reasonText
string | nullread-onlymax length 20000

Why the dose was refused, held or missed.

note
string | nullread-onlymax length 20000

Note recorded with the dose.

witnessName
string | nullread-onlymax length 2000

Witness, for medications that require one.

prnReason
string | nullread-onlymax length 2000

For as-needed doses, why it was given.

amended
boolean | nullread-only

Whether this entry was later corrected.

createdAt
string · date-time | nullread-only

When the medication administration was created.

updatedAt
string · date-time | nullread-only

When the medication administration was last changed.

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
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).
404
n/a
No such object, or it is not visible to this key (not_found).
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.