| resourceType | Immunization | This is a Immunization resource |
| id | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
| meta | Meta | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
| implicitRules | uri | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
| language | code | The base language in which the resource is written. |
| text | Narrative | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
| contained | BackboneElement | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
| extension | Extension | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| modifierExtension | Extension | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| identifier | Identifier | A unique identifier assigned to this immunization record. |
| status | code | Indicates the current status of the immunization event. |
| statusReason | CodeableConcept | Indicates the reason the immunization event was not performed. |
| vaccineCode | CodeableConcept | Vaccine that was administered or was to be administered. |
| patient | Reference | The patient who either received or did not receive the immunization. |
| encounter | Reference | The visit or admission or other contact between patient and health care provider the immunization was performed as part of. |
| occurrenceDateTime | string | Date vaccine administered or was to be administered. |
| occurrenceString | string | Date vaccine administered or was to be administered. |
| recorded | dateTime | The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event. |
| primarySource | boolean | 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 recorded. |
| reportOrigin | CodeableConcept | The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine. |
| location | Reference | The service delivery location where the vaccine administration occurred. |
| manufacturer | Reference | Name of vaccine manufacturer. |
| lotNumber | string | Lot number of the vaccine product. |
| expirationDate | date | Date vaccine batch expires. |
| site | CodeableConcept | Body site where vaccine was administered. |
| route | CodeableConcept | The path by which the vaccine product is taken into the body. |
| doseQuantity | Quantity | The quantity of vaccine product that was administered. |
| performer | BackboneElement | Indicates who performed the immunization event. |
| performer.id | string | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| performer.extension | Extension | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| performer.modifierExtension | Extension | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| performer.function | CodeableConcept | Describes the type of performance (e.g. ordering provider, administering provider, etc.). |
| performer.actor | Reference | The practitioner or organization who performed the action. |
| note | Annotation | Extra information about the immunization that is not conveyed by the other attributes. |
| reasonCode | CodeableConcept | Reasons why the vaccine was administered. |
| reasonReference | Reference | Condition, Observation or DiagnosticReport that supports why the immunization was administered. |
| isSubpotent | boolean | Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent. |
| subpotentReason | CodeableConcept | Reason why a dose is considered to be subpotent. |
| education | BackboneElement | Educational material presented to the patient (or guardian) at the time of vaccine administration. |
| education.id | string | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| education.extension | Extension | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| education.modifierExtension | Extension | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| education.documentType | string | Identifier of the material presented to the patient. |
| education.reference | uri | Reference pointer to the educational material given to the patient if the information was on line. |
| education.publicationDate | dateTime | Date the educational material was published. |
| education.presentationDate | dateTime | Date the educational material was given to the patient. |
| programEligibility | CodeableConcept | Indicates a patient's eligibility for a funding program. |
| fundingSource | CodeableConcept | Indicates the source of the vaccine actually administered. This may be different than the patient eligibility (e.g. the patient may be eligible for a publically purchased vaccine but due to inventory issues, vaccine purchased with private funds was actually administered). |
| reaction | BackboneElement | Categorical data indicating that an adverse event is associated in time to an immunization. |
| reaction.id | string | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| reaction.extension | Extension | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| reaction.modifierExtension | Extension | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| reaction.date | dateTime | Date of reaction to the immunization. |
| reaction.detail | Reference | Details of the reaction. |
| reaction.reported | boolean | Self-reported indicator. |
| protocolApplied | BackboneElement | The protocol (set of recommendations) being followed by the provider who administered the dose. |
| protocolApplied.id | string | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| protocolApplied.extension | Extension | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| protocolApplied.modifierExtension | Extension | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| protocolApplied.series | string | One possible path to achieve presumed immunity against a disease - within the context of an authority. |
| protocolApplied.authority | Reference | Indicates the authority who published the protocol (e.g. ACIP) that is being followed. |
| protocolApplied.targetDisease | CodeableConcept | The vaccine preventable disease the dose is being administered against. |
| protocolApplied.doseNumberPositiveInt | number | Nominal position in a series. |
| protocolApplied.doseNumberString | string | Nominal position in a series. |
| protocolApplied.seriesDosesPositiveInt | number | The recommended number of doses to achieve immunity. |
| protocolApplied.seriesDosesString | string | The recommended number of doses to achieve immunity. |