Pan-Canadian Patient Summary (PS-CA) 2.1.1 DFT
2.1.1-DFT 
DFT - For a full list of available versions, see the Directory of published versions
Immunization (PS-CA)
Links
Profile
Derived from
http://hl7.org/fhir/StructureDefinition/Immunization
Examples
Description
This profile represents the constraints applied to the Immunization resource by the PS-CA project to represent a record of immunization in the patient summary. It is informed by the constraints of the Immunization IPS-UV profile and the Canadian Baseline Profile to allow for cross-border and cross-jurisdiction sharing of Medication Summary information. It describes the event of a patient being administered a vaccination or a record of a vaccination as reported by a patient, a clinician or another party.
References to this resource
Resource Content
| ImmunizationPSCA (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 | S Σ ?! | 1..1 | codeBinding |
| statusReason | 0..1 | CodeableConcept | |
| vaccineCode | S Σ | 1..1 | CodeableConceptBinding |
| patient | S Σ | 1..1 | Reference(PatientPSCA) |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| reference | S Σ C | 1..1 | string |
| type | Σ | 0..1 | uriBinding |
| identifier | Σ | 0..1 | Identifier |
| display | Σ | 0..1 | string |
| encounter | 0..1 | Reference(Encounter) | |
| occurrence[x] | S Σ | 1..1 | |
| occurrenceDateTime | dateTime | ||
| occurrenceString | string | ||
| recorded | 0..1 | dateTime | |
| primarySource | Σ | 0..1 | boolean |
| reportOrigin | 0..1 | CodeableConcept | |
| location | 0..1 | Reference(Location) | |
| manufacturer | 0..1 | Reference(Organization) | |
| lotNumber | 0..1 | string | |
| expirationDate | 0..1 | date | |
| site | 0..1 | CodeableConceptPSCABinding | |
| route | 0..1 | CodeableConceptPSCABinding | |
| 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(Practitioner | PractitionerRole | Organization) |
| note | Σ | 0..* | Annotation |
| reasonCode | 0..* | CodeableConcept | |
| reasonReference | 0..* | Reference(Condition | 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..* | CodeableConceptBinding | |
| doseNumber[x] | 1..1 | ||
| doseNumberPositiveInt | positiveInt | ||
| doseNumberString | string | ||
| seriesDoses[x] | 0..1 | ||
| seriesDosesPositiveInt | positiveInt | ||
| seriesDosesString | string |
| ImmunizationPSCA (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 | S Σ ?! | 1..1 | codeBinding |
| statusReason | 0..1 | CodeableConcept | |
| vaccineCode | S Σ | 1..1 | CodeableConceptBinding |
| patient | S Σ | 1..1 | Reference(PatientPSCA) |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| reference | S Σ C | 1..1 | string |
| type | Σ | 0..1 | uriBinding |
| identifier | Σ | 0..1 | Identifier |
| display | Σ | 0..1 | string |
| encounter | 0..1 | Reference(Encounter) | |
| occurrence[x] | S Σ | 1..1 | |
| occurrenceDateTime | dateTime | ||
| occurrenceString | string | ||
| recorded | 0..1 | dateTime | |
| primarySource | Σ | 0..1 | boolean |
| reportOrigin | 0..1 | CodeableConcept | |
| location | 0..1 | Reference(Location) | |
| manufacturer | 0..1 | Reference(Organization) | |
| lotNumber | 0..1 | string | |
| expirationDate | 0..1 | date | |
| site | 0..1 | CodeableConceptPSCABinding | |
| route | 0..1 | CodeableConceptPSCABinding | |
| 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(Practitioner | PractitionerRole | Organization) |
| note | Σ | 0..* | Annotation |
| reasonCode | 0..* | CodeableConcept | |
| reasonReference | 0..* | Reference(Condition | 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..* | CodeableConceptBinding | |
| doseNumber[x] | 1..1 | ||
| doseNumberPositiveInt | positiveInt | ||
| doseNumberString | string | ||
| seriesDoses[x] | 0..1 | ||
| seriesDosesPositiveInt | positiveInt | ||
| seriesDosesString | string |
<description value="This profile represents the constraints applied to the Immunization resource by the PS-CA project to represent a record of immunization in the patient summary. It is informed by the constraints of the [Immunization IPS-UV profile](http://hl7.org/fhir/uv/ips/StructureDefinition-Immunization-uv-ips.html) and the [Canadian Baseline Profile](http://build.fhir.org/ig/HL7-Canada/ca-baseline/branches/master/StructureDefinition-profile-immunization.html) to allow for cross-border and cross-jurisdiction sharing of Medication Summary information. It describes the event of a patient being administered a vaccination or a record of a vaccination as reported by a patient, a clinician or another party." />
<copyright value="Copyright © 2024+ 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 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>
</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>
<short value="Vaccine that was administered or was to be administered. IPS-UV Note: Several kinds of vaccine product coding could be provided.\n\nThe IPS assumes that either the type of the vaccine for particular disease or diseases (e.g. MMR vaccine) against which the patient has been immunised is provided; or the known absent/unknown code.\n\nOther coded information can be provided as well as: the Pharmaceutical and medicinal product identifiers, when available, or equivalent coded concepts; the WHO ATC codes; or any other kind of code that that identifies, classifies or cluster the administered product.\n\nThe IPS-UV vaccine concepts are not used in Canadian implementations as they do not include Canadian trade or brand names. Implementers should use the following pan-Canadian value sets, depending on context: "VaccineHistoricalNameCode", "PassiveAdministeredImmunizingAgentCode", and "PassiveHistoricalImmunizingAgentCode", which are equivalently preferred alongside the primary binding." />
<comment value="See additionalBinding extension.\n\n Future releases of PS-CA may require use of coded entries. In this release, however, implementations that support codings are encouraged to send the codings for codeable concepts if they are available. Consistent with FHIR best practice, receivers should not produce failures or rejections if codings are received. Vendors should expect that some jurisdictions may further constrain support of this element within the context of their own jurisdictional content." />
</base>
</type>
</constraint>
</extension>
</extension>
</extension>
<valueMarkdown value="This refset is intended to capture the immunization history and includes concepts represented by a generic description for a vaccine that was previously administered to the client." />
</extension>
</extension>
</extension>
<valueCanonical value="https://fhir.infoway-inforoute.ca/ValueSet/passiveadministeredimmunizingagentcode" />
</extension>
<valueMarkdown value="This refset is intended to capture the product administered at the point of immunization and includes the passive immunizing agent tradenames that are currently licensed for use in Canada, those obtained through special access programs for use in Canada, and those that were never licensed in Canada." />
</extension>
</extension>
</extension>
<valueCanonical value="https://fhir.infoway-inforoute.ca/ValueSet/passivehistoricalimmunizingagentcode" />
</extension>
<valueMarkdown value="This refset is intended to capture the immunization history and includes concepts represented by a generic description for a passive immunizing agent that was previously administered to the client." />
</extension>
</extension>
</extension>
</extension>
<valueMarkdown value="IPS Vaccine codes value set. This value set includes codes from SNOMED CT." />
</extension>
</extension>
</extension>
</extension>
</extension>
</extension>
</extension>
<valueCanonical value="http://hl7.org/fhir/uv/ips/ValueSet/absent-or-unknown-immunizations-uv-ips" />
</extension>
</extension>
</extension>
<description value="Codes from the Vaccine Administered Trade Name Code ValueSet. Equivalently preferred to the Vaccine Historical Name Code ValueSet, Passive Administered Immunizing Agent Code ValueSet, or Passive Historical Immunizing Agent Code ValueSet found in additionalBinding extension" />
</binding>
</mapping>
</mapping>
</mapping>
</mapping>
<map value="ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code" />
</mapping>
</element>
</base>
<targetProfile value="http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/patient-ca-ps" />
</type>
</constraint>
</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>
</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>
</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>
</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>
</element>
</base>
</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>
</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>
</element>
</base>
</type>
</constraint>
</mapping>
<map value=".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].expirationTime" />
</mapping>
</element>
</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="For all CodeableConcepts, at least one of coding or text must be present. If coding contains only a display value (no code) then CodeableConcept must include text." />
</base>
<profile value="http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/CodeableConcept-ca-ps" />
</type>
</constraint>
</extension>
<valueSet value="https://fhir.infoway-inforoute.ca/ValueSet/immunizationadministrationanatomicalsitecode" />
</binding>
</mapping>
</mapping>
<map value="ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/approachSiteCode/code" />
</mapping>
</mapping>
</mapping>
</mapping>
</mapping>
</element>
</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="See additionalBinding extension.\n\nFuture releases of PS-CA may require use of coded entries. In this release, however, implementations that support codings are encouraged to send the codings for codeable concepts if they are available. Consistent with FHIR best practice, receivers should not produce failures or rejections if codings are received." />
</base>
<profile value="http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/CodeableConcept-ca-ps" />
</type>
</constraint>
</extension>
</extension>
</extension>
<valueMarkdown value="Route of immunization administration includes content from EDQM Standard Terms. While this additional binding is not primarily used in the Canadian healthcare context, it is retained to support potential use of PS-CA internationally and IPS within Canada. Implementers should be aware that this binding may not comprehensively represent all Canadian route of administration codes." />
</extension>
</extension>
</extension>
</extension>
<valueMarkdown value="The path the administered medication takes to get into the body or into contact with the body. While not the preferred terminology for broader pan-Canadian exchange use cases, this additional binding is surfaced to socialize the value sets that may be more commonly in use. Where multiple codings can be supplied, it is encouraged to supply the original coding alongside the pan-Canadian preferred terminology." />
</extension>
</extension>
<valueSet value="https://fhir.infoway-inforoute.ca/ValueSet/immunizationrouteofadministrationcode" />
</binding>
</mapping>
</mapping>
<map value="ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/routeCode/code" />
</mapping>
</mapping>
</mapping>
</mapping>
</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>
</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>
</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>
<comment value="See additionalBinding extension.\n\n IPS-UV no longer flags this as a Must Support element. It is not currently flagged as Must Support in PS-CA, as stakeholders have indicated the element may not be supported by the majority of systems today.\n\nSystems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received." />
</base>
</type>
</constraint>
</extension>
</extension>
</extension>
<valueMarkdown value="IPS Vaccine target disease codes value set. This value set includes codes from SNOMED CT" />
</extension>
</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>
</element>
<short value="Vaccine that was administered or was to be administered. IPS-UV Note: Several kinds of vaccine product coding could be provided.\n\nThe IPS assumes that either the type of the vaccine for particular disease or diseases (e.g. MMR vaccine) against which the patient has been immunised is provided; or the known absent/unknown code.\n\nOther coded information can be provided as well as: the Pharmaceutical and medicinal product identifiers, when available, or equivalent coded concepts; the WHO ATC codes; or any other kind of code that that identifies, classifies or cluster the administered product.\n\nThe IPS-UV vaccine concepts are not used in Canadian implementations as they do not include Canadian trade or brand names. Implementers should use the following pan-Canadian value sets, depending on context: "VaccineHistoricalNameCode", "PassiveAdministeredImmunizingAgentCode", and "PassiveHistoricalImmunizingAgentCode", which are equivalently preferred alongside the primary binding." />
<comment value="See additionalBinding extension.\n\n Future releases of PS-CA may require use of coded entries. In this release, however, implementations that support codings are encouraged to send the codings for codeable concepts if they are available. Consistent with FHIR best practice, receivers should not produce failures or rejections if codings are received. Vendors should expect that some jurisdictions may further constrain support of this element within the context of their own jurisdictional content." />
</extension>
</extension>
<valueMarkdown value="This refset is intended to capture the immunization history and includes concepts represented by a generic description for a vaccine that was previously administered to the client." />
</extension>
</extension>
</extension>
<valueCanonical value="https://fhir.infoway-inforoute.ca/ValueSet/passiveadministeredimmunizingagentcode" />
</extension>
<valueMarkdown value="This refset is intended to capture the product administered at the point of immunization and includes the passive immunizing agent tradenames that are currently licensed for use in Canada, those obtained through special access programs for use in Canada, and those that were never licensed in Canada." />
</extension>
</extension>
</extension>
<valueCanonical value="https://fhir.infoway-inforoute.ca/ValueSet/passivehistoricalimmunizingagentcode" />
</extension>
<valueMarkdown value="This refset is intended to capture the immunization history and includes concepts represented by a generic description for a passive immunizing agent that was previously administered to the client." />
</extension>
</extension>
</extension>
</extension>
<valueMarkdown value="IPS Vaccine codes value set. This value set includes codes from SNOMED CT." />
</extension>
</extension>
</extension>
</extension>
</extension>
</extension>
</extension>
<valueCanonical value="http://hl7.org/fhir/uv/ips/ValueSet/absent-or-unknown-immunizations-uv-ips" />
</extension>
</extension>
</extension>
<description value="Codes from the Vaccine Administered Trade Name Code ValueSet. Equivalently preferred to the Vaccine Historical Name Code ValueSet, Passive Administered Immunizing Agent Code ValueSet, or Passive Historical Immunizing Agent Code ValueSet found in additionalBinding extension" />
</binding>
</element>
<targetProfile value="http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/patient-ca-ps" />
</type>
</element>
</element>
</element>
<profile value="http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/CodeableConcept-ca-ps" />
</type>
<valueSet value="https://fhir.infoway-inforoute.ca/ValueSet/immunizationadministrationanatomicalsitecode" />
</binding>
</element>
<comment value="See additionalBinding extension.\n\nFuture releases of PS-CA may require use of coded entries. In this release, however, implementations that support codings are encouraged to send the codings for codeable concepts if they are available. Consistent with FHIR best practice, receivers should not produce failures or rejections if codings are received." />
<profile value="http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/CodeableConcept-ca-ps" />
</type>
</extension>
</extension>
<valueMarkdown value="Route of immunization administration includes content from EDQM Standard Terms. While this additional binding is not primarily used in the Canadian healthcare context, it is retained to support potential use of PS-CA internationally and IPS within Canada. Implementers should be aware that this binding may not comprehensively represent all Canadian route of administration codes." />
</extension>
</extension>
</extension>
</extension>
<valueMarkdown value="The path the administered medication takes to get into the body or into contact with the body. While not the preferred terminology for broader pan-Canadian exchange use cases, this additional binding is surfaced to socialize the value sets that may be more commonly in use. Where multiple codings can be supplied, it is encouraged to supply the original coding alongside the pan-Canadian preferred terminology." />
</extension>
</extension>
<valueSet value="https://fhir.infoway-inforoute.ca/ValueSet/immunizationrouteofadministrationcode" />
</binding>
</element>
<comment value="See additionalBinding extension.\n\n IPS-UV no longer flags this as a Must Support element. It is not currently flagged as Must Support in PS-CA, as stakeholders have indicated the element may not be supported by the majority of systems today.\n\nSystems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received." />
</extension>
</extension>
<valueMarkdown value="IPS Vaccine target disease codes value set. This value set includes codes from SNOMED CT" />
</extension>
</extension>
</binding>
</element>
</differential>
</StructureDefinition>
{
"description": "This profile represents the constraints applied to the Immunization resource by the PS-CA project to represent a record of immunization in the patient summary. It is informed by the constraints of the [Immunization IPS-UV profile](http://hl7.org/fhir/uv/ips/StructureDefinition-Immunization-uv-ips.html) and the [Canadian Baseline Profile](http://build.fhir.org/ig/HL7-Canada/ca-baseline/branches/master/StructureDefinition-profile-immunization.html) to allow for cross-border and cross-jurisdiction sharing of Medication Summary information. It describes the event of a patient being administered a vaccination or a record of a vaccination as reported by a patient, a clinician or another party.",
"copyright": "Copyright © 2024+ 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."
}
],
}
],
{
},
{
},
{
},
{
}
]
},
{
"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.",
},
],
{
}
],
{
}
],
},
{
},
{
}
]
},
{
"short": "Vaccine that was administered or was to be administered. IPS-UV Note: Several kinds of vaccine product coding could be provided.\n\nThe IPS assumes that either the type of the vaccine for particular disease or diseases (e.g. MMR vaccine) against which the patient has been immunised is provided; or the known absent/unknown code.\n\nOther coded information can be provided as well as: the Pharmaceutical and medicinal product identifiers, when available, or equivalent coded concepts; the WHO ATC codes; or any other kind of code that that identifies, classifies or cluster the administered product.\n\nThe IPS-UV vaccine concepts are not used in Canadian implementations as they do not include Canadian trade or brand names. Implementers should use the following pan-Canadian value sets, depending on context: \"VaccineHistoricalNameCode\", \"PassiveAdministeredImmunizingAgentCode\", and \"PassiveHistoricalImmunizingAgentCode\", which are equivalently preferred alongside the primary binding.",
"comment": "See additionalBinding extension.\n\n Future releases of PS-CA may require use of coded entries. In this release, however, implementations that support codings are encouraged to send the codings for codeable concepts if they are available. Consistent with FHIR best practice, receivers should not produce failures or rejections if codings are received. Vendors should expect that some jurisdictions may further constrain support of this element within the context of their own jurisdictional content.",
},
],
{
}
],
{
},
{
{
},
{
},
{
"valueMarkdown": "This refset is intended to capture the immunization history and includes concepts represented by a generic description for a vaccine that was previously administered to the client."
}
],
},
{
{
},
{
"valueCanonical": "https://fhir.infoway-inforoute.ca/ValueSet/passiveadministeredimmunizingagentcode"
},
{
"valueMarkdown": "This refset is intended to capture the product administered at the point of immunization and includes the passive immunizing agent tradenames that are currently licensed for use in Canada, those obtained through special access programs for use in Canada, and those that were never licensed in Canada."
}
],
},
{
{
},
{
},
{
"valueMarkdown": "This refset is intended to capture the immunization history and includes concepts represented by a generic description for a passive immunizing agent that was previously administered to the client."
}
],
},
{
{
},
{
},
{
}
],
},
{
{
},
{
},
{
}
],
},
{
{
},
{
},
{
}
],
}
],
"description": "Codes from the Vaccine Administered Trade Name Code ValueSet. Equivalently preferred to the Vaccine Historical Name Code ValueSet, Passive Administered Immunizing Agent Code ValueSet, or Passive Historical Immunizing Agent Code ValueSet found in additionalBinding extension",
},
{
},
{
},
{
},
{
},
{
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code"
}
]
},
{
},
{
"http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/patient-ca-ps"
]
}
],
{
}
],
{
},
{
},
{
},
{
},
{
}
]
},
{
"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)"
}
]
},
{
},
],
{
}
],
{
},
{
},
{
},
{
}
]
},
{
},
{
}
],
{
}
],
{
},
{
},
{
"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"
}
]
},
{
{
},
{
}
],
"definition": "A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.",
"comment": "For all CodeableConcepts, at least one of coding or text must be present. If coding contains only a display value (no code) then CodeableConcept must include text.",
},
{
"http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/CodeableConcept-ca-ps"
]
}
],
"ele-1"
],
{
}
],
{
}
],
"valueSet": "https://fhir.infoway-inforoute.ca/ValueSet/immunizationadministrationanatomicalsitecode"
},
{
},
{
},
{
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/approachSiteCode/code"
},
{
},
{
},
{
},
{
}
]
},
{
{
},
{
}
],
"definition": "A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.",
"comment": "See additionalBinding extension.\n\nFuture releases of PS-CA may require use of coded entries. In this release, however, implementations that support codings are encouraged to send the codings for codeable concepts if they are available. Consistent with FHIR best practice, receivers should not produce failures or rejections if codings are received.",
},
{
"http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/CodeableConcept-ca-ps"
]
}
],
"ele-1"
],
{
}
],
{
},
{
{
},
{
},
{
"valueMarkdown": "Route of immunization administration includes content from EDQM Standard Terms. While this additional binding is not primarily used in the Canadian healthcare context, it is retained to support potential use of PS-CA internationally and IPS within Canada. Implementers should be aware that this binding may not comprehensively represent all Canadian route of administration codes."
}
],
},
{
{
},
{
},
{
"valueMarkdown": "The path the administered medication takes to get into the body or into contact with the body. While not the preferred terminology for broader pan-Canadian exchange use cases, this additional binding is surfaced to socialize the value sets that may be more commonly in use. Where multiple codings can be supplied, it is encouraged to supply the original coding alongside the pan-Canadian preferred terminology."
}
],
}
],
},
{
},
{
},
{
"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://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole",
"http://hl7.org/fhir/StructureDefinition/Organization"
]
}
],
{
}
],
{
},
{
},
{
}
]
},
{
"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://hl7.org/fhir/StructureDefinition/Condition",
"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": "See additionalBinding extension.\n\n IPS-UV no longer flags this as a Must Support element. It is not currently flagged as Must Support in PS-CA, as stakeholders have indicated the element may not be supported by the majority of systems today.\n\nSystems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received.",
},
],
{
}
],
{
},
{
{
},
{
},
{
"valueMarkdown": "IPS Vaccine target disease codes value set. This value set includes codes from SNOMED CT"
}
],
}
],
},
]
},
{
"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).",
},
],
{
}
],
]
}
]
},
{
},
{
"short": "Vaccine that was administered or was to be administered. IPS-UV Note: Several kinds of vaccine product coding could be provided.\n\nThe IPS assumes that either the type of the vaccine for particular disease or diseases (e.g. MMR vaccine) against which the patient has been immunised is provided; or the known absent/unknown code.\n\nOther coded information can be provided as well as: the Pharmaceutical and medicinal product identifiers, when available, or equivalent coded concepts; the WHO ATC codes; or any other kind of code that that identifies, classifies or cluster the administered product.\n\nThe IPS-UV vaccine concepts are not used in Canadian implementations as they do not include Canadian trade or brand names. Implementers should use the following pan-Canadian value sets, depending on context: \"VaccineHistoricalNameCode\", \"PassiveAdministeredImmunizingAgentCode\", and \"PassiveHistoricalImmunizingAgentCode\", which are equivalently preferred alongside the primary binding.",
"comment": "See additionalBinding extension.\n\n Future releases of PS-CA may require use of coded entries. In this release, however, implementations that support codings are encouraged to send the codings for codeable concepts if they are available. Consistent with FHIR best practice, receivers should not produce failures or rejections if codings are received. Vendors should expect that some jurisdictions may further constrain support of this element within the context of their own jurisdictional content.",
{
{
},
{
},
{
"valueMarkdown": "This refset is intended to capture the immunization history and includes concepts represented by a generic description for a vaccine that was previously administered to the client."
}
],
},
{
{
},
{
"valueCanonical": "https://fhir.infoway-inforoute.ca/ValueSet/passiveadministeredimmunizingagentcode"
},
{
"valueMarkdown": "This refset is intended to capture the product administered at the point of immunization and includes the passive immunizing agent tradenames that are currently licensed for use in Canada, those obtained through special access programs for use in Canada, and those that were never licensed in Canada."
}
],
},
{
{
},
{
},
{
"valueMarkdown": "This refset is intended to capture the immunization history and includes concepts represented by a generic description for a passive immunizing agent that was previously administered to the client."
}
],
},
{
{
},
{
},
{
}
],
},
{
{
},
{
},
{
}
],
},
{
{
},
{
},
{
}
],
}
],
"description": "Codes from the Vaccine Administered Trade Name Code ValueSet. Equivalently preferred to the Vaccine Historical Name Code ValueSet, Passive Administered Immunizing Agent Code ValueSet, or Passive Historical Immunizing Agent Code ValueSet found in additionalBinding extension",
}
},
{
{
"http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/patient-ca-ps"
]
}
],
},
{
},
{
},
{
{
"http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/CodeableConcept-ca-ps"
]
}
],
"valueSet": "https://fhir.infoway-inforoute.ca/ValueSet/immunizationadministrationanatomicalsitecode"
}
},
{
"comment": "See additionalBinding extension.\n\nFuture releases of PS-CA may require use of coded entries. In this release, however, implementations that support codings are encouraged to send the codings for codeable concepts if they are available. Consistent with FHIR best practice, receivers should not produce failures or rejections if codings are received.",
{
"http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/CodeableConcept-ca-ps"
]
}
],
{
{
},
{
},
{
"valueMarkdown": "Route of immunization administration includes content from EDQM Standard Terms. While this additional binding is not primarily used in the Canadian healthcare context, it is retained to support potential use of PS-CA internationally and IPS within Canada. Implementers should be aware that this binding may not comprehensively represent all Canadian route of administration codes."
}
],
},
{
{
},
{
},
{
"valueMarkdown": "The path the administered medication takes to get into the body or into contact with the body. While not the preferred terminology for broader pan-Canadian exchange use cases, this additional binding is surfaced to socialize the value sets that may be more commonly in use. Where multiple codings can be supplied, it is encouraged to supply the original coding alongside the pan-Canadian preferred terminology."
}
],
}
],
}
},
{
"comment": "See additionalBinding extension.\n\n IPS-UV no longer flags this as a Must Support element. It is not currently flagged as Must Support in PS-CA, as stakeholders have indicated the element may not be supported by the majority of systems today.\n\nSystems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received.",
{
{
},
{
},
{
"valueMarkdown": "IPS Vaccine target disease codes value set. This value set includes codes from SNOMED CT"
}
],
}
],
}
}
]
}
}
Terminology bindings (Differential)
| Path | Conformance | ValueSet |
|---|---|---|
| Immunization.vaccineCode | preferred | https://fhir.infoway-inforoute.ca/ValueSet/vaccineadministeredtradenamecode |
| Immunization.site | preferred | https://fhir.infoway-inforoute.ca/ValueSet/immunizationadministrationanatomicalsitecode |
| Immunization.route | preferred | https://fhir.infoway-inforoute.ca/ValueSet/immunizationrouteofadministrationcode |
| Immunization.protocolApplied.targetDisease | preferred | https://fhir.infoway-inforoute.ca/ValueSet/vaccinepreventablediseasecode |
Terminology bindings (Snapshot)
Constraints
Key Differences between the IPS-UV and PS-CA
Must Support Differences:
The following elements are considered Must Support in the Immunization (IPS) profile that are relaxed in this version of the PS-CA profile:
Immunization.occurrence[x]: data-absent-reasonNote: Systems that support these elements are encouraged to send them in patient summaries
Cardinality Differences:
There are no cardinality differences between this profile and IPS-UV
Vocabulary Differences:
Immunization.vaccineCode- added preferred binding of SNOMED CT Canadian Edition VaccineAdministeredTradeNameCode
- Note: VaccineHistoricalNameCode, PassiveAdministeredImmunizingAgentCode, and PassiveHistoricalImmunizingAgentCode equivalently preferred to the primary binding as they convey codes that are intended to be utilized in different contexts (e.g., passive agents)
- The National Vaccine Catalogue leverages the Canada Health Infoway SNOMED CT Canadian Edition Immunization Terminology, developed and maintained with the support of the Canadian Public Health Surveillance Community. NVC adds additional product details (such as Health Canada lot numbers, expiry dates, and DINs) to provide a consistent framework for vaccine data in Canada. NVC delivers the integrated, operationally ready content required for standardized data collection, vaccine coverage surveillance, inventory management, and immunization programming in Canada.
- additionalBindings added for:
- SNOMED CT Canadian Edition Vaccine Historical Name VaccineHistoricalNameCode,
- SNOMED CT Canadian Edition Passive Administered Immunizing Agent Code PassiveAdministeredImmunizingAgentCode,
- SNOMED CT Canadian Edition Passive Historical Immunizing Agent Code PassiveHistoricalImmunizingAgentCode,
- IPS Vaccine Code VaccinesUvIps
- WHO ATC WhoAtcUvIps,
- absent or unknown immunizations AbsentOrUnknownImmunizationsUvIps IPS absent/unknown ValueSets have been deprecated as of IPS 2.0.0-ballot and subsumed into their VaccinesUvIps. This change is pending analysis & alignment in a future update.
- added preferred binding of SNOMED CT Canadian Edition VaccineAdministeredTradeNameCode
Immunization.route- added preferred binding of ImmunizationRouteOfAdministrationCode
- additionalBindings added for:
- EDQM route of administration MedicineRouteOfAdministrationUvIps,
- HL7 v3 route of administration v3.RouteOfAdministration
Immunization.protocolApplied.targetDisease- added preferred binding of VaccinePreventableDiseaseCode
- additionalBindings added for:
- IPS VaccineTargetDisease Code VaccineTargetDiseasesUvIps
Other differences between the IPS and PS-CA Include:
- Data type profiles (e.g., CodeableConcept) and reference targets (e.g., Patient) replaced with PS-CA equivalents when appropriate
Immunization.vaccineCode: IPS datatype profiling removed