description: Base StructureDefinition for Immunization Resource
package_name: hl7.fhir.r2b.examples
derivation: specialization
name: Immunization
type: null
elements:
  patient:
    isModifier: false
    short: Who was immunized
    index: 4
    type: Reference
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: Immunization.patient}
    isSummary: false
  explanation:
    isModifier: false
    short: Administration/non-administration reasons
    index: 18
    type: BackboneElement
    mustSupport: false
    elements:
      reason:
        isModifier: false
        short: Why immunization occurred
        index: 19
        type: CodeableConcept
        mustSupport: false
        array: true
        maxLength: 0
        base: {max: '*', min: 0, path: Immunization.explanation.reason}
        isSummary: false
      reasonNotGiven:
        isModifier: false
        short: Why immunization did not occur
        index: 20
        type: CodeableConcept
        mustSupport: false
        array: true
        maxLength: 0
        base: {max: '*', min: 0, path: Immunization.explanation.reasonNotGiven}
        isSummary: false
    maxLength: 0
    base: {max: '1', min: 0, path: Immunization.explanation}
    isSummary: false
  date:
    isModifier: false
    short: Vaccination administration date
    index: 2
    comments: When immunizations are given a specific date and time should always be known.   When immunizations are patient reported, a specific date might not be known.  Although partial dates are allowed, an adult patient might not be able to recall the year a childhood immunization was given.
    type: dateTime
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: Immunization.date}
    isSummary: false
  site:
    isModifier: false
    short: Body site vaccine  was administered
    type: CodeableConcept
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: Immunization.site}
    isSummary: false
    index: 14
  encounter:
    isModifier: false
    short: Encounter administered as part of
    type: Reference
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: Immunization.encounter}
    isSummary: false
    index: 9
  vaccineCode:
    isModifier: false
    short: Vaccine product administered
    index: 3
    type: CodeableConcept
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: Immunization.vaccineCode}
    isSummary: false
  vaccinationProtocol:
    isModifier: false
    short: What protocol was followed
    index: 25
    type: BackboneElement
    mustSupport: false
    array: true
    elements:
      doseSequence:
        isModifier: false
        short: Dose number within series
        index: 26
        type: positiveInt
        mustSupport: false
        maxLength: 0
        base: {max: '1', min: 0, path: Immunization.vaccinationProtocol.doseSequence}
        isSummary: false
      description:
        isModifier: false
        short: Details of vaccine protocol
        type: string
        mustSupport: false
        maxLength: 0
        base: {max: '1', min: 0, path: Immunization.vaccinationProtocol.description}
        isSummary: false
        index: 27
      authority:
        isModifier: false
        short: Who is responsible for protocol
        type: Reference
        mustSupport: false
        maxLength: 0
        base: {max: '1', min: 0, path: Immunization.vaccinationProtocol.authority}
        isSummary: false
        index: 28
      series:
        isModifier: false
        short: Name of vaccine series
        type: string
        mustSupport: false
        maxLength: 0
        base: {max: '1', min: 0, path: Immunization.vaccinationProtocol.series}
        isSummary: false
        index: 29
      seriesDoses:
        isModifier: false
        short: Recommended number of doses for immunity
        type: positiveInt
        mustSupport: false
        maxLength: 0
        base: {max: '1', min: 0, path: Immunization.vaccinationProtocol.seriesDoses}
        isSummary: false
        index: 30
      targetDisease:
        min: 1
        isModifier: false
        short: Disease immunized against
        index: 31
        type: CodeableConcept
        mustSupport: false
        array: true
        maxLength: 0
        base: {max: '*', min: 0, path: Immunization.vaccinationProtocol.targetDisease}
        isSummary: false
      doseStatus:
        isModifier: false
        short: Indicates if dose counts towards immunity
        index: 32
        comments: May need to differentiate between status declarations by a provider vs. a CDS engine.
        type: CodeableConcept
        mustSupport: false
        maxLength: 0
        base: {max: '1', min: 0, path: Immunization.vaccinationProtocol.doseStatus}
        isSummary: false
      doseStatusReason:
        isModifier: false
        short: Why dose does (not) count
        type: CodeableConcept
        mustSupport: false
        maxLength: 0
        base: {max: '1', min: 0, path: Immunization.vaccinationProtocol.doseStatusReason}
        isSummary: false
        index: 33
    maxLength: 0
    base: {max: '*', min: 0, path: Immunization.vaccinationProtocol}
    required: [targetDisease, doseStatus, doseSequence]
    isSummary: false
  doseQuantity:
    isModifier: false
    short: Amount of vaccine administered
    type: Quantity
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: Immunization.doseQuantity}
    isSummary: false
    index: 16
  reported:
    isModifier: false
    short: Indicates a self-reported record
    index: 6
    comments: May need source of reported info (e.g. parent), but leave out for now.
    type: boolean
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: Immunization.reported}
    isSummary: false
  route:
    isModifier: false
    short: How vaccine entered body
    type: CodeableConcept
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: Immunization.route}
    isSummary: false
    index: 15
  note:
    isModifier: false
    short: Vaccination notes
    index: 17
    type: Annotation
    mustSupport: false
    array: true
    maxLength: 0
    base: {max: '*', min: 0, path: Immunization.note}
    isSummary: true
  requester:
    isModifier: false
    short: Who ordered vaccination
    index: 8
    comments: Other participants - delegate to Provenance resource.
    type: Reference
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: Immunization.requester}
    isSummary: false
  status:
    isModifier: true
    short: in-progress | on-hold | completed | entered-in-error | stopped
    index: 1
    comments: Will generally be set to show that the immunization has been completed.
    type: code
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: Immunization.status}
    isSummary: true
  lotNumber:
    isModifier: false
    short: Vaccine lot number
    type: string
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: Immunization.lotNumber}
    isSummary: false
    index: 12
  identifier:
    isModifier: false
    short: Business identifier
    index: 0
    type: Identifier
    mustSupport: false
    array: true
    maxLength: 0
    base: {max: '*', min: 0, path: Immunization.identifier}
    isSummary: false
  wasNotGiven:
    isModifier: true
    short: Flag for whether immunization was given
    index: 5
    type: boolean
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: Immunization.wasNotGiven}
    isSummary: false
  manufacturer:
    isModifier: false
    short: Vaccine manufacturer
    type: Reference
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: Immunization.manufacturer}
    isSummary: false
    index: 10
  reaction:
    isModifier: false
    short: Details of a reaction that follows immunization
    index: 21
    comments: A reaction may be an indication of an allergy or intolerance and, if this is determined to be the case,  it should be recorded as a new [[[AllergyIntolerance]]] resource instance as most systems will not query against  past Immunization.reaction elements.
    type: BackboneElement
    mustSupport: false
    array: true
    elements:
      date:
        isModifier: false
        short: When reaction started
        type: dateTime
        mustSupport: false
        maxLength: 0
        base: {max: '1', min: 0, path: Immunization.reaction.date}
        isSummary: false
        index: 22
      detail:
        isModifier: false
        short: Additional information on reaction
        type: Reference
        mustSupport: false
        maxLength: 0
        base: {max: '1', min: 0, path: Immunization.reaction.detail}
        isSummary: false
        index: 23
      reported:
        isModifier: false
        short: Indicates self-reported reaction
        type: boolean
        mustSupport: false
        maxLength: 0
        base: {max: '1', min: 0, path: Immunization.reaction.reported}
        isSummary: false
        index: 24
    maxLength: 0
    base: {max: '*', min: 0, path: Immunization.reaction}
    isSummary: false
  location:
    isModifier: false
    short: Where vaccination occurred
    type: Reference
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: Immunization.location}
    isSummary: false
    index: 11
  expirationDate:
    isModifier: false
    short: Vaccine expiration date
    type: date
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: Immunization.expirationDate}
    isSummary: false
    index: 13
  performer:
    isModifier: false
    short: Who administered vaccine
    type: Reference
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: Immunization.performer}
    isSummary: false
    index: 7
package_version: 1.4.0
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/Immunization
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: null
required: [reported, vaccineCode, status, patient, wasNotGiven]