FHIR IG Statistics: ExampleScenario/Scen3ProviderToYMCAReferral

Resources that use this resource

No resources found

Resources that this resource uses

No resources found

Narrative

Note: links and images are rebased to the (stated) source

Source

{
  "resourceType": "ExampleScenario",
  "id": "Scen3ProviderToYMCAReferral",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "pc"
    }
  ],
  "url": "http://hl7.org/fhir/us/physical-activity/ExampleScenario/Scen3ProviderToYMCAReferral",
  "version": "1.0.1",
  "name": "PatientSeeksReferralforExerciseProgram",
  "status": "draft",
  "date": "2024-03-12T17:26:10+00:00",
  "publisher": "HL7 International / Patient Care",
  "contact": [
    {
      "name": "HL7 International / Patient Care",
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/patientcare"
        }
      ]
    }
  ],
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "US"
        }
      ]
    }
  ],
  "actor": [
    {
      "actorId": "mainClinic",
      "type": "entity",
      "name": "Main Street Clinic",
      "description": "Dr. Blackrock's EHR - creates referral at patient's request"
    },
    {
      "actorId": "YMCA",
      "type": "entity",
      "name": "Cincinnati Central YMCA",
      "description": "Fitness service provider who offers exercise program"
    }
  ],
  "instance": [
    {
      "resourceId": "Scen3query1",
      "resourceType": "Binary",
      "name": "Query for Referral & Patient for YMCA Task",
      "description": "Search to retrieve ServiceRequest and Patient for specified Task: `GET https://mainClinic.example.org/fhir/ServiceRequest?_id=Scen3ServiceRequest&_include=ServiceRequest:patient`"
    },
    {
      "resourceId": "Scen3query2",
      "resourceType": "Binary",
      "name": "Query for EHR-issued task based on notification",
      "description": "Search to retrieve Task: `GET https://YMCA.example.org/fhir/Task?_id=Scen3TaskYMCA`"
    },
    {
      "extension": [
        {
          "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.content",
          "valueReference": {
            "reference": "Subscription/Scen3SubscriptionEhr"
          }
        }
      ],
      "resourceId": "Scen3SubscriptionEhr",
      "resourceType": "Subscription",
      "name": "Subscription from EHR",
      "description": "Establishes the subscription for the EHR to monitor tasks it's created"
    },
    {
      "resourceId": "Scen3TaskYMCA",
      "resourceType": "Task",
      "name": "Task seeking FitLife to fulfill referral",
      "description": "A Task seeking fulfillment by the YMCA of the referral for an exercise program",
      "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"
        }
      ]
    },
    {
      "extension": [
        {
          "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.content",
          "valueReference": {
            "reference": "Bundle/Scen3ServiceRequestYMCAResponseBundle"
          }
        }
      ],
      "resourceId": "Scen3ServiceRequestYMCAResponseBundle",
      "resourceType": "Bundle",
      "name": "ServiceRequest search response for YMCA",
      "description": "Search-set Bundle returning ServiceRequest and Patient for the Task posted to the YMCA"
    },
    {
      "extension": [
        {
          "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.content",
          "valueReference": {
            "reference": "Bundle/Scen3NotificationUpdatedTaskBundle"
          }
        }
      ],
      "resourceId": "Scen3NotificationUpdatedTaskBundle",
      "resourceType": "Bundle",
      "name": "Subscription Notification that Task has updated",
      "description": "Pointer to the Task that has been updated"
    },
    {
      "extension": [
        {
          "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.content",
          "valueReference": {
            "reference": "Bundle/Scen3NotificationCompletedTaskBundle"
          }
        }
      ],
      "resourceId": "Scen3NotificationCompletedTaskBundle",
      "resourceType": "Bundle",
      "name": "Subscription Notification that Task has completed",
      "description": "Pointer to the Task that has been updated"
    },
    {
      "extension": [
        {
          "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.content",
          "valueReference": {
            "reference": "Bundle/Scen3TaskEHRResponseBundle1"
          }
        }
      ],
      "resourceId": "Scen3TaskEHRResponseBundle1",
      "resourceType": "Bundle",
      "name": "Accepted Task search response for EHR",
      "description": "Search-set Bundle returning 'accepted' Task with id based on subscription notification",
      "containedInstance": [
        {
          "resourceId": "Scen3TaskYMCA",
          "versionId": "2"
        }
      ]
    },
    {
      "extension": [
        {
          "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-ExampleScenario.instance.content",
          "valueReference": {
            "reference": "Bundle/Scen3TaskEHRResponseBundle2"
          }
        }
      ],
      "resourceId": "Scen3TaskEHRResponseBundle2",
      "resourceType": "Bundle",
      "name": "Completed Task search response for EHR",
      "description": "Search-set Bundle returning 'completed' Task with id based on subscription notification",
      "containedInstance": [
        {
          "resourceId": "Scen3TaskYMCA",
          "versionId": "3"
        }
      ]
    }
  ],
  "process": [
    {
      "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": {
            "number": "1",
            "type": "create",
            "name": "Create EHR-monitoring Subscription",
            "initiator": "YMCA",
            "receiver": "mainClinic",
            "description": "YMCA posts Subscription to EHR to monitor Tasks. Request: `POST https://mainClinic.example.org/fhir/Subscription`  Response: `201 Created`",
            "request": {
              "resourceId": "Scen3SubscriptionEhr"
            }
          }
        }
      ]
    },
    {
      "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": {
            "number": "2",
            "type": "create",
            "name": "Create Task on YMCA",
            "initiator": "mainClinic",
            "receiver": "YMCA",
            "description": "New Task is created directly on YMCA's server.  Request: `POST https://YMCA.example.org/fhir/Task` Response: `201 Created`",
            "request": {
              "resourceId": "Scen3TaskYMCA",
              "versionId": "1"
            }
          }
        },
        {
          "operation": {
            "number": "3",
            "type": "search-type",
            "name": "YMCA retrieves referral",
            "initiator": "YMCA",
            "receiver": "mainClinic",
            "description": "YMCA retrieves the ServiceRequest and Patient referenced by the Task.",
            "request": {
              "resourceId": "Scen3query1"
            },
            "response": {
              "resourceId": "Scen3ServiceRequestYMCAResponseBundle"
            }
          }
        },
        {
          "operation": {
            "number": "4",
            "type": "create",
            "name": "EHR gets referral acceptance",
            "initiator": "YMCA",
            "receiver": "mainClinic",
            "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`",
            "request": {
              "resourceId": "Scen3NotificationUpdatedTaskBundle"
            }
          }
        },
        {
          "operation": {
            "number": "5",
            "type": "search-type",
            "name": "EHR retrieves in-progress Task",
            "initiator": "mainClinic",
            "receiver": "YMCA",
            "description": "EHR retrieves the Task referenced by the subscription notification",
            "request": {
              "resourceId": "Scen3query2"
            },
            "response": {
              "resourceId": "Scen3TaskEHRResponseBundle1"
            }
          }
        }
      ]
    },
    {
      "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",
      "step": [
        {
          "operation": {
            "number": "6",
            "type": "create",
            "name": "EHR gets referral acceptance",
            "initiator": "YMCA",
            "receiver": "mainClinic",
            "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`",
            "request": {
              "resourceId": "Scen3NotificationCompletedTaskBundle"
            }
          }
        },
        {
          "operation": {
            "number": "7",
            "type": "search-type",
            "name": "EHR retrieves completed Task",
            "initiator": "mainClinic",
            "receiver": "YMCA",
            "description": "EHR retrieves the Task referenced by the subscription notification",
            "request": {
              "resourceId": "Scen3query2"
            },
            "response": {
              "resourceId": "Scen3TaskEHRResponseBundle2"
            }
          }
        }
      ]
    }
  ]
}