DRAFT - The specification is currently in development and subject to significant change. It is not ready for limited roll-out or production level use.
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 defined by this implementation guide:
| 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 |
| 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.communication.extension:communication-barrier.valueCoding | Extensible |
| CommunicationCategory | Codes for general categories of communications such as alerts, instructions, etc. | 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 |
| HealthServiceOffering | A code that represents the care procedures performed by a Provider for a particular service (i.e. .procedure, diagnostic investigation, or panel of investigations) that have been requested. Concepts from CHI InterventionCodeSubsetCare SNOMED CT subset. | ServiceRequest: ServiceRequest.code | Extensible |
| 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 |
| HumanLanguage | Languages understood or supported by patients and organizations. | Patient: Patient.communication.language, Practitioner: Practitioner.communication |
Preferred |
| IdentifierType | Codes supported by Ontario Health that can be used to determine which identifier to use for a specific purpose. This is an extension of the core FHIR value set. | MessageHeader: MessageHeader.extension:ReferralIdentifier Patient: Patient.identifier.type |
Extensible |
| LocationPhysicalType | This example value set defines a set of codes that can be used to indicate the physical form of the Location. | Location: Location.physicalType | Example |
| 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 event this message represents and connects it with its definition. Events defined as part of the FHIR specification.Alternatively uri to the EventDefinition. | MessageHeader: MessageHeader.eventCoding.code | Required |
| MessageReasonEncounter | Coded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message. | MessageHeader: MessageHeader.reason | Example |
| 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 |
| OrganizationType | This example value set defines a set of codes that can be used to indicate a type of organization. | Organization: Organization.type | Example |
| ParticipationStatus | Participation status of the actor. | Appointment: Appointment.participant.status | Required |
| PatientContactRelationship | The nature of the relationship between the patient and the contact person. | Patient: Patient.contact.relationship | Extensible |
| PractitionerQualification | 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. Concepts from CHI HealthCareProviderRoleType pan-Canadian subset. | Practitioner: Practitioner.qualification.code | Extensible |
| PractitionerSpecialty | This is the code representing the clinical specialty of the clinician or provider who interacted with, treated, or provided a service to/for the patient. | PractitionerRole: PractitionerRole.specialty | Extensible |
| PractitionerRoleCode | This value set defines a set of codes that can be used to indicate the role of a Practitioner. | PractitionerRole: PractitionerRole.code | 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 |
| TaskBusinessStatus | Contains business-specific nuances of the business state. | Task: Task.businessStatus.coding.code | Example |
| TaskCode | Codes indicating the type of action that is expected to be performed. | 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 |