v1.0.0-ballot1
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.
*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 Sets referenced by this implementation guide:
| Value Set (Code System Source) | Description | Profile | Binding Strength |
|---|---|---|---|
| AccountStatus (HL7 FHIR) | Indicates whether the account is available to be used. | Account - Account.status | Required |
| AdministrativeGender (HL7 FHIR) | The gender of a person used for administrative purposes. | Patient - Patient.gender | Required |
| AdmitSource (CIHI IRRS) | This field indicates the last point of entry prior to being admitted as an inpatient to the reporting facility. It is contributed in PV1-14 in HL7v2 and is used by the resource element Encounter.hospitalization.admitSource in FHIR. | Encounter - Encounter.hospitalization.admitSource | Required |
| AddressUse (HL7 FHIR) | The use of an address. | Patient - Patient.address.use Organization - Organization.address.use |
Required |
| AddressType (HL7 FHIR) | The type of an address (physical / postal). | Patient - Patient.address.type Organization - Organization.address.type |
Required |
| BundleType (HL7 FHIR) | Indicates the purpose of a bundle - how it is intended to be used. | Bundle - Bundle.type | Required |
| LanguageEHR (urn: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 |
| ContactPointSystem (HL7 FHIR) | Telecommunications form for contact point. | Organization - Organization.telecom.system | Required |
| ContactPointUse (HL7 FHIR) | Use of contact point. | Organization - Organization.telecom.use | Required |
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. | Organization - Organization.address.country | Required |
| DischargeDisposition (CIHI IRRS) | This field contains the disposition of the patient at time of discharge (i.e., discharged to home, expired, etc.). It is contributed in PV1-36 in HL7v2 and is used by the resource element Encounter.hospitalization.dischargeDisposition in FHIR. | Encounter - Encounter.hospitalization.admitSource | Required |
EncounterClassEHR (HL7 v2 + HL7 v3 + 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.status | Required |
| EncounterStatus (HL7 FHIR) | Current state of the encounter. | Encounter - Encounter.status | Required |
| EncounterReasonCodes (SNOMED CT) | This example value set defines the set of codes that can be used to indicate reasons for an encounter. | Encounter - Encounter.reasonCode | Preferred |
| EncounterLocationStatus (HL7 FHIR) | The status of the location. | Encounter - Encounter.location.status | 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 | Required |
| FinancialResourceStatusCodes (HL7 FHIR) | This value set includes Status codes. | Coverage - Coverage.status | Required |
IAREthnicityRace (Ontario Health + SNOMED CT + HL7 v3)* |
Includes codes to identify race and ethnicity. | Patient - Patient.extension:ethnicity.value[x]:valueCoding | Required |
IARGenderIdentity (Ontario Health + HL7 v3)* |
Includes codes that identify gender identity. | Patient - Patient.extension:genderIdentity.extension:value.value[x] | Required |
IARIndigenousIdentity (Ontario Health + FHIR v3 + CIHI IRRS)* |
Includes codes that identify indigenous identity. | Patient - Patient.extension:indigenousIdentity.value[x] | Required |
IARProgramType (Ontario Health)* |
Includes codes to identify program type. | Encounter - Encounter.type | Extensible |
IARSex (Ontario Health + HL7 v3)* |
Includes codes that identify birth sex. | Patient - Patient.extension:birthSex.value[x]:valueCoding | Required |
| IdentifierUse (HL7 FHIR) | Identifies the purpose for this identifier, if known. | Patient - Patient.identifier.use Organization - Organization.identifier.use |
Required |
| 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. | Patient - Patient.identifier.type Organization - Organization.identifier.type |
Extensible |
IdentifierTypeEHR (HL7 v2 + Ontario Health)* |
Codes supported by Ontario Health differentiating types of identifiers. | Encounter - Encounter.identifier.type | Extensible |
| irrs-account-type (HL7 v3) | Includes codes to identify account type. | Account - Account.type | Required |
| irrs-coverage-type (CIHI IIRRS + HL7 FHIR + HL7 v3) | Includes codes to identify coverage type. | Coverage - Coverage.type | Required |
| irrs-service-delivery-location-role-type (CIHI IRRS + SNOMED CT + HL7 v3) | Includes codes to identify service delivery location role type. | Location - Location.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 |
| NameUse (HL7 FHIR) | The use of a human name. | Patient - Patient.name.use | Required |
MessageEventCodeIAR (Ontario Health)* |
Includes codes to identify message event code. | MessageHeader - MessageHeader.event[x] | Preferred |
| Marital Status Codes (HL7 v3) | This value set defines the set of codes that can be used to indicate the marital status of a person. | Patient - Patient.maritalStatus | Extensible |
| PatientContactRelationship (HL7 v2) | The nature of the relationship between the patient and the contact person. | Patient - Patient.contact.relationship | Extensible |
ProvinceStateCodeEHR (Ontario Health)* |
Codes for provinces, states and territories supported by Ontario Health interfaces. | Organization - Organization.address.state | Required |
| QuestionnaireResponseStatus (HL7 FHIR) | Lifecycle status of the questionnaire response. | QuestionnaireResponse - QuestionnaireResponse.status | Required |