Terminology Index > Terminology
Terminology
This section lists the coded value sets that are referenced by the FHIR profiles in this implementation guide. These coded values are used to describe and standardize clinical concepts and other data content within health records.
Usage Guidance
Several ValueSets are not available at their canonical URL (e.g., CVC published value sets) or on the terminology servers used in implementation guide publication (i.e., tx.fhir.org). Primarily, this impacts validation against Canada Health Infoway-hosted ValueSets during the development of derived Implementation Guides. This does not affect deployed systems as these instances will be validated against loaded terminology. For several of these ValueSets, "stub" resources have been created to stand-in for the unresolvable ValueSets. These stub ValueSets include pointers to the locations where the full value sets can be downloaded. Current guidance is to manually download the value sets from, for example, the Terminology Gateway or Canadian Vaccine Catalogue. When terminology is not readily available as FHIR® Release 4 ValueSets or CodeSystems, implementers should work with terminology producers to identify options.
Proposed Pan-Canadian Value Sets
These are value sets that are proposed by the Ontario Patient Summary as the national standardized terminologies that implementers are encouraged to align to. SNOMED CT Canadian Edition (SNOMED CT-CA) is the terminology generally recommended for use in Canada, but in some cases the Ontario Patient Summary will also propose the use of other terminologies (e.g., CVC, CCDD, etc.) that have widespread adoption across Canada. While adoption of the national and global value sets is critical for national and global interoperability, recent feedback from participating jurisdictions has outlined the need to prioritize domestic jurisdictional exchange over global exchange in early versions of the specification and as such additional allowed bindings to other value sets are mentioned in the individual profiles, and while implementers are encouraged to align to the proposed pan-Canadian value sets, they should be aware that patient summaries may contain concepts from these other terminologies.
* Use of terminology subsets hosted on Canada Health Infoway Terminology Gateway is recommended in this interoperability specification.
** Use of terminology subsets hosted on the Canadian Vaccine Catalogue is recommended in this interoperability specification. Please note that Canadian Vaccine Catalogue (CVC)-published value set urls are currently not resolvable, but details of the referenced value sets are available in the current version of the CVC accessible here: https://cvc.canimmunize.ca/en/explore#/
Required, Extensible and Preferred Value Sets referenced by this implementation guide:
| Profile - Element | Binding Strength | Value Set (Code System) | Description |
|---|---|---|---|
| AllergyIntolerance (PS-ON) - AllergyIntolerance.code | Preferred | PharmaceuticalBiologicProductAndSubstanceCode * (SNOMED CT-CA) |
Codes for allergy or intolerance from the Infoway Substance Code and Pharmaceutical/Biologic Product Code value sets. |
| AllergyIntolerance (PS-ON) - AllergyIntolerance.code | Preferred | NoAllergiesInfoUvIps (IPS) | Negation/exclusion codes for reporting no known allergies or not available data. |
| AllergyIntolerance (PS-ON) - AllergyIntolerance.reaction.manifestation | Preferred | ClinicalFindingCode* (SNOMED CT-CA) |
This value set includes codes from SNOMED Clinical Terms® Canadian edition: all descendants of Value set that contains all subtypes of the concept 404684003 - Clinical finding (finding) - from the SNOMED CT Canadian Edition. |
| AllergyIntolerance (PS-ON) - AllergyIntolerance.reaction.severity | Required | AllergyIntoleranceSeverity (HL7 FHIR) | Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations. |
| AllergyIntolerance (PS-ON) - AllergyIntolerance.type | Required | AllergyIntoleranceType (HL7 FHIR) | Identification of the underlying physiological mechanism for a Reaction Risk. |
| Composition (PS-ON) - Composition.attester.mode | Required | CompositionAttestationMode (HL7 FHIR) | The way in which a person authenticated a composition. |
| Composition (PS-ON) - Composition.relatesTo.code | Required | DocumentRelationshipType (HL7 FHIR) | The type of relationship between documents. |
| Composition (PS-ON) - Composition.section.code | Required | DocumentSectionCodes (LOINC) | Classification of a section of a composition/document. |
| Composition (PS-ON) - Composition.status | Required | CompositionStatus (HL7 FHIR) | The workflow/clinical status of the composition |
| Condition (PS-ON) - Condition.bodySite | Preferred | AnatomicalOrAcquiredBodyStructureCode* (SNOMED CT-CA) |
This subset contains concepts that represent body structures including anatomical structures and acquired body structures. |
| Condition (PS-ON) - Condition.clinicalStatus | Required | ConditionClinicalStatusCodes (HL7 FHIR) | The clinical status of the condition or diagnosis. |
| Condition (PS-ON) - Condition.code | Preferred | ClinicalFindingCode* (SNOMED CT-CA) |
This value set includes codes from SNOMED Clinical Terms® Canadian edition: all descendants of Value set that contains all subtypes of the concept 404684003 - Clinical finding (finding) - from the SNOMED CT Canadian Edition. |
| Condition (PS-ON) - Condition.code | Preferred | NoProbsInfoUvIps (IPS) | Code representing the statement "absent problem" or the statement "problems unknown" |
| Condition (PS-ON) - Condition.severity | Preferred | SeverityCode * (SNOMED CT-CA) |
Code for the severity of a problem that is selected from the SNOMED CT Canadian edition value set. |
| Immunization (PS-ON) - Immunization.occurrence.dataAbsentReason | Required | DataAbsentReason (HL7 FHIR) | Used to specify why the normally expected content of the data element is missing. |
| Immunization (PS-ON) - Immunization.protocolApplied.targetDisease | Preferred | Disease** (SNOMED CT-CA) |
Code for a disease the vaccination is against from the Canadian Vaccine Catalogue code set. |
| Immunization (PS-ON) - Immunization.route | Preferred | RouteOfAdmin** (SNOMED CT-CA) |
The route by which the vaccine was administered. |
| Immunization (PS-ON) - Immunization.site | Preferred | AnatomicalSite** (SNOMED CT-CA) |
The site at which the vaccine was administered. |
| Immunization (PS-ON) - Immunization.status | Required | ImmunizationStatusCodes (HL7 FHIR) | A set of codes indicating the current status of an Immunization. |
| Immunization (PS-ON) - Immunization.vaccineCode | Preferred | Generic** (SNOMED CT-CA) |
The code for vaccine product administered. |
| Immunization (PS-ON) - Immunization.vaccineCode | Preferred | Tradename** (SNOMED CT-CA) |
The code for vaccine product administered. |
| Immunization (PS-ON) - Immunization.vaccineCode | Preferred | NoImmunizationInfoUvIps (IPS) | A reference to a code indicating that there there are no known immunizations or that this information is unknown. |
| Medication (PS-ON) - Medication.code | Preferred | PrescriptionMedicinalProduct * (CCDD) |
Medicinal products for prescribing and dispensing in Canada. The content of this subset only contains commonly used medicinal products that are available for prescribing and dispensing in Canada. This content will expand to include all human medicinal products over time. |
| Medication (PS-ON) - Medication.code | Preferred | Licenced Natural Health Products * (HL7 v3-hc-npn) |
Value set consisting of all Natural Product Number (NPN) and Homepathic Medicine Number (DIN-HM) codes that are licensed by Health Canada and present in the Licensed Natural Health Products Database. |
| Medication (PS-ON) - Medication.form | Preferred | PharmaceuticalDoseFormCode * (SNOMED CT-CA) |
A coded concept defining the form of a medication. SNOMED CT Canadian edition dose forms |
| Medication (PS-ON) - Medication.ingredient.itemCodeableConcept | Preferred | DrugOrMedicamentSubstanceCode * (SNOMED CT-CA) |
SNOMED CT Canadian edition drug active substances |
| MedicationRequest (PS-ON) - MedicationRequest.medication | Preferred | PrescriptionMedicinalProduct * (CCDD) |
Medicinal products for prescribing and dispensing in Canada. The content of this subset only contains commonly used medicinal products that are available for prescribing and dispensing in Canada. This content will expand to include all human medicinal products over time. |
| MedicationRequest (PS-ON) - MedicationRequest.status | Required | Medicationrequest Status Codes (HL7 FHIR) | A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription. |
| MedicationStatement (PS-ON) - MedicationStatement.effective.dataAbsentReason | Required | DataAbsentReason (HL7 FHIR) | Used to specify why the normally expected content of the data element is missing. |
| MedicationStatement (PS-ON) - MedicationStatement.status | Required | Medication Status Codes (HL7 FHIR) | A coded concept indicating the current status of a MedicationStatement. |
| MedicationStatement (PS-ON) - MedicationStatement.medication | Preferred | NoMedsInfoUvIps (IPS) | Representation of unknown or absent medications |
| Patient (PS-ON) - Patient.communication.language | Required | AllLanguages (urn:ietf:bcp:47) | A human language |
| Patient (PS-ON) - Patient.gender | Required | AdministrativeGender (HL7 FHIR) | The gender of a person used for administrative purposes. |
| Patient (PS-ON) - Patient.identifier.type | Extensible | Identifier Type Codes (HL7 v2) | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose |
| PractitionerRole (PS-ON) - PractitionerRole.code:HealthcareProviderRoleType | Preferred | HealthcareProviderRoleType * (CHI) |
A role type that is used to categorize an entity that delivers health care in an expected and professional manner to an entity in need of health care services. Examples: Registered Nurse, Chiropractor, Physician, Custodial Care Clinic. |
| Procedure (PS-ON) - Procedure.bodySite | Preferred | AnatomicalOrAcquiredBodyStructureCode* (SNOMED CT-CA) |
This subset contains concepts that represent body structures including anatomical structures and acquired body structures. |
| Procedure (PS-ON) - Procedure.code | Preferred | NoProceduresInfoUvIps (IPS) | A code to identify absent or unknown procedures |
| Procedure (PS-ON) - Procedure.code | Preferred | ProcedureCode * (SNOMED CT-CA) |
SNOMED CT Canadian codes to describe Services/Activities performed by Primary Health Care Providers. |
| Procedure (PS-ON) - Procedure.performed.dataAbsentReason | Required | DataAbsentReason (HL7 FHIR) | Used to specify why the normally expected content of the data element is missing. |
| Procedure (PS-ON) - Procedure.status | Required | EventStatus (HL7 FHIR) | A code specifying the state of the procedure. |