2nd DSTU Draft For Comment
This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). 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
Detailed Descriptions for the elements in the Immunization resource.
| Immunization | |
| Definition | Immunization event information. |
| Control | 1..1 |
| Immunization.identifier | |
| Definition | A unique identifier assigned to this immunization record. |
| Control | 0..* |
| Type | Identifier |
| Immunization.date | |
| Definition | Date vaccine administered or was to be administered. |
| Control | 1..1 |
| Type | dateTime |
| Immunization.vaccineType | |
| Definition | Vaccine that was administered or was to be administered. |
| Control | 1..1 |
| Binding | VaccineType: The type of vaccine administered (Example) |
| Type | CodeableConcept |
| Immunization.patient | |
| Definition | The patient who either received or did not receive the immunization. |
| Control | 1..1 |
| Type | Reference(Patient) |
| Immunization.wasNotGiven | |
| Definition | Indicates if the vaccination was or was not given. |
| Control | 1..1 |
| Type | boolean |
| Is Modifier | true |
| Invariants | Defined on this element imm-1: If immunization was not administred (wasNotGiven=true) then there SHALL be no reaction nor explanation.reason present (xpath: not(f:wasNotGiven/@value='true' and (count(f:reaction) > 0 or exists(f:explanation/reason)))) imm-2: If immunization was administered (wasNotGiven=false) then explanation.reasonNotGiven SHALL be absent. (xpath: not(f:wasNotGiven/@value='false' and exists(f:explanation/f:reasonNotGiven))) |
| Immunization.reported | |
| Definition | True if this administration was reported rather than directly administered. |
| Control | 1..1 |
| Type | boolean |
| Comments | May need source of reported info (e.g. parent), but leave out for now. |
| Immunization.performer | |
| Definition | Clinician who administered the vaccine. |
| Control | 0..1 |
| Type | Reference(Practitioner) |
| Immunization.requester | |
| Definition | Clinician who ordered the vaccination. |
| Control | 0..1 |
| Type | Reference(Practitioner) |
| Comments | Other participants - delegate to Provenance resource. |
| Immunization.encounter | |
| Definition | The visit or admission or other contact between patient and health care provider the immunization was performed as part of. |
| Control | 0..1 |
| Type | Reference(Encounter) |
| Immunization.manufacturer | |
| Definition | Name of vaccine manufacturer. |
| Control | 0..1 |
| Type | Reference(Organization) |
| Immunization.location | |
| Definition | The service delivery location where the vaccine administration occurred. |
| Control | 0..1 |
| Type | Reference(Location) |
| Immunization.lotNumber | |
| Definition | Lot number of the vaccine product. |
| Control | 0..1 |
| Type | string |
| Immunization.expirationDate | |
| Definition | Date vaccine batch expires. |
| Control | 0..1 |
| Type | date |
| Immunization.site | |
| Definition | Body site where vaccine was administered. |
| Control | 0..1 |
| Binding | ImmunizationSite: Example: See http://hl7.org/fhir/vs/immunization-site (The site at which the vaccine was administered) |
| Type | CodeableConcept |
| Immunization.route | |
| Definition | The path by which the vaccine product is taken into the body. |
| Control | 0..1 |
| Binding | ImmunizationRoute: Example: See http://hl7.org/fhir/vs/immunization-route (The route by which the vaccine was administered) |
| Type | CodeableConcept |
| Immunization.doseQuantity | |
| Definition | The quantity of vaccine product that was administered. |
| Control | 0..1 |
| Type | Quantity |
| Immunization.explanation | |
| Definition | Reasons why a vaccine was or was not administered. |
| Control | 0..1 |
| Immunization.explanation.reason | |
| Definition | Reasons why a vaccine was administered. |
| Control | 0..* |
| Binding | ImmunizationReason: Example: See http://hl7.org/fhir/vs/immunization-reason (The reason why a vaccine was administered) |
| Type | CodeableConcept |
| Immunization.explanation.reasonNotGiven | |
| Definition | Reason why a vaccine was not administered. |
| Control | 0..* |
| Binding | NoImmunizationReason: Example: See http://hl7.org/fhir/vs/no-immunization-reason (The reason why a vaccine was not administered) |
| Type | CodeableConcept |
| Immunization.reaction | |
| Definition | Categorical data indicating that an adverse event is associated in time to an immunization. |
| Control | 0..* |
| Immunization.reaction.date | |
| Definition | Date of reaction to the immunization. |
| Control | 0..1 |
| Type | dateTime |
| Immunization.reaction.detail | |
| Definition | Details of the reaction. |
| Control | 0..1 |
| Type | Reference(Observation) |
| Immunization.reaction.reported | |
| Definition | Self-reported indicator. |
| Control | 0..1 |
| Type | boolean |
| Immunization.vaccinationProtocol | |
| Definition | Contains information about the protocol(s) under which the vaccine was administered. |
| Control | 0..* |
| Immunization.vaccinationProtocol.doseSequence | |
| Definition | Nominal position in a series. |
| Control | 1..1 |
| Type | integer |
| Immunization.vaccinationProtocol.description | |
| Definition | Contains the description about the protocol under which the vaccine was administered. |
| Control | 0..1 |
| Type | string |
| Immunization.vaccinationProtocol.authority | |
| Definition | Indicates the authority who published the protocol? E.g. ACIP. |
| Control | 0..1 |
| Type | Reference(Organization) |
| Immunization.vaccinationProtocol.series | |
| Definition | One possible path to achieve presumed immunity against a disease - within the context of an authority. |
| Control | 0..1 |
| Type | string |
| Immunization.vaccinationProtocol.seriesDoses | |
| Definition | The recommended number of doses to achieve immunity. |
| Control | 0..1 |
| Type | integer |
| Immunization.vaccinationProtocol.doseTarget | |
| Definition | The targeted disease. |
| Control | 1..1 |
| Binding | VaccinationProtocolDoseTarget: Example: See http://hl7.org/fhir/vs/vaccination-protocol-dose-target (The disease target of the vaccination protocol) |
| Type | CodeableConcept |
| Immunization.vaccinationProtocol.doseStatus | |
| Definition | Indicates if the immunization event should "count" against the protocol. |
| Control | 1..1 |
| Binding | VaccinationProtocolDoseStatus: Example: See http://hl7.org/fhir/vs/vaccination-protocol-dose-status (The status of the vaccination protocol (i.e. should this count)) |
| Type | CodeableConcept |
| Comments | May need to differentiate between status declarations by a provider vs. a CDS engine. |
| Immunization.vaccinationProtocol.doseStatusReason | |
| Definition | Provides an explanation as to why a immunization event should or should not count against the protocol. |
| Control | 0..1 |
| Binding | VaccinationProtocolDoseStatusReason: Example: See http://hl7.org/fhir/vs/vaccination-protocol-dose-status-reason (The reason for the determining if a vaccination should count or why vaccination should not count.) |
| Type | CodeableConcept |
© HL7.org 2011+. FHIR DSTU (v0.4.0-4167) generated on Mon, Feb 23, 2015 09:20+1100.
Links: What's a DSTU? |
Version History |
Compare to DSTU1 |
|
Propose a change