Skip to main content
PATCH
Update or retract an allergy

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
allergy_id
string<uuid>
required

Body

application/json

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

clinical_status
enum<string>
Available options:
active,
inactive,
resolved,
entered_in_error
criticality
enum<string>
Available options:
low,
high,
unable_to_assess
category
enum<string>[]
Maximum array length: 4
Available options:
food,
medication,
environment,
biologic
type
enum<string>
Available options:
allergy,
intolerance
reactions
object[]
Maximum array length: 20
onset_date
string<date>
note
string
Maximum string length: 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.