Allergy data model
View field support, webhooks, and list parameters for each integration on the Supported Integrations page.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier for the allergy/intolerance |
created_at | string (date-time) | No | When the allergy record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | When the allergy record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
patient_id | string | No | The patient who has the allergy |
encounter_id | string | No | The encounter in which the allergy was recorded |
practitioner_id | string | No | The practitioner who recorded or asserted the allergy |
name | string | No | Human-readable name of the substance |
codes | HealthcareCode[] | No | Codings for the substance (e.g. RxNorm, SNOMED CT) |
codes[].system | string | No | The code system URI (e.g. http://loinc.org, http://snomed.info/sct) |
codes[].code | string | No | The code within the system |
codes[].display | string | No | Human-readable display text for the code |
status | enum | No | Clinical status of the allergy Values: ACTIVE, INACTIVE, RESOLVED, OTHER |
type | enum | No | Category of the substance Values: FOOD, MEDICATION, ENVIRONMENT, BIOLOGIC, OTHER |
criticality | enum | No | Potential severity of future reactions Values: LOW, HIGH, UNABLE_TO_ASSESS, OTHER |
reactions | HealthcareCode[] | No | Codings for observed reaction manifestations (e.g. hives, anaphylaxis) |
reactions[].system | string | No | The code system URI (e.g. http://loinc.org, http://snomed.info/sct) |
reactions[].code | string | No | The code within the system |
reactions[].display | string | No | Human-readable display text for the code |
onset_at | string (date-time) | No | When the allergy was first identified (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
recorded_at | string (date-time) | No | When the allergy was recorded (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
notes | string | No | Free-text notes about the allergy |
metadata | HealthcareMetadata[] | No | |
metadata[].id | string | No | |
metadata[].value | object | No | |
metadata[].namespace | string | No | |
metadata[].format | enum | No | Values: TEXT, NUMBER, DATE, BOOLEAN, ARRAY, OBJECT |
metadata[].extra_data | object | No | |
metadata[].slug | string | No |
Are we missing anything? Let us know