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.

CCDD contains information licensed under the Open Government Licence – Canada.

Value Sets referenced by this implementation guide:

Value Set (Code System Source)	Description	Profile	Binding Strength
AddressType (HL7 FHIR)	The type of an address (physical / postal).	Organization (Response) - Organization.address.type Organization (Submission) - Organization.address.type Patient (Response) - Patient.address.type Patient (Response) - Patient.contact.address.type Patient (Submission) - Patient.address.type	Required
AddressUse (HL7 FHIR)	The use of an address.	Organization (Response) - Organization.address.use Organization (Submission) - Organization.address.use Patient (Response) - Patient.address.use Patient (Response) - Patient.contact.address.use Patient (Submission) - Patient.address.use	Required
AdministrativeGender (HL7 FHIR)	The gender of a person used for administrative purposes.	Patient (Response) - Patient.gender Patient (Submission) - Patient.gender	Required
BundleType (HL7 FHIR)	Indicates the purpose of this bundle - how it is intended to be used.	Bundle (Document) - Bundle.type Bundle (Search Result) - Bundle.type	Required
CompositionStatus (HL7 FHIR)	The workflow/clinical status of the composition.	Composition (Response) - Composition.status Composition MedicationAdministration (Submission) - Composition.status Composition MedicationDispense (Submission) - Composition.status	Required
ContactPointSystem (HL7 FHIR)	Telecommunications form for contact point.	Organization (Response) - Organization.telecom.system Patient (Response) - Patient.telecom.system Patient (Submission) - Patient.telecom.system	Required
ContactPointUse (HL7 FHIR)	Use of contact point.	Organization (Response) - Organization.telecom.use Organization (Submission) - Organization.telecom:TelecomPhone.use Organization (Submission) - Organization.telecom:TelecomFax.use Patient (Response) - Patient.telecom.use Patient (Submission) - Patient.telecom.use PractitionerRole (Submission) - PractitionerRole.telecom:TelecomPhone.use PractitionerRole (Submission) - PractitionerRole.telecom:TelecomFax.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.	Organization (Response) - Organization.address.country Organization (Submission) - Organization.address.country Patient (Response) - Patient.address.country Patient (Submission) - Patient.address.country	Required
DaysOfWeek (HL7 FHIR)	The days of the week.	MedicationDispense (Response) - MedicationDispense.dosageInstruction.timing.repeat.dayOfWeek MedicationDispense (Submission) - MedicationDispense.dosageInstruction.timing.repeat.dayOfWeek	Required
DINvs (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 (Response) - Medication.code Medication (Response) - 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 (Response) - MedicationAdministration.category MedicationAdministration (Submission) - MedicationAdministration.category MedicationDispense (Response) - MedicationDispense.category MedicationDispense (Submission) - MedicationDispense.category	Required
DoseAndRateType (HL7 FHIR)	The kind of dose or rate specified.	MedicationDispense (Response) - MedicationDispense.dosageInstruction.doseAndRate.type.coding.code MedicationDispense (Submission) - MedicationDispense.dosageInstruction.doseAndRate.type.coding.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 (Response) - MedicationDispense.extension:DrugServiceCoverage.value[x].code MedicationDispense (Submission) - MedicationDispense.extension:DrugServiceCoverage.value[x].code	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 (Response) - MedicationDispense.dosageInstruction.timing.repeat.when MedicationDispense (Submission) - MedicationDispense.dosageInstruction.timing.repeat.when	Required
FHIRDocumentTypeCodes (LOINC)	FHIR Document Codes - all LOINC codes where scale type = 'DOC'.	Composition (Response) - Composition.type Composition MedicationAdministration (Submission) - Composition.type Composition MedicationDispense (Submission) - Composition.type	Preferred
HealthcareProviderRoleType`**` (SCPTYPE)	Concepts related to the role a person plays in representing an organization.	PractitionerRole (Response) - PractitionerRole.code	Preferred
IdentifierTypeEHR`*` (HL7 FHIR, Ontario Health)	Codes supported by Ontario Health differentiating types of identifiers.	Patient (Response) - Patient.identifier:JHN.type Patient (Response) - Patient.identifier:MRN.type Patient (Submission) - Patient.identifier:JHN.type Patient (Submission) - Patient.identifier:MRN.type Practitioner (Response) - Practitioner.identifier.type	Extensible
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 (Response) - Patient.communication.language	Extensible
LicensedNaturalHealthProducts (Health Canada Licensed Natural Health Products Database)	This subset contains all concepts represented in the Licensed Natural Health Products Database (LNHPD). The LNHPD contains information about natural health products that have been issued a product license by Health Canada.	Medication (Response) - Medication.code Medication (Response) - Medication.ingredient.item[x] Medication (Submission) - Medication.code Medication (Submission) - Medication.ingredient.item[x]	Candidate
MedicationAdministrationStatusCodes (HL7 FHIR)	A set of codes indicating the current status of a medication administration.	MedicationAdministration (Response) - MedicationAdministration.status MedicationAdministration (Submission) - MedicationAdministration.status	Required
MedicationDispenseStatusCodes (HL7 FHIR)	A coded concept specifying the state of the dispense event.	MedicationDispense (Response) - MedicationDispense.status MedicationDispense (Submission) - MedicationDispense.status	Required
MedicationReasonCode`**` (SNOMED CT CA)	A value set that includes coded concepts indicating why the medication was ordered.	MedicationRequest (Response) - MedicationRequest.reasonCode MedicationRequest (Submission) - MedicationRequest.reasonCode	Extensible
MedicationRequestIntent (HL7 FHIR)	A code that identifies the request intent.	MedicationRequest (Response) - MedicationRequest.intent MedicationRequest (Submission) - MedicationRequest.intent	Required
MedicationRequestStatus (HL7 FHIR)	A code specifying the current state of the order.	MedicationRequest (Response) - MedicationRequest.status MedicationRequest (Submission) - MedicationRequest.status	Required
MedicationRepeatPatternEHR`*` (SNOMED CT)	This value set includes codes for a known / defined timing pattern.	MedicationDispense (Response) - MedicationDispense.dosageInstruction.timing.code.coding.code MedicationDispense (Submission) - MedicationDispense.dosageInstruction.timing.code.coding.code MedicationRequest (Response) - MedicationRequest.dosageInstruction.timing.code MedicationRequest (Submission) - MedicationRequest.dosageInstruction.timing.code	Extensible
NameUse (HL7 FHIR)	The use of a human name.	Patient (Response) - Patient.name.use Patient (Response) - Patient.contact.name.use Patient (Submission) - Patient.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 (Response) - 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 (Response) - Medication.form Medication (Submission) - Medication.form	Extensible
PrescribedQuantityUnit`**` (UCUM, SNOMED CT CA)	Units of measure and/or products that convey the amount of drug being prescribed to a patient.	MedicationDispense (Response) - MedicationDispense.extension:DispenseRemainingQuantity.value[x].code MedicationDispense (Submission) - MedicationDispense.extension:DispenseRemainingQuantity.value[x].code MedicationDispense (Response) - MedicationDispense.quantity MedicationDispense (Submission) - 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.	MedicationAdministration (Response) - MedicationAdministration.dosage.dose MedicationAdministration (Submission) - MedicationAdministration.dosage.dose MedicationAdministration (Response) - MedicationAdministration.dosage.rate[x]:rateRatio MedicationAdministration (Submission) - MedicationAdministration.dosage.rate[x]:rateRatio MedicationAdministration (Response) - MedicationAdministration.dosage.rate[x]:rateQuantity MedicationAdministration (Submission) - MedicationAdministration.dosage.rate[x]:rateQuantity MedicationDispense (Response) - MedicationDispense.dosageInstruction.doseAndRate.dose[x]:doseRange MedicationDispense (Submission) - MedicationDispense.dosageInstruction.doseAndRate.dose[x]:doseRange MedicationDispense (Response) - MedicationDispense.dosageInstruction.doseAndRate.dose[x]:doseQuantity MedicationDispense (Submission) - MedicationDispense.dosageInstruction.doseAndRate.dose[x]:doseQuantity MedicationDispense (Response) - MedicationDispense.dosageInstruction.doseAndRate.rate[x]:rateRatio MedicationDispense (Submission) - MedicationDispense.dosageInstruction.doseAndRate.rate[x]:rateRatio MedicationDispense (Response) - MedicationDispense.dosageInstruction.doseAndRate.rate[x]:rateRange MedicationDispense (Submission) - MedicationDispense.dosageInstruction.doseAndRate.rate[x]:rateRange MedicationDispense (Response) - MedicationDispense.dosageInstruction.doseAndRate.rate[x]:rateQuantity MedicationDispense (Submission) - MedicationDispense.dosageInstruction.doseAndRate.rate[x]:rateQuantity MedicationRequest (Response) - MedicationRequest.dosageInstruction.doseAndRate.dose[x]:doseRange MedicationRequest (Submission) - MedicationRequest.dosageInstruction.doseAndRate.dose[x]:doseRange MedicationRequest (Response) - MedicationRequest.dosageInstruction.doseAndRate.dose[x]:doseQuantity MedicationRequest (Submission) - MedicationRequest.dosageInstruction.doseAndRate.dose[x]:doseQuantity MedicationRequest (Response) - MedicationRequest.dosageInstruction.doseAndRate.rate[x]:rateRange MedicationRequest (Submission) - MedicationRequest.dosageInstruction.doseAndRate.rate[x]:rateRange MedicationRequest (Response) - MedicationRequest.dosageInstruction.doseAndRate.rate[x]:rateQuantity MedicationRequest (Submission) - MedicationRequest.dosageInstruction.doseAndRate.rate[x]:rateQuantity	Extensible
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 (Response) - Medication.code Medication (Response) - Medication.ingredient.item[x] Medication (Submission) - Medication.code Medication (Submission) - Medication.ingredient.item[x]	Preferred
ProvinceStateCodeEHR`*`(Ontario Health)	Codes for provinces, states and territories supported by Ontario Health interfaces.	Organization (Response) - Organization.address.state Organization (Submission) - Organization.address.state Patient (Response) - Patient.address.state Patient (Submission) - Patient.address.state	Required
QuantityComparator (HL7 FHIR)	How the quantity should be understood and represented.	MedicationDispense (Response) - MedicationDispense.dosageInstruction.maxDosePerPeriod.numerator.comparator MedicationDispense (Submission) - MedicationDispense.dosageInstruction.maxDosePerPeriod.numerator.comparator MedicationDispense (Response) - MedicationDispense.dosageInstruction.maxDosePerPeriod.denominator.comparator MedicationDispense (Submission) - MedicationDispense.dosageInstruction.maxDosePerPeriod.denominator.comparator	Required
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 (Response) - MedicationAdministration.dosage.route.coding.code MedicationAdministration (Submission) - MedicationAdministration.dosage.route.coding.code MedicationDispense (Response) - MedicationDispense.dosageInstruction.route.coding.code MedicationDispense (Submission) - MedicationDispense.dosageInstruction.route.coding.code MedicationRequest (Response) - MedicationRequest.dosageInstruction.route.coding MedicationRequest (Submission) - MedicationRequest.dosageInstruction.route.coding	Required
SNOMEDCTAdministrationMethodCodes (SNOMED CT)	This value set contains concepts describing the technique by which the medicine is administered.	MedicationAdministration (Response) - MedicationAdministration.dosage.method MedicationAdministration (Submission) - MedicationAdministration.dosage.method MedicationDispense (Response) - MedicationDispense.dosageInstruction.method MedicationDispense (Submission) - MedicationDispense.dosageInstruction.method	Example
SNOMEDCTAdditionalDosageInstructions (SNOMED CT)	This value set includes all SNOMED CT additional dosage instructions.	MedicationDispense (Response) - MedicationDispense.dosageInstruction.additionalInstruction.coding.code MedicationDispense (Submission) - MedicationDispense.dosageInstruction.additionalInstruction.coding.code MedicationRequest (Response) - MedicationRequest.dosageInstruction.additionalInstruction MedicationRequest (Submission) - MedicationRequest.dosageInstruction.additionalInstruction	Example
SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (SNOMED CT)	This value set includes coded concept describing the site location the medicine enters into or onto the body.	MedicationDispense (Response) - MedicationDispense.dosageInstruction.site.coding.code MedicationDispense (Submission) - MedicationDispense.dosageInstruction.site.coding.code	Example
UnitsOfTime (UCUM)	A unit of time (units from UCUM).	MedicationDispense (Response) - MedicationDispense.dosageInstruction.timing.repeat.durationUnit MedicationDispense (Submission) - MedicationDispense.dosageInstruction.timing.repeat.durationUnit MedicationDispense (Response) - MedicationDispense.dosageInstruction.timing.repeat.periodUnit MedicationDispense (Submission) - MedicationDispense.dosageInstruction.timing.repeat.periodUnit	Required