Ontario Immunization Repository Implementation Guide -v1.0.0-draft1
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., pan-Canadian subsets) 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. National Vaccine Catalogue).
* 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). | Organization - Organization.address.type Patient - Patient.address.type Patient - Patient.contact.address.type |
Required |
| AddressUse (HL7 FHIR) | The use of an address. | Organization - Organization.address.use Patient - Patient.address.use Patient - Patient.contact.address.use |
Required |
| AdministrativeGender (HL7 FHIR) | The gender of a person used for administrative purposes. | Patient - Patient.gender Patient - Patient.contact.gender |
Required |
| CompositionStatus (HL7 FHIR) | The workflow/clinical status of the composition. | Composition - Composition.status | Required |
| ContactPointSystem (HL7 FHIR) | Telecommunications form for contact point. | Patient - Patient.telecom.system Patient - Patient.contact.telecom.system |
Required |
| ContactPointUse (HL7 FHIR) | Use of contact point. | Organization - Organization.telecom:TelecomPhone.use Organization - Organization.telecom:TelecomFax.use Patient - Patient.telecom.use Patient - Patient.contact.telecom.use PractitionerRole - PractitionerRole.telecom:TelecomPhone.use PractitionerRole - 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 - Organization.address.country Patient - Patient.address.country |
Required |
DrugServiceCoverageEHR* (HL7 FHIR + HL7 v3) |
Indicates whether a medication or service cost was covered by a public plan, a private insurance plan or by the patient themselves. | Immunization - Immunization.fundingSource | Extensible |
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 |
HealthcareProviderRoleCode** (SNOMED CT CA) |
The role of a person in a health related occupation, including relevant administrative and professional occupations as well as in the healthcare environment. | PractitionerRole - PractitionerRole.code | Required |
ImmunizationAdministrationAnatomicalSiteCode** (SNOMED CT CA) |
The anatomical site where the immunizing agent was administered. | Immunization - Immunization.site | Extensible |
ImmunizationReasonCode* (SNOMED CT, SNOMED CT CA) |
Reasons for why the immunization occurred. | Immunization - Immunization.reasonCode | Extensible |
ImmunizationRouteOfAdministrationCode** (SNOMED CT CA) |
The path the administered immunization takes to get into the body. The subset has been curated specifically to capture only routes of administration relevant to immunization. | Immunization - Immunization.route | Extensible |
| ImmunizationStatusCodes (HL7 FHIR) | A set of codes indicating the current status of an Immunization. | Immunization - Immunization.Immunization.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 |
| LocationStatus (HL7 FHIR) | Indicates whether the location is still in use. | Location - Location.status | Required |
| NameUse (HL7 FHIR) | The use of a human name. | Patient - Patient.name.use | Required |
PassiveAdministeredImmunizingAgentCode** (SNOMED CT CA) |
The subset includes concepts represented by the trade name (brand name) of the passive immunizing agent (immune globulin or antitoxin) that was administered to the client. The scope of this subset is all passive immunizing agents that that have been licensed for use in Canada, those obtained through special access programs for use in Canada, and those that were never licensed in Canada (i.e., administered in other countries). Passive immunizing agents are used to facilitate protection against vaccine preventable infections, when vaccines are not available or are contraindicated or when vaccines have not been used before exposure to the infective agent. | Immunization - Immunization.vaccineCode | Candidate |
PassiveHistoricalImmunizingAgentCode** (SNOMED CT CA) |
The scope of this subset is generic passive immunizing agents used in Canada (generically described, i.e. without trade name), those obtained through special access programs (generically described), and passive agents that never licensed in Canada. This content is intended to be used when populating an immunization history when the client and/or provider does not have the detail of the trade name of the agent administered or the product has never been licensed in Canada. Passive immunizing agents are used to facilitate protection against vaccine preventable infections, when vaccines are not available or are countraindicated or when vaccines have not been used before exposure to the infective agent. This subset will include concepts represented by a generic description for a passive agent that was previously administered to the client as may be expressed by the client or provider for an immunization history and concepts represented by the trade name for products. | Immunization - Immunization.vaccineCode | Candidate |
PrescriptionDoseQuantityUnit** (UCUM + SNOMED CT) |
Units of measure and/or products that convey the amount of drug to be given to a patient in one dose. | Immunization - Immunization.Immunization.doseQuantity.code | Extensible |
ProvinceStateCodeEHR* (Ontario Health) |
Codes for provinces, states and territories supported by Ontario Health interfaces. | Organization - Organization.address.state Patient - Patient.address.state |
Required |
VaccineAdministeredTradeNameCode** (SNOMED CT CA) |
The subset includes concepts represented by the trade name (brand name) of the vaccine administered to the client. The scope of this subset is all vaccines that have been licensed for use in Canada, those obtained through special access programs for use in Canada, and those that were never licensed in Canada (i.e., administered in other countries). | Immunization - Immunization.vaccineCode | Preferred |
VaccineHistoricalNameCode** (SNOMED CT CA) |
The scope of this subset is generic vaccines that have been licensed for use in Canada, those obtained through special access programs, and for vaccines that were never licensed in Canada.This content intended to be used when populating an immunization history when the client and /or provider does not have the detail of the trade name (brand name) of the vaccine administered or the product has never been licensed in Canada. This subset will include concepts represented by a generic description for a vaccine that was previously administered to the client as may be expressed by the client or provider for an immunization history and concepts represented by the trade name for products. | Immunization - Immunization.vaccineCode | Candidate |