description: Base StructureDefinition for Immunization Resource
package_name: hl7.fhir.core
derivation: specialization
name: Immunization
type: null
elements:
  patient: {type: Reference, short: Who was immunized, index: 4}
  explanation:
    type: BackboneElement
    short: Administration/non-administration reasons
    index: 18
    elements:
      reason: {type: CodeableConcept, short: Why immunization occurred, array: true, index: 19}
      reasonNotGiven: {type: CodeableConcept, short: Why immunization did not occur, array: true, index: 20}
  date: {type: dateTime, 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.', index: 2}
  site: {type: CodeableConcept, short: Body site vaccine  was administered, index: 14}
  encounter: {type: Reference, short: Encounter administered as part of, index: 9}
  vaccineCode: {type: CodeableConcept, short: Vaccine product administered, index: 3}
  vaccinationProtocol:
    type: BackboneElement
    short: What protocol was followed
    array: true
    index: 25
    elements:
      doseSequence: {type: positiveInt, short: Dose number within series, index: 26}
      description: {type: string, short: Details of vaccine protocol, index: 27}
      authority: {type: Reference, short: Who is responsible for protocol, index: 28}
      series: {type: string, short: Name of vaccine series, index: 29}
      seriesDoses: {type: positiveInt, short: Recommended number of doses for immunity, index: 30}
      targetDisease: {type: CodeableConcept, short: Disease immunized against, array: true, min: 1, index: 31}
      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: 32}
      doseStatusReason: {type: CodeableConcept, short: Why dose does (not) count, index: 33}
    required: [targetDisease, doseStatus, doseSequence]
  doseQuantity: {type: Quantity, short: Amount of vaccine administered, index: 16}
  reported: {type: boolean, short: Indicates a self-reported record, comments: 'May need source of reported info (e.g. parent), but leave out for now.', index: 6}
  route: {type: CodeableConcept, short: How vaccine entered body, index: 15}
  note: {type: Annotation, short: Vaccination notes, isSummary: true, array: true, index: 17}
  requester: {type: Reference, short: Who ordered vaccination, comments: Other participants - delegate to Provenance resource., index: 8}
  status: {isModifier: true, short: in-progress | on-hold | completed | entered-in-error | stopped, 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: 12}
  identifier: {type: Identifier, short: Business identifier, array: true, index: 0}
  wasNotGiven: {type: boolean, short: Flag for whether immunization was given, isModifier: true, index: 5}
  manufacturer: {type: Reference, short: Vaccine manufacturer, index: 10}
  reaction:
    type: BackboneElement
    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]]] resource instance as most systems will not query against  past Immunization.reaction elements.
    array: true
    index: 21
    elements:
      date: {type: dateTime, short: When reaction started, index: 22}
      detail: {type: Reference, short: Additional information on reaction, index: 23}
      reported: {type: boolean, short: Indicates self-reported reaction, index: 24}
  location: {type: Reference, short: Where vaccination occurred, index: 11}
  expirationDate: {type: date, short: Vaccine expiration date, index: 13}
  performer: {type: Reference, short: Who administered vaccine, 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]