Current Build

11.13 Resource Immunization - Content

Public Health and Emergency Response Work GroupMaturity Level: 3 Trial Use Compartments: Patient, Practitioner

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.

The Immunization resource is intended to cover the recording of current and historical administration of vaccines to patients across all healthcare disciplines in all care settings and all regions. This includes immunization of both humans and animals, but does not include the administration of non-vaccine agents, even those that may have or claim to have immunological effects.

Additionally, the Immunization resource is expected to cover key concepts related to the creation, revision and querying of a patient's immunization history. This resource - through consultation with the Public Health work group - is believed to meet key use cases and information requirements as defined in the existing HL7 v2 immunization implementation guide, HL7 v3 POIZ domain and Immunization Domain Analysis Model.

This resource references the following resources:

  • Patient
  • Practitioner
  • Organization
  • Location
  • Encounter

Administration of vaccines is intended to be handled using the Immunization resource. MedicationAdministration is intended for tracking the administration of non-vaccine medications. Some systems treat immunizations in the same way as any other medication administration. Such systems SHOULD use an immunization resource to represent these. If systems need to use a MedicationAdministration resource to capture vaccinations for workflow or other reasons, they SHOULD also expose an equivalent Immunization instance.

This resource is referenced by AdverseEvent, ChargeItem, ImmunizationEvaluation, ImmunizationRecommendation and Observation

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization TUDomainResourceImmunization event information
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier 0..*IdentifierBusiness identifier
... status ?!Σ1..1codecompleted | entered-in-error | not-done
Immunization Status Codes (Required)
... vaccineCode Σ1..1CodeableConceptVaccine product administered
Vaccine Administered Value Set (Example)
... patient Σ1..1Reference(Patient)Who was immunized
... encounter 0..1Reference(Encounter)Encounter immunization was part of
... date 0..1dateTimeVaccine administration date
... primarySource Σ1..1booleanIndicates context the data was recorded in
... reportOrigin 0..1CodeableConceptIndicates the source of a secondarily reported record
Immunization Origin Codes (Example)
... location 0..1Reference(Location)Where immunization occurred
... manufacturer 0..1Reference(Organization)Vaccine manufacturer
... lotNumber 0..1stringVaccine lot number
... expirationDate 0..1dateVaccine expiration date
... site 0..1CodeableConceptBody site vaccine was administered
Codes for Immunization Site of Administration (Example)
... route 0..1CodeableConceptHow vaccine entered body
Immunization Route Codes (Example)
... doseQuantity 0..1SimpleQuantityAmount of vaccine administered
... practitioner Σ0..*BackboneElementWho performed event
.... role Σ0..1CodeableConceptWhat type of performance was done
Immunization Role Codes (Extensible)
.... actor Σ1..1Reference(Practitioner)Individual who was performing
... note Σ0..*AnnotationAdditional immunization notes
... reason 0..*CodeableConceptWhy immunization did or did not occur
Immunization Reason Codes (Example)
... education I0..*BackboneElementEducational material presented to patient
+ One of documentType or reference SHALL be present
.... documentType 0..1stringEducational material document identifier
.... reference 0..1uriEducational material reference pointer
.... publicationDate 0..1dateTimeEducational material publication date
.... presentationDate 0..1dateTimeEducational material presentation date
... programEligibility 0..*CodeableConceptPatient eligibility for a vaccination program
Immunization Program Eligibility (Example)
... fundingSource 0..1CodeableConceptFunding source for the vaccine
Immunization Funding Source (Example)

doco Documentation for this format

UML Diagram (Legend)

