This page is part of the Data Access Framework (v1.6.0: STU 2 Ballot 1) based on FHIR v1.6.0. . For a full list of available versions, see the Directory of published versions
Definitions for the daf-core-immunization Profile.
Immunization(DAFCoreImmunization) | |
Definition | Describes the event of a patient being administered a vaccination or a record of a vaccination as reported by a patient, a clinician or another party and may include vaccine reaction information and what vaccination protocol was followed. |
Control | 0..* |
Invariants | Defined on this element dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (xpath: not(parent::f:contained and f:text)) dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (xpath: not(parent::f:contained and f:contained)) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (xpath: not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (xpath: not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))) imm-1: If immunization was not administered (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/f: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.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Control | 0..1 |
Type | id |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
Immunization.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. |
Control | 0..1 |
Type | Meta |
Immunization.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. |
Control | 0..1 |
Type | uri |
Is Modifier | true |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible. |
Immunization.language | |
Definition | The base language in which the resource is written. |
Control | 0..1 |
Binding | A human language. The codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable |
Type | code |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Immunization.text | |
Definition | A human-readable narrative that contains a summary of the resource, and may 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. |
Control | 0..1 This element is affected by the following invariants: dom-1 |
Type | Narrative |
Alternate Names | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later. |
Immunization.contained | |
Definition | 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. |
Control | 0..* |
Type | Resource |
Alternate Names | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. |
Immunization.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. In order 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Immunization.modifierExtension | |
Definition | 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. Usually modifier elements provide negation or qualification. In order 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Immunization.identifier | |
Definition | A unique identifier assigned to this immunization record. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
Immunization.status | |
Definition | Indicates the current status of the vaccination event. |
Control | 1..1 |
Binding | Constrained list of immunizaiotn status The codes SHALL be taken from Immunization Status |
Type | code |
Is Modifier | true |
Must Support | true |
Comments | Will generally be set to show that the immunization has been completed. |
Immunization.date | |
Definition | Date vaccine administered or was to be administered. |
Control | 1..1 |
Type | dateTime |
Must Support | true |
Comments | When immunizations are given a specific date and time should always be known. When immunizations are patient reported, a specific date might not be known. Although partial dates are allowed, an adult patient might not be able to recall the year a childhood immunization was given. |
Immunization.vaccineCode | |
Definition | Vaccine that was administered or was to be administered. |
Control | 1..1 |
Binding | The code for vaccine product administered For example codes, see Vaccine Administered Value Set |
Type | CodeableConcept |
Must Support | true |
Immunization.vaccineCode.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Immunization.vaccineCode.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Immunization.vaccineCode.coding | |
Definition | A reference to a code defined by a terminology system. |
Control | 0..* |
Type | Coding |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true. |
Immunization.vaccineCode.coding(DAFVaccineCodes) | |
Definition | A reference to a code defined by a terminology system. |
Control | 0..* |
Type | Coding |
Must Support | true |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true. |
Immunization.vaccineCode.coding | |
Definition | A reference to a code defined by a terminology system. |
Control | 1..1 |
Binding | The CVX (vaccine administered) code system The codes SHALL be taken from Vaccine Administered Value Set (CVX) |
Type | Coding |
Must Support | true |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true. |
Immunization.vaccineCode.coding | |
Definition | A reference to a code defined by a terminology system. |
Control | 0..1 |
Binding | NDC codes to identify vaccines The codes SHALL be taken from Vaccine National Drug Code (NDC) |
Type | Coding |
Must Support | true |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true. |
Immunization.vaccineCode.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Control | 0..1 |
Type | string |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Immunization.patient | |
Definition | The patient who either received or did not receive the immunization. |
Control | 1..1 |
Type | Reference(Profile daf-core-patient) |
Must Support | true |
Alternate Names | Patient |
Immunization.wasNotGiven | |
Definition | Indicates if the vaccination was or was not given. |
Control | 1..1 |
Type | boolean |
Is Modifier | true |
Must Support | true |
Immunization.reported | |
Definition | True if this administration was reported rather than directly administered. |
Control | 1..1 |
Type | boolean |
Must Support | true |
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 | The site at which the vaccine was administered For example codes, see Codes for Immunization Site of Administration |
Type | CodeableConcept |
Immunization.route | |
Definition | The path by which the vaccine product is taken into the body. |
Control | 0..1 |
Binding | The route by which the vaccine was administered For example codes, see Immunization Route Codes |
Type | CodeableConcept |
Immunization.doseQuantity | |
Definition | The quantity of vaccine product that was administered. |
Control | 0..1 |
Type | Quantity(SimpleQuantity) |
Immunization.note | |
Definition | Extra information about the immunization that is not conveyed by the other attributes. |
Control | 0..* |
Type | Annotation |
Immunization.explanation | |
Definition | Reasons why a vaccine was or was not administered. |
Control | 0..1 |
Type | BackboneElement |
Immunization.explanation.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Immunization.explanation.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Immunization.explanation.modifierExtension | |
Definition | 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 that contains it. Usually modifier elements provide negation or qualification. In order 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Immunization.explanation.reason | |
Definition | Reasons why a vaccine was administered. |
Control | 0..* |
Binding | The reason why a vaccine was administered For example codes, see Immunization Reason Codes |
Type | CodeableConcept |
Immunization.explanation.reasonNotGiven | |
Definition | Reason why a vaccine was not administered. |
Control | 0..* |
Binding | The reason why a vaccine was not administered For example codes, see Immunization Reasons for Not Immunizing Codes |
Type | CodeableConcept |
Immunization.reaction | |
Definition | Categorical data indicating that an adverse event is associated in time to an immunization. |
Control | 0..* |
Type | BackboneElement |
Comments | A reaction may be an indication of an allergy or intolerance and, if this is determined to be the case, it should be recorded as a new AllergyIntolerance resource instance as most systems will not query against past Immunization.reaction elements. |
Immunization.reaction.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Immunization.reaction.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Immunization.reaction.modifierExtension | |
Definition | 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 that contains it. Usually modifier elements provide negation or qualification. In order 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
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..* |
Type | BackboneElement |
Immunization.vaccinationProtocol.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Immunization.vaccinationProtocol.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Immunization.vaccinationProtocol.modifierExtension | |
Definition | 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 that contains it. Usually modifier elements provide negation or qualification. In order 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Immunization.vaccinationProtocol.doseSequence | |
Definition | Nominal position in a series. |
Control | 0..1 |
Type | positiveInt |
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 | positiveInt |
Immunization.vaccinationProtocol.targetDisease | |
Definition | The targeted disease. |
Control | 1..* |
Binding | The disease target of the vaccination protocol For example codes, see Vaccination Protocol Dose Target Codes |
Type | CodeableConcept |
Immunization.vaccinationProtocol.doseStatus | |
Definition | Indicates if the immunization event should "count" against the protocol. |
Control | 1..1 |
Binding | The status of the vaccination protocol (i.e. should this count) For example codes, see Vaccination Protocol Dose Status codes |
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 an immunization event should or should not count against the protocol. |
Control | 0..1 |
Binding | The reason for the determining if a vaccination should count or why vaccination should not count. For example codes, see Vaccination Protocol Dose Status Reason codes |
Type | CodeableConcept |