Immunization

Schema documentation for the Immunization table in the Metriport data model

The immunization resource is intended to cover the recording of current and historical administration of vaccines to patients across all healthcare disciplines in all care settings and all regions. This includes immunization of both humans and animals but does not include the administration of non-vaccine agents, even those that may have or claim to have immunological effects.

Reference Table:

The immunization_references table contains normalized references from the immunization to other entities. It supports the following reference properties:

• patient (required): links to the patient who received the immunization
• encounter: links to the encounter where the immunization was administered
• location: links to the location where the medication was dispensed
• performer.actor: links to practitioners who performed the immunization

For detailed information about reference table structure and indexing, see the Reference Tables documentation.

Immunization Table:

Primary Key:

• immunization_id

Foreign Keys:

• patient_id

Column	Data Type	Description
immunization_id	varchar	Unique identifier for the immunization
patient_id	varchar	Unique identifier for the patient
status	varchar	Status of the immunization record. Possible values: – completed: All steps required have been taken and the vaccine has been administered. – entered-in-error: The immunization record was created in error and should not be considered valid. – not-done: The immunization did not occur, as intended, but was not actually administered, for example, patient refusal.
occurrence_date	date	Date when the immunization was administered
cvx_code	varchar	CVX vaccine code
cvx_display	varchar	Human-readable description of CVX code
source_vaccine_code_code	varchar	Original vaccine code from source system
source_vaccine_code_display	varchar	Original vaccine code display from source system
source_vaccine_code_system	varchar	Original vaccine code system from source system
dose_amount	varchar	Quantity of the dose administered
dose_unit	varchar	Unit of measurement for the dose
note_text	varchar	Additional notes about the immunization
meta_source	varchar	Source document filename from FHIR meta.source
data_source	varchar	Deprecated. Use meta_source instead.
data_source_ext	varchar	Integration source of the data, derived from FHIR extension