Immunization (DomainResource)A unique identifier assigned to this immunization recordidentifier : Identifier [0..*]Indicates the current status of the immunization event (this element modifies the meaning of other elements)status : code [1..1] « A set of codes indicating the current status of an Immunization (Strength=Required)Immunization Status ! »Vaccine that was administered or was to be administeredvaccineCode : CodeableConcept [1..1] « The code for vaccine product administered (Strength=Example)Vaccine Administered Value Set?? »The patient who either received or did not receive the immunizationpatient : Reference [1..1] « Patient »The visit or admission or other contact between patient and health care provider the immunization was performed as part ofencounter : Reference [0..1] « Encounter »Date vaccine administered or was to be administereddate : dateTime [0..1]An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recordedprimarySource : boolean [1..1]The source of the data when the report of the immunization event is not based on information from the person who administered the vaccinereportOrigin : CodeableConcept [0..1] « The source of the data for a record which is not from a primary source. (Strength=Example)Immunization Origin ?? »The service delivery location where the vaccine administration occurredlocation : Reference [0..1] « Location »Name of vaccine manufacturermanufacturer : Reference [0..1] « Organization »Lot number of the vaccine productlotNumber : string [0..1]Date vaccine batch expiresexpirationDate : date [0..1]Body site where vaccine was administeredsite : CodeableConcept [0..1] « The site at which the vaccine was administered (Strength=Example)Codes for Immunization Site o...?? »The path by which the vaccine product is taken into the bodyroute : CodeableConcept [0..1] « The route by which the vaccine was administered (Strength=Example)Immunization Route ?? »The quantity of vaccine product that was administereddoseQuantity : Quantity(SimpleQuantity) [0..1]Extra information about the immunization that is not conveyed by the other attributesnote : Annotation [0..*]Reasons why a vaccine was or was not administeredreason : CodeableConcept [0..*] « The reason why a vaccine was administered (Strength=Example)Immunization Reason ?? »Indicates a patient's eligibility for a funding programprogramEligibility : CodeableConcept [0..*] « The patient's eligibility for a vaccation program (Strength=Example)Immunization Program Eligibil...?? »Indicates the source of the vaccine actually administered. This may be different than the patient eligbility (e.g. the patient may be eligibile for a publically purchased vaccine but due to inventory issues, vaccine purchased with private funds was actually administered)fundingSource : CodeableConcept [0..1] « The source of funding used to purchase the vaccine administered (Strength=Example)Immunization Funding Source?? »PractitionerDescribes the type of performance (e.g. ordering provider, administering provider, etc.)role : CodeableConcept [0..1] « The role a practitioner plays in the immunization event (Strength=Extensible)Immunization Role + »The practitioner who performed the actionactor : Reference [1..1] « Practitioner »EducationIdentifier of the material presented ot the patientdocumentType : string [0..1]Reference pointer to the educational material given to the patient if the information was on linereference : uri [0..1]Date the educational material was publishedpublicationDate : dateTime [0..1]Date the educational material was given to the patientpresentationDate : dateTime [0..1]Indicates who performed the immunization eventpractitioner[0..*]Educational material presented to the patient (or guardian) at the time of vaccine administrationeducation[0..*]

XML Template

<Immunization xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Business identifier --></identifier>
 <status value="[code]"/><!-- 1..1 completed | entered-in-error | not-done -->
 <vaccineCode><!-- 1..1 CodeableConcept Vaccine product administered --></vaccineCode>
 <patient><!-- 1..1 Reference(Patient) Who was immunized --></patient>
 <encounter><!-- 0..1 Reference(Encounter) Encounter immunization was part of --></encounter>
 <date value="[dateTime]"/><!-- 0..1 Vaccine administration date -->
 <primarySource value="[boolean]"/><!-- 1..1 Indicates context the data was recorded in -->
 <reportOrigin><!-- 0..1 CodeableConcept Indicates the source of a secondarily reported record --></reportOrigin>
 <location><!-- 0..1 Reference(Location) Where immunization occurred --></location>
 <manufacturer><!-- 0..1 Reference(Organization) Vaccine manufacturer --></manufacturer>
 <lotNumber value="[string]"/><!-- 0..1 Vaccine lot number -->
 <expirationDate value="[date]"/><!-- 0..1 Vaccine expiration date -->
 <site><!-- 0..1 CodeableConcept Body site vaccine  was administered --></site>
 <route><!-- 0..1 CodeableConcept How vaccine entered body --></route>
 <doseQuantity><!-- 0..1 Quantity(SimpleQuantity) Amount of vaccine administered --></doseQuantity>
 <practitioner>  <!-- 0..* Who performed event -->
  <role><!-- 0..1 CodeableConcept What type of performance was done --></role>
  <actor><!-- 1..1 Reference(Practitioner) Individual who was performing --></actor>
 </practitioner>
 <note><!-- 0..* Annotation Additional immunization notes --></note>
 <reason><!-- 0..* CodeableConcept Why immunization did or did not occur --></reason>
 <education>  <!-- 0..* Educational material presented to patient -->
  <documentType value="[string]"/><!-- 0..1 Educational material document identifier -->
  <reference value="[uri]"/><!-- 0..1 Educational material reference pointer -->
  <publicationDate value="[dateTime]"/><!-- 0..1 Educational material publication date -->
  <presentationDate value="[dateTime]"/><!-- 0..1 Educational material presentation date -->
 </education>
 <programEligibility><!-- 0..* CodeableConcept Patient eligibility for a vaccination program --></programEligibility>
 <fundingSource><!-- 0..1 CodeableConcept Funding source for the vaccine --></fundingSource>
