{
"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 - CACDI",
"identity": "pCHDCF-CACDI"
} ],
"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.3.1-dft-ballot",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "code",
"valueCode": "SHALL:able-to-populate"
}, {
"url": "elementId",
"valueString": "Immunization.vaccineCode"
}, {
"url": "elementId",
"valueString": "Immunization.vaccineCode.coding"
}, {
"url": "elementId",
"valueString": "Immunization.vaccineCode.coding.code"
}, {
"url": "elementId",
"valueString": "Immunization.vaccineCode.coding.display"
}, {
"url": "elementId",
"valueString": "Immunization.patient"
}, {
"url": "elementId",
"valueString": "Immunization.occurrence[x]:occurrenceDateTime"
}, {
"url": "elementId",
"valueString": "Immunization.reportOrigin"
}, {
"url": "elementId",
"valueString": "Immunization.reportOrigin.coding"
}, {
"url": "elementId",
"valueString": "Immunization.reportOrigin.coding.system"
}, {
"url": "elementId",
"valueString": "Immunization.reportOrigin.coding.code"
}, {
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/server"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "code",
"valueCode": "SHALL:handle"
}, {
"url": "elementId",
"valueString": "Immunization.vaccineCode"
}, {
"url": "elementId",
"valueString": "Immunization.vaccineCode.coding"
}, {
"url": "elementId",
"valueString": "Immunization.vaccineCode.coding.code"
}, {
"url": "elementId",
"valueString": "Immunization.vaccineCode.coding.display"
}, {
"url": "elementId",
"valueString": "Immunization.patient"
}, {
"url": "elementId",
"valueString": "Immunization.occurrence[x]:occurrenceDateTime"
}, {
"url": "elementId",
"valueString": "Immunization.reportOrigin"
}, {
"url": "elementId",
"valueString": "Immunization.reportOrigin.coding"
}, {
"url": "elementId",
"valueString": "Immunization.reportOrigin.coding.system"
}, {
"url": "elementId",
"valueString": "Immunization.reportOrigin.coding.code"
}, {
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/client"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-imposeProfile",
"valueCanonical": "http://hl7.org/fhir/ca/baseline/StructureDefinition/profile-immunization"
} ],
"status": "draft",
"id": "7627e4b7-2c93-4042-b628-2a9683c162d1",
"kind": "resource",
"url": "http://fhir.infoway-inforoute.ca/ca-core/StructureDefinition/immunization-ca-core",
"version": null,
"differential": {
"element": [ {
"id": "Immunization",
"path": "Immunization",
"mapping": [ {
"map": "Immunization",
"identity": "pCHDCF-CACDI"
} ],
"constraint": [ {
"key": "ca-core-im-1",
"human": "Immunization records created during an encounter event are expected to have occurrence populated. Occurrence SHALL be present if the primarySource is 'true'",
"severity": "warning",
"expression": "Immunization.primarySource = true implies Immunization.occurrence.exists()"
} ]
}, {
"id": "Immunization.vaccineCode",
"min": 1,
"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": "Drug",
"identity": "pCHDCF-CACDI"
} ],
"mustSupport": true
}, {
"id": "Immunization.vaccineCode.coding",
"min": 1,
"path": "Immunization.vaccineCode.coding",
"mustSupport": true
}, {
"id": "Immunization.vaccineCode.coding.code",
"min": 1,
"path": "Immunization.vaccineCode.coding.code",
"mapping": [ {
"map": "Drug Code",
"identity": "pCHDCF-CACDI"
} ],
"mustSupport": true
}, {
"id": "Immunization.vaccineCode.coding.display",
"path": "Immunization.vaccineCode.coding.display",
"mapping": [ {
"map": "Drug English Description",
"comment": "Display may be populated with english or french description depending on the context of the primary language for the user at the time this code is selected. Secondary or translated coding.display values should be conveyed using the translation extension",
"identity": "pCHDCF-CACDI"
}, {
"map": "Drug French Description",
"comment": "Display may be populated with english or french description depending on the context of the primary language for the user at the time this code is selected. Secondary or translated coding.display values should be conveyed using the translation extension",
"identity": "pCHDCF-CACDI"
} ],
"mustSupport": true
}, {
"id": "Immunization.vaccineCode.coding.display.extension:translation",
"path": "Immunization.vaccineCode.coding.display.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/StructureDefinition/translation" ]
} ],
"sliceName": "translation"
}, {
"id": "Immunization.patient",
"path": "Immunization.patient",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://fhir.infoway-inforoute.ca/ca-core/StructureDefinition/patient-ca-core" ]
} ],
"mapping": [ {
"map": "Patient",
"identity": "pCHDCF-CACDI"
} ],
"mustSupport": true
}, {
"id": "Immunization.occurrence[x]",
"path": "Immunization.occurrence[x]",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "$this",
"type": "type"
} ]
}
}, {
"id": "Immunization.occurrence[x]:occurrenceDateTime",
"path": "Immunization.occurrence[x]",
"type": [ {
"code": "dateTime"
} ],
"comment": "Immunizations",
"mapping": [ {
"map": "Patient Provided Immunization Date",
"identity": "pCHDCF-CACDI"
}, {
"map": "Event Start Date Time",
"identity": "pCHDCF-CACDI"
} ],
"sliceName": "occurrenceDateTime",
"mustSupport": true
}, {
"id": "Immunization.primarySource",
"path": "Immunization.primarySource",
"comment": "Immunization records created during an encounter event are expected to have occurrence populated"
}, {
"id": "Immunization.reportOrigin",
"path": "Immunization.reportOrigin",
"comment": "The historical nature of an immunization that is patient reported is expected to be expressed in this field.",
"mustSupport": true
}, {
"id": "Immunization.reportOrigin.coding",
"path": "Immunization.reportOrigin.coding",
"mustSupport": true
}, {
"id": "Immunization.reportOrigin.coding.code",
"min": 1,
"path": "Immunization.reportOrigin.coding.code",
"mapping": [ {
"map": "Immunization Reporting Source Code",
"identity": "pCHDCF-CACDI"
} ],
"mustSupport": true
} ]
},
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Immunization"
}