description: 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.
package_name: hl7.fhir.core
derivation: specialization
name: Immunization
type: Immunization
elements:
  patient:
    short: Who was immunized
    refers: ['http://hl7.org/fhir/StructureDefinition/Patient']
    type: Reference
    isSummary: true
    index: 3
  reportOrigin: {short: Indicates the source of a secondarily reported record, type: CodeableConcept, index: 7}
  date: {short: Vaccine administration date, type: dateTime, index: 5}
  site: {short: Body site vaccine  was administered, type: CodeableConcept, index: 12}
  encounter:
    short: Encounter immunization was part of
    refers: ['http://hl7.org/fhir/StructureDefinition/Encounter']
    type: Reference
    index: 4
  vaccineCode: {short: Vaccine product administered, type: CodeableConcept, isSummary: true, index: 2}
  doseQuantity: {type: Quantity, short: Amount of vaccine administered, index: 14}
  route: {short: How vaccine entered body, type: CodeableConcept, index: 13}
  programEligibility: {short: Patient eligibility for a vaccination program, type: CodeableConcept, array: true, index: 25}
  note: {short: Additional immunization notes, type: Annotation, array: true, isSummary: true, index: 18}
  reason: {short: Why immunization did or did not occur, type: CodeableConcept, array: true, index: 19}
  primarySource: {short: Indicates context the data was recorded in, type: boolean, isSummary: true, index: 6}
  status: {isModifier: true, short: completed | entered-in-error | not-done, type: code, isSummary: true, index: 1}
  lotNumber: {type: string, short: Vaccine lot number, index: 10}
  identifier: {type: Identifier, short: Business identifier, array: true, index: 0}
  practitioner:
    short: Who performed event
    type: BackboneElement
    array: true
    isSummary: true
    index: 15
    elements:
      role: {short: What type of performance was done, type: CodeableConcept, isSummary: true, index: 16}
      actor:
        short: Individual who was performing
        refers: ['http://hl7.org/fhir/StructureDefinition/Practitioner']
        type: Reference
        isSummary: true
        index: 17
    required: [actor]
  manufacturer:
    short: Vaccine manufacturer
    refers: ['http://hl7.org/fhir/StructureDefinition/Organization']
    type: Reference
    index: 9
  education:
    constraint:
      imm-1: {human: One of documentType or reference SHALL be present, severity: error, expression: documentType.exists() or reference.exists()}
    short: Educational material presented to patient
    type: BackboneElement
    array: true
    index: 20
    elements:
      documentType: {type: string, short: Educational material document identifier, index: 21}
      reference: {type: uri, short: Educational material reference pointer, index: 22}
      publicationDate: {type: dateTime, short: Educational material publication date, index: 23}
      presentationDate: {type: dateTime, short: Educational material presentation date, index: 24}
  location:
    short: Where immunization occurred
    refers: ['http://hl7.org/fhir/StructureDefinition/Location']
    type: Reference
    index: 8
  fundingSource: {short: Funding source for the vaccine, type: CodeableConcept, index: 26}
  expirationDate: {type: date, short: Vaccine expiration date, index: 11}
package_version: 3.2.0
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/Immunization
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: null
required: [primarySource, vaccineCode, status, patient]