</Immunization>

JSON Template

{doco
  "resourceType" : "Immunization",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business identifier
  "status" : "<code>", // R!  completed | entered-in-error | not-done
  "vaccineCode" : { CodeableConcept }, // R!  Vaccine product administered
  "patient" : { Reference(Patient) }, // R!  Who was immunized
  "encounter" : { Reference(Encounter) }, // Encounter immunization was part of
  "date" : "<dateTime>", // Vaccine administration date
  "primarySource" : <boolean>, // R!  Indicates context the data was recorded in
  "reportOrigin" : { CodeableConcept }, // Indicates the source of a secondarily reported record
  "location" : { Reference(Location) }, // Where immunization occurred
  "manufacturer" : { Reference(Organization) }, // Vaccine manufacturer
  "lotNumber" : "<string>", // Vaccine lot number
  "expirationDate" : "<date>", // Vaccine expiration date
  "site" : { CodeableConcept }, // Body site vaccine  was administered
  "route" : { CodeableConcept }, // How vaccine entered body
  "doseQuantity" : { Quantity(SimpleQuantity) }, // Amount of vaccine administered
  "practitioner" : [{ // Who performed event
    "role" : { CodeableConcept }, // What type of performance was done
    "actor" : { Reference(Practitioner) } // R!  Individual who was performing
  }],
  "note" : [{ Annotation }], // Additional immunization notes
  "reason" : [{ CodeableConcept }], // Why immunization did or did not occur
  "education" : [{ // Educational material presented to patient
    "documentType" : "<string>", // Educational material document identifier
    "reference" : "<uri>", // Educational material reference pointer
    "publicationDate" : "<dateTime>", // Educational material publication date
    "presentationDate" : "<dateTime>" // Educational material presentation date
  }],
  "programEligibility" : [{ CodeableConcept }], // Patient eligibility for a vaccination program
  "fundingSource" : { CodeableConcept } // Funding source for the vaccine
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:Immunization;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:Immunization.identifier [ Identifier ], ... ; # 0..* Business identifier
  fhir:Immunization.status [ code ]; # 1..1 completed | entered-in-error | not-done
  fhir:Immunization.vaccineCode [ CodeableConcept ]; # 1..1 Vaccine product administered
  fhir:Immunization.patient [ Reference(Patient) ]; # 1..1 Who was immunized
  fhir:Immunization.encounter [ Reference(Encounter) ]; # 0..1 Encounter immunization was part of
  fhir:Immunization.date [ dateTime ]; # 0..1 Vaccine administration date
  fhir:Immunization.primarySource [ boolean ]; # 1..1 Indicates context the data was recorded in
  fhir:Immunization.reportOrigin [ CodeableConcept ]; # 0..1 Indicates the source of a secondarily reported record
  fhir:Immunization.location [ Reference(Location) ]; # 0..1 Where immunization occurred
  fhir:Immunization.manufacturer [ Reference(Organization) ]; # 0..1 Vaccine manufacturer
  fhir:Immunization.lotNumber [ string ]; # 0..1 Vaccine lot number
  fhir:Immunization.expirationDate [ date ]; # 0..1 Vaccine expiration date
  fhir:Immunization.site [ CodeableConcept ]; # 0..1 Body site vaccine  was administered
  fhir:Immunization.route [ CodeableConcept ]; # 0..1 How vaccine entered body
  fhir:Immunization.doseQuantity [ Quantity(SimpleQuantity) ]; # 0..1 Amount of vaccine administered
  fhir:Immunization.practitioner [ # 0..* Who performed event
    fhir:Immunization.practitioner.role [ CodeableConcept ]; # 0..1 What type of performance was done
    fhir:Immunization.practitioner.actor [ Reference(Practitioner) ]; # 1..1 Individual who was performing
  ], ...;
  fhir:Immunization.note [ Annotation ], ... ; # 0..* Additional immunization notes
  fhir:Immunization.reason [ CodeableConcept ], ... ; # 0..* Why immunization did or did not occur
  fhir:Immunization.education [ # 0..* Educational material presented to patient
    fhir:Immunization.education.documentType [ string ]; # 0..1 Educational material document identifier
    fhir:Immunization.education.reference [ uri ]; # 0..1 Educational material reference pointer
    fhir:Immunization.education.publicationDate [ dateTime ]; # 0..1 Educational material publication date
    fhir:Immunization.education.presentationDate [ dateTime ]; # 0..1 Educational material presentation date
  ], ...;
  fhir:Immunization.programEligibility [ CodeableConcept ], ... ; # 0..* Patient eligibility for a vaccination program
  fhir:Immunization.fundingSource [ CodeableConcept ]; # 0..1 Funding source for the vaccine
]

