Skip to main content
PATCH
Update or retract a reported medicine

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string

Optional. A unique value you choose for this request, such as a UUID. When sent, a retry with the same key returns the first answer instead of applying the change twice. See Retries and idempotency.

Minimum string length: 1

Path Parameters

clinic_id
string<uuid>
required
medication_statement_id
string<uuid>
required

Body

application/json

A proposed change to a reported medicine. It becomes a NEW pending submission; the statement does not change until a clinician confirms it. The medicine itself can never be changed (a different medicine is a new statement). status: entered_in_error proposes retracting the statement and cannot be combined with other changes.

status
enum<string>
Available options:
active,
completed,
stopped,
on_hold,
not_taken,
entered_in_error
dosage
object
effective_start
string<date>
effective_end
string<date>
reason
string
Required string length: 1 - 500
note
string
Required string length: 1 - 2000
client_reference
string
Maximum string length: 200
origin_assistant_name
string
Maximum string length: 200

Response

Accepted - waiting for a clinician.

data
object
required

What the clinic's review queue holds for something this key sent: one outside record waiting for, or already past, a clinician's decision.