immunization

Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party. See the HL7 FHIR R4 spec for full details.

Previous version: immunization

Tables in this resource:

• immunization – Main immunization record (this page)
• immunization_vaccinecode_coding
• immunization_statusreason_coding
• immunization_route_coding
• immunization_site_coding
• immunization_extension
• immunization_extension_vcc_coding
• immunization_references – Normalized references; see Reference Tables

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
• performer.actor: links to practitioner or organization per reference_type

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

Primary Keys:

• immunization_id

Foreign Keys:

• patient_id - links to the patient table

_{† Metriport Platform added}

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 (e.g. completed, not-done)
occurrencedatetime	datetime	Occurrence date/time if provided directly
occurrencestring	varchar	Occurrence date/time as a string when not a structured date
occurrence_date†	datetime	Coalesced occurrence date (occurrencedatetime or occurrencestring)
vaccinecode_text	varchar	Free-text vaccine description
vaccinecode_cvx_code†	varchar	CVX vaccine code
vaccinecode_cvx_display†	varchar	Human-readable CVX description
statusreason_text	varchar	Free-text status reason
route_text	varchar	Free-text route of administration
site_text	varchar	Free-text administration site
dosequantity_value	varchar	Dose quantity value
dosequantity_unit	varchar	Dose quantity unit
lotnumber	varchar	Lot number of the vaccine
note_text†	varchar	Additional notes about the immunization (first note)
meta_source	varchar	Source document filename from FHIR meta.source
data_source_ext†	varchar	Integration source of the data, derived from FHIR extension

Related Tables:

Parent:

• patient

Child:

• immunization_extension
• immunization_route_coding
• immunization_site_coding
• immunization_statusreason_coding
• immunization_vaccinecode_coding

Version diff

Renamed

• cvx_code → vaccinecode_cvx_code
• cvx_display → vaccinecode_cvx_display
• dose_amount → dosequantity_value
• dose_unit → dosequantity_unit
• data_source → meta_source

Moved to separate tables

• source_vaccine_code_code → immunization_vaccinecode_coding.code w/ code_rank = 1
• source_vaccine_code_display → immunization_vaccinecode_coding.display w/ code_rank = 1
• source_vaccine_code_system → immunization_vaccinecode_coding.system w/ code_rank = 1