Immunization — Resources — FHIR R5

Immunization

draftResource61 elementsv5.0.0

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.

Metadata

hl7.org/fhir

Canonical URL: http://hl7.org/fhir/StructureDefinition/Immunization
ID: Immunization
Type
Base Definition
Derivation: specialization
Publisher: Health Level Seven International (Public Health and Emergency Response)
Version: 5.0.0

Path	Card.	Type	Description
`Immunization`	`0..*`		Immunization event information
`id`	`0..1`	string	Logical id of this artifact
`meta`	`0..1`	Meta	Metadata about the resource
`implicitRules`	`0..1`	uri	A set of rules under which this content was created
`language`	`0..1`	code	Language of the resource contentrequired: all-languages
`text`	`0..1`	Narrative	Text summary of the resource, for human interpretation
`contained`	`0..*`	Resource	Contained, inline Resources
`extension`	`0..*`	Extension	Additional content defined by implementations
`modifierExtension`	`0..*`	Extension	Extensions that cannot be ignored
`identifier`	`0..*`	Identifier	Business identifier
`basedOn`	`0..*`	Reference	Authority that the immunization event is based on
`status`	`1..1`	code	completed \| entered-in-error \| not-donerequired: immunization-status
`statusReason`	`0..1`	CodeableConcept	Reason for current statusexample: immunization-status-reason
`vaccineCode`	`1..1`	CodeableConcept	Vaccine administeredexample: vaccine-code
`administeredProduct`	`0..1`	CodeableReference	Product that was administered
`manufacturer`	`0..1`	CodeableReference	Vaccine manufacturer
`lotNumber`	`0..1`	string	Vaccine lot number
`expirationDate`	`0..1`	date	Vaccine expiration date
`patient`	`1..1`	Reference	Who was immunized
`encounter`	`0..1`	Reference	Encounter immunization was part of
`supportingInformation`	`0..*`	Reference	Additional information in support of the immunization
`occurrence[x]`	`1..1`	dateTimestring	Vaccine administration date
`primarySource`	`0..1`	boolean	Indicates context the data was captured in
`informationSource`	`0..1`	CodeableReference	Indicates the source of a reported recordexample: immunization-origin
`location`	`0..1`	Reference	Where immunization occurred
`site`	`0..1`	CodeableConcept	Body site vaccine was administeredexample: immunization-site
`route`	`0..1`	CodeableConcept	How vaccine entered bodyexample: immunization-route
`doseQuantity`	`0..1`	Quantity	Amount of vaccine administered
`performer`	`0..*`	BackboneElement	Who performed event
`note`	`0..*`	Annotation	Additional immunization notes
`reason`	`0..*`	CodeableReference	Why immunization occurredexample: immunization-reason
`isSubpotent`	`0..1`	boolean	Dose potency
`subpotentReason`	`0..*`	CodeableConcept	Reason for being subpotentexample: immunization-subpotent-reason
`programEligibility`	`0..*`	BackboneElement	Patient eligibility for a specific vaccination program
`fundingSource`	`0..1`	CodeableConcept	Funding source for the vaccineexample: immunization-funding-source
`reaction`	`0..*`	BackboneElement	Details of a reaction that follows immunization
`protocolApplied`	`0..*`	BackboneElement	Protocol followed by the provider