Ontario Clinical Report Exchange Implementation Guide v1.0.0 - Trial Use
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 value sets 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 Set (Code System Source) | Description | Profile | Binding Strength |
|---|---|---|---|
| AddressType (HL7 FHIR) | The type of an address (physical / postal). | Patient - Patient.address.type Patient (Submission) - Patient.address.type Location - Location.address.type Organization - Organization.address.type Organization (Submission) - Organization.address.type |
Required |
| AddressUse (HL7 FHIR) | The use of an address. | Patient - Patient.address.use Patient (Submission) - Patient.address.use Patient - Patient.contact.address.use Patient (Submission) - Patient.contact.address.use Organization - Organization.address.use Organization (Submission) - Organization.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) | Consists of codes to indicate the last point of entry prior to being admitted as an inpatient to the reporting facility. This value set is intended to represent Field 06: Entry Code set in the CIHI DAD Abstracting Manual. | Encounter - Encounter.hospitalization.admitSource Encounter (Submission) - Encounter.hospitalization.admitSource |
Required |
| AcquisitionModality (DICOM) | Transitive closure of CID 29 AcquisitionModality. | ServiceRequest - ServiceRequest.category | Candidate |
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. | 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 DiagnosticReport (Submission) - DiagnosticReport.conclusionCode |
Preferred |
| CommonLanguages (IETF BCP-47) | This value set includes common codes from BCP-47 (http://tools.ietf.org/html/bcp47) | DiagnosticReport - DiagnosticReport.presentedForm.language DiagnosticReport (Submission) - DiagnosticReport.presentedForm.language |
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 Patient (Submission) - Patient.telecom.system Organization - Organization.telecom.system Organization (Submission) - Organization.telecom.system |
Required |
| ContactPointUse (HL7 FHIR) | Use of contact point. | Patient - Patient.telecom.use Patient (Submission) - Patient.telecom.use Practitioner - PractitionerRole.telecom.use Practitioner (Submission) - PractitionerRole.telecom.use Organization - Organization.telecom.use Organization (Submission) - Organization.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 Patient (Submission) - Patient.address.country Patient - Patient.contact.address.country Patient (Submission) - Patient.contact.address.country Practitioner - Practitioner.address.country Location - Location.address.country Organization - Organization.address.country Organization (Submission) - Organization.address.country |
Extensible |
| 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 |
| DischargeDisposition (CIHI) | Codes to support the PV1-36 field in HL7 V2 for the disposition of the patient at time of discharge (i.e., discharged to home, expired, etc). This value set is intended to represent Field 05: Discharge Disposition in the CIHI DAD Abstracting Manual. | 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.reasonCode Encounter (Submission) - Encounter.reasonCode |
Preferred |
| EncounterStatus (HL7 FHIR) | Current state of the encounter. | Encounter - Encounter.status Encounter (Submission) - Encounter.status |
Required |
HealthcareProviderRoleType** (SCPTYPE) |
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. This resource is an informative value set; a normative subset containing the expanded values can be found on Canada Health Infoway's Terminology Server. | Practitioner - PractitionerRole.code Practitioner (Submission) - PractitionerRole.code |
Extensible |
| HospitalService (CIHI) | Codes that describe a group of similar patients with related diagnoses, conditions, problems or circumstances and interventions. It is contributed in PV1-10 in HL7 V2 and is used by the resource element Encounter.serviceType. This value set is intended to represent Field 01: Main Patient Service in the CIHI DAD Abstracting Manual. | Encounter - Encounter.serviceType Encounter (Submission) - Encounter.serviceType |
Extensible |
| ICD9CMAllCode (CIHI) | A value set for ICD-9-CM codes. | Condition - Condition.code Condition (Submission) - Condition.code DiagnosticReport (Submission) - DiagnosticReport.conclusionCode |
Candidate |
| ICD10CAAllCode (CIHI) | A value set for ICD-10-CA codes used in Canada. | Condition - Condition.code Condition (Submission) - Condition.code DiagnosticReport (Submission) - DiagnosticReport.conclusionCode ServiceRequest - ServiceRequest.reasonCode ServiceRequest (Submission) - ServiceRequest.reasonCode |
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 (Submission) - Patient.identifier.type DiagnosticReport (Submission) - DiagnosticReport.identifier.type |
Extensible |
| IdentifierTypeEHR (HL7 FHIR + Ontario Health) | Codes supported by Ontario Health differentiating types of identifiers. | Patient - Patient.identifier:JHN.type Patient (Submission) - Patient.identifier:JHN.type Patient - Patient.identifier:MRN.type Patient (Submission) - Patient.identifier:MRN.type Encounter - Encounter.identifier.type Encounter (Submission) - Encounter.identifier.type Practitioner - Practitioner.identifier.type Practitioner (Submission) - Practitioner.identifier.type ServiceRequest - ServiceRequest.requisition.type ServiceRequest (Submission) - ServiceRequest.requisition.type |
Extensible |
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 |
Extensible |
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 |
Candidate |
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 ServiceRequest (Submission) - ServiceRequest.code |
Candidate |
| LocationType (HL7 FHIR) | This example value set defines a set of codes that can be used to indicate the physical form of the Location. | Encounter - Encounter.location.physicalType Encounter (Submission) - Encounter.location.physicalType |
Example |
| LOINCCodes (LOINC) | This value set includes all LOINC codes. | Profile-ObservationImaging - Observation.code | Example |
| MimeType (IETF BCP-13) | Attachment mime types 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 Patient (Submission) - Patient.name.use Patient - Patient.contact.name.use Patient (Submission) - Patient.contact.name.use |
Required |
PatientContactRelationshipEHR* (HL7 FHIR, HL7 v2) |
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 Patient (Submission) - Patient.contact.relationship |
Extensible |
| ProcedureBodyPartEHR (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. | ServiceRequest - ServiceRequest.category | Candidate |
| ProcedureCodes (SNOMED CT) | Procedure Code: All SNOMED CT procedure codes. | ServiceRequest - ServiceRequest.code | Example |
| ProcedureContrastUsedEHR (SNOMED CT CA) | A code that classifies a use of Contrast for an MI procedure. This is used for searching, sorting and display purposes. | ServiceRequest - ServiceRequest.category | Candidate |
| ProcedureLateralityEHR (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. | ServiceRequest - ServiceRequest.category | Candidate |
| ProcedureReasonCodes (SNOMED CT) | This example value set defines the set of codes that can be used to indicate a reason for a procedure. | ServiceRequest - ServiceRequest.reasonCode ServiceRequest (Submission) - ServiceRequest.reasonCode |
Preferred |
ProcedureServiceTypeEHR* (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 - DiagnosticReport.category DiagnosticReport (Submission) - DiagnosticReport.category ServiceRequest - ServiceRequest.category ServiceRequest (Submission) - ServiceRequest.category |
Required |
ProvinceStateCodeEHR* (Ontario Health) |
Codes for provinces, states and territories supported by Ontario Health interfaces. | Patient - Patient.address.state Patient (Submission) - Patient.address.state Patient - Patient.contact.address.state Patient (Submission) - Patient.contact.address.state Practitioner - Practitioner.address.state Location - Location.address.state Organization - Organization.address.state Organization (Submission) - Organization.address.state |
Extensible |
ProvincialDocumentTypeEHR* (Ontario Health, LOINC) |
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 |
ProvincialImagingProcedureCodeEHR* (SNOMED CT) |
This value set contains SNOMED CT procedure codes that describe a medical imaging order used in Ontario Health interfaces. | ServiceRequest - ServiceRequest.code | Candidate |
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 ServiceRequest (Submission) - ServiceRequest.intent |
Required |
| RequestPriority (HL7 FHIR) | The clinical priority of a diagnostic order. | ServiceRequest - ServiceRequest.priority ServiceRequest (Submission) - ServiceRequest.priority |
Required |
| RequestStatus (HL7 FHIR) | The status of the order | ServiceRequest - ServiceRequest.status ServiceRequest (Submission) - ServiceRequest.status |
Required |
| ServiceRequestCategoryCodes (SNOMED CT) | An example value set of SNOMED CT concepts that can classify a requested service. | ServiceRequest - ServiceRequest.category | Example |
| SNOMEDCTBodyStructures (SNOMED CT) | This value set includes all codes from SNOMED CT where concept is-a 442083009 (Anatomical or acquired body site (body structure)). | ServiceRequest - ServiceRequest.bodySite ServiceRequest (Submission) - ServiceRequest.bodySite |
Example |