Patient Immunization

  • Version 3
  • Published
  • Updated

A patient's immunization event (vaccination) or reported immunization.
For reported rather than actual event information, if specific attribute values are not available, corresponding free text descriptions can be entered instead as clinical annotation(s).
Since reported information is provided by a non-practitioner, expectations about its accuracy are low, unlike for actual (immunization) event information whose reporting source is a health care practitioner or a computer record. Thus, although the information may sometimes be accurate (e.g., when a patient has access to prescriptions or to the report of a vaccination performed in a clinic), it may also be incomplete and inaccurate, as some patients may not recall their medical history precisely.

Appears in

Constraints

n/a

Stereotype(s)

n/a

Attributes

AttributeTypeMultiplicityAttribute note
Patient Immunization Occurrence Date Time Date Time 0..1
The date and, if known, the time when an immunization (vaccination) of a patient was recorded or reported as having occurred. Note: This attribute will not be populated for immunizations that have a status other than "completed" (e.g., not done because deferred or refused). If Patient Immunization is a Health Care Service Event (i.e., actually recorded in EMR, rather than simply reported by a non-clinician), then this attribute must be: equal to Health Care Service Event Period.Start Date Time (usually) or (later than (>) Health Care Service Event Period.Start Date Time and earlier than (<) Health Care Service Event Period.End Date Time if specified).
Patient Immunization Dose Quantity 0..1
The dose quantity (volume) and unit of measure code (e.g., ml, mg, mcg) of immunization product being administered to a patient. Unit of Measure Code Value Set: https://ui.terminologystandardsservice.ca/ui/deeplink?iss=https://terminologystandardsservice.ca/fhir&type=ValueSet&canonicalUrl=https://fhir.infoway-inforoute.ca/ValueSet/prescriptiondosequantityunit
Patient Immunization Dose Number Integer 0..1
The dose number within a series (e.g., dose 1 of 2 for Shingles immunization) administered to a patient.
Patient Immunization Status Code Codeable Concept 1
Uniquely specifies the current status of the immunization event on a patient (e.g., completed, entered in error, not done). Value Set: https://fhir.infoway-inforoute.ca/ValueSet/immunizationstatuscodes
Patient Immunization Reason Code Codeable Concept 0..*
Uniquely specifies the reason(s) the immunization product was administered to a patient (e.g., high-risk immunization, routine immunization). Value Set: To be developed.
Patient Immunization Reason Not Performed Code Codeable Concept 0..1
Uniquely specifies the reason the immunization was not performed on a patient (e.g., known immunity). Value Set: https://fhir.infoway-inforoute.ca/ValueSet/actnoimmunizationreason
Patient Immunization Subpotent Reason Code Codeable Concept 0..1
Uniquely specifies the reason the immunization dose is considered to be subpotent for a patient (e.g., partial dose, recall). Value Set: To be developed.
Patient Immunization Route of Administration Code Codeable Concept 0..1
Uniquely specifies the path by which the immunization product is taken into or makes contact with the body of a patient (e.g., oral, intramuscular). Value Set: nvc-cnv.canada.ca/en/route-of-administration
Patient Immunization Body Site Code Codeable Concept 0..1
Uniquely specifies the anatomical site where the immunization product was administered to a patient (e.g., left deltoid muscle). Value Set: https://nvc-cnv.canada.ca/en/anatomical-site
Patient Immunization Program Eligibility Code Codeable Concept 0..1
Uniquely specifies a patient's eligibility for a funding program (e.g., not eligible, uninsured). Value Set: To be developed.
Patient Immunization Funding Source Code Codeable Concept 0..1
Uniquely specifies the source of the vaccine actually administered (e.g., public, private). This may be different than the patient eligibility: for instance, the patient may be eligible for a publicly purchased vaccine but due to inventory issues, vaccine purchased with private funds was actually administered. Value Set: To be developed.
Patient Immunization Information Source Code Codeable Concept 0..1
Uniquely specifies the source of information reporting or recording the immunization event (e.g., patient record, record maintained by health care professional, oral record from person in health care environment). Value Set: To be developed.

Relationships

From class From multiplicity Relationship To class To multiplicity
Patient Immunization 0..1 has (composition) Clinical Annotation 0..*
Clinical Document 0..* supports Patient Immunization 0..*
Patient Immunization 1 involves Vaccine Administered 1
Patient Immunization 0..* has Clinical Information Life Cycle Event 0..*
Patient Immunization 0..* based on Patient Immunization Forecast 0..*
Patient Immunization 0..1 results in Adverse Event 0..*
Patient Immunization 0..* for Patient 1
Patient Immunization 1 has Immunization Performer 0..*
Patient Immunization 0..* has Vaccine Product Administered 0..1
Patient Immunization 0..* documented in Encounter 0..1
Patient Immunization 0..* has (composition) Patient Immunization Reaction 0..*
Patient Immunization 0..1 is Health Care Service Event 0..1
Patient Immunization 0..* prescriber Health Care Provider 0..1
Immunization Guideline 0..* based on Patient Immunization 0..*
Health Care Service Event 0..1 is Patient Immunization 0..1
Patient Immunization 0..* has Vaccine Generic Concept 0..1

Contact us

If you have questions about this initiative, would like to be added to our stakeholder notification list or would like to participate in our consultations, please email us.

connectedcare@cihi.ca

How to cite:

Canadian Institute for Health Information. Patient Immunization. Accessed November 02, 2026.

If you would like CIHI information in a different format, visit our Accessibility page.