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., Canada Health Infoway published value sets) or on the terminology servers used in implementation guide publication (e.g., 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 Server. When terminology is not readily available as FHIR® Release 4 ValueSets or CodeSystems, implementers should work with terminology producers to identify options.
* Please note that these value sets and/or code systems are created by Ontario Health.
** Use of terminology subsets hosted on Canada Health Infoway Terminology Server is required in order to comply with this interoperability specification. Access to and use of SNOMED CT and other subsets on Infoway's Terminology Server requires an Infoway account with acceptance of the SNOMED CT license agreements.
Value Sets referenced by this implementation guide:
| Value Set (Code System) | Description | Profile - Element | Binding Strength |
|---|---|---|---|
| AddressType (HL7 FHIR) | The type of an address (physical / postal). | Patient - Patient.address.type Organization - Organization.address.type |
Required |
| AddressUse (HL7 FHIR) | The use of an address. | Patient - Patient.address.use Organization - Organization.address.use |
Required |
| AdministrativeGender (HL7 FHIR) | The gender of a person used for administrative purposes. | Patient - Patient.gender | Required |
| CompositionStatus (HL7 FHIR) | The workflow/clinical status of the composition. | Composition - Composition.status | Required |
| ContactPointSystem (HL7 FHIR) | Telecommunications form for contact point. | Patient - Patient.telecom.system Organization - Organization.telecom.system |
Required |
| ContactPointUse (HL7 FHIR) | Use of contact point. | PractitionerRole - PractitionerRole.telecom.use Organization - Organization.telecom.use |
Required |
CountryCodeEHR* (ISO 3166-3) |
The set of 3-character ISO-3166 standard (e.g. CAN, USA) country codes supported by Ontario Health interfaces for use in addresses. | Patient - Patient.address.country Patient - Patient.contact.address.country Organization - Organization.address.country |
Extensible |
| DaysOfWeek (HL7 FHIR) | The days of the week. | MedicationDispense - MedicationDispense.dosageInstruction.timing.repeat.dayOfWeek MedicationRequest - MedicationRequest.dosageInstruction.timing.repeat.dayOfWeek |
Required |
| DIN (Health Canada Drug Product Database) | This subset contains all concepts represented by the Health Canada Drug Identification Number code system. A Drug Identification Number (DIN) is a computer-generated eight digit number assigned by Health Canada to a drug product prior to being marketed in Canada. It uniquely identifies all drug products sold in a dosage form in Canada and is located on the label of prescription and over-the-counter drug products that have been evaluated and authorized for sale in Canada. | Medication - Medication.code Medication - Medication.ingredient.item[x] |
Candidate |
DispenseCategoryEHR* (Ontario Health) |
Dispense type, e.g. drug, device or pharmacy service. A reference to a code defined by a terminology system. | MedicationAdministration - MedicationAdministration.category MedicationDispense - MedicationDispense.category |
Required |
| DocumentSectionCodes (HL7 FHIR) | Document section codes (LOINC codes used in CCDA sections). | Composition - Composition.section.code | Example |
DrugServiceCoverageEHR* (Ontario Health) |
Codes indicate whether a medication or service cost was covered by a public plan, a private insurance plan or by the patient themselves. | MedicationDispense - MedicationDispense.extension:DrugServiceCoverage | Required |
ErrorCodeEHR* (Ontario Health) |
This value set is comprised of error codes used in Ontario Health interfaces. These error codes are returned to consumers of Ontario Health assets. | OperationOutcome - OperationOutcome.issue.details.coding | Extensible |
| EventTiming (HL7 FHIR) | Real world event relating to the schedule. | MedicationDispense - MedicationDispense.dosageInstruction.timing.repeat.when MedicationRequest - MedicationRequest.dosageInstruction.timing.repeat.when |
Required |
| FHIRDocumentTypeCodes (HL7 FHIR) | FHIR Document Codes - all LOINC codes where scale type = 'DOC'. | Composition - Composition.type | Preferred |
HealthcareProviderRoleType** (SCPTYPE) |
Concepts related to the role a person plays in representing an organization. | PractitionerRole - PractitionerRole.code | Preferred |
| IssueSeverity (HL7 FHIR) | How the issue affects the success of the action. | OperationOutcome - OperationOutcome.issue.severity | Required |
| IssueType (HL7 FHIR) | A code that describes the type of issue. | OperationOutcome - OperationOutcome.issue.code | Required |
LanguageEHR* (IETF BCP 47) |
Languages understood or supported by Ontario Health clients and organizations. This value set represents the subset of all ISO living languages as of April 22, 2020. | Patient - Patient.communication.language | Extensible |
| LicensedNaturalHealthProducts (Health Canada Natural Product Number) | This subset contains all concepts represented in the Licensed Natural Health Products Database. The Licensed Natural Health Products Database contains information about natural health products that have been issued a product license by Health Canada. | Medication - Medication.code Medication - Medication.ingredient.item[x] |
Candidate |
| MedicationAdministrationStatusCodes (HL7 FHIR) | A set of codes indicating the current status of a medication administration. | MedicationAdministration - MedicationAdministration.status | Required |
| MedicationDispenseStatusCodes (HL7 FHIR) | A coded concept specifying the state of the dispense event. | MedicationDispense - MedicationDispense.status | Required |
MedicationRepeatPatternEHR* (SNOMED CT) |
This value set includes codes for a known / defined timing pattern. | MedicationDispense - MedicationDispense.dosageInstruction.timing.code MedicationRequest - MedicationRequest.dosageInstruction.timing.code |
Extensible |
| MedicationRequestStatus (HL7 FHIR) | A code specifying the current state of the order. | MedicationRequest - MedicationRequest.status | Required |
| NameUse (HL7 FHIR) | The use of a human name. | Patient - Patient.name.use Patient - Patient.contact.name.use |
Required |
PatientContactRelationshipEHR* (HL7 FHIR) |
This value set contains concepts related to the type of personal relationship between two living subjects, to support Ontario Health interfaces. | Patient - Patient.contact.relationship | Extensible |
PharmaceuticalDoseFormCode** (SNOMED CT CA) |
This subset contains concepts that represent the physical dosage forms of pharmaceutical products in which drug products are administered and the form in which drug products must be, has been manufactured, or is extemporaneous or magistrally prepared. | Medication - Medication.form | Preferred |
PrescribedQuantityUnit** (UCUM, SNOMED CT CA) |
Units of measure and/or products that convey the amount of drug being prescribed to a patient. | MedicationDispense - MedicationDispense.quantity | Extensible |
PrescriptionDoseQuantityUnit** (UCUM, SNOMED CT CA) |
Units of measure and/or products that convey the amount of drug to be given to a patient in one dose. | MedicationDispense - MedicationDispense.dosageInstruction.doseAndRate.dose[x] MedicationAdministration - MedicationAdministration.dosage.dose MedicationAdministration - MedicationAdministration.dosage.rate[x]:rateQuantity MedicationRequest - MedicationRequest.dosageInstruction.doseAndRate.dose[x]:doseQuantity |
Extensible |
PrescriptionDrugForm** (HL7 v3, SNOMED CT, SNOMED CT CA) |
The form in which a compounded drug or active ingredient can be dispensed to the patient. | Medication - Medication.form | Candidate |
PrescriptionMedicinalProduct** (Canadian Clinical Drug Data Set) |
Medicinal products for prescribing. The content of this ValueSet only contains commonly used medicinal products that are available for prescribing and dispensing in Canada. | Medication - Medication.code Medication - Medication.ingredient.item[x] |
Preferred |
ProvinceStateCodeEHR* (Ontario Health) |
Codes for provinces, states and territories supported by Ontario Health interfaces. | Patient - Patient.address.state Patient - Patient.contact.address.state Organization - Organization.address.state |
Extensible |
RouteOfAdministration** (SNOMED CT CA) |
This subset contains concepts that represent the path the medication takes to get into the body or into contact with the body. | MedicationAdministration - MedicationAdministration.dosage.route.coding MedicationDispense - MedicationDispense.dosageInstruction.route MedicationRequest - MedicationRequest.dosageInstruction.route |
Extensible |
| SNOMEDCTAdditionalDosageInstructions (SNOMED CT) | This value set includes all SNOMED CT additional dosage instructions. | MedicationRequest - MedicationRequest.dosageInstruction.additionalInstruction MedicationDispense - MedicationDispense.dosageInstruction.additionalInstruction |
Example |
| SNOMEDCTAdministrationMethodCodes (SNOMED CT) | This value set contains concepts describing the technique by which the medicine is administered. | MedicationAdministration - MedicationAdministration.dosage.method MedicationDispense - MedicationDispense.dosageInstruction.method |
Example |
| SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (SNOMED CT) | This value set includes coded concept describing the site location the medicine enters into or onto the body. | MedicationDispense - MedicationDispense.dosageInstruction.site MedicationDispense - MedicationDispense.dosageInstruction.additionalInstruction |
Example |
| UnitsOfTime (UCUM) | A unit of time (units from UCUM). | MedicationRequest - MedicationRequest.dosageInstruction.timing.repeat.durationUnit MedicationDispense - MedicationDispense.dosageInstruction.timing.repeat.durationUnit |
Required |