Immunization 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 immunization |
created_at | string (date-time) | No | When the immunization record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | When the immunization record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
patient_id | string | No | The patient who was immunized |
encounter_id | string | No | The encounter in which the vaccine was administered |
practitioner_id | string | No | The practitioner who administered the vaccine |
location_id | string | No | Where the vaccine was administered |
name | string | No | Human-readable name of the vaccine |
codes | HealthcareCode[] | No | Codings for the vaccine (e.g. CVX) |
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 | Status of the immunization Values: COMPLETED, NOT_DONE, ENTERED_IN_ERROR, OTHER |
administered_at | string (date-time) | No | When the vaccine was administered (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
lot_number | string | No | Vaccine lot number |
expires_at | string (date-time) | No | Vaccine expiration date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
notes | string | No | Free-text notes about the immunization |
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