SDOH Clinical Care, published by HL7 International / Patient Care. This guide is not an authorized publication; it is the continuous build for version 2.2.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-sdoh-clinicalcare/ and changes regularly. See the Directory of published versions
Page standards status: Informative |
This section describes the interactions between the actors in an SDOH referral starting both at a high-level and at the level of FHIR API calls. First, a high-level overview of the interactions is provided. This description abstracts technical details and should be accessible to the non-technical reader. For the sake of simplicity, only relationships critical to the Referral Workflow are provided. (For additional details on task status updates see Checking Task Status, and on relationships between profiles see Data Modeling Framework.)
The use cases here relate to the Gravity Use Cases. Implementers will benefit from looking at the detailed technical description of the exchange work flow for each use case, as well as the Capability Statements associated with each workflow and the conformance artifacts generally.
This IG supports the following general workflow:
The figure below shows this high-level workflow, the actors involved in each step, and the FHIR resources that support each step.
The actors in the workflows are described in the table below. The graphical icons are used throughout the IG. For each use case, the assumptions regarding each type of actor are described.
Actor | Description |
---|---|
Provider | Includes licensed providers and others that interact with the patient to assess social risk, set goals, and determine/recommend referrals. |
Community Based Organization (CBO) | An organization that provides specific services to the community or to a targeted population within the community. |
Coordination Platform (CP) | An intermediary between a provider and a CBO that plays a role in facilitating the referral process and finding resources for at-risk individuals. |
Patient | A consumer, or client, who is the subject of the assessment, goals, referrals and services delivered. Use of the term in this IG does not necessarily imply a clinical context. |
FHIR Server | A server that supports a FHIR API and can make FHIR API calls to other servers |
FHIR-enabled Application | An application that can make FHIR API calls to a FHIR server, but does not itself support a FHIR API |
FHIR-enabled Patient Application | A patient application that can connect to FHIR servers |
The functional use cases in the table below describe the referral process, initiated by a referral source (e.g., provider or other healthcare actor) to a referral target (e.g., a CBO), either directly or indirectly via an intermediary (e.g., a CP). For each use case, the capabilities or limitations of the actors are described. The table links to the functional use case and the associated detailed technical exchange workflow.
Functional Use Case | Description | Actors |
---|---|---|
Direct Referral | A referral between a referral source (e.g., provider) and a referral target (e.g., CBO) where both entities have FHIR server APIs and an intermediary (e.g., CP) is not involved in the referral. | , |
Direct Referral Light | A “light” version of the Direct Referral. A referral between a referral source (e.g., provider) and a referral target (e.g., CBO) where the referral source has a FHIR server API, the referral target does not have a FHIR server API but has an application that can access the referral source’s FHIR server API, and an intermediary (e.g., CP) is not involved in the referral. | , |
Indirect Referral | A referral between a referral source (e.g., provider) and a referral target (e.g., a CBO) that involves an intermediary (e.g., a CP) and all entities have FHIR servers APIs. | , . |
Indirect Referral Light | A “light” version of the Indirect Referral. A referral between a referral source (e.g., provider) and a referral target (e.g., CBO) that involves an intermediary (e.g., a CP) where the referral source and intermediary have FHIR server APIs and the referral target does not have a FHIR server API but has an application that can access the intermediaries FHIR server API. | , . |
Indirect Referral requires making data instances (e.g., ServiceRequest, Condition, DocumentReference) from the referral source on the intermediary server available for query by the referral target and making some data instances (e.g., Procedures) from the referral target available on the intermediary server for query by the referral source. The intermediary can make this happen by cloning the data from the original record creator, or by proxying access to the creating system. This IG does not specify how precisely this should be done and resolution of this issue should be a topic of implementer discussion.
The direct and indirect referral use cases described below are all preceded by a provider interacting with a patient to assess their needs, establish goals, agree to a referral, and acquire consent. The referral is then initiated, its progress is tracked, and goals are updated as appropriate. The “direct” and “indirect” use cases are distinguished by the absence or presence of an intermediary and, in the “light” versions, the FHIR capabilities of the referral target.
Figure 1 and the Table below show the high-level context of the referral use cases that are described in the sections that follow. For the Table, the “Exchanged” column shows data that could be exchanged at that step, and the “Aligns With” column shows data that is not exchanged in FHIR form but whose content typically corresponds with the listed FHIR profile(s). This only specifies the data that is exchanged, so systems are free to use any internal representation.
The Patient Coordination Workflow shows some, but not all of the possible interactions with the patient. It provides a way for the provider, CP, or CBO to ask a patient to do something, and track whether they have done it and possibly the outcomes. In Figure 1 below, patient coordination is indicated by a red box on steps 9 and 12.
Step | Actors | Description | Exchanged | Aligns With |
---|---|---|---|---|
1 | Patient takes standardized assessment tool to identify social risks and needs. This could be done via a SMART app that would post a QuestionnaireResponse or via the PatientTask mechanism, but could be manual | none | ||
2 | Provider evaluates assessment and identifies social risks | none | ||
3 | , | Provider and Patient:
|
none | none |
4 | Provider promotes the health concern to the problem list, records goals, and captures patient consent | none | ||
5 (optional) | Provider makes information regarding the referral, goals and plan available to the patient’s application | none | ||
6 | , or | Provider1 initiates a referral to the CBO or CP | none | |
7 | or | CBO or CP retrieves information about the referral and any needed supporting information, then decides to accept or reject the referral. If the referral is rejected, the process ends or resumes at step #6 with a new task. | none | |
8 | or | CBO or CP updates the status of their work (task) to reflect progress via notes or status. | none | |
9 (optional) | or , | CBO or CP communicates with the patient via their application to schedule appointments, collect additional information, etc. This IG doesn't highlight communication outside of electronic means, but such communication is possible. | none | none |
10 | or | CBO or CP completes the requested action, updates the status of their work (task) to completed, and includes information on what was completed | none | |
11 | Provider receives the updated status and updates the status of the referral (service request) | none | ||
12 (Optional) | Provider closes loop by gathering feedback/satisfaction via questionnaire | none | ||
13 | Provider determines if the goals/plan have been satisfied and/or progress has been made on the goal/plan and updates the goal/plan appropriately | none |
1Although this workflow references provider as the referral source, the requester element in the two profiles exchanged here allow other roles (e.g., care coordinator) and organizations (e.g., payer) to request a referral.
In this use case, the patient is referred to a CBO for help addressing prioritized needs. The CBO accepts the referral, provides the requested support to the patient, and shares the updated information with the referring provider.
The provider and the CBO have FHIR server APIs.
The example assumes that the provider has an existing relationship with the CBO. The CBO may not accept the referral or may be unable to perform the requested service.
The details of the FHIR-based exchanges are provided in the following section.
Figure 2 shows the FHIR exchanges between the referral source and referral target. For each numbered exchange, the details of the data elements exchanged, and the FHIR request and response are provided.
# | From | Description | Instances involved |
---|---|---|---|
1 | Source | Post Referral Task | Referral Task |
2 | Target | Get Service Request and Referenced Resources | ServiceRequest, Consent, Condition |
3 | Target | Send Notification | Subscription Notification Bundle |
4 | Source | Get Task | Referral Task with status changed |
5 | Target | Send Notification | Subscription Notification Bundle |
6 | Source | Get Task | Referral Task with status changed |
7 | Target | Send Notification | Subscription Notification Bundle |
8 | Source | Get Task | Referral Task with status changed |
9 | Source | Get Procedures | Food Provided, Application Assistance |
In this use case, a provider works with a patient using a standardized assessment instrument to identify and prioritize social risks and needs, and then refers the patient to a CBO for help addressing those needs. The CBO provides the requested support to the patient and the updated information is shared with the referring provider.
The provider has a FHIR server API. Functionally, this differs from the Direct Referral in that the CBO does not have a FHIR server API but has an application that can access a FHIR server API. As a result, the provider can’t push information to the CBO, but rather the CBO needs to pull information from the provider. At the conclusion of the referral, the CBO POSTS necessary information (e.g., Procedures) to the provider’s FHIR server API and updates the status and the linked resources of the Task.
The details of the FHIR-based exchanges are provided in the following section.
This referral occurs between the provider (referral source) and the CBO (referral target) where the CBO does not have a FHIR server API. The CBO accesses and manipulates information either using its own software which has a conformant FHIR client or using a third-party application as a FHIR client.
Figure 3 shows the FHIR exchanges between the referral source and referral target. For each numbered exchange, the details of the data elements exchanged, and the FHIR request and response are provided.
# | From | Description | Instances involved |
---|---|---|---|
1 | Source | Send e-mail with link to application and authentication instructions | |
2 | Target | Get Task | Referral Task |
3 | Target | Get Service Request and Referenced Resources | ServiceRequest, Consent, Condition |
4 | Target | Update Task (accepted) | Referral Task with status changed |
5 | Target | Update Task (in-progress) | Referral Task with status changed |
6 | Target | Post Procedures | Food Provided, Application Assistance |
7 | Source | Update Task (completed) | Referral Task with status changed |
In this use case, a provider works with a patient using a standardized assessment instrument to identify and prioritize social risks and needs, and then refers the patient indirectly via a CP to a CBO for help addressing those needs. The CP relays the referral to the CBO. The CBO provides the requested support to the patient and the updated information is relayed back through the CP where it is shared with the referring provider.
Functionally, this Indirect Referral is essentially two direct referrals (provider to CP, and CP to CBO) chained together. The provider, CP, and CBO all have FHIR server APIs.
The provider has a relationship with the CP, but not with the CBO. The use case assumes that the CP and the CPO have an established relationship. The provider may request to have the service delivered by a specific CBO. The CP may not accept the referral, be unable to perform the requested service, or may need to split the request into multiple tasks to be performed by one or more CBOs.
The referral occurs in two separate interactions. The first is between the referral source and the intermediary and the second is between the intermediary and the referral target.
In the Indirect Referral, this IG assumes that the referral source does not have the ability to communicate directly with the referral target. There may be multiple referral targets for responsibilities that will be determined and managed by the intermediary.
The intermediary SHALL support the following:
The patient is assessed by a provider and referred to a CP. The CP refers to a CBO to deliver the service. The provider and CP have FHIR server APIs. The CBO does not have a FHIR server API but has an application that can access a FHIR server API.
This section differs from the Indirect Referral in that the interactions between the CP and CBO follow the Direct Light paradigm. The CBO will maintain data on the CP’s FHIR server API. CBOs without their own FHIR server API will modify tasks directly on the CP’s FHIR server API.
The provider has a relationship with the CP, but not with the CBO. The use case assumes that the CP and the CBO have an established relationship. The provider may request to have the service delivered by a specific CBO. The CP may not accept the referral, be unable to perform the requested service, or may need to split the request into multiple tasks to be performed by one or more CBOs.
The referral occurs in two separate interactions. The first is between the referral source and the intermediary and the second is between the intermediary and the referral target.
The intermediary SHALL support the following:
This implementation guide supports additional interactions with a patient/client application (on a smartphone or portal) including:
Functional Use Case | Task.code | Description | Actors |
---|---|---|---|
Complete Questionnaire Request | complete-questionnaire |
Requesting party (e.g., provider, CBO, or CP) asks a patient to complete a questionnaire. This functionality can be used to assess social risks, inform service qualification or application, indicate reasons for cancellation, or determine the patient’s view of their interaction with the CBO and whether the service provided met their needs. | , , , |
General Information Request | general-information-request |
Requesting party sends a patient a free text question and receives a free text response. | , , , |
Make Contact Request | make-contact-directions |
Requesting party provides contact information for the CBO (in cases where the patient does not want the CBO to initiate contact). | , , , |
Review Material Request | review-material |
Requesting party requests that the patient review a document (usually a PDF), video, etc. | , , , |
In the examples below, it is assumed that the patient has been equipped with the patient application, and authenticated communication between the patient application and the requester has already been established. See Connecting Applications with API Data Sources for more details. The referenced data instances are all in their completed state. In practice, they would move through the state transitions indicated, with the requester initializing their input fields, and the patient completing the output fields, and updating the status.
Here we provide a detailed view of an example interaction between a patient application and a requester (provider, CBO, or CP) for the completion of a questionnaire. The example shows one of the four ways the questionnaire can be transmitted and the response received from the patient.
# | From | Description | Instances involved |
---|---|---|---|
1 | Patient | Get Task | Patient Task |
2 | Patient | Get Questionnaire, Questionnaire PDF, or Questionnaire URL | Questionnaire |
3 | Patient | Update Task (in-progress) | Patient Task with status changed |
4 | Patient | Post Questionnaire Response or Document Reference with Filled Out PDF | QuestionnaireResponse |
5 | Patient | Update Task (completed and .Output references QuestionnaireResponse) | Patient Task with status changed |
Here we provide a detailed view of an interaction between a patient application and a requester (provider, CBO, or CP) for a general information request. The example shows the patient returning an optional response.
# | From | Description | Instances involved |
---|---|---|---|
1 | Patient | Get Task | Patient Task |
2 | Patient | Update Task (in-progress) | Patient Task with status changed |
3 | Patient | Update Task (completed and .Output.value includes text of response) | Patient Task with status changed |
Here we provide a detailed view of an interaction between a patient application and a requester (provider, CBO, or CP) for providing one or more options from which to select to make contact with a service, provider or organization. The example shows the patient returning an optional response.
# | From | Description | Instances involved |
---|---|---|---|
1 | Patient | Get Task | Patient Task |
2 | Patient | Get Contact | HealthCareService |
3 | Patient | Update Task (in-progress) | Patient Task with status changed |
4 | Patient | Update Task (completed and .Output includes chosen contact) | Patient Task with status changed |
Here we provide a detailed view of an interaction between a patient application and a requester (provider, CBO, or CP) for providing review material.
# | From | Description | Instances involved |
---|---|---|---|
1 | Patient | Get Task | Patient Task |
2 | Patient | Get DocumentReference | DocumentReference |
3 | Patient | Update Task (in-progress) | Patient Task with status changed |
4 | Patient | Update Task (completed) | Patient Task with status changed |