This page is part of the FHIR Specification (v0.0.82: DSTU 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

4.13.6 Resource Immunization - Formal Definitions

Formal definitions for the elements in the Immunization resource.

Immunization
DefinitionImmunization event information.
Control1..1
Immunization.identifier
DefinitionA unique identifier assigned to this adverse reaction record.
Control0..*
TypeIdentifier
Immunization.date
DefinitionDate vaccine administered or was to be administered.
Control1..1
TypedateTime
Immunization.vaccineType
DefinitionVaccine that was administered or was to be administered.
Control1..1
BindingVaccineType: The type of vaccine administered (Value Set Definition)
TypeCodeableConcept
Immunization.subject
DefinitionThe patient to whom the vaccine was to be administered.
Control1..1
TypeResource(Patient)
Immunization.refusedIndicator
DefinitionIndicates if the vaccination was refused.
Control1..1
Typeboolean
Immunization.reported
DefinitionTrue if this administration was reported rather than directly administered.
Control1..1
Typeboolean
CommentsMay need source of reported info (e.g. parent), but leave out for now.
Immunization.performer
DefinitionClinician who administered the vaccine.
Control0..1
TypeResource(Practitioner)
Immunization.requester
DefinitionClinician who ordered the vaccination.
Control0..1
TypeResource(Practitioner)
CommentsOther participants - delegate to Provenance resource.
Immunization.manufacturer
DefinitionName of vaccine manufacturer.
Control0..1
TypeResource(Organization)
Immunization.location
DefinitionThe service delivery location where the vaccine administration occurred.
Control0..1
TypeResource(Location)
Immunization.lotNumber
DefinitionLot number of the vaccine product.
Control0..1
Typestring
Immunization.expirationDate
DefinitionDate vaccine batch expires.
Control0..1
Typedate
Immunization.site
DefinitionBody site where vaccine was administered.
Control0..1
BindingImmunizationSite: (See http://hl7.org/fhir/vs/immunization-site)
TypeCodeableConcept
Immunization.route
DefinitionThe path by which the vaccine product is taken into the body.
Control0..1
BindingImmunizationRoute: (See http://hl7.org/fhir/vs/immunization-route)
TypeCodeableConcept
Immunization.doseQuantity
DefinitionThe quantity of vaccine product that was administered.
Control0..1
TypeQuantity
Immunization.explanation
DefinitionReasons why a vaccine was administered or refused.
Control0..1
Immunization.explanation.reason
DefinitionReasons why a vaccine was administered.
Control0..*
BindingImmunizationReason: (See http://hl7.org/fhir/vs/immunization-reason)
TypeCodeableConcept
Immunization.explanation.refusalReason
DefinitionRefusal or exemption reasons.
Control0..*
BindingNoImmunizationReason: (See http://hl7.org/fhir/vs/no-immunization-reason)
TypeCodeableConcept
Immunization.reaction
DefinitionCategorical data indicating that an adverse event is associated in time to an immunization.
Control0..*
Immunization.reaction.date
DefinitionDate of reaction to the immunization.
Control0..1
TypedateTime
Immunization.reaction.detail
DefinitionDetails of the reaction.
Control0..1
TypeResource(AdverseReaction | Observation)
Immunization.reaction.reported
DefinitionSelf-reported indicator.
Control0..1
Typeboolean
Immunization.vaccinationProtocol
DefinitionContains information about the protocol(s) under which the vaccine was administered.
Control0..*
Immunization.vaccinationProtocol.doseSequence
DefinitionNominal position in a series.
Control1..1
Typeinteger
Immunization.vaccinationProtocol.description
DefinitionContains the description about the protocol under which the vaccine was administered.
Control0..1
Typestring
Immunization.vaccinationProtocol.authority
DefinitionIndicates the authority who published the protocol? E.g. ACIP.
Control0..1
TypeResource(Organization)
Immunization.vaccinationProtocol.series
DefinitionOne possible path to achieve presumed immunity against a disease - within the context of an authority.
Control0..1
Typestring
Immunization.vaccinationProtocol.seriesDoses
DefinitionThe recommended number of doses to achieve immunity.
Control0..1
Typeinteger
Immunization.vaccinationProtocol.doseTarget
DefinitionThe targeted disease.
Control1..1
BindingVaccinationProtocolDoseTarget: (See http://hl7.org/fhir/vs/vaccination-protocol-dose-target)
TypeCodeableConcept
Immunization.vaccinationProtocol.doseStatus
DefinitionIndicates if the immunization event should "count" against the protocol.
Control1..1
BindingVaccinationProtocolDoseStatus: (See http://hl7.org/fhir/vs/vaccination-protocol-dose-status)
TypeCodeableConcept
CommentsMay need to differentiate between status declarations by a provider vs. a CDS engine.
Immunization.vaccinationProtocol.doseStatusReason
DefinitionProvides an explanation as to why a immunization event should or should not count against the protocol.
Control0..1
BindingVaccinationProtocolDoseStatusReason: (See http://hl7.org/fhir/vs/vaccination-protocol-dose-status-reason)
TypeCodeableConcept
comments powered by Disqus