{ "resourceType": "StructureDefinition", "id": "immunization-ca-ps", "url": "http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/immunization-ca-ps", "version": "2.2.0", "name": "ImmunizationPSCA", "title": "Immunization (PS-CA)", "status": "draft", "experimental": false, "date": "2024-04-09T08:00:00+00:00", "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 allows 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).", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "Immunization", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Immunization", "derivation": "constraint", "differential": { "element": [ { "id": "Immunization.status", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/obligation", "extension": [ { "url": "code", "valueCode": "SHALL:populate" }, { "url": "actor", "valueCanonical": "http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer" } ] }, { "url": "http://hl7.org/fhir/StructureDefinition/obligation", "extension": [ { "url": "code", "valueCode": "SHALL:no-error" }, { "url": "actor", "valueCanonical": "http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer" } ] }, { "url": "http://hl7.org/fhir/StructureDefinition/obligation", "extension": [ { "url": "code", "valueCode": "SHALL:handle" }, { "url": "actor", "valueCanonical": "http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer" } ] }, { "url": "http://hl7.org/fhir/StructureDefinition/obligation", "extension": [ { "url": "code", "valueCode": "SHOULD:display" }, { "url": "actor", "valueCanonical": "http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer" } ] } ], "path": "Immunization.status", "mustSupport": true }, { "id": "Immunization.vaccineCode", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/obligation", "extension": [ { "url": "code", "valueCode": "SHALL:populate" }, { "url": "actor", "valueCanonical": "http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer" } ] }, { "url": "http://hl7.org/fhir/StructureDefinition/obligation", "extension": [ { "url": "code", "valueCode": "SHALL:no-error" }, { "url": "actor", "valueCanonical": "http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer" } ] }, { "url": "http://hl7.org/fhir/StructureDefinition/obligation", "extension": [ { "url": "code", "valueCode": "SHALL:handle" }, { "url": "actor", "valueCanonical": "http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer" } ] }, { "url": "http://hl7.org/fhir/StructureDefinition/obligation", "extension": [ { "url": "code", "valueCode": "SHOULD:display" }, { "url": "actor", "valueCanonical": "http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer" } ] } ], "path": "Immunization.vaccineCode", "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.\r\n\r\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.\r\n\r\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.", "mustSupport": true, "binding": { "strength": "preferred", "valueSet": "https://fhir.infoway-inforoute.ca/ValueSet/vaccineadministeredtradenamecode", "extension": [ { "extension": [ { "url": "purpose", "valueCode": "preferred" }, { "url": "valueSet", "valueCanonical": "https://fhir.infoway-inforoute.ca/ValueSet/vaccinehistoricalnamecode" }, { "url": "documentation", "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." } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/additional-binding" }, { "extension": [ { "url": "purpose", "valueCode": "preferred" }, { "url": "valueSet", "valueCanonical": "https://fhir.infoway-inforoute.ca/ValueSet/passiveadministeredimmunizingagentcode" }, { "url": "documentation", "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." } ], "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": "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." } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/additional-binding" }, { "extension": [ { "url": "purpose", "valueCode": "candidate" }, { "url": "valueSet", "valueCanonical": "http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips" }, { "url": "documentation", "valueMarkdown": "IPS Vaccine codes value set. This value set includes codes from SNOMED CT." } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/additional-binding" }, { "extension": [ { "url": "purpose", "valueCode": "candidate" }, { "url": "valueSet", "valueCanonical": "http://hl7.org/fhir/uv/ips/ValueSet/whoatc-uv-ips" }, { "url": "documentation", "valueMarkdown": "Code that is selected from the WHO ATC classification." } ], "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": "Code to identify absent or unknown immunizations." } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/additional-binding" } ], "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" } }, { "id": "Immunization.patient", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/obligation", "extension": [ { "url": "code", "valueCode": "SHALL:populate" }, { "url": "actor", "valueCanonical": "http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer" } ] }, { "url": "http://hl7.org/fhir/StructureDefinition/obligation", "extension": [ { "url": "code", "valueCode": "SHALL:no-error" }, { "url": "actor", "valueCanonical": "http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer" } ] }, { "url": "http://hl7.org/fhir/StructureDefinition/obligation", "extension": [ { "url": "code", "valueCode": "SHALL:handle" }, { "url": "actor", "valueCanonical": "http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer" } ] }, { "url": "http://hl7.org/fhir/StructureDefinition/obligation", "extension": [ { "url": "code", "valueCode": "SHOULD:display" }, { "url": "actor", "valueCanonical": "http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer" } ] } ], "path": "Immunization.patient", "type": [ { "code": "Reference", "targetProfile": [ "http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/patient-ca-ps" ] } ], "mustSupport": true }, { "id": "Immunization.patient.reference", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/obligation", "extension": [ { "url": "code", "valueCode": "SHALL:populate" }, { "url": "actor", "valueCanonical": "http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer" } ] }, { "url": "http://hl7.org/fhir/StructureDefinition/obligation", "extension": [ { "url": "code", "valueCode": "SHALL:no-error" }, { "url": "actor", "valueCanonical": "http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer" } ] }, { "url": "http://hl7.org/fhir/StructureDefinition/obligation", "extension": [ { "url": "code", "valueCode": "SHALL:handle" }, { "url": "actor", "valueCanonical": "http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer" } ] }, { "url": "http://hl7.org/fhir/StructureDefinition/obligation", "extension": [ { "url": "code", "valueCode": "SHOULD:display" }, { "url": "actor", "valueCanonical": "http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer" } ] } ], "path": "Immunization.patient.reference", "min": 1, "mustSupport": true }, { "id": "Immunization.occurrence[x]", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/obligation", "extension": [ { "url": "code", "valueCode": "SHALL:populate" }, { "url": "actor", "valueCanonical": "http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/producer" } ] }, { "url": "http://hl7.org/fhir/StructureDefinition/obligation", "extension": [ { "url": "code", "valueCode": "SHALL:no-error" }, { "url": "actor", "valueCanonical": "http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer" } ] }, { "url": "http://hl7.org/fhir/StructureDefinition/obligation", "extension": [ { "url": "code", "valueCode": "SHALL:handle" }, { "url": "actor", "valueCanonical": "http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer" } ] }, { "url": "http://hl7.org/fhir/StructureDefinition/obligation", "extension": [ { "url": "code", "valueCode": "SHOULD:display" }, { "url": "actor", "valueCanonical": "http://fhir.infoway-inforoute.ca/io/psca/ActorDefinition/consumer" } ] } ], "path": "Immunization.occurrence[x]", "mustSupport": true }, { "id": "Immunization.site", "path": "Immunization.site", "type": [ { "code": "CodeableConcept", "profile": [ "http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/CodeableConcept-ca-ps" ] } ], "binding": { "strength": "preferred", "valueSet": "https://fhir.infoway-inforoute.ca/ValueSet/immunizationadministrationanatomicalsitecode" } }, { "id": "Immunization.route", "path": "Immunization.route", "comment": "See additionalBinding extension.\r\n\r\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.", "type": [ { "code": "CodeableConcept", "profile": [ "http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/CodeableConcept-ca-ps" ] } ], "binding": { "strength": "preferred", "valueSet": "https://fhir.infoway-inforoute.ca/ValueSet/immunizationrouteofadministrationcode", "description": "The path or route by which the vaccine was administered.", "extension": [ { "extension": [ { "url": "purpose", "valueCode": "candidate" }, { "url": "valueSet", "valueCanonical": "http://hl7.org/fhir/uv/ips/ValueSet/medicine-route-of-administration" }, { "url": "documentation", "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." } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/additional-binding" }, { "extension": [ { "url": "purpose", "valueCode": "candidate" }, { "url": "valueSet", "valueCanonical": "http://terminology.hl7.org/ValueSet/v3-RouteOfAdministration" }, { "url": "documentation", "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." } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/additional-binding" } ] } }, { "id": "Immunization.protocolApplied.targetDisease", "path": "Immunization.protocolApplied.targetDisease", "comment": "See additionalBinding extension.\r\n\r\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.", "binding": { "strength": "preferred", "valueSet": "https://fhir.infoway-inforoute.ca/ValueSet/vaccinepreventablediseasecode", "extension": [ { "extension": [ { "url": "purpose", "valueCode": "candidate" }, { "url": "valueSet", "valueCanonical": "http://hl7.org/fhir/uv/ips/ValueSet/target-diseases-uv-ips" }, { "url": "documentation", "valueMarkdown": "IPS Vaccine target disease codes value set. This value set includes codes from SNOMED CT" } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/additional-binding" } ] } } ] } }