DFT - The specification is currently in development and subject to change. For a full list of available versions, see the Directory of published versions

Terminology

Value Sets

Various coded values which are used to describe clinical concepts within health records as well as codes used within messages to meet the structural requirements of interfaces.

Value Sets used by this implementation guide:

*This indicates the ValueSet is maintained on Canada Health Infoway's Terminology Server. The direct link to the ValueSet on the Terminology Server will require an InfoCentral account for access.

• Several ValueSets are not available at their canonical URL (e.g. canonicals starting with fhir.infoway-inforoute.ca). 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 browsed or downloaded, typically from the Canadian Terminology Server. In a future release, after canonical URLs are resolving, the respective stub ValueSets will be removed.

**This indicates the ValueSet is targeted for an upcoming release on Canada Health Infoway's Terminology Server. The valueSet canonical URL and/or name is expected to change

Value Set	Description	Profile	Binding Strength
AddressType	Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.	Organization: Organization.address.type Organization: Organization.contact.address.type Patient: Patient.address.type	Required
AddressUse	The purpose of this address.	Organization: Organization.address.use Organization: Organization.contact.address.use Patient: Patient.address.use	Required
AdministrativeGender	The gender of a person used for administrative purposes.	Patient: Patient.gender, Patient: Patient.contact.gender, Practitioner: Practitioner.gender	Required
AppointmentStatus	The free/busy status of an appointment.	Appointment: Appointment.status	Required
BundleType	Indicates the purpose of this bundle - how it is intended to be used.	Bundle: Bundle.type	Required
CommonLanguages	Languages understood or supported by patients and organizations.	Patient: Patient.communication.language, Practitioner: Practitioner.communication	Preferred
CommunicationBarrier*	Contains codes required to identify if the patient speaks/understands an offical language (English/French), or if she/he does not and an interpreter is required.	Patient:Patient.extension:communication-barrier.valueCoding	Extensible
ReferralCommunicationCategory*	Codes for categories of communications used in pan-Canadian eReferral/eConsult (CA:eReC) integrations.	Communication: Communication.category	Extensible
CommunicationStatus	The status of the transmission.	Communication: Communication.status	Required
ContactEntityType	Indicates a purpose for which the contact can be reached.	Organization: Organization.contact.purpose	Extensible
ContactRelationship	The nature of the relationship between the patient and the contact person.	Patient: Patient.contact.relationship	Extensible
ContactPointSystem	Telecommunications form for contact point.	MessageHeader: MessageHeader.source.contact.system Organization: Organization.telecom.system Organization: Organization.contact.telecom.system Patient: Patient.telecom.system	Required
ContactPointUse	Use of contact point.	MessageHeader: MessageHeader.source.contact.use Organization: Organization.telecom.use Organization: Organization.contact.telecom.use Patient: Patient.telecom.use	Required
DaysOfWeek	Indicates which days of the week are available between the start and end Times.	Location: Location.hoursOfOperation.daysOfWeek	Required
DocumentReferenceStatus	The status of this document reference.	DocumentReference: DocumentReference.status	Required
EncounterClass	This value set defines a set of codes that can be used to indicate the class of encounter: a specific code indicating class of service provided.	Appointment: Appointment.extension:AppointmentClass	Preferred
HealthcareProviderRoleCode*	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	Preferred
HealthcareProviderSpecialtyCode*	Represents the specialty or subspecialty of the healthcare provider.	PractitionerRole: PractitionerRole.specialty	Preferred
HealthConditionCode*	This subset contains concepts that represent health-related conditions which can be diagnoses, the results of a clinical observation, assessment of judgment, events or other situations with explicit context. This is a broad data exchange subset 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.	ServiceRequest: ServiceRequest.reasonCode	Preferred
HTTPVerb	In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.	Bundle: Bundle.entry.request.method	Required
IdentifierType	A coded type for an identifier that can be used to determine which identifier to use for a specific purpose	Patient: Patient.identifier.type	Extensible
LocationStatus	Indicates whether the location is still in use.	Location: Location.status	Required
MaritalStatus	This value set defines the set of codes that can be used to indicate the marital status of a person.The specific meanings of these codes can vary somewhat by jurisdiction and implementation so caution should be used when determining equivalency.	Patient: Patient.maritalStatus	Extensible
MessageEventCode*	Code that identifies the business event this message represents and connects it with its MessageDefinition for pan-Canadian eReferral/eConsult (CA:eReC) FHIR messaging integrations.	MessageHeader: MessageHeader.eventCoding.code	Extensible
MessageChangeReasonCode*	Coded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message for pan-Canadian eReferral/eConsult (CA:eReC) FHIR messaging integrations.	MessageHeader: MessageHeader.reason	Extensible
NarrativeStatus	The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.	Appointment: Appointment.text.status	Required
OperationalStatus	FHIR Value set/code system definition for HL7 v2 table 0116 (BED STATUS).	Location: Location.operationalStatus	Preferred
OrganizationContactPurpose	Indicates a purpose for which the contact can be reached.	Organization: Organization.contact.purpose	Extensible
ParticipationStatus	Participation status of the actor.	Appointment: Appointment.participant.status	Required
PersonalRelationshipCodes*	Types of personal relationships between two living subjects.	Patient: Patient.contact.relationship	Extensible
ProcedureCode*	This subset contains concepts that represent activities performed in the provision of health care including invasive procedures, laboratory procedures, administration of medicines, imaging, education, therapies, and administrative procedures. This is a broad data exchange subset 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.	ServiceRequest: ServiceRequest.code	Extensible
PreferenceTypeCode*	Contains codes to indicate preferences for providers or service locations, used in pan-Canadian eReferral/eConsult (CA:eReC) integrations.	ServiceRequest: ServiceRequest.extension:ServiceProviderPreference.PreferenceType	Extensible
QuestionnaireResponseStatus	The position of the questionnaire response within its overall lifecycle.	QuestionnaireResponse: QuestionnaireResponse.status	Extensible
ReferralDocumentType	Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced.	DocumentReference: DocumentReference.type	Extensible
RequestIntent	Codes indicating the degree of authority/intentionality associated with a request.	ServiceRequest: ServiceRequest.intent	Required
RequestPriority	Identifies the level of importance to be assigned to actioning the request.	ServiceRequest: ServiceRequest.priority	Required
RequestStatus	Codes identifying the lifecycle stage of a request.	ServiceRequest: ServiceRequest.status	Required
SearchEntryMode	Why this entry is in the result set - whether it's included as a match or because of an '_include' requirement, or to convey information or warning information about the search process.	Bundle: Bundle.entry.search.mode	Required
ServiceRequestCategory**	Codes to represent types of healthcare services and medical specialties	HealthcareService: HealthcareService.type ServiceRequest: ServiceRequest.category	Preferred
ReferralBusinessStatus*	Codes to communicate business-specific nuances of the referral status used in pan-Canadian eReferral/eConsult (CA:eReC) integrations.	Task: Task.businessStatus.coding.code	Extensible
ReferralStatusReason*	Codes to communicate reasons for the referral status used in pan-Canadian eReferral/eConsult (CA:eReC) integrations.	Task: Task.businessStatus.extension:businessStatusReason ServiceRequest:ServiceRequest.extension:RequestStatusReason	Extensible
ReferralSourceTypes	This is a stub value set for binding against the pan-Canadian Routing Options extension.	MessageHeader: MessageHeader.extension:RoutingOptions ServiceRequest:ServiceRequest.extension:RoutingOptions	Required
TaskCode*	Codes indicating the type of action that is expected to be performed for pan-Canadian eReferral/eConsult (CA:eReC) integrations.	Task: Task.code	Extensible
TaskIntent	Distinguishes whether the task is a proposal, plan or full order.	Task: Task.intent	Required
TaskStatus	The current status of the task.	Task: Task.status	Required
VisitModalityCode*	Represents the mode of contact between the Provider and the Client.	Appointment : Appointment.extension:VirtualService.extension:channelType	Extensible