Changes since DSTU2

Immunization
Immunization.status
  • Change value set from http://hl7.org/fhir/ValueSet/medication-admin-status to http://hl7.org/fhir/ValueSet/immunization-status
Immunization.primarySource
  • Added Element
Immunization.reportOrigin
  • Added Element
Immunization.practitioner
  • Added Element
Immunization.practitioner.role
  • Added Element
Immunization.practitioner.actor
  • Added Element
Immunization.reason
  • Added Element
Immunization.education
  • Added Element
Immunization.education.documentType
  • Added Element
Immunization.education.reference
  • Added Element
Immunization.education.publicationDate
  • Added Element
Immunization.education.presentationDate
  • Added Element
Immunization.programEligibility
  • Added Element
Immunization.fundingSource
  • Added Element
Immunization.wasNotGiven
  • deleted
Immunization.reported
  • deleted
Immunization.performer
  • deleted
Immunization.requester
  • deleted
Immunization.explanation
  • deleted
Immunization.reaction
  • deleted
Immunization.vaccinationProtocol
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON.

See R2 <--> R3 Conversion Maps (status = 2 tests that all execute ok. 2 fail round-trip testing and 2 r3 resources are invalid (2 errors).).

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization TUDomainResourceImmunization event information
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier 0..*IdentifierBusiness identifier
... status ?!Σ1..1codecompleted | entered-in-error | not-done
Immunization Status Codes (Required)
... vaccineCode Σ1..1CodeableConceptVaccine product administered
Vaccine Administered Value Set (Example)
... patient Σ1..1Reference(Patient)Who was immunized
... encounter 0..1Reference(Encounter)Encounter immunization was part of
... date 0..1dateTimeVaccine administration date
... primarySource Σ1..1booleanIndicates context the data was recorded in
... reportOrigin 0..1CodeableConceptIndicates the source of a secondarily reported record
Immunization Origin Codes (Example)
... location 0..1Reference(Location)Where immunization occurred
... manufacturer 0..1Reference(Organization)Vaccine manufacturer
... lotNumber 0..1stringVaccine lot number
... expirationDate 0..1dateVaccine expiration date
... site 0..1CodeableConceptBody site vaccine was administered
Codes for Immunization Site of Administration (Example)
... route 0..1CodeableConceptHow vaccine entered body
Immunization Route Codes (Example)
... doseQuantity 0..1SimpleQuantityAmount of vaccine administered
... practitioner Σ0..*BackboneElementWho performed event
.... role Σ0..1CodeableConceptWhat type of performance was done
Immunization Role Codes (Extensible)
.... actor Σ1..1Reference(Practitioner)Individual who was performing
... note Σ0..*AnnotationAdditional immunization notes
... reason 0..*CodeableConceptWhy immunization did or did not occur
Immunization Reason Codes (Example)
... education I0..*BackboneElementEducational material presented to patient
+ One of documentType or reference SHALL be present
.... documentType 0..1stringEducational material document identifier
.... reference 0..1uriEducational material reference pointer
.... publicationDate 0..1dateTimeEducational material publication date
.... presentationDate 0..1dateTimeEducational material presentation date
... programEligibility 0..*CodeableConceptPatient eligibility for a vaccination program
Immunization Program Eligibility (Example)
... fundingSource 0..1CodeableConceptFunding source for the vaccine
Immunization Funding Source (Example)

doco Documentation for this format

UML Diagram (Legend)

