{
"description": null,
"_filename": "ExampleScenario-Scen3ProviderToYMCAReferral.json",
"package_name": "hl7.fhir.us.physical-activity.r4",
"date": "2023-08-25T16:04:38+00:00",
"publisher": "HL7 International - Patient Care WG",
"instance": [ {
"name": "Query for Referral & Patient for YMCA Task",
"resourceId": "Scen3query1",
"description": "Search to retrieve ServiceRequest and Patient for specified Task: `GET https://mainClinic.example.org/fhir/ServiceRequest?_id=Scen3ServiceRequest&_include=ServiceRequest:patient`",
"resourceType": "Binary"
}, {
"name": "Query for EHR-issued task based on notification",
"resourceId": "Scen3query2",
"description": "Search to retrieve Task: `GET https://YMCA.example.org/fhir/Task?_id=Scen3TaskYMCA`",
"resourceType": "Binary"
}, {
"name": "Subscription from EHR",
"extension": [ {
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.content",
"valueReference": {
"reference": "Subscription/Scen3SubscriptionEhr"
}
} ],
"resourceId": "Scen3SubscriptionEhr",
"description": "Establishes the subscription for the EHR to monitor tasks it's created",
"resourceType": "Subscription"
}, {
"name": "Task seeking FitLife to fulfill referral",
"version": [ {
"extension": [ {
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.version.title",
"valueString": "Initial YMCA Task"
}, {
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.version.content",
"valueReference": {
"reference": "Task/Scen3TaskYMCAV1"
}
} ],
"versionId": "1",
"description": "Initial version of the referral fulfillment request for YMCA with a status of 'requested'"
}, {
"extension": [ {
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.version.title",
"valueString": "Updated YMCA Task"
}, {
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.version.content",
"valueReference": {
"reference": "Task/Scen3TaskYMCAV2"
}
} ],
"versionId": "2",
"description": "Version of the referral fulfillment request for YMCA after it has been changed to 'accepted'"
}, {
"extension": [ {
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.version.title",
"valueString": "Completed YMCA Task"
}, {
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.version.content",
"valueReference": {
"reference": "Task/Scen3TaskYMCAV3"
}
} ],
"versionId": "3",
"description": "Version of the referral fulfillment request for YMCA after it has been changed to 'completed' and a link to the report added"
} ],
"resourceId": "Scen3TaskYMCA",
"description": "A Task seeking fulfillment by the YMCA of the referral for an exercise program",
"resourceType": "Task"
}, {
"name": "ServiceRequest search response for YMCA",
"extension": [ {
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.content",
"valueReference": {
"reference": "Bundle/Scen3ServiceRequestYMCAResponseBundle"
}
} ],
"resourceId": "Scen3ServiceRequestYMCAResponseBundle",
"description": "Search-set Bundle returning ServiceRequest and Patient for the Task posted to the YMCA",
"resourceType": "Bundle"
}, {
"name": "Subscription Notification that Task has updated",
"extension": [ {
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.content",
"valueReference": {
"reference": "Bundle/Scen3NotificationUpdatedTaskBundle"
}
} ],
"resourceId": "Scen3NotificationUpdatedTaskBundle",
"description": "Pointer to the Task that has been updated",
"resourceType": "Bundle"
}, {
"name": "Subscription Notification that Task has completed",
"extension": [ {
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.content",
"valueReference": {
"reference": "Bundle/Scen3NotificationCompletedTaskBundle"
}
} ],
"resourceId": "Scen3NotificationCompletedTaskBundle",
"description": "Pointer to the Task that has been updated",
"resourceType": "Bundle"
}, {
"name": "Accepted Task search response for EHR",
"extension": [ {
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.content",
"valueReference": {
"reference": "Bundle/Scen3TaskEHRResponseBundle1"
}
} ],
"resourceId": "Scen3TaskEHRResponseBundle1",
"description": "Search-set Bundle returning 'accepted' Task with id based on subscription notification",
"resourceType": "Bundle",
"containedInstance": [ {
"versionId": "2",
"resourceId": "Scen3TaskYMCA"
} ]
}, {
"name": "Completed Task search response for EHR",
"extension": [ {
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.content",
"valueReference": {
"reference": "Bundle/Scen3TaskEHRResponseBundle2"
}
} ],
"resourceId": "Scen3TaskEHRResponseBundle2",
"description": "Search-set Bundle returning 'completed' Task with id based on subscription notification",
"resourceType": "Bundle",
"containedInstance": [ {
"versionId": "3",
"resourceId": "Scen3TaskYMCA"
} ]
} ],
"jurisdiction": [ {
"coding": [ {
"code": "US",
"system": "urn:iso:std:iso:3166"
} ]
} ],
"name": "PatientSeeksReferralforExerciseProgram",
"process": [ {
"step": [ {
"operation": {
"name": "Create EHR-monitoring Subscription",
"type": "create",
"number": "1",
"request": {
"resourceId": "Scen3SubscriptionEhr"
},
"receiver": "mainClinic",
"initiator": "YMCA",
"description": "YMCA posts Subscription to EHR to monitor Tasks. Request: `POST https://mainClinic.example.org/fhir/Subscription` Response: `201 Created`"
}
} ],
"title": "Subscription Establishment",
"preConditions": "Main Street Clinic and Cinicinnati Central YMCA have established legal and technical arrangements for interoperability",
"postConditions": "Subscription is successfully created allowing Main Street Clinic to monitor YMCA-assigned Tasks"
}, {
"step": [ {
"operation": {
"name": "Create Task on YMCA",
"type": "create",
"number": "2",
"request": {
"versionId": "1",
"resourceId": "Scen3TaskYMCA"
},
"receiver": "YMCA",
"initiator": "mainClinic",
"description": "New Task is created directly on YMCA's server. Request: `POST https://YMCA.example.org/fhir/Task` Response: `201 Created`"
}
}, {
"operation": {
"name": "YMCA retrieves referral",
"type": "search-type",
"number": "3",
"request": {
"resourceId": "Scen3query1"
},
"receiver": "mainClinic",
"response": {
"resourceId": "Scen3ServiceRequestYMCAResponseBundle"
},
"initiator": "YMCA",
"description": "YMCA retrieves the ServiceRequest and Patient referenced by the Task."
}
}, {
"operation": {
"name": "EHR gets referral acceptance",
"type": "create",
"number": "4",
"request": {
"resourceId": "Scen3NotificationUpdatedTaskBundle"
},
"receiver": "mainClinic",
"initiator": "YMCA",
"description": "A subscription notification to the EHR is triggered when YMCA changes the prescription status to 'in-progress'. Request: `POST https://mainClinic.example.org/mySubscriptions` Response: `200 Ok`"
}
}, {
"operation": {
"name": "EHR retrieves in-progress Task",
"type": "search-type",
"number": "5",
"request": {
"resourceId": "Scen3query2"
},
"receiver": "YMCA",
"response": {
"resourceId": "Scen3TaskEHRResponseBundle1"
},
"initiator": "mainClinic",
"description": "EHR retrieves the Task referenced by the subscription notification"
}
} ],
"title": "A minute after creation of ServiceRequest",
"preConditions": "EHR has created a ServiceRequest for Mr. Shevchenko",
"postConditions": "YMCA has retrieved the ServiceRequest and the Patient, and updated the Task to 'in-progress'"
}, {
"step": [ {
"operation": {
"name": "EHR gets referral acceptance",
"type": "create",
"number": "6",
"request": {
"resourceId": "Scen3NotificationCompletedTaskBundle"
},
"receiver": "mainClinic",
"initiator": "YMCA",
"description": "A subscription notification to the EHR is triggered when the YMCA changes the Task status to 'completed'. Request: `POST https://mainClinic.example.org/mySubscriptions` Response: `200 Ok`"
}
}, {
"operation": {
"name": "EHR retrieves completed Task",
"type": "search-type",
"number": "7",
"request": {
"resourceId": "Scen3query2"
},
"receiver": "YMCA",
"response": {
"resourceId": "Scen3TaskEHRResponseBundle2"
},
"initiator": "mainClinic",
"description": "EHR retrieves the Task referenced by the subscription notification"
}
} ],
"title": "About 4 Months Later",
"preConditions": "YMCA is actively working on the Task",
"postConditions": "YMCA has completed the referral and Dr. Blackrock is aware of the results"
} ],
"type": null,
"experimental": null,
"resourceType": "ExampleScenario",
"title": null,
"package_version": "1.0.0",
"status": "draft",
"id": "c7255a79-c17a-4e35-80a3-7fcbc16709f4",
"kind": null,
"url": "http://hl7.org/fhir/us/physical-activity/ExampleScenario/Scen3ProviderToYMCAReferral",
"version": "1.0.0",
"contact": [ {
"name": "HL7 International - Patient Care WG",
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/patientcare",
"system": "url"
} ]
} ],
"actor": [ {
"name": "Main Street Clinic",
"type": "entity",
"actorId": "mainClinic",
"description": "Dr. Blackrock's EHR - creates referral at patient's request"
}, {
"name": "Cincinnati Central YMCA",
"type": "entity",
"actorId": "YMCA",
"description": "Fitness service provider who offers exercise program"
} ]
}