Source | ca.infoway.io.psca#1.0.1-alpha3:Pan-Canadian Patient Summary (v4.0.1) |
resourceType | StructureDefinition |
id | immunization-ca-ps |
canonical | http://fhir.infoway-inforoute.ca/io/psca/StructureDefinition/immunization-ca-ps |
version | 1.0.0 |
status | active |
publisher | Canada Health Infoway |
name | ImmunizationPSCA |
title | Immunization (PS-CA) |
date | 2022-07-28T01:23:00-08:00 |
experimental | false |
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 © 2021,2022 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). |
jurisdictions | ca |
fhirVersion | 4.0.1 |
kind | resource |
abstract | false |
sdTtype | Immunization |
derivation | constraint |
base | http://hl7.org/fhir/StructureDefinition/Immunization |
Usages |
|
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Immunization | Immunization | |||
status | S | |||
vaccineCode | S | 1..1 |
Vaccine that was administered or was to be administered. IPS-UV Note: Several kinds of vaccine product coding could be provided.
The 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.
Other 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. Binding: Canadian Vaccine Catalogue Vaccine Generic Names ( preferred ): Codes from the Canadian Vaccine Catalogue Generic Value Set. Use of Tradename Value Set is equivalently preferred. |
|
Slices for coding | Slice: Unordered, Open by pattern:$this | |||
coding:vaccineSctIpsFreeSet |
Optional slice for representing the code for vaccine from the SNOMED International Patient Set (IPS) subset of SNOMED CT (IPS Free Set). Binding: Vaccines - SNOMED CT IPS Free Set ( required ) |
|||
coding:atcClass |
Optional slice for representing the vaccine code from the WHO ATC classification Binding: WHO ATC - IPS ( required ) |
|||
coding:CVCTradename |
Optional slice for representing the codes from the Canadian Vaccine Catalogue Tradenames value set. Binding: Canadian Vaccine Catalogue Vaccine Tradenames ( required ) |
|||
coding:CVCGeneric |
Optional slice for representing the codes from the Canadian Vaccine Catalogue Generic names value set. Binding: Canadian Vaccine Catalogue Vaccine Generic Names ( required ) |
|||
coding:absentOrUnknownImmunization |
Optional slice for representing the codes for an Absent or Unknown Immunization Binding: Absent or Unknown Immunization - IPS ( required ) |
|||
patient | S | Reference (Patient (PS-CA)) | ||
reference | S | 1.. | ||
occurrence[x] | S | 1..1 | ||
Slices for extension | Slice: Unordered, Open by value:url | |||
data-absent-reason | S | 0..1 | code |
occurrence[x] absence reason URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: Data Absent Reason ( required ) |
site | CodeableConcept | Binding: Canadian Vaccine Catalogue Anatomical Site ( preferred ) | ||
Slices for coding | Slice: Unordered, Open by pattern:$this | |||
coding:siteIPS |
Optional slice for representing the site of an immunization from the IPS SNOMED CT value set. Binding: Target Site - IPS ( required ) |
|||
coding:siteCVC |
Optional slice for representing the site of an immunization from the Canadian Vaccine Catalogue Anatomical Site value set. Binding: Canadian Vaccine Catalogue Anatomical Site ( required ) |
|||
coding:HumanSubstanceAdministrationSiteV3 |
The set of body locations to or through which a drug product may be administered. Binding: todo ( required ) |
|||
route | CodeableConcept |
Binding:
Canadian Vaccine Catalogue Route of Administration
( preferred
): CVC Route of Administration |
||
Slices for coding | Slice: Unordered, Open by pattern:$this | |||
coding:routeEDQM |
Optional slice for representing the route of immunization administraction drawn from the EDQM value set. Binding: Medicine Route of Administration - IPS ( required ) |
|||
coding:routeCVC |
Optional slice for representing the route of immunization administraction drawn from the Canadian Vaccine Catalogue Route of Administration value set. Binding: Canadian Vaccine Catalogue Route of Administration ( required ) |
|||
coding:RouteOfAdministrationV3 |
The path the administered medication takes to get into the body or into contact with the body. Binding: todo ( required ) |
|||
protocolApplied | ||||
targetDisease | Binding: Canadian Vaccine Catalogue Vaccine Preventable Disease ( preferred ) | |||
Slices for coding | Slice: Unordered, Open by pattern:$this | |||
coding:targetDiseasesSctIpsFreeSet |
Optional slice for representing the code for a disease the vaccination is against from the SNOMED International Patient Set (IPS) subset of SNOMED CT (IPS Free Set). Binding: Vaccine Target Diseases - SNOMED CT IPS Free Set ( required ) |
|||
coding:targetDiseaseCVC |
Optional slice for representing the code for a disease the vaccination is against from the Canadian Vaccine Catalogue Disease value set. Binding: Canadian Vaccine Catalogue Vaccine Preventable Disease ( required ) |
|||
Documentation for this format |
Produced 06 Apr 2023