Immunization (DomainResource)A unique identifier assigned to this immunization recordidentifier : Identifier [0..*]Indicates the current status of the immunization event (this element modifies the meaning of other elements)status : code [1..1] « A set of codes indicating the current status of an Immunization (Strength=Required)Immunization Status ! »Vaccine that was administered or was to be administeredvaccineCode : CodeableConcept [1..1] « The code for vaccine product administered (Strength=Example)Vaccine Administered Value Set?? »The patient who either received or did not receive the immunizationpatient : Reference [1..1] « Patient »The visit or admission or other contact between patient and health care provider the immunization was performed as part ofencounter : Reference [0..1] « Encounter »Date vaccine administered or was to be administereddate : dateTime [0..1]An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recordedprimarySource : boolean [1..1]The source of the data when the report of the immunization event is not based on information from the person who administered the vaccinereportOrigin : CodeableConcept [0..1] « The source of the data for a record which is not from a primary source. (Strength=Example)Immunization Origin ?? »The service delivery location where the vaccine administration occurredlocation : Reference [0..1] « Location »Name of vaccine manufacturermanufacturer : Reference [0..1] « Organization »Lot number of the vaccine productlotNumber : string [0..1]Date vaccine batch expiresexpirationDate : date [0..1]Body site where vaccine was administeredsite : CodeableConcept [0..1] « The site at which the vaccine was administered (Strength=Example)Codes for Immunization Site o...?? »The path by which the vaccine product is taken into the bodyroute : CodeableConcept [0..1] « The route by which the vaccine was administered (Strength=Example)Immunization Route ?? »The quantity of vaccine product that was administereddoseQuantity : Quantity(SimpleQuantity) [0..1]Extra information about the immunization that is not conveyed by the other attributesnote : Annotation [0..*]Reasons why a vaccine was or was not administeredreason : CodeableConcept [0..*] « The reason why a vaccine was administered (Strength=Example)Immunization Reason ?? »Indicates a patient's eligibility for a funding programprogramEligibility : CodeableConcept [0..*] « The patient's eligibility for a vaccation program (Strength=Example)Immunization Program Eligibil...?? »Indicates the source of the vaccine actually administered. This may be different than the patient eligbility (e.g. the patient may be eligibile for a publically purchased vaccine but due to inventory issues, vaccine purchased with private funds was actually administered)fundingSource : CodeableConcept [0..1] « The source of funding used to purchase the vaccine administered (Strength=Example)Immunization Funding Source?? »PractitionerDescribes the type of performance (e.g. ordering provider, administering provider, etc.)role : CodeableConcept [0..1] « The role a practitioner plays in the immunization event (Strength=Extensible)Immunization Role + »The practitioner who performed the actionactor : Reference [1..1] « Practitioner »EducationIdentifier of the material presented ot the patientdocumentType : string [0..1]Reference pointer to the educational material given to the patient if the information was on linereference : uri [0..1]Date the educational material was publishedpublicationDate : dateTime [0..1]Date the educational material was given to the patientpresentationDate : dateTime [0..1]Indicates who performed the immunization eventpractitioner[0..*]Educational material presented to the patient (or guardian) at the time of vaccine administrationeducation[0..*]

XML Template

<Immunization xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Business identifier --></identifier>
 <status value="[code]"/><!-- 1..1 completed | entered-in-error | not-done -->
 <vaccineCode><!-- 1..1 CodeableConcept Vaccine product administered --></vaccineCode>
 <patient><!-- 1..1 Reference(Patient) Who was immunized --></patient>
 <encounter><!-- 0..1 Reference(Encounter) Encounter immunization was part of --></encounter>
 <date value="[dateTime]"/><!-- 0..1 Vaccine administration date -->
 <primarySource value="[boolean]"/><!-- 1..1 Indicates context the data was recorded in -->
 <reportOrigin><!-- 0..1 CodeableConcept Indicates the source of a secondarily reported record --></reportOrigin>
 <location><!-- 0..1 Reference(Location) Where immunization occurred --></location>
 <manufacturer><!-- 0..1 Reference(Organization) Vaccine manufacturer --></manufacturer>
 <lotNumber value="[string]"/><!-- 0..1 Vaccine lot number -->
 <expirationDate value="[date]"/><!-- 0..1 Vaccine expiration date -->
 <site><!-- 0..1 CodeableConcept Body site vaccine  was administered --></site>
 <route><!-- 0..1 CodeableConcept How vaccine entered body --></route>
 <doseQuantity><!-- 0..1 Quantity(SimpleQuantity) Amount of vaccine administered --></doseQuantity>
 <practitioner>  <!-- 0..* Who performed event -->
  <role><!-- 0..1 CodeableConcept What type of performance was done --></role>
  <actor><!-- 1..1 Reference(Practitioner) Individual who was performing --></actor>
 </practitioner>
 <note><!-- 0..* Annotation Additional immunization notes --></note>
 <reason><!-- 0..* CodeableConcept Why immunization did or did not occur --></reason>
 <education>  <!-- 0..* Educational material presented to patient -->
  <documentType value="[string]"/><!-- 0..1 Educational material document identifier -->
  <reference value="[uri]"/><!-- 0..1 Educational material reference pointer -->
  <publicationDate value="[dateTime]"/><!-- 0..1 Educational material publication date -->
  <presentationDate value="[dateTime]"/><!-- 0..1 Educational material presentation date -->
 </education>
 <programEligibility><!-- 0..* CodeableConcept Patient eligibility for a vaccination program --></programEligibility>
 <fundingSource><!-- 0..1 CodeableConcept Funding source for the vaccine --></fundingSource>
