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.r4b.examples
derivation: specialization
name: Immunization
type: Immunization
elements:
  patient:
    isModifier: false
    short: Who was immunized
    refers: ['http://hl7.org/fhir/StructureDefinition/Patient']
    type: Reference
    mustSupport: false
    isSummary: true
    index: 4
  isSubpotent: {isModifier: true, short: Dose potency, type: boolean, mustSupport: false, meaningWhenMissing: 'By default, a dose should be considered to be potent.', isModifierReason: This element is labeled as a modifier because an immunization event with a subpotent vaccine doesn't protect the patient the same way as a potent dose., isSummary: true, index: 26}
  reportOrigin:
    isModifier: false
    short: Indicates the source of a secondarily reported record
    type: CodeableConcept
    mustSupport: false
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/immunization-origin'}
    isSummary: false
    index: 12
  protocolApplied:
    isModifier: false
    short: Protocol followed by the provider
    index: 39
    type: BackboneElement
    mustSupport: false
    array: true
    elements:
      seriesDosesPositiveInt: {isModifier: false, short: Recommended number of doses for immunity, type: positiveInt, mustSupport: false, choiceOf: seriesDoses, isSummary: false, index: 49}
      doseNumberPositiveInt: {isModifier: false, short: Dose number within series, type: positiveInt, mustSupport: false, choiceOf: doseNumber, isSummary: false, index: 45}
      series: {isModifier: false, short: Name of vaccine series, type: string, mustSupport: false, isSummary: false, index: 40}
      doseNumber:
        isModifier: false
        short: Dose number within series
        mustSupport: false
        choices: [doseNumberPositiveInt, doseNumberString]
        isSummary: false
        index: 44
      authority:
        isModifier: false
        short: Who is responsible for publishing the recommendations
        refers: ['http://hl7.org/fhir/StructureDefinition/Organization']
        type: Reference
        mustSupport: false
        isSummary: false
        index: 41
      doseNumberString: {isModifier: false, short: Dose number within series, type: string, mustSupport: false, choiceOf: doseNumber, isSummary: false, index: 46}
      seriesDosesString: {isModifier: false, short: Recommended number of doses for immunity, type: string, mustSupport: false, choiceOf: seriesDoses, isSummary: false, index: 50}
      seriesDoses:
        isModifier: false
        short: Recommended number of doses for immunity
        mustSupport: false
        choices: [seriesDosesPositiveInt, seriesDosesString]
        isSummary: false
        index: 48
      targetDisease:
        isModifier: false
        short: Vaccine preventatable disease being targetted
        type: CodeableConcept
        mustSupport: false
        array: true
        binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/immunization-target-disease'}
        isSummary: false
        index: 42
    required: [doseNumberString, doseNumberPositiveInt, doseNumber]
    isSummary: false
  site:
    isModifier: false
    short: Body site vaccine  was administered
    type: CodeableConcept
    mustSupport: false
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/immunization-site'}
    isSummary: false
    index: 17
  encounter:
    isModifier: false
    short: Encounter immunization was part of
    refers: ['http://hl7.org/fhir/StructureDefinition/Encounter']
    type: Reference
    mustSupport: false
    isSummary: false
    index: 5
  vaccineCode:
    isModifier: false
    short: Vaccine product administered
    type: CodeableConcept
    mustSupport: false
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/vaccine-code'}
    isSummary: true
    index: 3
  doseQuantity: {isModifier: false, short: Amount of vaccine administered, type: Quantity, mustSupport: false, isSummary: false, index: 19}
  reasonCode:
    isModifier: false
    short: Why immunization occurred
    type: CodeableConcept
    mustSupport: false
    array: true
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/immunization-reason'}
    isSummary: false
    index: 24
  statusReason:
    isModifier: false
    short: Reason not done
    type: CodeableConcept
    mustSupport: false
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/immunization-status-reason'}
    isSummary: false
    index: 2
  route:
    isModifier: false
    short: How vaccine entered body
    type: CodeableConcept
    mustSupport: false
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/immunization-route'}
    isSummary: false
    index: 18
  recorded: {isModifier: false, short: When the immunization was first captured in the subject's record, type: dateTime, mustSupport: false, isSummary: false, index: 10}
  programEligibility:
    isModifier: false
    short: Patient eligibility for a vaccination program
    type: CodeableConcept
    mustSupport: false
    array: true
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/immunization-program-eligibility'}
    isSummary: false
    index: 33
  note: {isModifier: false, short: Additional immunization notes, type: Annotation, mustSupport: false, array: true, isSummary: true, index: 23}
  primarySource: {isModifier: false, short: Indicates context the data was recorded in, type: boolean, mustSupport: false, isSummary: true, index: 11}
  status:
    isModifier: true
    short: completed | entered-in-error | not-done
    index: 1
    type: code
    mustSupport: false
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/immunization-status|4.3.0-snapshot1'}
    isModifierReason: This element is labeled as a modifier because it is a status element that contains statuses entered-in-error and not-done which means that the resource should not be treated as valid
    isSummary: true
  lotNumber: {isModifier: false, short: Vaccine lot number, type: string, mustSupport: false, isSummary: false, index: 15}
  identifier: {isModifier: false, short: Business identifier, type: Identifier, mustSupport: false, array: true, isSummary: false, index: 0}
  manufacturer:
    isModifier: false
    short: Vaccine manufacturer
    refers: ['http://hl7.org/fhir/StructureDefinition/Organization']
    type: Reference
    mustSupport: false
    isSummary: false
    index: 14
  education:
    constraint:
      imm-1: {human: One of documentType or reference SHALL be present, source: 'http://hl7.org/fhir/StructureDefinition/Immunization', severity: error, expression: documentType.exists() or reference.exists()}
    isModifier: false
    short: Educational material presented to patient
    index: 28
    type: BackboneElement
    mustSupport: false
    array: true
    elements:
      documentType: {isModifier: false, short: Educational material document identifier, type: string, mustSupport: false, isSummary: false, index: 29}
      reference: {isModifier: false, short: Educational material reference pointer, type: uri, mustSupport: false, isSummary: false, index: 30}
      publicationDate: {isModifier: false, short: Educational material publication date, type: dateTime, mustSupport: false, isSummary: false, index: 31}
      presentationDate: {isModifier: false, short: Educational material presentation date, type: dateTime, mustSupport: false, isSummary: false, index: 32}
    isSummary: false
  occurrenceString: {isModifier: false, short: Vaccine administration date, type: string, mustSupport: false, choiceOf: occurrence, isSummary: true, index: 9}
  reaction:
    isModifier: false
    short: Details of a reaction that follows immunization
    type: BackboneElement
    mustSupport: false
    array: true
    isSummary: false
    index: 35
    elements:
      date: {isModifier: false, short: When reaction started, type: dateTime, mustSupport: false, isSummary: false, index: 36}
      detail:
        isModifier: false
        short: Additional information on reaction
        refers: ['http://hl7.org/fhir/StructureDefinition/Observation']
        type: Reference
        mustSupport: false
        isSummary: false
        index: 37
      reported: {isModifier: false, short: Indicates self-reported reaction, type: boolean, mustSupport: false, isSummary: false, index: 38}
  location:
    isModifier: false
    short: Where immunization occurred
    refers: ['http://hl7.org/fhir/StructureDefinition/Location']
    type: Reference
    mustSupport: false
    isSummary: false
    index: 13
  occurrenceDateTime: {isModifier: false, short: Vaccine administration date, type: dateTime, mustSupport: false, choiceOf: occurrence, isSummary: true, index: 8}
  fundingSource:
    isModifier: false
    short: Funding source for the vaccine
    type: CodeableConcept
    mustSupport: false
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/immunization-funding-source'}
    isSummary: false
    index: 34
  subpotentReason:
    isModifier: false
    short: Reason for being subpotent
    type: CodeableConcept
    mustSupport: false
    array: true
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/immunization-subpotent-reason'}
    isSummary: false
    index: 27
  occurrence:
    isModifier: false
    short: Vaccine administration date
    mustSupport: false
    choices: [occurrenceDateTime, occurrenceString]
    isSummary: true
    index: 7
  expirationDate: {isModifier: false, short: Vaccine expiration date, type: date, mustSupport: false, isSummary: false, index: 16}
  performer:
    isModifier: false
    short: Who performed event
    index: 20
    type: BackboneElement
    mustSupport: false
    array: true
    elements:
      function:
        isModifier: false
        short: What type of performance was done
        type: CodeableConcept
        mustSupport: false
        binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/immunization-function'}
        isSummary: true
        index: 21
      actor:
        isModifier: false
        short: Individual or organization who was performing
        refers: ['http://hl7.org/fhir/StructureDefinition/Organization', 'http://hl7.org/fhir/StructureDefinition/Practitioner', 'http://hl7.org/fhir/StructureDefinition/PractitionerRole']
        type: Reference
        mustSupport: false
        isSummary: true
        index: 22
    required: [actor]
    isSummary: true
  reasonReference:
    isModifier: false
    short: Why immunization occurred
    refers: ['http://hl7.org/fhir/StructureDefinition/Condition', 'http://hl7.org/fhir/StructureDefinition/DiagnosticReport', 'http://hl7.org/fhir/StructureDefinition/Observation']
    type: Reference
    mustSupport: false
    array: true
    isSummary: false
    index: 25
package_version: 4.3.0-snapshot1
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/Immunization
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: 4.3.0-snapshot1
required: [vaccineCode, occurrenceDateTime, occurrenceString, status, occurrence, patient]