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

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.
Structure JSON Dependencies FHIRSchema Other Versions Dependant (0)Elements Summary
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.
derivation: specialization
name: Immunization
type: Immunization
elements:
  patient: {isModifier: false, short: Who was immunized, mustSupport: false, isSummary: true, index: 9}
  isSubpotent: {isModifier: true, short: Dose potency, 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: 25}
  protocolApplied:
    isModifier: false
    short: Protocol followed by the provider
    mustSupport: false
    array: true
    isSummary: false
    index: 35
    elements:
      series: {isModifier: false, short: Name of vaccine series, mustSupport: false, isSummary: false, index: 36}
      authority: {isModifier: false, short: Who is responsible for publishing the recommendations, mustSupport: false, isSummary: false, index: 37}
      targetDisease:
        isModifier: false
        short: Vaccine preventatable disease being targeted
        mustSupport: false
        array: true
        binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/immunization-target-disease'}
        isSummary: false
        index: 38
      doseNumber: {isModifier: false, short: Dose number within series, mustSupport: false, isSummary: false, index: 39}
      seriesDoses: {isModifier: false, short: Recommended number of doses for immunity, mustSupport: false, isSummary: false, index: 40}
    required: [doseNumber]
  site:
    isModifier: false
    short: Body site vaccine  was administered
    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, mustSupport: false, isSummary: false, index: 10}
  vaccineCode:
    isModifier: false
    short: Vaccine administered
    mustSupport: false
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/vaccine-code'}
    isSummary: true
    index: 4
  doseQuantity: {isModifier: false, short: Amount of vaccine administered, mustSupport: false, isSummary: false, index: 19}
  statusReason:
    isModifier: false
    short: Reason for current status
    mustSupport: false
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/immunization-status-reason'}
    isSummary: false
    index: 3
  route:
    isModifier: false
    short: How vaccine entered body
    mustSupport: false
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/immunization-route'}
    isSummary: false
    index: 18
  programEligibility:
    isModifier: false
    short: Patient eligibility for a specific vaccination program
    mustSupport: false
    array: true
    isSummary: false
    index: 27
    elements:
      program:
        isModifier: false
        short: The program that eligibility is declared for
        mustSupport: false
        binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/immunization-vaccine-funding-program'}
        isSummary: false
        index: 28
      programStatus:
        isModifier: false
        short: The patient's eligibility status for the program
        mustSupport: false
        binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/immunization-program-eligibility'}
        isSummary: false
        index: 29
    required: [programStatus, program]
  note: {isModifier: false, short: Additional immunization notes, mustSupport: false, array: true, isSummary: true, index: 23}
  reason:
    isModifier: false
    short: Why immunization occurred
    mustSupport: false
    array: true
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/immunization-reason'}
    isSummary: false
    index: 24
  supportingInformation: {isModifier: false, short: Additional information in support of the immunization, mustSupport: false, array: true, isSummary: false, index: 11}
  primarySource: {isModifier: false, short: Indicates context the data was captured in, mustSupport: false, isSummary: true, index: 14}
  status:
    isModifier: true
    short: completed | entered-in-error | not-done
    mustSupport: false
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/immunization-status|5.0.0'}
    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
    index: 2
  lotNumber: {isModifier: false, short: Vaccine lot number, mustSupport: false, isSummary: false, index: 7}
  identifier: {isModifier: false, short: Business identifier, mustSupport: false, array: true, isSummary: false, index: 0}
  manufacturer: {isModifier: false, short: Vaccine manufacturer, mustSupport: false, isSummary: false, index: 6}
  administeredProduct: {isModifier: false, short: Product that was administered, mustSupport: false, isSummary: false, index: 5}
  basedOn: {isModifier: false, short: Authority that the immunization event is based on, mustSupport: false, array: true, isSummary: true, index: 1}
  informationSource:
    isModifier: false
    short: Indicates the source of a  reported record
    mustSupport: false
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/immunization-origin'}
    isSummary: false
    index: 15
  reaction:
    isModifier: false
    short: Details of a reaction that follows immunization
    mustSupport: false
    array: true
    isSummary: false
    index: 31
    elements:
      date: {isModifier: false, short: When reaction started, mustSupport: false, isSummary: false, index: 32}
      manifestation: {isModifier: false, short: Additional information on reaction, mustSupport: false, isSummary: false, index: 33}
      reported: {isModifier: false, short: Indicates self-reported reaction, mustSupport: false, isSummary: false, index: 34}
  location: {isModifier: false, short: Where immunization occurred, mustSupport: false, isSummary: false, index: 16}
  fundingSource:
    isModifier: false
    short: Funding source for the vaccine
    mustSupport: false
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/immunization-funding-source'}
    isSummary: false
    index: 30
  subpotentReason:
    isModifier: false
    short: Reason for being subpotent
    mustSupport: false
    array: true
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/immunization-subpotent-reason'}
    isSummary: false
    index: 26
  occurrence:
    isModifier: false
    short: Vaccine administration date
    mustSupport: false
    choices: []
    isSummary: true
    index: 13
  expirationDate: {isModifier: false, short: Vaccine expiration date, mustSupport: false, isSummary: false, index: 8}
  performer:
    isModifier: false
    short: Who performed event
    mustSupport: false
    array: true
    isSummary: true
    index: 20
    elements:
      function:
        isModifier: false
        short: What type of performance was done
        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, mustSupport: false, isSummary: true, index: 22}
    required: [actor]
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/Immunization
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: 5.0.0
required: [vaccineCode, status, occurrence, patient]