description: Base StructureDefinition for Immunization Resource
package_name: hl7.fhir.core
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: 19
    elements:
      reason: {short: Why immunization occurred, type: CodeableConcept, array: true, index: 20}
      reasonNotGiven: {short: Why immunization did not occur, type: CodeableConcept, array: true, index: 21}
  reportOrigin: {short: Indicates the source of a secondarily reported record, comments: 'Should not be populated if primarySource = True, will not be required even if primarySource = False.', type: CodeableConcept, index: 7}
  date: {short: Vaccination administration date, 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, index: 2}
  site: {short: Body site vaccine  was administered, type: CodeableConcept, index: 15}
  encounter:
    short: Encounter administered as part of
    refers: ['http://hl7.org/fhir/StructureDefinition/Encounter']
    type: Reference
    index: 10
  vaccineCode: {short: Vaccine product administered, type: CodeableConcept, index: 3}
  vaccinationProtocol:
    type: BackboneElement
    short: What protocol was followed
    array: true
    index: 26
    elements:
      doseSequence: {type: positiveInt, short: Dose number within series, index: 27}
      description: {type: string, short: Details of vaccine protocol, index: 28}
      authority:
        short: Who is responsible for protocol
        refers: ['http://hl7.org/fhir/StructureDefinition/Organization']
        type: Reference
        index: 29
      series: {type: string, short: Name of vaccine series, index: 30}
      seriesDoses: {type: positiveInt, short: Recommended number of doses for immunity, index: 31}
      targetDisease: {min: 1, short: Disease immunized against, type: CodeableConcept, array: true, index: 32}
      doseStatus: {short: Indicates if dose counts towards immunity, comments: May need to differentiate between status declarations by a provider vs. a CDS engine., type: CodeableConcept, index: 33}
      doseStatusReason: {short: Why dose does (not) count, type: CodeableConcept, index: 34}
    required: [targetDisease, doseStatus]
  doseQuantity: {type: Quantity, short: Amount of vaccine administered, index: 17}
  route: {short: How vaccine entered body, type: CodeableConcept, index: 16}
  note: {short: Vaccination notes, type: Annotation, array: true, isSummary: true, index: 18}
  requester:
    short: Who ordered vaccination
    refers: ['http://hl7.org/fhir/StructureDefinition/Practitioner']
    comments: Other participants - delegate to Provenance resource.
    type: Reference
    index: 9
  primarySource: {short: Indicates context the data was recorded in, comments: Reflects the “reliability” of the content., type: boolean, index: 6}
  status: {isModifier: true, short: completed | entered-in-error, comments: Will generally be set to show that the immunization has been completed., type: code, isSummary: true, index: 1}
  lotNumber: {type: string, short: Vaccine lot number, index: 13}
  identifier: {type: Identifier, short: Business identifier, array: true, index: 0}
  wasNotGiven: {isModifier: true, short: Flag for whether immunization was given, type: boolean, isSummary: true, index: 5}
  manufacturer:
    short: Vaccine manufacturer
    refers: ['http://hl7.org/fhir/StructureDefinition/Organization']
    type: Reference
    index: 11
  reaction:
    short: Details of a reaction that follows immunization
    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](allergyintolerance.html) resource instance as most systems will not query against  past Immunization.reaction elements.
    type: BackboneElement
    array: true
    index: 22
    elements:
      date: {type: dateTime, short: When reaction started, index: 23}
      detail:
        short: Additional information on reaction
        refers: ['http://hl7.org/fhir/StructureDefinition/Observation']
        type: Reference
        index: 24
      reported: {type: boolean, short: Indicates self-reported reaction, index: 25}
  location:
    short: Where vaccination occurred
    refers: ['http://hl7.org/fhir/StructureDefinition/Location']
    type: Reference
    index: 12
  expirationDate: {type: date, short: Vaccine expiration date, index: 14}
  performer:
    short: Who administered vaccine
    refers: ['http://hl7.org/fhir/StructureDefinition/Practitioner']
    type: Reference
    index: 8
package_version: 1.8.0
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/Immunization
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: null
required: [primarySource, vaccineCode, status, patient, wasNotGiven]