Ontario Medical Imaging HL7® FHIR® Implementation Guide v1.0.0-Ballot
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 are created by Ontario Health
** Please note that use of terminology subsets hosted on Canada Health Infoway Terminology Gateway is required in order to comply with this interoperability specification. Access to and use of SNOMED CT and other subsets on Canada Health Infoway Terminology Gateway requires an Infoway account with acceptance of the SNOMED CT license agreements
| Value Set (Code System Source) | Description | Profile | Binding Strength |
|---|---|---|---|
| AcquisitionModality (DICOM) | Transitive closure of CID 29 AcquisitionModality. | ServiceRequest - ServiceRequest.category | Candidate |
| AcquisitionModality (DICOM) | Transitive closure of CID 29 AcquisitionModality. | ImagingStudy - ImagingStudy.modality ImagingStudy - ImagingStudy.series.modality |
Extensible |
| AdministrativeGender (HL7 FHIR) | The gender of a person used for administrative purposes. | Patient - Patient.gender Patient (submission) - Patient.gender |
Required |
| AddressUse (HL7 FHIR) | The use of an address. | Patient - Patient.address.use Patient - Patient.contact.address.use Patient (submission) - Patient.address.use |
Required |
| AddressType (HL7 FHIR) | The type of an address (physical / postal). | Patient - Patient.address.type Patient (submission) - Patient.address.type Location - Location.address.type |
Required |
| ContactPointSystem (HL7 FHIR) | Telecommunications form for contact point. | Patient - Patient.telecom.system - Patient.identifier:MRN.type Patient (submission) - Patient.telecom.system |
Required |
| ContactPointUse (HL7 FHIR) | Use of contact point. | Patient - Patient.telecom.use Patient (submission) - Patient.telecom.use PractitionerRole - PractitionerRole.telecom.use |
Required |
| CompositionStatus (HL7 FHIR) | The workflow/clinical status of the composition. | DocumentReference - DocumentReference.docStatus | Required |
| CommonLanguages (HL7 FHIR) | This value set includes common codes from BCP-47 (http://tools.ietf.org/html/bcp47). | DiagnosticReport - DiagnosticReport.language DiagnosticReport - DiagnosticReport.presentedForm.language DiagnosticReport (submission) - DiagnosticReport.language |
Preferred |
CountryCodeEHR (Ontario Health)* |
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 Patient (submission) - Patient.address.country Location - Location.address.country |
Extensible |
| DataAbsentReason (HL7 FHIR) | Used to specify why the normally expected content of the data element is missing. | Observation - Observation.dataAbsentReason | Extensible |
| DiagnosticReportStatus (HL7 FHIR) | The status of the diagnostic report. | DiagnosticReport - DiagnosticReport.status DiagnosticReport (submission) - DiagnosticReport.status |
Required |
| 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 |
| DocumentReferenceStatus (HL7 FHIR) | The status of the document reference. | DocumentReference - DocumentReference.status | Required |
| DocumentRelationshipType (HL7 FHIR) | The type of relationship between documents. | DocumentReference - DocumentReference.relatesTo.code | Required |
EndpointConnectionTypeEHR (HL7 FHIR + Ontario Health)* |
A coded value that represents the technical details of the usage of this endpoint. | Endpoint - Endpoint.connectionType | Required |
| EndpointStatus (HL7 FHIR) | The status of the endpoint. | Endpoint - Endpoint.status | Required |
HealthcareProviderRoleType (HL7 FHIR)** |
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. | PractitionerRole - PractitionerRole.code | Required |
| ICD10CAAllCode (CIHI) | This subset contains all concepts represented by the ICD-10-CA code system. This is a broad data exchange value set that is intended to support semantic interoperability and conformance testing. It is recommended that jurisdictions define and implement more specific clinically curated subsets that contain a portion of these concepts for data capture at the point of care for their specific use case. Further details about ICD-10-CA are available from the Canadian Institute for Health Information (CIHI) which includes details on the ICD-10-CA/CCI Folio Views for Core Plan Subscribers Product. This resource is an informative value set; a normative subset containing the expanded values can be found on Canada Health Infoway's Terminology Server. | ServiceRequest - ServiceRequest.reasonCode | Candidate |
| Identifier Type Codes (HL7 v2) | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ServiceRequest (submission) - ServiceRequest.identifier:identifier-accession.type ServiceRequest (submission) - ServiceRequest.identifier:identifier-placerOrderNumber.type DiagnosticReport - DiagnosticReport.identifier:identifier-accession.type DiagnosticReport - DiagnosticReport.identifier:identifier-placerOrderNumber.type DiagnosticReport (submission) - DiagnosticReport.identifier:identifier-accession.type DiagnosticReport (submission) - DiagnosticReport.identifier:identifier-placerOrderNumber.type Observation - Observation.identifier.type |
Extensible |
IdentifierTypeEHR (Ontario Health + HL7 v2)* |
Codes supported by Ontario Health differentiating types of identifiers. | Patient - Patient.identifier:JHN.type Patient - Patient.identifier:MRN.type Patient (submission) - Patient.identifier:MRN.type Patient (submission) - Patient.identifier:JHN.type ServiceRequest - ServiceRequest.identifier.type Practitioner - Practitioner.identifier.type |
Extensible |
| ImagingStudyStatus (HL7 FHIR) | The status of the ImagingStudy. | ImagingStudy - ImagingStudy.status | Required |
| 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 (Ontario Health)* |
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 Patient (submission) - Patient.communication.language |
Extensible |
LabTestRequestCodeEHR (Ontario Health)* |
A Test Request Code uniquely identifies a single Test Request in the OLIS Test Request Nomenclature. Complete list of concepts are found in the Test Request Nomenclature tab of the downloadable Excel spreadsheet. Download the latest OLIS Nomenclatures file. | ServiceRequest - ServiceRequest.code | Candidate |
LocalImagingProcedureCodeEHR (Ontario Health)* |
This value set contains example local procedure codes contributed by sites to identify the procedure of the medical imaging order. Each contributing site has their own set of local codes/code systems defined by OIDs. | ServiceRequest - ServiceRequest.code DiagnosticReport - DiagnosticReport.code DiagnosticReport (submission) - DiagnosticReport.code |
Candidate |
LocalImagingProcedureCodeEHR (Ontario Health)* |
This value set contains example local procedure codes contributed by sites to identify the procedure of the medical imaging order. Each contributing site has their own set of local codes/code systems defined by OIDs. | ServiceRequest (submission) - ServiceRequest.code | Preferred |
MimeTypeEHR (Ontario Health)* |
Attachment mime type supported by Ontario Health interfaces, including but not limited to acCDR and eForms. | DiagnosticReport - DiagnosticReport.presentedForm.contentType DiagnosticReport (submission) - DiagnosticReport.presentedForm.contentType |
Required |
| NameUse (HL7 FHIR) | The use of a human name. | Patient - Patient.name.use Patient - Patient.contact.name.use |
Required |
| ObservationStatus (HL7 FHIR) | Codes providing the status of an observation. | Observation - Observation.status | Required |
ProvinceStateCodeEHR (Ontario Health)* |
Codes for provinces, states and territories supported by Ontario Health interfaces. | Patient - Patient.address.state Patient - Patient.contact.address.state Patient (submission) - Patient.address.state Location - Location.address.state |
Extensible |
| PatientContactRelationshipEHR (HL7 v2 + HL7 v3) | 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 |
| ProcedureServiceTypeEHR (SNOMED CT) | A code that classifies a service type of a medical imaging procedure, using SNOMED CT codes. This is used for searching, sorting and display purposes. | ServiceRequest - ServiceRequest.category | Candidate |
| ProcedureServiceTypeEHR (SNOMED CT) | A code that classifies a service type of a medical imaging procedure, using SNOMED CT codes. This is used for searching, sorting and display purposes. | ServiceRequest (submission) - ServiceRequest.category DiagnosticReport - DiagnosticReport.category DiagnosticReport (submission) - DiagnosticReport.category ImagingStudy - ImagingStudy.extension:imagingStudyServiceType |
Extensible |
| ProcedureBodyPartEHR (SNOMED CT) | A code that classifies a body part of a medical imaging procedure using SNOMED CT codes. This is used for searching, sorting and display purposes. | ServiceRequest - ServiceRequest.category | Candidate |
| ProcedureLateralityEHR (SNOMED CT) | A code that classifies a laterality of a medical imaging procedure using SNOMED CT codes. This is used for searching, sorting and display purposes. | ServiceRequest - ServiceRequest.category | Candidate |
| ProcedureContrastUsedEHR (SNOMED CT) | A code that classifies a use of contrast for a medical imaging procedure. This is used for searching, sorting and display purposes. | ServiceRequest - ServiceRequest.category | Candidate |
| ProvincialImagingProcedureCodeEHR (SNOMED CT) | A SNOMED CT MI procedure code that describes an MI order. | 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 |
| 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 | Preferred |
ProvincialDocumentTypeEHR (LOINC + Ontario Health)* |
This value set contains all document type codes used to represent clinical documents and/or medical record reports in the EHR. The full subset of LOINC codes are available in the ConnectingOntario Site Terminology Mapping Worksheet under cON Terminology. | DocumentReference - DocumentReference.type | Extensible |
| RadLex (LOINC) | Individual terms and concepts related to medical imaging. | ImagingStudy - ImagingStudy.procedureCode | Extensible |
| RequestStatus (HL7 FHIR) | Codes identifying the lifecycle stage of a request. | ServiceRequest - ServiceRequest.status ServiceRequest (submission) - ServiceRequest.status |
Required |
| 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 | Required |
| v2.0065 (HL7 v2) | FHIR Value set/code system definition for HL7 v2 table 0065 ( ACTION CODE). | ServiceRequest - ServiceRequest.orderDetail | Candidate |