0.1.0 - ci-build

eReferralMustSupport - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

CAeReCAppointment

The resource involves booking one (or a series) of appointment(s) between the patient and the practitioner(s) for a specific date/time. The encounter may be a scheduled referral or an econsult.

CAeReCBundle

The bundle resource is used to package a collection of resources into a single instance. This resource would be used for referral in the following contexts:

  • Sending a set of resources as part of a message exchange
  • Grouping a self-contained set of resources to act as an exchangeable and persistable collection with clinical integrity - e.g. a clinical document
CAeReCCommunication

Communication resource is used to achieve the bi-directional communication between two systems. The Communication resource can be used to ask questions regarding a referral, request a referral be updated with missing information, or request additional information not covered by the specific referral dataset.

CAeReCDocumentReference

A reference to a document of any kind for any purpose. While the term “document” implies a more narrow focus, for this resource this "document" encompasses any serialized object with a mime-type, it includes formal patient-centric documents (CDA), clinical notes, scanned paper, non-patient specific documents like policy text, as well as a photo, video, or audio recording acquired or used in healthcare. The DocumentReference resource provides metadata about the document so that the document can be discovered and managed. The actual content may be inline base64 encoded data or provided by direct reference.

CAeReCHealthcareService

ServiceRequest is the main resource used to send all referral related information to the destination system.

CAeReCLocation

Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated. Used to help identify the location of the patient, provider (requester and service provider), and where the service will be provided. May be used in future to conduct analytics and help requesters find best services in closer proximity to the patient.

CAeReCMessageHeader

The header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.

CAeReCOrganization

Organization profile describes the details of the organization where the referral originated from.

CAeReCPatient

The Patient resources contain demographics and other administrative information about the individual who is the subject of the referral.

CAeReCPractitioner

Practitioner covers all individuals who are engaged in the healthcare process and healthcare-related services as part of their formal responsibilities and this Resource is used for attribution of activities and responsibilities to these individuals. Practitioners include (but are not limited to): physicians, specialists, physician assistants, nurses, social workers, professional homecare providers, and receptionists handling patient registration.

CAeReCPractitionerRole

PractitionerRole describes the types of services that practitioners provide for an organization at specific location(s). The PractitionerRole resource can be used in multiple contexts including:

  • In a Clinical system as a point of reference rather than an event, such as a patient's preferred general practitioner (at a specific clinic)
CAeReCQuestionnaire
CAeReCQuestionnaireResponse

QuestionnaireResponse resource is used to capture additional information, notes, record question/answers, etc. about the referral. This resource will be referrenced via ServiceRequest resource.

CAeReCServiceRequest

ServiceRequest is the main resource used to send all referral related information to the destination system.

CAeReCTask

A task resource describes an activity that can be performed and tracks the state of completion of that activity. It is a representation that an activity should be or has been initiated, and eventually, represents the successful or unsuccessful completion of that activity.

Structures: Extension Definitions

These define constraints on FHIR data types for systems conforming to this implementation guide.

Communication Barrier

The extension is required to identify if the patient speaks/understands an offical language (english/french), or if she/he does not an interpretor is required.

CopiedParticipants

Extension used to CC updates to the ServiceRequest in cases of forwarding referrals

DARC

DARC stands for 'Dates Affecting Readiness to Consult' and is defines as: Periods of time between the referral and consult date when the patient is unavailable for a first consultation due to patient-related reasons.

DART

DART stands for 'Dates Affecting Readiness to Treat' and is defined as: Periods of time between the Decision To Treat (DTT) and the Procedure Date when the patient is unavailable for a procedure due to patient-related reasons.

HealthCardNumberVersionCode

An assigned sequence code, uniquely identifying a Health Card issued (or potentially issued) to a Registered Person

PatientNeedsToBeSeen

Following a consult, this extension is used to identify if a patient needs to be seen in person.

PatientPresentLocation

Extension used to communicate the present location of the patient if it is different than the patient's home address.

PerformerIdentifier

This extension allows additional identifiers to be included under ServiceRequest.performer and ServiceRequest.identifier

ReasonForNoHCN

This extension is used to convey the reason for not providing the patient's health card number as a business identifier.

ReceivedDate

Extension used to communicate the date and time that the electronic referral was received by the incoming system.

ReferralIdentifier

For requisitions this extension is used to convey the ServiceRequest.requisition identifier in the message header.

RoutingOptions

This is an extension required for Referral Source Type identification. Only one referral routing object expected.

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

Communication Barrier

Contains codes required to identify if the patient speaks/understands an offical language (english/french), or if she/he does not and an interpretor is required.

Communication Category

Codes for general categories of communications.

DARC and DART Reasons

Codes supported by Ontario Health which intent to capture the wait time to access services from a patient’s perspective.

Human Language

Languages understood or supported by Ontario clients, practitioners and organizations based on ISO639-3 standard.

Identifier Type

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.

Message Event Code

Code that identifies the event this message represents and connects it with its definition.

Patient Contact Relationships

Types of personal relationships between two living subjects.

Task Business Status

Contains business-specific nuances of the business state.

Task Code

Contains codes indicating the type of action that is expected to be performed.