Skip to main content
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
ColumnData TypeDescription
immunization_idvarcharUnique identifier for the immunization
patient_idvarcharUnique identifier for the patient
statusvarcharStatus 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_datedateDate when the immunization was administered
cvx_codevarcharCVX vaccine code
cvx_displayvarcharHuman-readable description of CVX code
source_vaccine_code_codevarcharOriginal vaccine code from source system
source_vaccine_code_displayvarcharOriginal vaccine code display from source system
source_vaccine_code_systemvarcharOriginal vaccine code system from source system
dose_amountvarcharQuantity of the dose administered
dose_unitvarcharUnit of measurement for the dose
note_textvarcharAdditional notes about the immunization
meta_sourcevarcharSource document filename from FHIR meta.source
data_sourcevarcharDeprecated. Use meta_source instead.
data_source_extvarcharIntegration source of the data, derived from FHIR extension