</Immunization>

JSON Template

{doco
  "resourceType" : "Immunization",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business identifier
  "status" : "<code>", // R!  completed | entered-in-error | not-done
  "vaccineCode" : { CodeableConcept }, // R!  Vaccine product administered
  "patient" : { Reference(Patient) }, // R!  Who was immunized
  "encounter" : { Reference(Encounter) }, // Encounter immunization was part of
  "date" : "<dateTime>", // Vaccine administration date
  "primarySource" : <boolean>, // R!  Indicates context the data was recorded in
  "reportOrigin" : { CodeableConcept }, // Indicates the source of a secondarily reported record
  "location" : { Reference(Location) }, // Where immunization occurred
  "manufacturer" : { Reference(Organization) }, // Vaccine manufacturer
  "lotNumber" : "<string>", // Vaccine lot number
  "expirationDate" : "<date>", // Vaccine expiration date
  "site" : { CodeableConcept }, // Body site vaccine  was administered
  "route" : { CodeableConcept }, // How vaccine entered body
  "doseQuantity" : { Quantity(SimpleQuantity) }, // Amount of vaccine administered
  "practitioner" : [{ // Who performed event
    "role" : { CodeableConcept }, // What type of performance was done
    "actor" : { Reference(Practitioner) } // R!  Individual who was performing
  }],
  "note" : [{ Annotation }], // Additional immunization notes
  "reason" : [{ CodeableConcept }], // Why immunization did or did not occur
  "education" : [{ // Educational material presented to patient
    "documentType" : "<string>", // Educational material document identifier
    "reference" : "<uri>", // Educational material reference pointer
    "publicationDate" : "<dateTime>", // Educational material publication date
    "presentationDate" : "<dateTime>" // Educational material presentation date
  }],
  "programEligibility" : [{ CodeableConcept }], // Patient eligibility for a vaccination program
  "fundingSource" : { CodeableConcept } // Funding source for the vaccine
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:Immunization;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:Immunization.identifier [ Identifier ], ... ; # 0..* Business identifier
  fhir:Immunization.status [ code ]; # 1..1 completed | entered-in-error | not-done
  fhir:Immunization.vaccineCode [ CodeableConcept ]; # 1..1 Vaccine product administered
  fhir:Immunization.patient [ Reference(Patient) ]; # 1..1 Who was immunized
  fhir:Immunization.encounter [ Reference(Encounter) ]; # 0..1 Encounter immunization was part of
  fhir:Immunization.date [ dateTime ]; # 0..1 Vaccine administration date
  fhir:Immunization.primarySource [ boolean ]; # 1..1 Indicates context the data was recorded in
  fhir:Immunization.reportOrigin [ CodeableConcept ]; # 0..1 Indicates the source of a secondarily reported record
  fhir:Immunization.location [ Reference(Location) ]; # 0..1 Where immunization occurred
  fhir:Immunization.manufacturer [ Reference(Organization) ]; # 0..1 Vaccine manufacturer
  fhir:Immunization.lotNumber [ string ]; # 0..1 Vaccine lot number
  fhir:Immunization.expirationDate [ date ]; # 0..1 Vaccine expiration date
  fhir:Immunization.site [ CodeableConcept ]; # 0..1 Body site vaccine  was administered
  fhir:Immunization.route [ CodeableConcept ]; # 0..1 How vaccine entered body
  fhir:Immunization.doseQuantity [ Quantity(SimpleQuantity) ]; # 0..1 Amount of vaccine administered
  fhir:Immunization.practitioner [ # 0..* Who performed event
    fhir:Immunization.practitioner.role [ CodeableConcept ]; # 0..1 What type of performance was done
    fhir:Immunization.practitioner.actor [ Reference(Practitioner) ]; # 1..1 Individual who was performing
  ], ...;
  fhir:Immunization.note [ Annotation ], ... ; # 0..* Additional immunization notes
  fhir:Immunization.reason [ CodeableConcept ], ... ; # 0..* Why immunization did or did not occur
  fhir:Immunization.education [ # 0..* Educational material presented to patient
    fhir:Immunization.education.documentType [ string ]; # 0..1 Educational material document identifier
    fhir:Immunization.education.reference [ uri ]; # 0..1 Educational material reference pointer
    fhir:Immunization.education.publicationDate [ dateTime ]; # 0..1 Educational material publication date
    fhir:Immunization.education.presentationDate [ dateTime ]; # 0..1 Educational material presentation date
  ], ...;
  fhir:Immunization.programEligibility [ CodeableConcept ], ... ; # 0..* Patient eligibility for a vaccination program
  fhir:Immunization.fundingSource [ CodeableConcept ]; # 0..1 Funding source for the vaccine
]

