{ "resourceType": "StructureDefinition", "id": "profile-immunization", "url": "http://hl7.org/fhir/ca/baseline/StructureDefinition/profile-immunization", "version": "1.2.2", "name": "ImmunizationProfile", "title": "Immunization Profile", "status": "draft", "date": "2024-12-27", "publisher": "HL7 Canada - FHIR Implementation Work Group", "contact": [ { "telecom": [ { "system": "url", "value": "https://infocentral.infoway-inforoute.ca/en/collaboration/wg/fhir-implementations" } ] } ], "description": "Proposed constraints and extensions on the Immunization resource. Generated as a first step toward creating a set of Canadian Baseline FHIR profiles.", "jurisdiction": [ { "coding": [ { "system": "urn:iso:std:iso:3166", "code": "CA" } ] } ], "fhirVersion": "4.0.1", "mapping": [ { "identity": "workflow", "uri": "http://hl7.org/fhir/workflow", "name": "Workflow Pattern" }, { "identity": "v2", "uri": "http://hl7.org/v2", "name": "HL7 v2 Mapping" }, { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" }, { "identity": "w5", "uri": "http://hl7.org/fhir/fivews", "name": "FiveWs Pattern Mapping" }, { "identity": "cda", "uri": "http://hl7.org/v3/cda", "name": "CDA (R2)" } ], "kind": "resource", "abstract": false, "type": "Immunization", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Immunization", "derivation": "constraint", "differential": { "element": [ { "id": "Immunization", "path": "Immunization" }, { "id": "Immunization.statusReason", "path": "Immunization.statusReason", "comment": "CA Baseline Usage Notes: a reason should be provided if the status is \"not-done\"." }, { "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": "preferred" }, { "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)." } ] }, { "extension": [ { "url": "purpose", "valueCode": "preferred" }, { "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": "preferred" }, { "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" } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/additional-binding" }, { "extension": [ { "url": "purpose", "valueCode": "candidate" }, { "url": "valueSet", "valueCanonical": "http://hl7.org/fhir/uv/ips/ValueSet/absent-or-unknown-immunizations-uv-ips" }, { "url": "documentation", "valueMarkdown": "Absent or unknown codes" } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/additional-binding" } ] } }, { "id": "Immunization.patient", "path": "Immunization.patient", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/ca/baseline/StructureDefinition/profile-patient" ] } ] }, { "id": "Immunization.encounter", "path": "Immunization.encounter", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/ca/baseline/StructureDefinition/profile-encounter" ] } ] }, { "id": "Immunization.occurrence[x]", "path": "Immunization.occurrence[x]", "slicing": { "discriminator": [ { "type": "type", "path": "$this" } ], "ordered": false, "rules": "closed" }, "short": "Vaccine administration date", "definition": "Date vaccine administered or was to be administered.", "comment": "CA Baseline Usage Notes: While occurrenceString is allowed given its use in existing Canadian systems - a combination of occurrenceDateTime (full or partial) with the 'estimated' extension is the preferred mechanism for expressing when an exact date is unknown. For example, if a patient recalls that they were immunized in June 1980, occurrenceDateTime will have a partial date '1980-06' with 'estimated'=true. Another example: if in 2020, a 55 y.o. patient recalls that they were immunized at the age of 5, occurrenceDateTime will have a partial date '1970' with 'estimated'=true.", "min": 1, "max": "1", "base": { "path": "Immunization.occurrence[x]", "min": 1, "max": "1" }, "type": [ { "code": "dateTime" }, { "code": "string" } ] }, { "id": "Immunization.occurrence[x]:occurrenceDateTime", "path": "Immunization.occurrence[x]", "sliceName": "occurrenceDateTime", "short": "Vaccine administration date", "definition": "Date vaccine administered or was to be administered.", "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.", "min": 0, "max": "1", "base": { "path": "Immunization.occurrence[x]", "min": 1, "max": "1" }, "type": [ { "code": "dateTime" } ] }, { "id": "Immunization.occurrence[x]:occurrenceDateTime.extension", "path": "Immunization.occurrence[x].extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "ordered": false, "rules": "open" }, "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ] }, { "id": "Immunization.occurrence[x]:occurrenceDateTime.extension:estimated", "path": "Immunization.occurrence[x].extension", "sliceName": "estimated", "max": "1", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-dateestimated" ] } ], "mustSupport": false }, { "id": "Immunization.primarySource", "path": "Immunization.primarySource", "short": "Indicates that data is from the primary record created at the time the vaccine was administered." }, { "id": "Immunization.reportOrigin", "path": "Immunization.reportOrigin", "binding": { "strength": "preferred", "valueSet": "https://cvc.canimmunize.ca/v3/ValueSet/RepSource" } }, { "id": "Immunization.location", "path": "Immunization.location", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/ca/baseline/StructureDefinition/profile-location" ] } ] }, { "id": "Immunization.manufacturer", "path": "Immunization.manufacturer", "comment": "CA Baseline Usage Notes: This is a reference to an organization that manufactures the vaccine. TBD: if there is a need to reference a 'DPD Company', a new extension should be created and used. A 'DPD Company' name, as used in the Health Canada DPF, indicates the organization (company) that holds the authorization to place the product on the market in Canada. This may not be the company that has manufactured the product, but it is the company that holds the legal responsibility for the use of the product in Canada and should be the same as the company named on the product label/packaging.", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/ca/baseline/StructureDefinition/profile-organization" ] } ] }, { "id": "Immunization.site", "path": "Immunization.site", "binding": { "strength": "preferred", "valueSet": "https://cvc.canimmunize.ca/v3/ValueSet/AnatomicalSite" } }, { "id": "Immunization.route", "path": "Immunization.route", "binding": { "strength": "preferred", "valueSet": "https://cvc.canimmunize.ca/v3/ValueSet/RouteOfAdmin" } }, { "id": "Immunization.performer.actor", "path": "Immunization.performer.actor", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/ca/baseline/StructureDefinition/profile-practitioner", "http://hl7.org/fhir/ca/baseline/StructureDefinition/profile-practitionerrole", "http://hl7.org/fhir/ca/baseline/StructureDefinition/profile-organization" ] } ] }, { "id": "Immunization.reasonReference", "path": "Immunization.reasonReference", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/ca/baseline/StructureDefinition/profile-condition", "http://hl7.org/fhir/ca/baseline/StructureDefinition/profile-observation", "http://hl7.org/fhir/ca/baseline/StructureDefinition/profile-diagnosticreport", "http://hl7.org/fhir/ca/baseline/StructureDefinition/profile-diagnosticreportnote" ] } ] }, { "id": "Immunization.reaction.detail", "path": "Immunization.reaction.detail", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/ca/baseline/StructureDefinition/profile-observation" ] } ] }, { "id": "Immunization.protocolApplied.authority", "path": "Immunization.protocolApplied.authority", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/ca/baseline/StructureDefinition/profile-organization" ] } ] }, { "id": "Immunization.protocolApplied.targetDisease", "path": "Immunization.protocolApplied.targetDisease", "binding": { "strength": "preferred", "valueSet": "https://cvc.canimmunize.ca/v3/ValueSet/Disease" } } ] } }