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