For a full list of available versions, see the Directory of published versions
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.
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, Infoway's Terminology Server, or Health Canada (e.g. Licensed Natural Health Products). 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 Set (Code System Source) | Description | Profile | Binding Strength |
|---|---|---|---|
| AddressType (HL7 FHIR) | The use of an address | Patient - Patient.address.type | Required |
| AddressUse (HL7 FHIR) | The use of an address | Patient - Patient.address.use | Required |
| AdministrativeGender (HL7 FHIR) | The gender of a person used for administrative purposes | Patient - Patient.gender Patient (Submission) - Patient.gender |
Required |
AdmitSource* (CIHI) |
This field indicates the last point of entry prior to being admitted as an inpatient to the reporting facility | Encounter - Encounter.hospitalization.admitSource Encounter (Submission) - Encounter.hospitalization.admitSource |
Required |
| CanadianTriageAcuityScale (Canadian Association of Emergency Physicians) | The Canadian Triage and Acuity Scale (CTAS) is a scale used to determine the triage level. Triage level categorizes the patient according to the type and severity of the patient’s initial presenting signs and symptoms. This value set is used Encounter.priority data element in FHIR and contributed in PV2-40 in HL7 v2. | Encounter - Encounter.priority Encounter (Submission) - Encounter.priority |
Required |
ClinicalFindingCode** (SNOMED CT CA) |
This subset contains concepts that represent diagnoses, the results of a clinical observation, assessment of judgment, and includes normal and abnormal clinical states. | Condition - Condition.code Condition (Submission) - Condition.code |
Preferred |
| CompositionStatus (HL7 FHIR) | The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document. | Composition - Composition.status Composition (Submission) - Composition.status |
Required |
| ConditionClinicalStatusCodes (HL7 FHIR) | The clinical status of the condition or diagnosis. | Condition - Condition.clinicalStatus Condition (Submission) - Condition.clinicalStatus |
Required |
| ConditionVerificationStatus (HL7 FHIR) | The verification status to support or decline the clinical status of the condition or diagnosis. | Condition - Condition.verificationStatus Condition (Submission) - Condition.verificationStatus |
Required |
| ContactPointSystem (HL7 FHIR) | Telecommunications form for contact point. | Patient - Patient.telecom.system | Required |
| ContactPointUse (HL7 FHIR) | Use of contact point | Patient - Patient.telecom.use | Required |
CountryCodeEHR* (urn:iso:std:iso:3166-3) |
3-character ISO country codes supported by Ontario Health interfaces for use in addresses. | Patient - Patient.address.country Practitioner - Practitioner.address.country |
Required |
| DiagnosisRole (HL7 FHIR) | This value set defines a set of codes that can be used to express the role of a diagnosis on the Encounter or EpisodeOfCare record. | Encounter - Encounter.diagnosis.use Encounter (Submission) - Encounter.diagnosis.use |
Preferred |
DiagnosticReportCodeEHR* (LOINC) |
This value set includes a subset of document codes in LOINC that represent radiology reports, with LOINC Class: RAD and LOINC Scale: Doc. These documents contain a consulting specialist's interpretation of image data. | DiagnosticReport - DiagnosticReport.code DiagnosticReport (Submission) - DiagnosticReport.code |
Extensible |
| DiagnosticReportStatus (HL7 FHIR) | The status of the diagnostic report. | DiagnosticReport - DiagnosticReport.status DiagnosticReport (Submission) - DiagnosticReport.status |
Required |
| DiagnosticServiceSectionCodes (HL7 FHIR) | Codes for diagnostic service sections. | DiagnosticReport - DiagnosticReport.category | Example |
DischargeDisposition* (CIHI) |
This field contains the disposition of the patient at time of discharge (i.e., discharged to home, expired, etc.) | Encounter - Encounter.hospitalization.dischargeDisposition Encounter (Submission) - Encounter.hospitalization.dischargeDisposition |
Required |
DocumentClassEHR *(LOINC) |
This value set defines the codes representing document class from LOINC as defined in the LOINC Manual, excluding class = RAD. The class codes from LOINC is intended to be used for report categorization based on the type of study performed. Radiology class type is excluded from this value set it will be contributed using DiagnosticReport resource. | Composition - Composition.category | Candidate |
| DocumentClassValueSet (HL7 FHIR) | High-level kind of a clinical document at a macro level. | Composition - Composition.category | Example |
DocumentKindEHR *(LOINC + Ontario Health) |
This value set contains all Document Kind part codes in LOINC Document Ontology as defined in the LOINC User's Guide and some Ontario Health-defined codes supported by Ontario Health assets, such as ConnectingOntario ClinicalViewer. | Composition - Composition.category | Candidate |
| DocumentRelationshipType (HL7 FHIR) | The type of relationship between documents. | Composition - Composition.relatesTo.code Composition (Submission) - Composition.relatesTo.code |
Required |
| DocumentSectionCodes (HL7 FHIR) | Classification of a section of a composition/document. | Composition - Composition.section.code Composition (Submission) - Composition.section.code |
Example |
DocumentRoleEHR *(LOINC + Ontario Health) |
This value set contains all Document Role part codes in LOINC Document Ontology as defined in the LOINC User's Guide and some Ontario Health-defined codes supported by Ontario Health assets, such as ConnectingOntario ClinicalViewer. | Composition - Composition.category | Candidate |
DocumentSettingEHR *(LOINC + Ontario Health) |
This value set contains all Document Setting part codes in LOINC Document Ontology as defined in the LOINC User's Guide and some Ontario Health-defined codes supported by Ontario Health assets, such as ConnectingOntario ClinicalViewer. | Composition - Composition.category | Candidate |
DocumentSubjectMatterDomainEHR *(LOINC + Ontario Health) |
This value set contains all Document Subject Matter Domain part codes in LOINC Document Ontology as defined in the LOINC User's Guide and some Ontario Health-defined codes supported by Ontario Health assets, such as ConnectingOntario ClinicalViewer. | Composition - Composition.category | Candidate |
DocumentTypeOfServiceEHR *(LOINC + Ontario Health) |
This value set contains all Document Type of Service part codes in LOINC Document Ontology as defined in the LOINC User's Guide and some Ontario Health-defined codes supported by Ontario Health assets, such as ConnectingOntario ClinicalViewer. | Composition - Composition.category | Candidate |
EncounterClassEHR* (HL7 FHIR + Ontario Health) |
This value set defines a set of codes that can be used to indicate the class of encounter for Ontario Health interfaces, contributed in PV1-2 in HL7 v2 and Encounter.class data element in FHIR. | Encounter - Encounter.class Encounter (Submission) - Encounter.class |
Extensible |
| EncounterLocationStatus (HL7 FHIR) | The status of the location. | Encounter - Encounter.location.status Encounter (Submission) - Encounter.location.status |
Required |
| EncounterParticipantTypeEHR (HL7 v3) | Role of participant in the encounter. | Encounter - Encounter.participant.type Encounter (Submission) - Encounter.participant.type |
Required |
| EncounterReasonCodes (HL7 FHIR) | Set of codes that can be used to indicate reasons for an encounter. | Encounter - Encounter.status Encounter (Submission) - Encounter.status |
Preferred |
| EncounterStatus (HL7 FHIR) | Current state of the encounter. | Encounter - Encounter.status Encounter (Submission) - Encounter.status |
Required |
HospitalService* (CIHI) |
This field indicates description of the Hospital Service. It is contributed in PV1-10 in HL7v2 and is used by the resource element Encounter.serviceType. | Encounter - Encounter.serviceType Encounter (Submission) - Encounter.serviceType |
Extensible |
| ICD9CMAllCode (CIHI) | This subset contains all concepts represented by the ICD-9 CM code system. | Condition - Condition.code Condition (Submission) - Condition.code |
Candidate |
| ICD10CAAllCode (CIHI) | This subset contains all concepts represented by the ICD-10 CM code system. | Condition - Condition.code Condition (Submission) - Condition.code |
Candidate |
| IdentifierType (HL7 FHIR) | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | Patient - Patient.identifier.type DiagnosticReport - DiagnosticReport.identifier.type |
Extensible |
| IdentifierTypeEHR (HL7 FHIR + Ontario Health) | Codes supported by Ontario Health differentiating types of identifiers. | Encounter - Encounter.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 clients, practitioners and organizations. This value set represents the subset of all ISO living languages as of April 22, 2020. | Binary - Binary.language Binary (Submission) - Binary.language Patient - Patient.communication.language Patient (Submission) - Patient.communication.language |
Required |
LocalDocumentTypeEHR* (Ontario Health) |
This value set represents all local codes contributed by over 160 sending systems (code systems) in HL7v2 OBR-4 and/or OBX-3 to identify the local document type/section. | Composition - Composition.type Composition (Submission) - Composition.type |
Required |
LocalEncounterTypeEHR* (Ontario Health) |
This value set contains all Local PV1-4 Codes contributed by over 160 HIC organizations to identify the local Encounter Type. | Encounter - Encounter.type Encounter (Submission) - Encounter.type |
Extensible |
LocalImagingProcedureCodeEHR* (Ontario Health) |
This value set contains example local procedure codes contributed by sites to DIRs to identify the procedure of the medical imaging order. Each contributing site has their own set of local codes/code systems defined by OIDs. | DiagnosticReport - DiagnosticReport.code DiagnosticReport (Submission) - DiagnosticReport.code |
Extensible |
| MimeType (IETF BCP-13) | Attachment mime type supported by OCRE. | Binary (Submission) - Binary.contentType DiagnosticReport (Submission) - DiagnosticReport.presentedForm.contentType |
Required |
| MimeTypeEHR (IETF BCP-13) | Attachment mime types supported by Ontario Health interfaces. | Binary - Binary.contentType DiagnosticReport - DiagnosticReport.presentedForm.contentType |
Required |
| NameUse (HL7 FHIR) | The use of a human name. | Patient - Patient.name.use | Required |
| PatientIdentifierSystem (HL7 v2) | Patient Identifier System URI. | Patient - Patient.identifier.system | Required |
| PatientIdentifierType (HL7 FHIR) | Patient Identifier Type. | Patient - Patient.identifier.type | Required |
| ProcedureBodyPartDicom (DICOM) | A code that classifies a body part of an MI procedure using DICOM codes. This is used for searching, sorting and display purposes. | DiagnosticReport - DiagnosticReport.category(bodypart).coding(dicom) ServiceRequest - ServiceRequest.category(bodypart).coding(dicom) |
Required |
| ProcedureBodyPartSct (SNOMED CT CA) | A code that classifies a body part of an MI procedure using SNOMED CT codes. This is used for searching, sorting and display purposes. | DiagnosticReport - DiagnosticReport.category(bodypart).coding(sct) ServiceRequest - ServiceRequest.category(bodypart).coding(sct) |
Required |
| ProcedureContrast (SNOMED CT CA) | A code that classifies a use of Contrast for an MI procedure. This is used for searching, sorting and display purposes. | DiagnosticReport - DiagnosticReport.category(contrast) ServiceRequest - ServiceRequest.category(contrast) |
Required |
| ProcedureLateralityDicom (DICOM) | A code that classifies a laterality of an MI procedure using DICOM codes. This is used for searching, sorting and display purposes. | DiagnosticReport - DiagnosticReport.category(laterality).coding(sct) ServiceRequest - ServiceRequest.category(laterality).coding(sct) |
Required |
| ProcedureLateralitySct (SNOMED CT CA) | A code that classifies a laterality of an MI procedure using SNOMED CT codes. This is used for searching, sorting and display purposes. | DiagnosticReport - DiagnosticReport.category(laterality).coding(dicom) ServiceRequest - ServiceRequest.category(laterality).coding(dicom) |
Required |
| ProcedureModality (DICOM) | A code that classifies a modality of an MI procedure. This is used for searching, sorting and display purposes. | DiagnosticReport - DiagnosticReport.category(modality) ServiceRequest - ServiceRequest.category(modality) |
Required |
| ProcedureSpecialtyEHR (SNOMED CT CA) | A code that classifies a specialty of a medical imaging procedure, using SNOMED CT codes. This is used for searching, sorting and display purposes. | DiagnosticReport (Submission) - DiagnosticReport.category ServiceRequest - ServiceRequest.category(specialty) |
Required |
| ProcedureTypeSct (SNOMED CT CA) | A SNOMED CT MI procedure code that describes an MI report or order | DiagnosticReport - DiagnosticReport.code.coding(sct) ServiceRequest - ServiceRequest.code.coding(sct) |
Required |
ProvinceStateCode* (Ontario Health) |
Codes for provinces, states and territories supported by Ontario Health interfaces. | Patient - Patient.address.state Practitioner - Practitioner.address.state |
Required |
ProvincialDocumentTypeEHR* (Ontario Health) |
This value set contains all document type codes used to represent clinical documents and/or reports in the EHR. | Composition - Composition.type Composition (Submission) - Composition.type |
Extensible |
ProvincialImagingReportTypeEHR* (Ontario Health) |
This value set contains a subset of provincial ConnectingOntario diagnostic imaging report codes used in OH assets. | DiagnosticReport - DiagnosticReport.code | Candidate |
| RequestIntent (HL7 FHIR) | Codes indicating the degree of authority/intentionality associated with a request. | ServiceRequest - ServiceRequest.intent | Required |
| RequestStatus (HL7 FHIR) | The status of the order | ServiceRequest - ServiceRequest.status | Required |