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

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: {short: Who was immunized, isSummary: true, index: 4}
  isSubpotent: {isModifier: true, short: Dose potency, 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: 24}
  reportOrigin:
    short: Indicates the source of a secondarily reported record
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/immunization-origin'}
    index: 10
  protocolApplied:
    short: Protocol followed by the provider
    array: true
    index: 37
    elements:
      series: {short: Name of vaccine series, index: 38}
      authority: {short: Who is responsible for publishing the recommendations, index: 39}
      targetDisease:
        short: Vaccine preventatable disease being targetted
        array: true
        binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/immunization-target-disease'}
        index: 40
      doseNumber:
        short: Dose number within series
        choices: []
        index: 42
      seriesDoses:
        short: Recommended number of doses for immunity
        choices: []
        index: 44
    required: [doseNumber]
  site:
    short: Body site vaccine  was administered
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/immunization-site'}
    index: 15
  encounter: {short: Encounter immunization was part of, index: 5}
  vaccineCode:
    short: Vaccine product administered
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/vaccine-code'}
    isSummary: true
    index: 3
  doseQuantity: {short: Amount of vaccine administered, index: 17}
  reasonCode:
    short: Why immunization occurred
    array: true
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/immunization-reason'}
    index: 22
  statusReason:
    short: Reason not done
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/immunization-status-reason'}
    index: 2
  route:
    short: How vaccine entered body
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/immunization-route'}
    index: 16
  recorded: {short: When the immunization was first captured in the subject's record, isSummary: false, index: 8}
  programEligibility:
    short: Patient eligibility for a vaccination program
    array: true
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/immunization-program-eligibility'}
    index: 31
  note: {short: Additional immunization notes, array: true, isSummary: true, index: 21}
  primarySource: {short: Indicates context the data was recorded in, isSummary: true, index: 9}
  status:
    isModifier: true
    short: completed | entered-in-error | not-done
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/immunization-status|4.0.1'}
    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: 1
  lotNumber: {short: Vaccine lot number, index: 13}
  identifier: {short: Business identifier, array: true, index: 0}
  manufacturer: {short: Vaccine manufacturer, index: 12}
  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
    array: true
    index: 26
    elements:
      documentType: {short: Educational material document identifier, index: 27}
      reference: {short: Educational material reference pointer, index: 28}
      publicationDate: {short: Educational material publication date, index: 29}
      presentationDate: {short: Educational material presentation date, index: 30}
  reaction:
    short: Details of a reaction that follows immunization
    array: true
    index: 33
    elements:
      date: {short: When reaction started, index: 34}
      detail: {short: Additional information on reaction, index: 35}
      reported: {short: Indicates self-reported reaction, index: 36}
  location: {short: Where immunization occurred, index: 11}
  fundingSource:
    short: Funding source for the vaccine
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/immunization-funding-source'}
    index: 32
  subpotentReason:
    short: Reason for being subpotent
    array: true
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/immunization-subpotent-reason'}
    index: 25
  occurrence:
    short: Vaccine administration date
    choices: []
    isSummary: true
    index: 7
  expirationDate: {short: Vaccine expiration date, index: 14}
  performer:
    short: Who performed event
    array: true
    isSummary: true
    index: 18
    elements:
      function:
        short: What type of performance was done
        binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/immunization-function'}
        isSummary: true
        index: 19
      actor: {short: Individual or organization who was performing, isSummary: true, index: 20}
    required: [actor]
  reasonReference: {short: Why immunization occurred, array: true, index: 23}
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/Immunization
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: 4.0.1
required: [vaccineCode, status, occurrence, patient]