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.
* Use of terminology subsets hosted on Canada Health Infoway Terminology Gateway is required in order to comply with this interoperability specification.
** Use of terminology subsets hosted on the Canadian Vaccine Catalogue is required in order to comply with 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#/
Value Sets referenced by this implementation guide:
Value Set | Description | Profile | Binding Strength |
---|---|---|---|
AdministrativeGender | The gender of a person used for administrative purposes. | Patient (PS-ON) - Patient.gender | Required |
AllergyIntoleranceClinicalStatusCodes | The clinical status of the allergy or intolerance. | AllergyIntolerance (PS-ON) - AllergyIntolerance.clinicalStatus | Required |
AllergyIntoleranceCriticality | Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance. | AllergyIntolerance (PS-ON) - AllergyIntolerance.criticality | Required |
AllergyIntoleranceSeverity | Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations. | AllergyIntolerance (PS-ON) - AllergyIntolerance.reaction.severity | Required |
AllergyIntoleranceStatusCode * |
Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. | AllergyIntolerance (PS-ON) - AllergyIntolerance.verificationStatus | Required |
AllergyIntoleranceType | Identification of the underlying physiological mechanism for a Reaction Risk. | AllergyIntolerance (PS-ON) - AllergyIntolerance.type | Required |
AllergyIntoleranceVerificationStatusCodes | Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. | AllergyIntolerance (PS-ON) - AllergyIntolerance.verificationStatus | Required |
AllLanguages | A human language | Patient (PS-ON) - Patient.communication.language | Required |
AnatomicalSite** |
The site at which the vaccine was administered. | Immunization (PS-ON) - Immunization.site | Preferred |
AnatomicalOrAcquiredBodyStructureCode* |
This subset contains concepts that represent body structures including anatomical structures and acquired body structures. | Condition (PS-ON) - Condition.bodySite Procedure (PS-ON) - Procedure.bodySite |
Preferred |
ClinicalFindingCode* |
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:codeSCTCA AllergyIntolerance (PS-ON) - AllergyIntolerance.reaction.manifestation |
Required |
CompositionAttestationMode | The way in which a person authenticated a composition. | Composition (PS-ON) - Composition.attester.mode | Required |
CompositionStatus | The workflow/clinical status of the composition | Composition (PS-ON) - Composition.status | Required |
ConditionCategoryCodes | A category assigned to the condition. | Condition (PS-ON) - Condition.category | Extensible |
ConditionClinicalStatusCodes | The clinical status of the condition or diagnosis. | Condition (PS-ON) - Condition.clinicalStatus | Required |
ConditionVerificationStatus | The verification status to support or decline the clinical status of the condition or diagnosis. | Condition (PS-ON) - Condition.verificationStatus | Required |
DataAbsentReason | Used to specify why the normally expected content of the data element is missing. | Immunization (PS-ON) - Immunization.occurrence.dataAbsentReason MedicationStatement (PS-ON) - MedicationStatement.effective.dataAbsentReason Procedure (PS-ON) - Procedure.performed.dataAbsentReason | Required |
Disease** |
Code for a disease the vaccination is against from the Canadian Vaccine Catalogue code set. | Immunization (PS-ON) - Immunization.protocolApplied.targetDisease | Preferred |
DocumentRelationshipType | The type of relationship between documents. | Composition (PS-ON) - Composition.relatesTo.code | Required |
DocumentSectionCodes | Classification of a section of a composition/document. | Composition (PS-ON) - Composition.section.code | Example |
DrugOrMedicamentSubstanceCode * |
SNOMED CT Canadian edition drug active substances | Medication (PS-ON) - Medication.ingredient.itemCodeableConcept | Required |
EventStatus | A code specifying the state of the procedure. | Procedure (PS-ON) - Procedure.status | Required |
Generic** |
The code for vaccine product administered. | Immunization (PS-ON) - Immunization.vaccineCode | Preferred |
HealthcareProviderRoleType * |
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. | PractitionerRole (PS-ON) - PractitionerRole.code | Preferred |
Identifier Type Codes | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose | Patient (PS-ON) - Patient.identifier.type | Extensible |
ImmunizationStatusCodes | A set of codes indicating the current status of an Immunization. | Immunization (PS-ON) - Immunization.status | Required |
Medication Status Codes | A coded concept indicating the current status of a MedicationStatement. | MedicationStatement (PS-ON) - MedicationStatement.status | Required |
medicationrequest Status | A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription. | MedicationRequest (PS-ON) - MedicationRequest.status | Required |
NoAllergiesInfoUvIps | Negation/exclusion codes for reporting no known allergies or not available data. | AllergyIntolerance (PS-ON) - AllergyIntolerance.code | Required |
NoImmunizationInfoUvIps | A reference to a code indicating that there there are no known immunizations or that this information is unknown. | Immunization (PS-ON) - Immunization.vaccineCode | Required |
NoMedsInfoUvIps | Representation of unknown or absent medications | MedicationStatement (PS-ON) - MedicationStatement.medication | Extensible |
NoProbsInfoUvIps | Code representing the statement "absent problem" or the statement "problems unknown" | Condition (PS-ON) - Condition.code | Required |
NoProceduresInfoUvIps | A code to identify absent or unknown procedures | Procedure (PS-ON) - Procedure.code | Required |
PersonalRelationshipUvIps | The nature of the relationship between a patient and a contact person for that patient. | Patient (PS-ON) - Patient.contact.relationship | Required |
PharmaceuticalBiologicProductAndSubstanceCode * |
Codes for allergy or intolerance from the Infoway Substance Code and Pharmaceutical/Biologic Product Code value sets. | AllergyIntolerance (PS-ON) - AllergyIntolerance.code | Required |
PharmaceuticalDoseFormCode * |
A coded concept defining the form of a medication. SNOMED CT Canadian edition dose forms | Medication (PS-ON) - Medication.form | Required |
PrescriptionMedicinalProduct * |
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 MedicationRequest (PS-ON) - MedicationRequest.medication |
Preferred |
ProcedureCode * |
SNOMED CT Canadian codes to describe Services/Activities performed by Primary Health Care Providers. | Procedure (PS-ON) - Procedure.code | Required |
RouteOfAdmin** |
The route by which the vaccine was administered. | Immunization (PS-ON) - Immunization.route | Preferred |
SeverityCode * |
Code for the severity of a problem that is selected from the SNOMED CT Canadian edition value set. | Condition (PS-ON) - Condition.severity | Required |
Tradename** |
The code for vaccine product administered. | Immunization (PS-ON) - Immunization.vaccineCode | Preferred |
v3.ConfidentialityClassification | Set of codes used to value Act.Confidentiality and Role.Confidentiality attribute in accordance with the definition for concept domain "Confidentiality". | Composition (PS-ON) - Composition.confidentiality | Required |