description: Base StructureDefinition for Immunization Resource
package_name: hl7.fhir.r3.examples
derivation: specialization
name: Immunization
type: Immunization
elements:
  patient:
    short: Who was immunized
    refers: ['http://hl7.org/fhir/StructureDefinition/Patient']
    type: Reference
    index: 4
  explanation:
    type: BackboneElement
    short: Administration/non-administration reasons
    index: 20
    elements:
      reason: {short: Why immunization occurred, type: CodeableConcept, array: true, index: 21}
      reasonNotGiven: {short: Why immunization did not occur, type: CodeableConcept, array: true, index: 22}
  reportOrigin: {short: Indicates the source of a secondarily reported record, type: CodeableConcept, index: 8}
  date: {short: Vaccination administration date, type: dateTime, index: 6}
  site: {short: Body site vaccine  was administered, type: CodeableConcept, index: 13}
  encounter:
    short: Encounter administered as part of
    refers: ['http://hl7.org/fhir/StructureDefinition/Encounter']
    type: Reference
    index: 5
  vaccineCode: {short: Vaccine product administered, type: CodeableConcept, index: 3}
  vaccinationProtocol:
    type: BackboneElement
    short: What protocol was followed
    array: true
    index: 27
    elements:
      doseSequence: {type: positiveInt, short: Dose number within series, index: 28}
      description: {type: string, short: Details of vaccine protocol, index: 29}
      authority:
        short: Who is responsible for protocol
        refers: ['http://hl7.org/fhir/StructureDefinition/Organization']
        type: Reference
        index: 30
      series: {type: string, short: Name of vaccine series, index: 31}
      seriesDoses: {type: positiveInt, short: Recommended number of doses for immunity, index: 32}
      targetDisease: {min: 1, short: Disease immunized against, type: CodeableConcept, array: true, index: 33}
      doseStatus: {short: Indicates if dose counts towards immunity, type: CodeableConcept, index: 34}
      doseStatusReason: {short: Why dose does (not) count, type: CodeableConcept, index: 35}
    required: [targetDisease, doseStatus]
  doseQuantity: {type: Quantity, short: Amount of vaccine administered, index: 15}
  notGiven: {isModifier: true, short: Flag for whether immunization was given, type: boolean, isSummary: true, index: 2}
  route: {short: How vaccine entered body, type: CodeableConcept, index: 14}
  note: {short: Vaccination notes, type: Annotation, array: true, isSummary: true, index: 19}
  primarySource: {short: Indicates context the data was recorded in, type: boolean, index: 7}
  status: {isModifier: true, short: completed | entered-in-error, type: code, isSummary: true, index: 1}
  lotNumber: {type: string, short: Vaccine lot number, index: 11}
  identifier: {type: Identifier, short: Business identifier, array: true, index: 0}
  practitioner:
    short: Who performed event
    type: BackboneElement
    array: true
    isSummary: true
    index: 16
    elements:
      role: {short: What type of performance was done, type: CodeableConcept, isSummary: true, index: 17}
      actor:
        short: Individual who was performing
        refers: ['http://hl7.org/fhir/StructureDefinition/Practitioner']
        type: Reference
        isSummary: true
        index: 18
    required: [actor]
  manufacturer:
    short: Vaccine manufacturer
    refers: ['http://hl7.org/fhir/StructureDefinition/Organization']
    type: Reference
    index: 10
  reaction:
    short: Details of a reaction that follows immunization
    type: BackboneElement
    array: true
    index: 23
    elements:
      date: {type: dateTime, short: When reaction started, index: 24}
      detail:
        short: Additional information on reaction
        refers: ['http://hl7.org/fhir/StructureDefinition/Observation']
        type: Reference
        index: 25
      reported: {type: boolean, short: Indicates self-reported reaction, index: 26}
  location:
    short: Where vaccination occurred
    refers: ['http://hl7.org/fhir/StructureDefinition/Location']
    type: Reference
    index: 9
  expirationDate: {type: date, short: Vaccine expiration date, index: 12}
package_version: 3.0.2
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/Immunization
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: null
required: [primarySource, vaccineCode, notGiven, status, patient]