This page is part of the U.S. Physical Activity IG (v1.0.0: STU 1.0) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/fhir/us/physical-activity/ExampleScenario/Scen3ProviderToYMCAReferral | Version: 1.0.0 | |||
Standards status: Informative | Computable Name: PatientSeeksReferralforExerciseProgram |
This scenario provides an example of the types of data exchanges that are described in the Patient Seeks Referral for Exercise Program scenario from the Scenarios page.
The scenario shows the flows of information between the different systems and the various FHIR calls involved, as well as what the data might have looked like in each of the exchanges. There are detailed tables below that provide details on each of the steps in the exchange as well as the types of data being shared. From the instances table, it's possible to navigate to sample XML and JSON instances.
Name | Type | Description |
---|---|---|
Main Street Clinic | System | Dr. Blackrock's EHR - creates referral at patient's request |
Cincinnati Central YMCA | System | Fitness service provider who offers exercise program |
Pre-conditions:
Main Street Clinic and Cinicinnati Central YMCA have established legal and technical arrangements for interoperability
Post-conditions:
Subscription is successfully created allowing Main Street Clinic to monitor YMCA-assigned Tasks
Step | Name | Description | Initator | Receiver | Request | Response |
---|---|---|---|---|---|---|
1 | Create EHR-monitoring Subscription - create | YMCA posts Subscription to EHR to monitor Tasks. Request: | Cincinnati Central YMCA | Main Street Clinic | Subscription from EHR |
Pre-conditions:
EHR has created a ServiceRequest for Mr. Shevchenko
Post-conditions:
YMCA has retrieved the ServiceRequest and the Patient, and updated the Task to 'in-progress'
Step | Name | Description | Initator | Receiver | Request | Response |
---|---|---|---|---|---|---|
2 | Create Task on YMCA - create | New Task is created directly on YMCA's server. Request: | Main Street Clinic | Cincinnati Central YMCA | Initial YMCA Task | |
3 | YMCA retrieves referral - search-type | YMCA retrieves the ServiceRequest and Patient referenced by the Task. | Cincinnati Central YMCA | Main Street Clinic | Query for Referral & Patient for YMCA Task | ServiceRequest search response for YMCA |
4 | EHR gets referral acceptance - create | A subscription notification to the EHR is triggered when YMCA changes the prescription status to 'in-progress'. Request: | Cincinnati Central YMCA | Main Street Clinic | Subscription Notification that Task has updated | |
5 | EHR retrieves in-progress Task - search-type | EHR retrieves the Task referenced by the subscription notification | Main Street Clinic | Cincinnati Central YMCA | Query for EHR-issued task based on notification | Accepted Task search response for EHR |
Pre-conditions:
YMCA is actively working on the Task
Post-conditions:
YMCA has completed the referral and Dr. Blackrock is aware of the results
Step | Name | Description | Initator | Receiver | Request | Response |
---|---|---|---|---|---|---|
6 | EHR gets referral acceptance - create | A subscription notification to the EHR is triggered when the YMCA changes the Task status to 'completed'. Request: | Cincinnati Central YMCA | Main Street Clinic | Subscription Notification that Task has completed | |
7 | EHR retrieves completed Task - search-type | EHR retrieves the Task referenced by the subscription notification | Main Street Clinic | Cincinnati Central YMCA | Query for EHR-issued task based on notification | Completed Task search response for EHR |
Name | Type | Content | Description |
---|---|---|---|
Query for Referral & Patient for YMCA Task | Binary | Search to retrieve ServiceRequest and Patient for specified Task: | |
Query for EHR-issued task based on notification | Binary | Search to retrieve Task: | |
Subscription from EHR | Subscription | here | Establishes the subscription for the EHR to monitor tasks it's created |
Task seeking FitLife to fulfill referral | Task | A Task seeking fulfillment by the YMCA of the referral for an exercise program | |
| here | A Task seeking fulfillment by the YMCA of the referral for an exercise program | |
| here | A Task seeking fulfillment by the YMCA of the referral for an exercise program | |
| here | A Task seeking fulfillment by the YMCA of the referral for an exercise program | |
ServiceRequest search response for YMCA | Bundle | here | Search-set Bundle returning ServiceRequest and Patient for the Task posted to the YMCA |
Subscription Notification that Task has updated | Bundle | here | Pointer to the Task that has been updated |
Subscription Notification that Task has completed | Bundle | here | Pointer to the Task that has been updated |
Accepted Task search response for EHR | Bundle | here | Search-set Bundle returning 'accepted' Task with id based on subscription notification |
Completed Task search response for EHR | Bundle | here | Search-set Bundle returning 'completed' Task with id based on subscription notification |