Difference between revisions of "201701 Resource Subscription Track"

From HL7Wiki
Jump to navigation Jump to search
(201701 FHIR Connectathon Resource Subscription Track)
 
Line 1: Line 1:
 
+
[http://wiki.hl7.org/index.php?title=Category:201701_FHIR_Connectathon_Track_Proposals Return to January 2017 Proposals]
 
[[Category:201701_FHIR_Connectathon_Track_Proposals|Jan 2017 Proposals]]
 
[[Category:201701_FHIR_Connectathon_Track_Proposals|Jan 2017 Proposals]]
 
__NOTOC__
 
__NOTOC__
=Track Name=
+
=FHIR Resource Subscription Track=
  
 
==Submitting WG/Project/Implementer Group==
 
==Submitting WG/Project/Implementer Group==
 
<!-- Who is asking for this track? -->
 
<!-- Who is asking for this track? -->
 +
[http://www.hl7.org/Special/committees/fiwg/index.cfm  FHIR Management Group (FMG)] (Proposed)
 +
[http://hspconsortium.org Healthcare Services Platform Consortium (HSPC)] (Proposed)
  
 
==Justification==
 
==Justification==
 
<!--Why is this an important track to include in the connectathon - include implementer need, impact on ballot, FMM readiness of the resources, etc. -->
 
<!--Why is this an important track to include in the connectathon - include implementer need, impact on ballot, FMM readiness of the resources, etc. -->
 +
As part of the Workflow Module, the FHIR specification includes capabilities for a client to subscribe to receive notifications to resources that have been created or updated. The Subscription resource is used to define a push based subscription from a server to another system through a number of defined “channels”. The subscription includes criteria in the form of a search string that, when a resource is created or updated that match it, trigger a notification from the server through the channel specified in the original subscription request. Depending on the subscription request and channel, the notification may take the form of a simple reference, either to the search string or matching resource, or may include the content of the matching resources.
 +
 +
Proper workflow management and information orchestration is critical for any diverse and complex interoperable health IT ecosystem. A critical component of enabling effective workflow is the ability to receive updates on particular pieces of information of interest. For example, if a patient has a number of tests run during a specific encounter the results of those tests may not be immediately available. A provider that is interested in those results when they arrive could subscribe for notifications about the creation or updating of Observation resources that are associated with that encounter. Another example is where a provider may be interested in getting notifications on the progress of a specific patient’s condition.
 +
 +
The purpose of this track is to gain more implementer experience in the Subscription resource and identify areas where more definition may be needed in the specification and help move this resource to a higher maturity level.
 +
  
 
==Proposed Track Lead==
 
==Proposed Track Lead==
 
<!-- Name, email and Skype id of individual who will coordinate the track at the connectathon -->
 
<!-- Name, email and Skype id of individual who will coordinate the track at the connectathon -->
 
See [[Connectathon_Track_Lead_Responsibilities]]
 
See [[Connectathon_Track_Lead_Responsibilities]]
 +
 +
*[mailto:CoreySpears@infor.com Corey Spears]
 +
*[mailto:simone.heckmann@health-comm.de Simone Heckmann]
 +
  
 
==Expected participants==
 
==Expected participants==
 
<!-- List of the individuals and/or organizations that have indicated a desire to attend the connectathon and implement this track -->
 
<!-- List of the individuals and/or organizations that have indicated a desire to attend the connectathon and implement this track -->
 +
*[http://www.infor.com Infor]
 +
*[http://health-comm.de Health-Comm GmbH]
 +
*[http://http://hapifhir.io HAPI] (Proposed)
 +
*[http://hspconsortium.org Healthcare Services Platform Consortium (HSPC)] (Proposed)
 +
 +
Please sign up!
 +
 +
If you're working on a server, please complete the [https://docs.google.com/a/healthedatainc.com/spreadsheets/d/1WVL09ge7SXE-Og6k3oVqWH9dcRexq76uIpGjJOBO4rQ/edit?usp=sharing "servers" tab of the Signup Spreadsheet] **This time around you'll need to update the `status` flag to indicate whether you've begun work (or completed work), so clients will know when to start testing.** You'll also share details about how a developer can obtain OAuth client credentials (`client_id` for public apps, or a `client_id` and `client_secret` for confidential apps) as well as user login credentials. You might consider simply sharing a set of fixed credentials in this spreadsheet, or else directing users to a web page where they can complete self-service registration. If absolutely necessary, you can ask developers to e-mail you directly.
 +
 +
If you're working on a client, please complete the [https://docs.google.com/a/healthedatainc.com/spreadsheets/d/1WVL09ge7SXE-Og6k3oVqWH9dcRexq76uIpGjJOBO4rQ/edit?usp=sharing "clients" tab of the Sprint 4 Spreadsheet]. You'll also need to update the `status` flag to indicate whether you've begun work (or completed work).
 +
  
 
==Roles==
 
==Roles==
 
Please include information here regarding how much advance preparation will be required if creating a client and/or server.
 
Please include information here regarding how much advance preparation will be required if creating a client and/or server.
 
<!-- Roles are sets of functionality (generally defined by a Conformance resource) that a single system can take on -->
 
<!-- Roles are sets of functionality (generally defined by a Conformance resource) that a single system can take on -->
===Role 1 Name===
+
===FHIR Subscription Client===
 +
<!-- Provide a description of the capabilities this role will have within the connectathon -->
 +
Enable creating, updating, and deleting of subscription resources that include a search string criteria.
 +
 
 +
===FHIR Server===
 +
<!-- Provide a description of the capabilities this role will have within the connectathon -->
 +
Support the receiving and processing of subscription resources and provide notifications for resources through the requested channel (if the channel is supported).
 +
 
 +
===Subscription Notification Receiver===
 
<!-- Provide a description of the capabilities this role will have within the connectathon -->
 
<!-- Provide a description of the capabilities this role will have within the connectathon -->
 +
Receive notifications from the server over the channel identified in the subscription resource. Query for the resource information if not provided in the notification payload. (NOTE: The notification receiver may, but does not have to, be the same as the subscription client, particularly considering the receiver may be a mobile device (SMS) or secure emailing system)
  
 
==Scenarios==
 
==Scenarios==
 
<!-- What will be the actions performed by participants? -->
 
<!-- What will be the actions performed by participants? -->
 +
=== 1. Create an Active Subscription ===
 +
:Action: <!--Who does what?  (Use the role names listed above when referring to the participants -->tbd
 +
:Precondition: <!-- What setup is required prior to executing this step? -->tbd
 +
:Success Criteria: <!-- How will the participants know if the test was successful? -->tbd
 +
:Bonus point: <!-- Any additional complexity to make the scenario more challenging -->tbd
 +
 +
=== 2. Search for Active Subscriptions ===
 +
:Action: tbd
 +
:Precondition: tbd
 +
:Success Criteria: tbd
 +
:Bonus point: tbd
 +
 +
=== 3. Delete a Subscription ===
 +
:Action: tbd
 +
:Precondition: tbd
 +
:Success Criteria: tbd
 +
:Bonus point: tbd
  
===Scenario Step 1 Name===
+
=== 4. Receive a Notification ===
:Action: <!--Who does what?  (Use the role names listed above when referring to the participants -->
+
:Action: tbd
:Precondition: <!-- What setup is required prior to executing this step? -->
+
:Precondition: tbd
:Success Criteria: <!-- How will the participants know if the test was successful? -->
+
:Success Criteria: tbd
:Bonus point: <!-- Any additional complexity to make the scenario more challenging -->
+
:Bonus point: tbd
  
 
<!-- Provide a description of each task -->
 
<!-- Provide a description of each task -->
Line 38: Line 87:
 
These should be committed to SVN under trunk/connectathons/[connectathon]
 
These should be committed to SVN under trunk/connectathons/[connectathon]
 
-->
 
-->
 +
The supporting TestScripts and corresponding fixtures will be committed to the FHIR SVN.
 +
 +
==Help Links==
 +
[http://build.fhir.org/subscription.html Subscription Resource Definition]

Revision as of 00:54, 28 October 2016

Return to January 2017 Proposals

FHIR Resource Subscription Track

Submitting WG/Project/Implementer Group

FHIR Management Group (FMG) (Proposed) Healthcare Services Platform Consortium (HSPC) (Proposed)

Justification

As part of the Workflow Module, the FHIR specification includes capabilities for a client to subscribe to receive notifications to resources that have been created or updated. The Subscription resource is used to define a push based subscription from a server to another system through a number of defined “channels”. The subscription includes criteria in the form of a search string that, when a resource is created or updated that match it, trigger a notification from the server through the channel specified in the original subscription request. Depending on the subscription request and channel, the notification may take the form of a simple reference, either to the search string or matching resource, or may include the content of the matching resources.

Proper workflow management and information orchestration is critical for any diverse and complex interoperable health IT ecosystem. A critical component of enabling effective workflow is the ability to receive updates on particular pieces of information of interest. For example, if a patient has a number of tests run during a specific encounter the results of those tests may not be immediately available. A provider that is interested in those results when they arrive could subscribe for notifications about the creation or updating of Observation resources that are associated with that encounter. Another example is where a provider may be interested in getting notifications on the progress of a specific patient’s condition.

The purpose of this track is to gain more implementer experience in the Subscription resource and identify areas where more definition may be needed in the specification and help move this resource to a higher maturity level.


Proposed Track Lead

See Connectathon_Track_Lead_Responsibilities


Expected participants

Please sign up!

If you're working on a server, please complete the "servers" tab of the Signup Spreadsheet **This time around you'll need to update the `status` flag to indicate whether you've begun work (or completed work), so clients will know when to start testing.** You'll also share details about how a developer can obtain OAuth client credentials (`client_id` for public apps, or a `client_id` and `client_secret` for confidential apps) as well as user login credentials. You might consider simply sharing a set of fixed credentials in this spreadsheet, or else directing users to a web page where they can complete self-service registration. If absolutely necessary, you can ask developers to e-mail you directly.

If you're working on a client, please complete the "clients" tab of the Sprint 4 Spreadsheet. You'll also need to update the `status` flag to indicate whether you've begun work (or completed work).


Roles

Please include information here regarding how much advance preparation will be required if creating a client and/or server.

FHIR Subscription Client

Enable creating, updating, and deleting of subscription resources that include a search string criteria.

FHIR Server

Support the receiving and processing of subscription resources and provide notifications for resources through the requested channel (if the channel is supported).

Subscription Notification Receiver

Receive notifications from the server over the channel identified in the subscription resource. Query for the resource information if not provided in the notification payload. (NOTE: The notification receiver may, but does not have to, be the same as the subscription client, particularly considering the receiver may be a mobile device (SMS) or secure emailing system)

Scenarios

1. Create an Active Subscription

Action: tbd
Precondition: tbd
Success Criteria: tbd
Bonus point: tbd

2. Search for Active Subscriptions

Action: tbd
Precondition: tbd
Success Criteria: tbd
Bonus point: tbd

3. Delete a Subscription

Action: tbd
Precondition: tbd
Success Criteria: tbd
Bonus point: tbd

4. Receive a Notification

Action: tbd
Precondition: tbd
Success Criteria: tbd
Bonus point: tbd


TestScript(s)

The supporting TestScripts and corresponding fixtures will be committed to the FHIR SVN.

Help Links

Subscription Resource Definition