CA Core+ v1.1.0 DFT-preBallot
1.1.0-DFT-preBallot 
DFT-preBallot - The specification is a DFT-preBallot version of CA Core+ for collecting community feedback. For a full list of available versions, see the Directory of published versions
Immunization (CA-Core)
Links
Profile
Derived from
http://hl7.org/fhir/StructureDefinition/Immunization
Examples
Description
This profile applies constraints to the Immunization resource for CA Core+ to support documentation of administered vaccines in the pan-Canadian context.
References to this resource
CFMM: 2
Resource Content
| ImmunizationCACore (Immunization) | C | Immunization | |
| id | Σ | 0..1 | string |
| meta | Σ | 0..1 | Meta |
| implicitRules | Σ ?! | 0..1 | uri |
| language | 0..1 | codeBinding | |
| text | 0..1 | Narrative | |
| contained | 0..* | Resource | |
| extension | C | 0..* | Extension |
| modifierExtension | ?! C | 0..* | Extension |
| identifier | 0..* | Identifier | |
| status | Σ ?! | 1..1 | codeBinding |
| statusReason | 0..1 | CodeableConcept | |
| vaccineCode | O Σ | 1..1 | CodeableConceptCACoreBinding |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| coding | Σ | 0..* | CodingCACore |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| system | Σ | 0..1 | uri |
| version | Σ | 0..1 | string |
| code | Σ | 0..1 | code |
| display | Σ | 0..1 | string |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| translation | C | 0..* | Extension(Complex) |
| value | 0..1 | System.String | |
| userSelected | Σ | 0..1 | boolean |
| text | Σ | 0..1 | string |
| patient | Σ | 1..1 | Reference(PatientCACore) |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| reference | Σ C | 1..1 | string |
| type | Σ | 0..1 | uriBinding |
| identifier | Σ | 0..1 | Identifier |
| display | Σ | 0..1 | string |
| encounter | 0..1 | Reference(Encounter) | |
| occurrence[x] | Σ | 1..1 | |
| occurrenceDateTime | dateTime | ||
| occurrenceString | string | ||
| recorded | 0..1 | dateTime | |
| primarySource | Σ | 0..1 | boolean |
| reportOrigin | 0..1 | CodeableConcept | |
| location | 0..1 | Reference(LocationCACore) | |
| manufacturer | 0..1 | Reference(Organization) | |
| lotNumber | O | 0..1 | string |
| expirationDate | 0..1 | date | |
| site | 0..1 | CodeableConcept | |
| route | 0..1 | CodeableConcept | |
| doseQuantity | 0..1 | SimpleQuantity | |
| performer | Σ | 0..* | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| function | Σ | 0..1 | CodeableConceptBinding |
| actor | Σ | 1..1 | Reference(PractitionerCACore | PractitionerRoleCACore | OrganizationCACore) |
| note | Σ | 0..* | Annotation |
| reasonCode | 0..* | CodeableConcept | |
| reasonReference | 0..* | Reference(ConditionCACore | Observation | DiagnosticReport) | |
| isSubpotent | Σ ?! | 0..1 | boolean |
| subpotentReason | 0..* | CodeableConcept | |
| education | C | 0..* | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| documentType | 0..1 | string | |
| reference | 0..1 | uri | |
| publicationDate | 0..1 | dateTime | |
| presentationDate | 0..1 | dateTime | |
| programEligibility | 0..* | CodeableConcept | |
| fundingSource | 0..1 | CodeableConcept | |
| reaction | 0..* | BackboneElement | |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| date | 0..1 | dateTime | |
| detail | 0..1 | Reference(Observation) | |
| reported | 0..1 | boolean | |
| protocolApplied | 0..* | BackboneElement | |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| series | 0..1 | string | |
| authority | 0..1 | Reference(Organization) | |
| targetDisease | 0..* | CodeableConcept | |
| doseNumber[x] | 1..1 | ||
| doseNumberPositiveInt | positiveInt | ||
| doseNumberString | string | ||
| seriesDoses[x] | 0..1 | ||
| seriesDosesPositiveInt | positiveInt | ||
| seriesDosesString | string |
| ImmunizationCACore (Immunization) | C | Immunization | |
| id | Σ | 0..1 | string |
| meta | Σ | 0..1 | Meta |
| implicitRules | Σ ?! | 0..1 | uri |
| language | 0..1 | codeBinding | |
| text | 0..1 | Narrative | |
| contained | 0..* | Resource | |
| extension | C | 0..* | Extension |
| modifierExtension | ?! C | 0..* | Extension |
| identifier | 0..* | Identifier | |
| status | Σ ?! | 1..1 | codeBinding |
| statusReason | 0..1 | CodeableConcept | |
| vaccineCode | O Σ | 1..1 | CodeableConceptCACoreBinding |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| coding | Σ | 0..* | CodingCACore |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| system | Σ | 0..1 | uri |
| version | Σ | 0..1 | string |
| code | Σ | 0..1 | code |
| display | Σ | 0..1 | string |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| translation | C | 0..* | Extension(Complex) |
| value | 0..1 | System.String | |
| userSelected | Σ | 0..1 | boolean |
| text | Σ | 0..1 | string |
| patient | Σ | 1..1 | Reference(PatientCACore) |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| reference | Σ C | 1..1 | string |
| type | Σ | 0..1 | uriBinding |
| identifier | Σ | 0..1 | Identifier |
| display | Σ | 0..1 | string |
| encounter | 0..1 | Reference(Encounter) | |
| occurrence[x] | Σ | 1..1 | |
| occurrenceDateTime | dateTime | ||
| occurrenceString | string | ||
| recorded | 0..1 | dateTime | |
| primarySource | Σ | 0..1 | boolean |
| reportOrigin | 0..1 | CodeableConcept | |
| location | 0..1 | Reference(LocationCACore) | |
| manufacturer | 0..1 | Reference(Organization) | |
| lotNumber | O | 0..1 | string |
| expirationDate | 0..1 | date | |
| site | 0..1 | CodeableConcept | |
| route | 0..1 | CodeableConcept | |
| doseQuantity | 0..1 | SimpleQuantity | |
| performer | Σ | 0..* | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| function | Σ | 0..1 | CodeableConceptBinding |
| actor | Σ | 1..1 | Reference(PractitionerCACore | PractitionerRoleCACore | OrganizationCACore) |
| note | Σ | 0..* | Annotation |
| reasonCode | 0..* | CodeableConcept | |
| reasonReference | 0..* | Reference(ConditionCACore | Observation | DiagnosticReport) | |
| isSubpotent | Σ ?! | 0..1 | boolean |
| subpotentReason | 0..* | CodeableConcept | |
| education | C | 0..* | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| documentType | 0..1 | string | |
| reference | 0..1 | uri | |
| publicationDate | 0..1 | dateTime | |
| presentationDate | 0..1 | dateTime | |
| programEligibility | 0..* | CodeableConcept | |
| fundingSource | 0..1 | CodeableConcept | |
| reaction | 0..* | BackboneElement | |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| date | 0..1 | dateTime | |
| detail | 0..1 | Reference(Observation) | |
| reported | 0..1 | boolean | |
| protocolApplied | 0..* | BackboneElement | |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| series | 0..1 | string | |
| authority | 0..1 | Reference(Organization) | |
| targetDisease | 0..* | CodeableConcept | |
| doseNumber[x] | 1..1 | ||
| doseNumberPositiveInt | positiveInt | ||
| doseNumberString | string | ||
| seriesDoses[x] | 0..1 | ||
| seriesDosesPositiveInt | positiveInt | ||
| seriesDosesString | string |
</extension>
</telecom>
</telecom>
</contact>
<description value="This profile applies constraints to the Immunization resource for CA Core+ to support documentation of administered vaccines in the pan-Canadian context." />
</jurisdiction>
<copyright value="Copyright © 2025+ Canada Health Infoway. All rights reserved. [Terms of Use and License Agreements](https://ic.infoway-inforoute.ca/en/about/tou). [Privacy Policy](https://www.infoway-inforoute.ca/en/legal/privacy-policy)." />
<comment value="Mapping for ImmunizationCACore to Canadian Core Data for Interoperability (CACDI)." />
</mapping>
<definition value="Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party." />
</base>
<human value="If the resource is contained in another resource, it SHALL NOT contain nested Resources" />
</constraint>
<human value="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" />
<expression value="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()" />
<xpath value="not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))" />
</constraint>
<human value="If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated" />
<xpath value="not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))" />
</constraint>
<human value="If a resource is contained in another resource, it SHALL NOT have a security label" />
</constraint>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation">
<valueMarkdown value="When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time." />
</extension>
</constraint>
<human value="Immunization records created during an encounter event are expected to have occurrence populated. Occurrence SHALL be present if the primarySource is 'true'" />
</constraint>
</mapping>
</mapping>
</mapping>
</mapping>
</mapping>
</mapping>
</mapping>
</mapping>
</mapping>
</mapping>
</element>
<definition value="The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes." />
<comment value="The only time that a resource does not have an id is when it is being submitted to the server using a create operation." />
</base>
</extension>
</type>
</element>
<definition value="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." />
</base>
</type>
</constraint>
</element>
<definition value="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." />
<comment value="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." />
</base>
</type>
</constraint>
<isModifierReason value="This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation" />
</element>
<comment value="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)." />
</base>
</type>
</constraint>
</extension>
</extension>
</extension>
</binding>
</element>
<definition value="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." />
<comment value="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." />
</base>
</type>
</constraint>
</mapping>
</element>
<definition value="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." />
<comment value="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." />
</base>
</type>
</mapping>
</element>
<definition value="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." />
<comment value="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." />
</base>
</type>
</constraint>
</constraint>
</mapping>
</element>
<definition value="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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)." />
<comment value="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." />
<requirements value="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](extensibility.html#modifierExtension)." />
</base>
</type>
</constraint>
</constraint>
<isModifierReason value="Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them" />
</mapping>
</element>
</base>
</type>
</constraint>
</mapping>
</mapping>
</mapping>
<map value="ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/id" />
</mapping>
</element>
<comment value="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." />
</base>
</type>
</constraint>
<isModifierReason value="This element is labeled as a modifier because it is a status element that contains statuses entered-in-error and not-done which means that the resource should not be treated as valid" />
</extension>
</binding>
</mapping>
</mapping>
</mapping>
</element>
<comment value="This is generally only used for the status of "not-done". The reason for performing the immunization event is captured in reasonCode, not here." />
</base>
</type>
</constraint>
</extension>
</binding>
</mapping>
</mapping>
</element>
</extension>
</extension>
</extension>
</extension>
</extension>
</extension>
</extension>
</extension>
<definition value="A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text." />
<comment value="The additionalBinding extension will be used to express the valueSet for additional negation/exclusion codes for reporting the known absence of immunizations. At the time of this release, the publisher of the current ValueSet for absence codes (IPS) is developing a SNOMED ValueSet that will replace the current http://hl7.org/fhir/uv/ips/ValueSet/absent-or-unknown-immunizations-uv-ips" />
</base>
<profile value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/codeableconcept-ca-core" />
</type>
</constraint>
</extension>
</extension>
</extension>
<valueMarkdown value="Recommended for use when conveying vaccine generic names for scenarios when brand name is not known or does not exist (e.g., immunization history where provider does not have detail of the trade name, the product has been discontinued and/or never licensed in Canada)." />
</extension>
</extension>
</extension>
<valueCanonical value="https://fhir.infoway-inforoute.ca/ValueSet/passiveadministeredimmunizingagentcode" />
</extension>
<valueMarkdown value="per pCHDCF: Alternate value sets can be used when passive immunization products are used" />
</extension>
</extension>
</extension>
<valueCanonical value="https://fhir.infoway-inforoute.ca/ValueSet/passivehistoricalimmunizingagentcode" />
</extension>
<valueMarkdown value="per pCHDCF: Alternate value sets can be used when passive immunization products are used" />
</extension>
</extension>
</extension>
<valueCanonical value="http://hl7.org/fhir/uv/ips/ValueSet/absent-or-unknown-immunizations-uv-ips" />
</extension>
</extension>
</extension>
</binding>
</mapping>
</mapping>
</mapping>
</mapping>
<map value="ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code" />
</mapping>
</mapping>
</mapping>
</mapping>
</mapping>
</mapping>
</mapping>
</element>
<definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." />
</base>
</extension>
</type>
</mapping>
</element>
</discriminator>
</slicing>
<definition value="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." />
<comment value="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." />
</base>
</type>
</constraint>
</constraint>
</mapping>
</element>
</extension>
</extension>
<comment value="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." />
<requirements value="Allows for alternative encodings within a code system, and translations to other code systems." />
</base>
</type>
</constraint>
</mapping>
</mapping>
</mapping>
</mapping>
</mapping>
</mapping>
</mapping>
</element>
<definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." />
</base>
</extension>
</type>
</mapping>
</element>
</discriminator>
</slicing>
<definition value="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." />
<comment value="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." />
</base>
</type>
</constraint>
</constraint>
</mapping>
</element>
<definition value="The identification of the code system that defines the meaning of the symbol in the code." />
<comment value="The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously." />
</base>
</type>
</constraint>
</mapping>
</mapping>
</mapping>
</mapping>
</element>
<definition value="The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged." />
<comment value="Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date." />
</base>
</type>
</constraint>
</mapping>
</mapping>
</mapping>
</element>
<definition value="A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination)." />
</base>
</type>
</constraint>
</mapping>
</mapping>
</mapping>
</element>
</extension>
<definition value="A representation of the meaning of the code in the system, following the rules of the system." />
<requirements value="Need to be able to carry a human-readable meaning of the code for readers that do not know the system." />
</base>
</type>
</constraint>
</mapping>
</mapping>
</mapping>
</element>
</base>
</extension>
</type>
</element>
</slicing>
<definition value="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." />
<comment value="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." />
</base>
</type>
</constraint>
</constraint>
</element>
<definition value="Language translation from base language of resource to another language, used to provide translations for strings, including markdown. Generally, the type of the translation extension SHOULD match that of the element being extended." />
<comment value="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." />
</base>
</type>
</constraint>
</constraint>
</mapping>
</element>
</base>
</extension>
</extension>
</type>
</element>
<definition value="Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays)." />
<comment value="Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely." />
<requirements value="This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing." />
</base>
</type>
</constraint>
</mapping>
</mapping>
<map value="fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]" />
</mapping>
</element>
</extension>
<definition value="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." />
<requirements value="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." />
</base>
</type>
</constraint>
</mapping>
</mapping>
</mapping>
</element>
</base>
<targetProfile value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/patient-ca-core" />
</type>
</constraint>
</mapping>
</mapping>
</mapping>
</mapping>
</mapping>
</mapping>
</element>
<definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." />
</base>
</extension>
</type>
</mapping>
</element>
</discriminator>
</slicing>
<definition value="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." />
<comment value="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." />
</base>
</type>
</constraint>
</constraint>
</mapping>
</element>
<definition value="A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources." />
<comment value="Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server." />
</base>
</type>
</constraint>
</mapping>
</element>
<definition value="The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.\n\nThe type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources)." />
<comment value="This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified." />
</base>
</type>
</constraint>
</extension>
</binding>
</mapping>
</element>
<definition value="An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference." />
<comment value="When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.\n\nReference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any)." />
</base>
</type>
</constraint>
</mapping>
</element>
</extension>
<definition value="Plain text narrative that identifies the resource in addition to the resource reference." />
<comment value="This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it." />
</base>
</type>
</constraint>
</mapping>
</element>
<definition value="The visit or admission or other contact between patient and health care provider the immunization was performed as part of." />
</base>
</type>
</constraint>
</mapping>
</mapping>
</mapping>
</mapping>
</element>
<comment value="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." />
</base>
</type>
</type>
</constraint>
</mapping>
</mapping>
</mapping>
</mapping>
<map value="ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveTime/value" />
</mapping>
</mapping>
</mapping>
</element>
<definition value="The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event." />
</base>
</type>
</constraint>
</mapping>
</mapping>
</mapping>
</element>
<definition value="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." />
</base>
</type>
</constraint>
</mapping>
</mapping>
</mapping>
</mapping>
</element>
<definition value="The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine." />
<comment value="Should not be populated if primarySource = True, not required even if primarySource = False." />
</base>
</type>
</constraint>
</extension>
</binding>
</mapping>
</mapping>
<map value=".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)" />
</mapping>
</mapping>
</element>
</base>
<targetProfile value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/location-ca-core" />
</type>
</constraint>
</mapping>
</mapping>
</mapping>
</mapping>
</element>
</base>
</type>
</constraint>
</mapping>
</mapping>
<map value="ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacuturerOrganization/name" />
</mapping>
</element>
</extension>
</extension>
</extension>
</extension>
</extension>
</extension>
</base>
</type>
</constraint>
</mapping>
<map value=".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].id" />
</mapping>
<map value="ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/lotNumberText" />
</mapping>
</mapping>
</element>
</base>
</type>
</constraint>
</mapping>
<map value=".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].expirationTime" />
</mapping>
</element>
</base>
</type>
</constraint>
</extension>
</binding>
</mapping>
</mapping>
<map value="ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/approachSiteCode/code" />
</mapping>
</element>
</base>
</type>
</constraint>
</extension>
</binding>
</mapping>
</mapping>
<map value="ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/routeCode/code" />
</mapping>
</element>
</base>
</type>
</constraint>
</mapping>
</mapping>
</element>
</base>
</type>
</constraint>
</mapping>
</mapping>
</mapping>
</element>
<definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." />
</base>
</extension>
</type>
</mapping>
</element>
<definition value="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." />
<comment value="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." />
</base>
</type>
</constraint>
</constraint>
</mapping>
</element>
<definition value="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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)." />
<comment value="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." />
<requirements value="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](extensibility.html#modifierExtension)." />
</base>
</type>
</constraint>
</constraint>
<isModifierReason value="Modifier extensions are expected to modify the meaning or interpretation of the element that contains them" />
</mapping>
</element>
<definition value="Describes the type of performance (e.g. ordering provider, administering provider, etc.)." />
</base>
</type>
</constraint>
</extension>
</binding>
</mapping>
</mapping>
</element>
<comment value="When the individual practitioner who performed the action is known, it is best to send." />
</base>
<targetProfile value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/practitioner-ca-core" />
<targetProfile value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/practitionerRole-ca-core" />
<targetProfile value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/organization-ca-core" />
</type>
</constraint>
</mapping>
</mapping>
</mapping>
</element>
<definition value="Extra information about the immunization that is not conveyed by the other attributes." />
</base>
</type>
</constraint>
</mapping>
</mapping>
</mapping>
</element>
</base>
</type>
</constraint>
</extension>
</binding>
</mapping>
</mapping>
</element>
<definition value="Condition, Observation or DiagnosticReport that supports why the immunization was administered." />
</base>
<targetProfile value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/condition-ca-core" />
</type>
</constraint>
</mapping>
</mapping>
</element>
<definition value="Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent." />
<comment value="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." />
</base>
</type>
</constraint>
<isModifierReason value="This element is labeled as a modifier because an immunization event with a subpotent vaccine doesn't protect the patient the same way as a potent dose." />
</mapping>
</mapping>
</element>
</base>
</type>
</constraint>
</extension>
</binding>
</mapping>
</element>
<definition value="Educational material presented to the patient (or guardian) at the time of vaccine administration." />
</base>
</type>
</constraint>
</constraint>
</mapping>
</element>
<definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." />
</base>
</extension>
</type>
</mapping>
</element>
<definition value="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." />
<comment value="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." />
</base>
</type>
</constraint>
</constraint>
</mapping>
</element>
<definition value="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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)." />
<comment value="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." />
<requirements value="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](extensibility.html#modifierExtension)." />
</base>
</type>
</constraint>
</constraint>
<isModifierReason value="Modifier extensions are expected to modify the meaning or interpretation of the element that contains them" />
</mapping>
</element>
</base>
</type>
</constraint>
</mapping>
</mapping>
</element>
<definition value="Reference pointer to the educational material given to the patient if the information was on line." />
</base>
</type>
</constraint>
</mapping>
</element>
</base>
</type>
</constraint>
</mapping>
</mapping>
</element>
</base>
</type>
</constraint>
</mapping>
</mapping>
</element>
</base>
</type>
</constraint>
</extension>
</binding>
</mapping>
</mapping>
</element>
<definition value="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)." />
</base>
</type>
</constraint>
</extension>
</binding>
</mapping>
</element>
<definition value="Categorical data indicating that an adverse event is associated in time to an immunization." />
<comment value="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." />
</base>
</type>
</constraint>
</mapping>
</mapping>
</element>
<definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." />
</base>
</extension>
</type>
</mapping>
</element>
<definition value="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." />
<comment value="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." />
</base>
</type>
</constraint>
</constraint>
</mapping>
</element>
<definition value="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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)." />
<comment value="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." />
<requirements value="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](extensibility.html#modifierExtension)." />
</base>
</type>
</constraint>
</constraint>
<isModifierReason value="Modifier extensions are expected to modify the meaning or interpretation of the element that contains them" />
</mapping>
</element>
</base>
</type>
</constraint>
<map value="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)" />
</mapping>
</mapping>
</element>
</base>
</type>
</constraint>
</mapping>
</mapping>
</element>
</base>
</type>
</constraint>
</mapping>
<map value=".participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported=true)" />
</mapping>
</element>
<definition value="The protocol (set of recommendations) being followed by the provider who administered the dose." />
</base>
</type>
</constraint>
</mapping>
</element>
<definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." />
</base>
</extension>
</type>
</mapping>
</element>
<definition value="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." />
<comment value="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." />
</base>
</type>
</constraint>
</constraint>
</mapping>
</element>
<definition value="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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)." />
<comment value="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." />
<requirements value="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](extensibility.html#modifierExtension)." />
</base>
</type>
</constraint>
</constraint>
<isModifierReason value="Modifier extensions are expected to modify the meaning or interpretation of the element that contains them" />
</mapping>
</element>
<definition value="One possible path to achieve presumed immunity against a disease - within the context of an authority." />
</base>
</type>
</constraint>
</mapping>
</element>
<definition value="Indicates the authority who published the protocol (e.g. ACIP) that is being followed." />
</base>
</type>
</constraint>
</mapping>
</element>
</base>
</type>
</constraint>
</extension>
</binding>
</mapping>
</element>
<comment value="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)." />
</base>
</type>
</type>
</constraint>
</mapping>
</element>
<comment value="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)." />
</base>
</type>
</type>
</constraint>
</mapping>
</element>
</snapshot>
<human value="Immunization records created during an encounter event are expected to have occurrence populated. Occurrence SHALL be present if the primarySource is 'true'" />
</constraint>
</mapping>
</mapping>
</mapping>
</mapping>
</mapping>
</mapping>
</element>
</extension>
</extension>
</extension>
</extension>
</extension>
</extension>
<comment value="The additionalBinding extension will be used to express the valueSet for additional negation/exclusion codes for reporting the known absence of immunizations. At the time of this release, the publisher of the current ValueSet for absence codes (IPS) is developing a SNOMED ValueSet that will replace the current http://hl7.org/fhir/uv/ips/ValueSet/absent-or-unknown-immunizations-uv-ips" />
<profile value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/codeableconcept-ca-core" />
</type>
</extension>
</extension>
<valueMarkdown value="Recommended for use when conveying vaccine generic names for scenarios when brand name is not known or does not exist (e.g., immunization history where provider does not have detail of the trade name, the product has been discontinued and/or never licensed in Canada)." />
</extension>
</extension>
</extension>
<valueCanonical value="https://fhir.infoway-inforoute.ca/ValueSet/passiveadministeredimmunizingagentcode" />
</extension>
<valueMarkdown value="per pCHDCF: Alternate value sets can be used when passive immunization products are used" />
</extension>
</extension>
</extension>
<valueCanonical value="https://fhir.infoway-inforoute.ca/ValueSet/passivehistoricalimmunizingagentcode" />
</extension>
<valueMarkdown value="per pCHDCF: Alternate value sets can be used when passive immunization products are used" />
</extension>
</extension>
</extension>
<valueCanonical value="http://hl7.org/fhir/uv/ips/ValueSet/absent-or-unknown-immunizations-uv-ips" />
</extension>
</extension>
</extension>
</binding>
</mapping>
</mapping>
</element>
</mapping>
</element>
<targetProfile value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/patient-ca-core" />
</type>
</mapping>
</element>
</element>
</mapping>
</mapping>
</element>
</mapping>
</element>
</mapping>
</element>
</mapping>
</element>
<targetProfile value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/location-ca-core" />
</type>
</element>
</extension>
</extension>
</extension>
</extension>
</extension>
</extension>
</mapping>
</element>
<targetProfile value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/practitioner-ca-core" />
<targetProfile value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/practitionerRole-ca-core" />
<targetProfile value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/organization-ca-core" />
</type>
</element>
<targetProfile value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/condition-ca-core" />
</type>
</element>
</differential>
</StructureDefinition>
{
],
{
{
},
{
}
]
}
],
"description": "This profile applies constraints to the Immunization resource for CA Core+ to support documentation of administered vaccines in the pan-Canadian context.",
],
"copyright": "Copyright © 2025+ Canada Health Infoway. All rights reserved. [Terms of Use and License Agreements](https://ic.infoway-inforoute.ca/en/about/tou). [Privacy Policy](https://www.infoway-inforoute.ca/en/legal/privacy-policy).",
{
}
],
{
"definition": "Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.",
},
{
},
{
"human": "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",
"expression": "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()",
"xpath": "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
},
{
"human": "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))",
},
{
},
{
{
},
{
"valueMarkdown": "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}
],
},
{
"human": "Immunization records created during an encounter event are expected to have occurrence populated. Occurrence SHALL be present if the primarySource is 'true'",
}
],
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
}
]
},
{
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
},
{
{
}
],
}
],
},
{
"definition": "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.",
},
],
{
}
],
},
{
"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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment": "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.",
},
],
{
}
],
"isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
},
{
"comment": "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).",
},
],
{
}
],
{
},
{
},
{
}
],
}
},
{
"definition": "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.",
"comment": "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",
"html",
"xhtml",
"display"
],
},
],
{
}
],
]
},
{
"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.",
"comment": "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.",
"inline resources",
"anonymous resources",
"contained resources"
],
},
],
]
},
{
"definition": "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.",
"comment": "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.",
"extensions",
"user content"
],
},
],
{
},
{
}
],
]
},
{
"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 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "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.",
"requirements": "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](extensibility.html#modifierExtension).",
"extensions",
"user content"
],
},
],
{
},
{
}
],
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
]
},
{
},
],
{
}
],
{
},
{
},
{
},
{
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/id"
}
]
},
{
"comment": "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.",
},
],
{
}
],
"isModifierReason": "This element is labeled as a modifier because it is a status element that contains statuses entered-in-error and not-done which means that the resource should not be treated as valid",
{
}
],
},
{
},
{
},
{
}
]
},
{
"comment": "This is generally only used for the status of \"not-done\". The reason for performing the immunization event is captured in reasonCode, not here.",
},
],
{
}
],
{
}
],
},
{
},
{
}
]
},
{
{
},
{
},
{
{
},
{
}
],
},
{
{
},
{
}
],
}
],
"definition": "A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.",
"comment": "The additionalBinding extension will be used to express the valueSet for additional negation/exclusion codes for reporting the known absence of immunizations. At the time of this release, the publisher of the current ValueSet for absence codes (IPS) is developing a SNOMED ValueSet that will replace the current http://hl7.org/fhir/uv/ips/ValueSet/absent-or-unknown-immunizations-uv-ips",
},
{
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/codeableconcept-ca-core"
]
}
],
"ele-1"
],
{
}
],
{
},
{
{
},
{
},
{
"valueMarkdown": "Recommended for use when conveying vaccine generic names for scenarios when brand name is not known or does not exist (e.g., immunization history where provider does not have detail of the trade name, the product has been discontinued and/or never licensed in Canada)."
}
],
},
{
{
},
{
"valueCanonical": "https://fhir.infoway-inforoute.ca/ValueSet/passiveadministeredimmunizingagentcode"
},
{
"valueMarkdown": "per pCHDCF: Alternate value sets can be used when passive immunization products are used"
}
],
},
{
{
},
{
},
{
"valueMarkdown": "per pCHDCF: Alternate value sets can be used when passive immunization products are used"
}
],
},
{
{
},
{
},
{
}
],
}
],
},
{
},
{
},
{
},
{
},
{
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code"
},
{
},
{
},
{
},
{
},
{
},
{
}
]
},
{
"xmlAttr"
],
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
},
{
{
}
],
}
],
]
},
{
],
},
"definition": "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.",
"comment": "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.",
"extensions",
"user content"
],
},
],
{
},
{
}
],
]
},
{
{
},
{
}
],
"comment": "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.",
"requirements": "Allows for alternative encodings within a code system, and translations to other code systems.",
},
{
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/coding-ca-core"
]
}
],
"ele-1"
],
{
}
],
{
},
{
},
{
},
{
},
{
},
{
},
{
}
]
},
{
"xmlAttr"
],
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
},
{
{
}
],
}
],
]
},
{
],
},
"definition": "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.",
"comment": "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.",
"extensions",
"user content"
],
},
],
{
},
{
}
],
]
},
{
"definition": "The identification of the code system that defines the meaning of the symbol in the code.",
"comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.",
},
],
{
}
],
{
},
{
},
{
},
{
}
]
},
{
"definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.",
"comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.",
},
],
{
}
],
{
},
{
},
{
}
]
},
{
"definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).",
},
],
{
}
],
{
},
{
},
{
}
]
},
{
{
}
],
"definition": "A representation of the meaning of the code in the system, following the rules of the system.",
"requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.",
},
],
{
}
],
{
},
{
},
{
}
]
},
{
"xmlAttr"
],
},
{
{
}
],
}
],
},
{
},
"definition": "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.",
"comment": "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.",
"extensions",
"user content"
],
},
],
{
},
{
}
],
},
{
"definition": "Language translation from base language of resource to another language, used to provide translations for strings, including markdown. Generally, the type of the translation extension SHOULD match that of the element being extended.",
"comment": "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.",
"extensions",
"user content"
],
},
],
"ele-1"
],
{
},
{
}
],
]
},
{
"xmlAttr"
],
},
{
{
},
{
}
],
}
],
},
{
"definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).",
"comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.",
"requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.",
},
],
{
}
],
{
},
{
},
{
"map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]"
}
]
},
{
{
}
],
"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.",
"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.",
},
],
{
}
],
{
},
{
},
{
}
]
},
{
},
{
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/patient-ca-core"
]
}
],
{
}
],
{
},
{
},
{
},
{
},
{
},
{
}
]
},
{
"xmlAttr"
],
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
},
{
{
}
],
}
],
]
},
{
],
},
"definition": "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.",
"comment": "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.",
"extensions",
"user content"
],
},
],
{
},
{
}
],
]
},
{
"definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
},
],
"ref-1"
],
{
}
],
]
},
{
"definition": "The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.\n\nThe type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. \"Patient\" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).",
"comment": "This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.",
},
],
{
}
],
{
}
],
},
]
},
{
"definition": "An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.\n\nReference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).",
},
],
{
}
],
]
},
{
{
}
],
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
},
],
{
}
],
]
},
{
"definition": "The visit or admission or other contact between patient and health care provider the immunization was performed as part of.",
},
],
{
}
],
{
},
{
},
{
},
{
}
]
},
{
"comment": "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.",
},
],
{
}
],
{
},
{
},
{
},
{
},
{
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveTime/value"
},
{
},
{
}
]
},
{
"definition": "The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.",
},
],
{
}
],
{
},
{
},
{
}
]
},
{
"definition": "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.",
},
],
{
}
],
{
},
{
},
{
},
{
}
]
},
{
"definition": "The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.",
"comment": "Should not be populated if primarySource = True, not required even if primarySource = False.",
},
],
{
}
],
{
}
],
},
{
},
{
},
{
"map": ".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)"
},
{
}
]
},
{
},
{
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/location-ca-core"
]
}
],
{
}
],
{
},
{
},
{
},
{
}
]
},
{
},
{
}
],
{
}
],
{
},
{
},
{
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacuturerOrganization/name"
}
]
},
{
{
{
},
{
}
],
},
{
{
},
{
}
],
}
],
},
],
{
}
],
{
},
{
},
{
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/lotNumberText"
},
{
}
]
},
{
},
],
{
}
],
{
},
{
"map": ".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].expirationTime"
}
]
},
{
},
],
{
}
],
{
}
],
},
{
},
{
},
{
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/approachSiteCode/code"
}
]
},
{
},
],
{
}
],
{
}
],
},
{
},
{
},
{
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/routeCode/code"
}
]
},
{
},
],
{
}
],
]
},
{
},
],
{
}
],
{
},
{
},
{
}
]
},
{
"xmlAttr"
],
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
},
{
{
}
],
}
],
]
},
{
"definition": "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.",
"comment": "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.",
"extensions",
"user content"
],
},
],
{
},
{
}
],
]
},
{
"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 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "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.",
"requirements": "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](extensibility.html#modifierExtension).",
"extensions",
"user content",
"modifiers"
],
},
],
{
},
{
}
],
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
]
},
{
"definition": "Describes the type of performance (e.g. ordering provider, administering provider, etc.).",
},
],
{
}
],
{
}
],
},
{
},
{
}
]
},
{
"comment": "When the individual practitioner who performed the action is known, it is best to send.",
},
{
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/practitioner-ca-core",
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/practitionerRole-ca-core",
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/organization-ca-core"
]
}
],
{
}
],
{
},
{
},
{
}
]
},
{
"definition": "Extra information about the immunization that is not conveyed by the other attributes.",
},
],
{
}
],
{
},
{
},
{
}
]
},
{
},
],
{
}
],
{
}
],
},
{
},
{
}
]
},
{
"definition": "Condition, Observation or DiagnosticReport that supports why the immunization was administered.",
},
{
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/condition-ca-core",
"http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/DiagnosticReport"
]
}
],
{
}
],
]
},
{
"definition": "Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.",
"comment": "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.",
},
],
{
}
],
"isModifierReason": "This element is labeled as a modifier because an immunization event with a subpotent vaccine doesn't protect the patient the same way as a potent dose.",
{
},
{
}
]
},
{
},
],
{
}
],
{
}
],
},
]
},
{
"definition": "Educational material presented to the patient (or guardian) at the time of vaccine administration.",
},
],
{
},
{
}
],
]
},
{
"xmlAttr"
],
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
},
{
{
}
],
}
],
]
},
{
"definition": "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.",
"comment": "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.",
"extensions",
"user content"
],
},
],
{
},
{
}
],
]
},
{
"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 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "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.",
"requirements": "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](extensibility.html#modifierExtension).",
"extensions",
"user content",
"modifiers"
],
},
],
{
},
{
}
],
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
]
},
{
},
],
{
}
],
]
},
{
"definition": "Reference pointer to the educational material given to the patient if the information was on line.",
},
],
{
}
],
]
},
{
},
],
{
}
],
]
},
{
},
],
{
}
],
]
},
{
},
],
{
}
],
{
}
],
},
]
},
{
"definition": "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).",
},
],
{
}
],
{
}
],
},
]
},
{
"definition": "Categorical data indicating that an adverse event is associated in time to an immunization.",
"comment": "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.",
},
],
{
}
],
{
},
{
}
]
},
{
"xmlAttr"
],
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
},
{
{
}
],
}
],
]
},
{
"definition": "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.",
"comment": "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.",
"extensions",
"user content"
],
},
],
{
},
{
}
],
]
},
{
"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 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "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.",
"requirements": "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](extensibility.html#modifierExtension).",
"extensions",
"user content",
"modifiers"
],
},
],
{
},
{
}
],
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
]
},
{
},
],
{
}
],
{
"map": "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)"
},
{
}
]
},
{
},
],
{
}
],
]
},
{
},
],
{
}
],
{
},
{
}
]
},
{
"definition": "The protocol (set of recommendations) being followed by the provider who administered the dose.",
},
],
{
}
],
]
},
{
"xmlAttr"
],
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
},
{
{
}
],
}
],
]
},
{
"definition": "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.",
"comment": "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.",
"extensions",
"user content"
],
},
],
{
},
{
}
],
]
},
{
"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 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "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.",
"requirements": "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](extensibility.html#modifierExtension).",
"extensions",
"user content",
"modifiers"
],
},
],
{
},
{
}
],
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
]
},
{
"definition": "One possible path to achieve presumed immunity against a disease - within the context of an authority.",
},
],
{
}
],
]
},
{
"definition": "Indicates the authority who published the protocol (e.g. ACIP) that is being followed.",
},
{
}
],
{
}
],
]
},
{
},
],
{
}
],
{
}
],
},
]
},
{
"comment": "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).",
},
],
{
}
],
]
},
{
"comment": "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).",
},
],
{
}
],
]
}
]
},
{
{
"human": "Immunization records created during an encounter event are expected to have occurrence populated. Occurrence SHALL be present if the primarySource is 'true'",
}
],
{
},
{
},
{
},
{
},
{
},
{
}
]
},
{
{
{
},
{
}
],
},
{
{
},
{
}
],
}
],
"comment": "The additionalBinding extension will be used to express the valueSet for additional negation/exclusion codes for reporting the known absence of immunizations. At the time of this release, the publisher of the current ValueSet for absence codes (IPS) is developing a SNOMED ValueSet that will replace the current http://hl7.org/fhir/uv/ips/ValueSet/absent-or-unknown-immunizations-uv-ips",
{
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/codeableconcept-ca-core"
]
}
],
{
{
},
{
},
{
"valueMarkdown": "Recommended for use when conveying vaccine generic names for scenarios when brand name is not known or does not exist (e.g., immunization history where provider does not have detail of the trade name, the product has been discontinued and/or never licensed in Canada)."
}
],
},
{
{
},
{
"valueCanonical": "https://fhir.infoway-inforoute.ca/ValueSet/passiveadministeredimmunizingagentcode"
},
{
"valueMarkdown": "per pCHDCF: Alternate value sets can be used when passive immunization products are used"
}
],
},
{
{
},
{
},
{
"valueMarkdown": "per pCHDCF: Alternate value sets can be used when passive immunization products are used"
}
],
},
{
{
},
{
},
{
}
],
}
],
},
]
},
{
]
},
{
{
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/patient-ca-core"
]
}
],
]
},
{
},
{
{
},
{
}
]
},
{
]
},
{
{
}
]
},
{
{
}
]
},
{
{
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/location-ca-core"
]
}
]
},
{
{
{
},
{
}
],
},
{
{
},
{
}
],
}
],
]
},
{
{
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/practitioner-ca-core",
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/practitionerRole-ca-core",
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/organization-ca-core"
]
}
]
},
{
{
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/condition-ca-core",
"http://hl7.org/fhir/StructureDefinition/Observation",
"http://hl7.org/fhir/StructureDefinition/DiagnosticReport"
]
}
]
}
]
}
}
Terminology bindings
| Path | Conformance | ValueSet |
|---|---|---|
| Immunization.vaccineCode | preferred | https://fhir.infoway-inforoute.ca/ValueSet/vaccineadministeredtradenamecode |
Additional Terminology Bindings
These bindings may be used in lieu of the primary bindings in the table above.
| Path | Conformance | AdditionalValueSet |
|---|---|---|
| Immunization.vaccineCode | preferred | https://fhir.infoway-inforoute.ca/ValueSet/vaccinehistoricalnamecode |
Mappings to CACDI
The following tables list how the data elements from CA Core+ map to CACDI. For more information visit Mapping Logic.
| FHIR Profile Element | CACDI Element(s) |
|---|---|
| Immunization | Reported Clinical Information, Immunization Event, Immunization Detail, Health Care Service Event, Health Care Service Event.Health Care Service Event Type Code, Reported Immunization |
| Immunization.vaccineCode | Drug.Drug Code, Drug |
| Immunization.vaccineCode.coding.system | Drug.Drug Code System URI |
| Immunization.patient | Patient |
| Immunization.occurrence[x] | Healthcare Service Event.Event Start Date Time, Reported Clinical Information.Reported Clinical Information Date Time |
| Immunization.recorded | Healthcare Service Event.Event Start Date Time |
| Immunization.primarySource | Reported Clinical Information.Reported Clinical Information Source Code |
| Immunization.reportOrigin | Reported Clinical Information.Reported Clinical Information Source Code |
| Immunization.lotNumber | Immunization Drug Product Lot |