{
"description": "This profile represents the constraints applied to the Immunization resource by the CA Core+ project to represent the minimum expectations for the Immunization resource when used to promote capacity building for functionality found across Canadian FHIR implementations. It is informed by the constraints of shared across CIHI pCHDCF data sets and has also undergone analysis to assert alignment with the [Canadian Baseline Immunization Profile](http://build.fhir.org/ig/HL7-Canada/ca-baseline/branches/master/StructureDefinition-profile-immunization.html)",
"_filename": "structuredefinition-immunization-ca-core.json",
"package_name": "ca.infoway.io.core",
"date": null,
"derivation": "constraint",
"publisher": null,
"fhirVersion": "4.0.1",
"name": "ImmunizationCACore",
"mapping": [ {
"name": "Pan-Canadian Health Data Content Framework",
"identity": "pCHDCF"
} ],
"abstract": false,
"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).",
"type": "Immunization",
"experimental": "false",
"resourceType": "StructureDefinition",
"title": "Immunization (CA-Core)",
"package_version": "0.2.0-dft",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-imposeProfile",
"valueCanonical": "http://hl7.org/fhir/ca/baseline/StructureDefinition/profile-immunization"
} ],
"status": "draft",
"id": "16cdfadf-8dd2-450d-8b69-7a2cc24f13ea",
"kind": "resource",
"url": "http://fhir.infoway-inforoute.ca/ca-core/StructureDefinition/immunization-ca-core",
"version": null,
"differential": {
"element": [ {
"id": "Immunization.extension:supportingInformation",
"path": "Immunization.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.supportingInformation" ]
} ],
"comment": "This extension is used to pre-adopt an element from FHIR R5 Immunization",
"mapping": [ {
"map": "Immunization Supporting Documents",
"identity": "pCHDCF"
} ],
"sliceName": "supportingInformation"
}, {
"id": "Immunization.status",
"path": "Immunization.status",
"mapping": [ {
"map": "Immunization Status",
"identity": "pCHDCF"
} ]
}, {
"id": "Immunization.statusReason",
"path": "Immunization.statusReason",
"binding": {
"strength": "preferred",
"valueSet": "https://fhir.infoway-inforoute.ca/ValueSet/actnoimmunizationreason"
},
"mapping": [ {
"map": "Immunization Reason Not Performed",
"identity": "pCHDCF"
} ]
}, {
"id": "Immunization.vaccineCode",
"path": "Immunization.vaccineCode",
"binding": {
"strength": "preferred",
"valueSet": "https://fhir.infoway-inforoute.ca/ValueSet/vaccineadministeredtradenamecode",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/additional-binding",
"extension": [ {
"url": "purpose",
"valueCode": "candidate"
}, {
"url": "valueSet",
"valueCanonical": "https://fhir.infoway-inforoute.ca/ValueSet/vaccinehistoricalnamecode"
}, {
"url": "documentation",
"valueMarkdown": "Recommended for use when conveying vaccine generic names for scenarios when brand name is not known or does not exist (e.g., immunization history where provider does not have detail of the trade name, the product has been discontinued and/or never licensed in Canada)."
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/additional-binding",
"extension": [ {
"url": "purpose",
"valueCode": "candidate"
}, {
"url": "valueSet",
"valueCanonical": "https://fhir.infoway-inforoute.ca/ValueSet/passiveadministeredimmunizingagentcode"
}, {
"url": "documentation",
"valueMarkdown": "per pCHDCF: Alternate value sets can be used when passive immunization products are used"
} ]
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/additional-binding",
"extension": [ {
"url": "purpose",
"valueCode": "candidate"
}, {
"url": "valueSet",
"valueCanonical": "https://fhir.infoway-inforoute.ca/ValueSet/passivehistoricalimmunizingagentcode"
}, {
"url": "documentation",
"valueMarkdown": "per pCHDCF: Alternate value sets can be used when passive immunization products are used"
} ]
} ],
"description": "Codes from the National Vaccine Catalogue Vaccine Administered Trade Name Code ValueSet."
},
"comment": "The additionalBinding extension will be used to express the valueSet for additional negation/exclusion codes for reporting the known absence of immunizations. At the time of this release, the publisher of the current ValueSet for absence codes (IPS) is developing a SNOMED ValueSet that will replace the current http://hl7.org/fhir/uv/ips/ValueSet/absent-or-unknown-immunizations-uv-ips",
"mapping": [ {
"map": "Immunization Name",
"identity": "pCHDCF"
} ]
}, {
"id": "Immunization.patient",
"path": "Immunization.patient",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://fhir.infoway-inforoute.ca/ca-core/StructureDefinition/patient-ca-core" ]
} ]
}, {
"id": "Immunization.occurrence[x]",
"path": "Immunization.occurrence[x]",
"mapping": [ {
"map": "Immunization Date*",
"comment": "*Mapping of this concept could apply to both the dateTime and string data types, however dateTime is the primary mapping and preferred dataType to support to promote the capabilities to capture structured data",
"identity": "pCHDCF"
}, {
"map": "Immunization Reason Not Performed Date*",
"comment": "*Mapping applies when the status is 'not-done'. Mapping of this concept could apply to both the dateTime and string data types, however dateTime is the primary mapping and preferred dataType to support to promote the capabilities to capture structured data",
"identity": "pCHDCF"
} ],
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "$this",
"type": "type"
} ]
}
}, {
"id": "Immunization.occurrence[x]:occurrenceDateTime",
"path": "Immunization.occurrence[x]",
"type": [ {
"code": "dateTime"
} ],
"mapping": [ {
"map": "Immunization Date",
"identity": "pCHDCF"
}, {
"map": "Immunization Reason Not Performed Date",
"comment": "Mapping applies when the status is 'not-done'",
"identity": "pCHDCF"
} ],
"sliceName": "occurrenceDateTime"
}, {
"id": "Immunization.occurrence[x]:occurrenceString",
"path": "Immunization.occurrence[x]",
"type": [ {
"code": "string"
} ],
"mapping": [ {
"map": "Immunization Date*",
"comment": "*Mapping of this concept could apply to both the dateTime and string data types, however dateTime is the primary mapping and preferred dataType to support to promote the capabilities to capture structured data",
"identity": "pCHDCF"
}, {
"map": "Immunization Reason Not Performed Date*",
"comment": "*Mapping applies when the status is 'not-done'. Mapping of this concept could apply to both the dateTime and string data types, however dateTime is the primary mapping and preferred dataType to support to promote the capabilities to capture structured data",
"identity": "pCHDCF"
} ],
"sliceName": "occurrenceString"
}, {
"id": "Immunization.reportOrigin",
"path": "Immunization.reportOrigin",
"mapping": [ {
"map": "Immunization Reporting Source",
"identity": "pCHDCF"
} ]
}, {
"id": "Immunization.manufacturer",
"path": "Immunization.manufacturer",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://fhir.infoway-inforoute.ca/ca-core/StructureDefinition/organization-ca-core", "http://hl7.org/fhir/StructureDefinition/Organization" ]
} ],
"mapping": [ {
"map": "Immunization Manufacturer",
"identity": "pCHDCF"
} ]
}, {
"id": "Immunization.lotNumber",
"path": "Immunization.lotNumber",
"mapping": [ {
"map": "Immunization Lot Number",
"identity": "pCHDCF"
} ]
}, {
"id": "Immunization.expirationDate",
"path": "Immunization.expirationDate",
"mapping": [ {
"map": "Immunization Expiration Date",
"identity": "pCHDCF"
} ]
}, {
"id": "Immunization.site",
"path": "Immunization.site",
"binding": {
"strength": "preferred",
"valueSet": "https://fhir.infoway-inforoute.ca/ValueSet/immunizationadministrationanatomicalsitecode"
},
"mapping": [ {
"map": "Immunization Site",
"identity": "pCHDCF"
} ]
}, {
"id": "Immunization.route",
"path": "Immunization.route",
"comment": "The preferred binding for this element is forthcoming in pCHDCF",
"mapping": [ {
"map": "Immunization Route of Administration",
"identity": "pCHDCF"
} ]
}, {
"id": "Immunization.doseQuantity",
"path": "Immunization.doseQuantity",
"type": [ {
"code": "Quantity",
"profile": [ "http://fhir.infoway-inforoute.ca/ca-core/StructureDefinition/drug-quantity-ca-core" ]
} ],
"mapping": [ {
"map": "Immunization Dose Volume",
"comment": "Use of volume in concept may imply that further dataType sub-elements may be required (e.g., coded units to express volume). Further mapping may be applied as this concept is refined in the pCHDCF",
"identity": "pCHDCF"
} ]
}, {
"id": "Immunization.doseQuantity.value",
"path": "Immunization.doseQuantity.value",
"mapping": [ {
"map": "Immunization Dose Volume*",
"comment": "*Mapping has been applied to indicate the sub-element that conveys a value for the concept",
"identity": "pCHDCF"
} ]
}, {
"id": "Immunization.doseQuantity.unit",
"path": "Immunization.doseQuantity.unit",
"mapping": [ {
"map": "Immunization Dose Volume*",
"comment": "*To fully provide meaning to volume value under this definition, value and unit sub-elements must be used together",
"identity": "pCHDCF"
} ]
}, {
"id": "Immunization.performer",
"path": "Immunization.performer"
}, {
"id": "Immunization.performer.function",
"path": "Immunization.performer.function",
"mapping": [ {
"map": "Immunization Reaction Reporter*",
"comment": "*The current definition for this concept implies that the performer is understood with a given function (reporter). The mapping is also based on the assumption that the reaction is captured within the record of the immunization event (instead of as an AdverseEvent or AllergyIntolerance). To fully provide meaning to performer under this definition, the Immunization.performer.function element must also be used. The mapping proposed is based on similar structures in national base implementation guides for other roles (e.g., approvers). Reviewers are encouraged to provide feedback on the mapping for this element compared to other alternatives (e.g. extensions, representation in AdverseEvent).",
"identity": "pCHDCF"
} ]
}, {
"id": "Immunization.performer.actor",
"path": "Immunization.performer.actor",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://fhir.infoway-inforoute.ca/ca-core/StructureDefinition/practitioner-ca-core", "http://fhir.infoway-inforoute.ca/ca-core/StructureDefinition/practitionerRole-ca-core", "http://fhir.infoway-inforoute.ca/ca-core/StructureDefinition/organization-ca-core", "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/Organization" ]
} ],
"mapping": [ {
"map": "Immunization Reaction Reporter*",
"comment": "*The current definition for this concept implies that the performer is understood with a given function (reporter). The mapping is also based on the assumption that the reaction is captured within the record of the immunization event (instead of as an AdverseEvent or AllergyIntolerance). To fully provide meaning to performer under this definition, the Immunization.performer.function element must also be used. The mapping proposed is based on similar structures in national base implementation guides for other roles (e.g., approvers). Reviewers are encouraged to provide feedback on the mapping for this element compared to other alternatives (e.g. extensions, representation in AdverseEvent).",
"identity": "pCHDCF"
} ]
}, {
"id": "Immunization.reasonCode",
"path": "Immunization.reasonCode",
"binding": {
"strength": "preferred",
"valueSet": "https://fhir.infoway-inforoute.ca/ValueSet/actimmunizationreason"
},
"mapping": [ {
"map": "Immunization Reason",
"identity": "pCHDCF"
} ]
}, {
"id": "Immunization.subpotentReason",
"path": "Immunization.subpotentReason",
"comment": "The preferred binding for this element is forthcoming in pCHDCF",
"mapping": [ {
"map": "Immunization Subpotent Reason",
"identity": "pCHDCF"
} ]
}, {
"id": "Immunization.education",
"path": "Immunization.education",
"comment": "While the FHIR R4 Immunization resource has the education element, it was removed in later releases of FHIR and replaced with guidance to convey details on the education provided to the person using the Communication resource. To maximize compatibility with future versions of FHIR, Communication is recommended over Immunization.education"
}, {
"id": "Immunization.reaction",
"path": "Immunization.reaction",
"binding": {
"strength": "preferred",
"valueSet": "https://fhir.infoway-inforoute.ca/ValueSet/PHCVScode"
},
"comment": "The FHIR Base Specification advises that if Immunization.reaction is deemed to be an indication of an allergy or intolerance, a separate AllergyIntolerance resource instance should be created to indicate it, as most systems will not query against past Immunization.reaction"
}, {
"id": "Immunization.reaction.date",
"path": "Immunization.reaction.date",
"mapping": [ {
"map": "Immunization Reaction Date",
"identity": "pCHDCF"
}, {
"map": "Immunization Reaction Time",
"identity": "pCHDCF"
} ]
}, {
"id": "Immunization.reaction.detail",
"path": "Immunization.reaction.detail",
"mapping": [ {
"map": "Immunization Reaction*",
"comment": "*This mapping is inexact and the pCHDCF concept definition may need to be further refined to determine if the details are more appropriately housed in the AllergyIntolerance or AdverseEvent resources. Reviewers are encouraged to provide feedback on how this concept is currently captured in their systems today",
"identity": "pCHDCF"
} ]
}, {
"id": "Immunization.protocolApplied",
"path": "Immunization.protocolApplied"
}, {
"id": "Immunization.protocolApplied.series",
"path": "Immunization.protocolApplied.series",
"mapping": [ {
"map": "Immunization Protocol Series",
"identity": "pCHDCF"
} ]
}, {
"id": "Immunization.protocolApplied.authority",
"path": "Immunization.protocolApplied.authority",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://fhir.infoway-inforoute.ca/ca-core/StructureDefinition/organization-ca-core", "http://hl7.org/fhir/StructureDefinition/Organization" ]
} ],
"mapping": [ {
"map": "Immunization Protocol Authority",
"identity": "pCHDCF"
} ]
}, {
"id": "Immunization.protocolApplied.targetDisease",
"path": "Immunization.protocolApplied.targetDisease",
"binding": {
"strength": "preferred",
"valueSet": "https://fhir.infoway-inforoute.ca/ValueSet/vaccinepreventablediseasecode"
},
"mapping": [ {
"map": "Immunization Protocol Target Disease",
"identity": "pCHDCF"
} ]
}, {
"id": "Immunization.protocolApplied.doseNumber[x]",
"path": "Immunization.protocolApplied.doseNumber[x]",
"mapping": [ {
"map": "Immunization Dose Number*",
"comment": "*Mapping of this concept could apply to both the positiveInt and string data types, however string is the primary mapping and preferred dataType to support in order to maximize compatibility with future versions of FHIR (later versions of FHIR removing the positiveInt dataType from this element)",
"identity": "pCHDCF"
} ],
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "$this",
"type": "type"
} ]
}
}, {
"id": "Immunization.protocolApplied.doseNumber[x]:doseNumberPositiveInt",
"path": "Immunization.protocolApplied.doseNumber[x]",
"type": [ {
"code": "positiveInt"
} ],
"mapping": [ {
"map": "Immunization Dose Number*",
"comment": "*Mapping of this concept could apply to both the positiveInt and string data types, however string is the primary mapping and preferred dataType to support in order to maximize compatibility with future versions of FHIR (later versions of FHIR removing the positiveInt dataType from this element)",
"identity": "pCHDCF"
} ],
"sliceName": "doseNumberPositiveInt"
}, {
"id": "Immunization.protocolApplied.doseNumber[x]:doseNumberString",
"path": "Immunization.protocolApplied.doseNumber[x]",
"type": [ {
"code": "string"
} ],
"mapping": [ {
"map": "Immunization Dose Number",
"identity": "pCHDCF"
} ],
"sliceName": "doseNumberString"
}, {
"id": "Immunization.protocolApplied.seriesDoses[x]",
"path": "Immunization.protocolApplied.seriesDoses[x]",
"mapping": [ {
"map": "Immunization Series Doses*",
"comment": "*Mapping of this concept could apply to both the positiveInt and string data types, however string is the primary mapping and preferred dataType to support in order to maximize compatibility with future versions of FHIR (later versions of FHIR removing the positiveInt dataType from this element)",
"identity": "pCHDCF"
} ],
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "$this",
"type": "type"
} ]
}
}, {
"id": "Immunization.protocolApplied.seriesDoses[x]:seriesDosesPositiveInt",
"path": "Immunization.protocolApplied.seriesDoses[x]",
"type": [ {
"code": "positiveInt"
} ],
"mapping": [ {
"map": "Immunization Series Doses*",
"comment": "*Mapping of this concept could apply to both the positiveInt and string data types, however string is the primary mapping and preferred dataType to support in order to maximize compatibility with future versions of FHIR (later versions of FHIR removing the positiveInt dataType from this element)",
"identity": "pCHDCF"
} ],
"sliceName": "seriesDosesPositiveInt"
}, {
"id": "Immunization.protocolApplied.seriesDoses[x]:seriesDosesString",
"path": "Immunization.protocolApplied.seriesDoses[x]",
"type": [ {
"code": "string"
} ],
"mapping": [ {
"map": "Immunization Series Doses",
"identity": "pCHDCF"
} ],
"sliceName": "seriesDosesString"
} ]
},
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Immunization"
}