Changes since DSTU2

Immunization
Immunization.status
  • Change value set from http://hl7.org/fhir/ValueSet/medication-admin-status to http://hl7.org/fhir/ValueSet/immunization-status
Immunization.primarySource
  • Added Element
Immunization.reportOrigin
  • Added Element
Immunization.practitioner
  • Added Element
Immunization.practitioner.role
  • Added Element
Immunization.practitioner.actor
  • Added Element
Immunization.reason
  • Added Element
Immunization.education
  • Added Element
Immunization.education.documentType
  • Added Element
Immunization.education.reference
  • Added Element
Immunization.education.publicationDate
  • Added Element
Immunization.education.presentationDate
  • Added Element
Immunization.programEligibility
  • Added Element
Immunization.fundingSource
  • Added Element
Immunization.wasNotGiven
  • deleted
Immunization.reported
  • deleted
Immunization.performer
  • deleted
Immunization.requester
  • deleted
Immunization.explanation
  • deleted
Immunization.reaction
  • deleted
Immunization.vaccinationProtocol
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON.

See R2 <--> R3 Conversion Maps (status = 2 tests that all execute ok. 2 fail round-trip testing and 2 r3 resources are invalid (2 errors).).

 

Alternate definitions: Master Definition (XML, JSON), XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions & the dependency analysis

PathDefinitionTypeReference
Immunization.status A set of codes indicating the current status of an ImmunizationRequiredImmunization Status Codes
Immunization.vaccineCode The code for vaccine product administeredExampleVaccine Administered Value Set
Immunization.reportOrigin The source of the data for a record which is not from a primary source.ExampleImmunization Origin Codes
Immunization.site The site at which the vaccine was administeredExampleCodes for Immunization Site of Administration
Immunization.route The route by which the vaccine was administeredExampleImmunization Route Codes
Immunization.practitioner.role The role a practitioner plays in the immunization eventExtensibleImmunization Role Codes
Immunization.reason The reason why a vaccine was administeredExampleImmunization Reason Codes
Immunization.programEligibility The patient's eligibility for a vaccation programExampleImmunization Program Eligibility
Immunization.fundingSource The source of funding used to purchase the vaccine administeredExampleImmunization Funding Source

  • imm-1: On Immunization.education: One of documentType or reference SHALL be present (expression on Immunization.education: documentType.exists() or reference.exists())

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionExpressionIn Common
datedateVaccination (non)-Administration DateImmunization.date17 Resources
identifiertokenBusiness identifierImmunization.identifier26 Resources
locationreferenceThe service delivery location or facility in which the vaccine was / was to be administeredImmunization.location
(Location)
lot-numberstringVaccine Lot NumberImmunization.lotNumber
manufacturerreferenceVaccine ManufacturerImmunization.manufacturer
(Organization)
patientreferenceThe patient for the vaccination recordImmunization.patient
(Patient)
29 Resources
practitionerreferenceThe practitioner who played a role in the vaccinationImmunization.practitioner.actor
(Practitioner)
reasontokenWhy immunization did or did not occurImmunization.reason
statustokenImmunization event statusImmunization.status
vaccine-codetokenVaccine Product AdministeredImmunization.vaccineCode