| UKCoreImmunization (Immunization) | C | | Immunization | Element idImmunization Short descriptionImmunization event information DefinitionDescribes 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.
Immunization Constraints- dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty() - dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() - dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() - dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty() - dom-6: A resource should have narrative for robust management
text.`div`.exists() - ukcore-imm-001: If the immunization was not given then Immunization.status value SHALL = 'not-done', and the Immunization.statusReason SHALL be populated
(status != 'not-done') or (status = 'not-done' and statusReason.exists())
Mappings- rim: Entity. Role, or Act
- workflow: Event
- v2: VXU_V04
- rim: SubstanceAdministration
|
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idImmunization.id Short descriptionLogical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
string |
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idImmunization.meta Short descriptionMetadata about the resource DefinitionThe 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.
Meta Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idImmunization.implicitRules Short descriptionA set of rules under which this content was created DefinitionA 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.
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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
uri Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| language | | 0..1 | codeBinding | There are no (further) constraints on this element Element idImmunization.language Short descriptionLanguage of the resource content DefinitionThe base language in which the resource is written.
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).
code BindingCommonLanguages (preferred) Binding extensionsConstraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
| text | | 0..1 | Narrative | There are no (further) constraints on this element Element idImmunization.text Short descriptionText summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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 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 information is added later.
Narrative Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
| contained | | 0..* | Resource | There are no (further) constraints on this element Element idImmunization.contained Short descriptionContained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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.
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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
Resource Mappings |
| extension | C | 0..* | Extension | Element idImmunization.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay 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.
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.
Extension SlicingUnordered, Open, by url(Value) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| parentPresent | C | 0..1 | Extension(boolean) | Element idImmunization.extension:parentPresent Short descriptionWas a parent of the patient present at an immunisation? Alternate namesextensions, user content DefinitionWas a parent of the patient present at an immunisation?
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.
Extension(boolean) Extension URLhttps://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ParentPresent ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| vaccinationProcedure | C | 0..1 | Extension(CodeableConcept) | Element idImmunization.extension:vaccinationProcedure Short descriptionAn extension to hold an immunization procedure code Alternate namesextensions, user content DefinitionAn extension to hold an immunization procedure code.
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.
Extension(CodeableConcept) Extension URLhttps://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-VaccinationProcedure ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idImmunization.modifierExtension Short descriptionExtensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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).
Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
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.
Extension Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| identifier | | 0..* | Identifier | There are no (further) constraints on this element Element idImmunization.identifier Short descriptionBusiness identifier DefinitionA unique identifier assigned to this immunization record.
Identifier Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- workflow: Event.identifier
- w5: FiveWs.identifier
- rim: .id
- cda: ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/id
|
| status | S Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idImmunization.status Short descriptioncompleted | entered-in-error | not-done DefinitionIndicates the current status of the immunization event.
Will generally be set to show that the immunization has been completed or not done. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.
code BindingA set of codes indicating the current status of an Immunization.
ImmunizationStatusCodes (required) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- workflow: Event.status
- w5: FiveWs.status
- rim: statusCode
|
| statusReason | | 0..1 | CodeableConceptBinding | Element idImmunization.statusReason Short descriptionReason not done DefinitionIndicates the reason the immunization event was not performed.
This is generally only used for the status of "not-done". The reason for performing the immunization event is captured in reasonCode, not here.
CodeableConcept BindingThe reason why a vaccine was not administered.
UKCoreReasonImmunizationNotAdministered (preferred) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- workflow: Event.statusReason
- rim: .inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN].reasonCOde
|
| vaccineCode | S Σ | 1..1 | CodeableConceptBinding | Element idImmunization.vaccineCode Short descriptionVaccine product administered DefinitionVaccine that was administered or was to be administered.
CodeableConcept BindingThe code for vaccine product administered.
UKCoreVaccineCode (preferred) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- workflow: Event.code
- w5: FiveWs.what[x]
- v2: RXA-5
- rim: .code
- cda: ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code
|
| patient | S Σ | 1..1 | Reference(Patient) | There are no (further) constraints on this element Element idImmunization.patient Short descriptionWho was immunized DefinitionThe patient who either received or did not receive the immunization.
Reference(Patient) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- workflow: Event.subject
- w5: FiveWs.subject[x]
- v2: PID-3
- rim: .partipication[ttypeCode=].role
- w5: FiveWs.subject
|
| encounter | | 0..1 | Reference(Encounter) | There are no (further) constraints on this element Element idImmunization.encounter Short descriptionEncounter immunization was part of DefinitionThe visit or admission or other contact between patient and health care provider the immunization was performed as part of.
Reference(Encounter) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- workflow: Event.context
- w5: FiveWs.context
- v2: PV1-19
- rim: component->EncounterEvent
|
| occurrence[x] | S Σ | 1..1 | | There are no (further) constraints on this element Element idImmunization.occurrence[x] Short descriptionVaccine administration date DefinitionDate vaccine administered or was to be administered.
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. An exact date is always preferable, but the use of the String data type is acceptable when an exact date is not known. A small number of vaccines (e.g. live oral typhoid vaccine) are given as a series of patient self-administered dose over a span of time. In cases like this, often, only the first dose (typically a provider supervised dose) is recorded with the occurrence indicating the date/time of the first dose.
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- workflow: Event.occurrence[x]
- w5: FiveWs.done[x]
- v2: RXA-3
- rim: .effectiveTime
- cda: ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveTime/value
|
| occurrenceDateTime | | | dateTime | There are no (further) constraints on this element Data typedateTime |
| occurrenceString | | | string | There are no (further) constraints on this element Data typestring |
| recorded | | 0..1 | dateTime | There are no (further) constraints on this element Element idImmunization.recorded Short descriptionWhen the immunization was first captured in the subject's record DefinitionThe date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.
dateTime Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- w5: FiveWs.recorded
- rim: .participation[typeCode=AUT].time
|
| primarySource | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idImmunization.primarySource Short descriptionIndicates context the data was recorded in DefinitionAn 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.
Reflects the “reliability” of the content.
boolean Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- w5: FiveWs.source
- v2: RXA-9
- rim: immunization.uncertaintycode (if primary source=false, uncertainty=U)
|
| reportOrigin | | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idImmunization.reportOrigin Short descriptionIndicates the source of a secondarily reported record DefinitionThe source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.
Should not be populated if primarySource = True, not required even if primarySource = False.
CodeableConcept BindingThe source of the data for a record which is not from a primary source.
ImmunizationOriginCodes (example) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- w5: FiveWs.source
- v2: RXA-9
- rim: .participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported) .participation[typeCode=INF].role[classCode=LIC] (this syntax for health care professional) .participation[typeCode=INF].role[classCode=PRS] (this syntax for family member)
|
| location | | 0..1 | Reference(Location) | There are no (further) constraints on this element Element idImmunization.location Short descriptionWhere immunization occurred DefinitionThe service delivery location where the vaccine administration occurred.
Reference(Location) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- workflow: Event.location
- w5: FiveWs.where[x]
- v2: RXA-27 (or RXA-11, deprecated as of v2.7)
- rim: .participation[typeCode=LOC].COCT_MT240000UV
|
| manufacturer | S | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idImmunization.manufacturer Short descriptionVaccine manufacturer DefinitionName of vaccine manufacturer.
Reference(Organization) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- v2: RXA-17
- rim: .participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=ORG]
- cda: ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacuturerOrganization/name
|
| lotNumber | S | 0..1 | string | There are no (further) constraints on this element Element idImmunization.lotNumber Short descriptionVaccine lot number DefinitionLot number of the vaccine product.
string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- v2: RXA-15
- rim: .participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].id
- cda: ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/lotNumberText
|
| expirationDate | | 0..1 | date | There are no (further) constraints on this element Element idImmunization.expirationDate Short descriptionVaccine expiration date DefinitionDate vaccine batch expires.
date Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- v2: RXA-16
- rim: .participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].expirationTime
|
| site | | 0..1 | CodeableConceptBinding | Element idImmunization.site Short descriptionBody site vaccine was administered DefinitionBody site where vaccine was administered.
CodeableConcept BindingThe site at which the vaccine was administered.
UKCoreImmunizationAdministrationBodySite (preferred) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- v2: RXR-2
- rim: observation.targetSiteCode
- cda: ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/approachSiteCode/code
|
| route | | 0..1 | CodeableConceptBinding | Element idImmunization.route Short descriptionHow vaccine entered body DefinitionThe path by which the vaccine product is taken into the body.
CodeableConcept BindingThe route by which the vaccine was administered.
UKCoreSubstanceOrProductAdministrationRoute (preferred) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- v2: RXR-1
- rim: .routeCode
- cda: ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/routeCode/code
|
| doseQuantity | S | 0..1 | SimpleQuantity | There are no (further) constraints on this element Element idImmunization.doseQuantity Short descriptionAmount of vaccine administered DefinitionThe quantity of vaccine product that was administered.
SimpleQuantity Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- v2: RXA-6 / RXA-7
- rim: .doseQuantity
|
| performer | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element idImmunization.performer Short descriptionWho performed event DefinitionIndicates who performed the immunization event.
BackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- workflow: Event.performer
- v2: ORC-12 / RXA-10
- rim: .participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idImmunization.performer.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
string Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idImmunization.performer.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay 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.
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.
Extension Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idImmunization.performer.modifierExtension Short descriptionExtensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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).
Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
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.
Extension Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| function | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idImmunization.performer.function Short descriptionWhat type of performance was done DefinitionDescribes the type of performance (e.g. ordering provider, administering provider, etc.).
CodeableConcept BindingThe role a practitioner or organization plays in the immunization event.
ImmunizationFunctionCodes (extensible) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- workflow: Event.performer.function
- rim: .participation.functionCode
|
| actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | There are no (further) constraints on this element Element idImmunization.performer.actor Short descriptionIndividual or organization who was performing DefinitionThe practitioner or organization who performed the action.
When the individual practitioner who performed the action is known, it is best to send.
Reference(Practitioner | PractitionerRole | Organization) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- workflow: Event.performer.actor
- w5: FiveWs.actor
- rim: .player
|
| note | Σ | 0..* | Annotation | There are no (further) constraints on this element Element idImmunization.note Short descriptionAdditional immunization notes DefinitionExtra information about the immunization that is not conveyed by the other attributes.
Annotation Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- workflow: Event.note
- v2: OBX-5 : OBX-3 = 48767-8
- rim: note
|
| reasonCode | | 0..* | CodeableConceptBinding | Element idImmunization.reasonCode Short descriptionWhy immunization occurred DefinitionReasons why the vaccine was administered.
CodeableConcept BindingThe reason why a vaccine was administered.
UKCoreImmunizationExplanationReason (preferred) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- workflow: Event.reasonCode
- rim: [actionNegationInd=false].reasonCode
|
| reasonReference | | 0..* | Reference(Condition | Observation | DiagnosticReport) | There are no (further) constraints on this element Element idImmunization.reasonReference Short descriptionWhy immunization occurred DefinitionCondition, Observation or DiagnosticReport that supports why the immunization was administered.
Reference(Condition | Observation | DiagnosticReport) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- workflow: Event.reasonReference
- rim: N/A
|
| isSubpotent | Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element idImmunization.isSubpotent Short descriptionDose potency DefinitionIndication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.
Typically, the recognition of the dose being sub-potent is retrospective, after the administration (ex. notification of a manufacturer recall after administration). However, in the case of a partial administration (the patient moves unexpectedly and only some of the dose is actually administered), subpotency may be recognized immediately, but it is still important to record the event.
By default, a dose should be considered to be potent.
boolean Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- v2: RXA-20 = PA (partial administration)
- rim: N/A
|
| subpotentReason | | 0..* | CodeableConcept | There are no (further) constraints on this element Element idImmunization.subpotentReason Short descriptionReason for being subpotent DefinitionReason why a dose is considered to be subpotent.
CodeableConcept BindingThe reason why a dose is considered to be subpotent.
ImmunizationSubpotentReason (example) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
| education | C | 0..* | BackboneElement | There are no (further) constraints on this element Element idImmunization.education Short descriptionEducational material presented to patient DefinitionEducational material presented to the patient (or guardian) at the time of vaccine administration.
BackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - imm-1: One of documentType or reference SHALL be present
documentType.exists() or reference.exists()
Mappings |
| id | | 0..1 | string | There are no (further) constraints on this element Element idImmunization.education.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
string Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idImmunization.education.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay 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.
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.
Extension Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idImmunization.education.modifierExtension Short descriptionExtensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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).
Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
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.
Extension Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| documentType | | 0..1 | string | There are no (further) constraints on this element Element idImmunization.education.documentType Short descriptionEducational material document identifier DefinitionIdentifier of the material presented to the patient.
string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- v2: OBX-5 : OBX-3 = 69764-9
- rim: N/A
|
| reference | | 0..1 | uri | There are no (further) constraints on this element Element idImmunization.education.reference Short descriptionEducational material reference pointer DefinitionReference pointer to the educational material given to the patient if the information was on line.
uri Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
| publicationDate | | 0..1 | dateTime | There are no (further) constraints on this element Element idImmunization.education.publicationDate Short descriptionEducational material publication date DefinitionDate the educational material was published.
dateTime Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- v2: OBX-5 : OBX-3 = 29768-9
- rim: N/A
|
| presentationDate | | 0..1 | dateTime | There are no (further) constraints on this element Element idImmunization.education.presentationDate Short descriptionEducational material presentation date DefinitionDate the educational material was given to the patient.
dateTime Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- v2: OBX-5 : OBX-3 = 29769-7
- rim: N/A
|
| programEligibility | | 0..* | CodeableConcept | There are no (further) constraints on this element Element idImmunization.programEligibility Short descriptionPatient eligibility for a vaccination program DefinitionIndicates a patient's eligibility for a funding program.
CodeableConcept BindingThe patient's eligibility for a vaccation program.
ImmunizationProgramEligibility (example) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- v2: OBX-5 : OBX-3 = 64994-7
- rim: N/A
|
| fundingSource | | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idImmunization.fundingSource Short descriptionFunding source for the vaccine DefinitionIndicates 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).
CodeableConcept BindingThe source of funding used to purchase the vaccine administered.
ImmunizationFundingSource (example) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
| reaction | | 0..* | BackboneElement | There are no (further) constraints on this element Element idImmunization.reaction Short descriptionDetails of a reaction that follows immunization DefinitionCategorical data indicating that an adverse event is associated in time to an immunization.
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.
BackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- v2: OBX-3
- rim: Observation[classCode=obs].code
|
| id | | 0..1 | string | There are no (further) constraints on this element Element idImmunization.reaction.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
string Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idImmunization.reaction.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay 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.
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.
Extension Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idImmunization.reaction.modifierExtension Short descriptionExtensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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).
Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
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.
Extension Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| date | | 0..1 | dateTime | There are no (further) constraints on this element Element idImmunization.reaction.date Short descriptionWhen reaction started DefinitionDate of reaction to the immunization.
dateTime Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- v2: OBX-14 (ideally this would be reported in an IAM segment, but IAM is not part of the HL7 v2 VXU message - most likely would appear in OBX segments if at all)
- rim: .effectiveTime
|
| detail | | 0..1 | Reference(Observation) | There are no (further) constraints on this element Element idImmunization.reaction.detail Short descriptionAdditional information on reaction DefinitionData typeReference(Observation) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
| reported | | 0..1 | boolean | There are no (further) constraints on this element Element idImmunization.reaction.reported Short descriptionIndicates self-reported reaction DefinitionData typeboolean Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- v2: (HL7 v2 doesn't seem to provide for this)
- rim: .participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported=true)
|
| protocolApplied | | 0..* | BackboneElement | There are no (further) constraints on this element Element idImmunization.protocolApplied Short descriptionProtocol followed by the provider DefinitionThe protocol (set of recommendations) being followed by the provider who administered the dose.
BackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
| id | | 0..1 | string | There are no (further) constraints on this element Element idImmunization.protocolApplied.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
string Mappings |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idImmunization.protocolApplied.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay 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.
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.
Extension Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idImmunization.protocolApplied.modifierExtension Short descriptionExtensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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).
Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
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.
Extension Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
| series | | 0..1 | string | There are no (further) constraints on this element Element idImmunization.protocolApplied.series Short descriptionName of vaccine series DefinitionOne possible path to achieve presumed immunity against a disease - within the context of an authority.
string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
| authority | | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idImmunization.protocolApplied.authority Short descriptionWho is responsible for publishing the recommendations DefinitionIndicates the authority who published the protocol (e.g. ACIP) that is being followed.
Reference(Organization) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
| targetDisease | | 0..* | CodeableConcept | There are no (further) constraints on this element Element idImmunization.protocolApplied.targetDisease Short descriptionVaccine preventatable disease being targetted DefinitionThe vaccine preventable disease the dose is being administered against.
CodeableConcept BindingThe vaccine preventable disease the dose is being administered for.
ImmunizationTargetDiseaseCodes (example) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
| doseNumber[x] | | 1..1 | | There are no (further) constraints on this element Element idImmunization.protocolApplied.doseNumber[x] Short descriptionDose number within series DefinitionNominal position in a series.
The use of an integer is preferred if known. A string should only be used in cases where an integer is not available (such as when documenting a recurring booster dose).
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
| doseNumberPositiveInt | | | positiveInt | There are no (further) constraints on this element Data typepositiveInt |
| doseNumberString | | | string | There are no (further) constraints on this element Data typestring |
| seriesDoses[x] | | 0..1 | | There are no (further) constraints on this element Element idImmunization.protocolApplied.seriesDoses[x] Short descriptionRecommended number of doses for immunity DefinitionThe recommended number of doses to achieve immunity.
The use of an integer is preferred if known. A string should only be used in cases where an integer is not available (such as when documenting a recurring booster dose).
- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
| seriesDosesPositiveInt | | | positiveInt | There are no (further) constraints on this element Data typepositiveInt |
| seriesDosesString | | | string | There are no (further) constraints on this element Data typestring |
