http://hl7.org/fhir/StructureDefinition/Immunization|4.0.1

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.
NameFlagsCardTypeDescription & Constraints
Immunization
0..*Immunization event information
 
identifier
0..*IdentifierBusiness identifier
 
status *
?!Σ
1..1codecompleted | entered-in-error | not-done ImmunizationStatus (required)
 
statusReason
0..1CodeableConceptReason not done ImmunizationStatusReason (example)
 
vaccineCode *
Σ
1..1CodeableConceptVaccine product administered VaccineCode (example)
 
patient *
Σ
1..1ReferenceWho was immunized
 
encounter
0..1ReferenceEncounter immunization was part of
 
occurrence[x] *
Σ
1..1Vaccine administration date
 
 
occurrenceDateTime *
Σ
1..1dateTime
 
 
occurrenceString *
Σ
1..1string
 
recorded
0..1dateTimeWhen the immunization was first captured in the subject's record
 
primarySource
Σ
0..1booleanIndicates context the data was recorded in
 
reportOrigin
0..1CodeableConceptIndicates the source of a secondarily reported record ImmunizationReportOrigin (example)
 
location
0..1ReferenceWhere immunization occurred
 
manufacturer
0..1ReferenceVaccine manufacturer
 
lotNumber
0..1stringVaccine lot number
 
expirationDate
0..1dateVaccine expiration date
 
site
0..1CodeableConceptBody site vaccine was administered ImmunizationSite (example)
 
route
0..1CodeableConceptHow vaccine entered body ImmunizationRoute (example)
 
doseQuantity
0..1QuantityAmount of vaccine administered
 
performer
Σ
0..*BackboneElementWho performed event
 
 
function
Σ
0..1CodeableConceptWhat type of performance was done ImmunizationFunction (extensible)
 
 
actor *
Σ
1..1ReferenceIndividual or organization who was performing
 
note
Σ
0..*AnnotationAdditional immunization notes
 
reasonCode
0..*CodeableConceptWhy immunization occurred ImmunizationReason (example)
 
reasonReference
0..*ReferenceWhy immunization occurred
 
isSubpotent
?!Σ
0..1booleanDose potency
 
subpotentReason
0..*CodeableConceptReason for being subpotent SubpotentReason (example)
 
education
0..*BackboneElementEducational material presented to patient
 
 
documentType
0..1stringEducational material document identifier
 
 
reference
0..1uriEducational material reference pointer
 
 
publicationDate
0..1dateTimeEducational material publication date
 
 
presentationDate
0..1dateTimeEducational material presentation date
 
programEligibility
0..*CodeableConceptPatient eligibility for a vaccination program ProgramEligibility (example)
 
fundingSource
0..1CodeableConceptFunding source for the vaccine FundingSource (example)
 
reaction
0..*BackboneElementDetails of a reaction that follows immunization
 
 
date
0..1dateTimeWhen reaction started
 
 
detail
0..1ReferenceAdditional information on reaction
 
 
reported
0..1booleanIndicates self-reported reaction
 
protocolApplied
0..*BackboneElementProtocol followed by the provider
 
 
series
0..1stringName of vaccine series
 
 
authority
0..1ReferenceWho is responsible for publishing the recommendations
 
 
targetDisease
0..*CodeableConceptVaccine preventatable disease being targetted TargetDisease (example)
 
 
doseNumber[x] *
1..1Dose number within series
 
 
 
doseNumberPositiveInt *
1..1positiveInt
 
 
 
doseNumberString *
1..1string
 
 
seriesDoses[x]
0..1Recommended number of doses for immunity
 
 
 
seriesDosesPositiveInt
0..1positiveInt
 
 
 
seriesDosesString
0..1string