Skip to main content
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: Reference Table: The immunization_references table contains normalized references from the immunization to other entities. It supports the following reference properties: 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
ColumnData TypeDescription
immunization_idvarcharUnique identifier for the immunization
patient_idvarcharUnique identifier for the patient
statusvarcharStatus of the immunization record (e.g. completed, not-done)
occurrencedatetimedatetimeOccurrence date/time if provided directly
occurrencestringvarcharOccurrence date/time as a string when not a structured date
occurrence_date†datetimeCoalesced occurrence date (occurrencedatetime or occurrencestring)
vaccinecode_textvarcharFree-text vaccine description
vaccinecode_cvx_code†varcharCVX vaccine code
vaccinecode_cvx_display†varcharHuman-readable CVX description
statusreason_textvarcharFree-text status reason
route_textvarcharFree-text route of administration
site_textvarcharFree-text administration site
dosequantity_valuevarcharDose quantity value
dosequantity_unitvarcharDose quantity unit
lotnumbervarcharLot number of the vaccine
note_text†varcharAdditional notes about the immunization (first note)
meta_sourcevarcharSource document filename from FHIR meta.source
data_source_ext†varcharIntegration source of the data, derived from FHIR extension
Related Tables: Parent: Child:

​
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