This wiki has undergone a migration to Confluence found Here
<meta name="googlebot" content="noindex">

Difference between revisions of "201801 FHIR Subscriptions"

From HL7Wiki
Jump to navigation Jump to search
Line 34: Line 34:
 
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 Server===
<!-- Provide a description of the capabilities this role will have within the connectathon -->
+
The FHIR Server supports the Subscription resource and pushing relevant FHIR resources to client.
 +
* Must expose a Subscriptions resource supporting read, create and update.
 +
* Must also act as a FHIR client to send notifications.
  
==Scenarios==
+
==Subscribing client==
<!-- What will be the actions performed by participants? -->
+
Subscribes to FHIR server and gets updates.
 +
* Must create a Subscriptions instance on external FHIR server.
 +
* Must expose an endpoint to accept notifications.
  
===Scenario Step 1 Name===
+
===Create FHIR Subscription===
:Action: <!--Who does what?  (Use the role names listed above when referring to the participants -->
+
:Action: Subscribing client creates a Subscription instance on FHIR Server using the topic extension, as illustrated, below.
:Precondition: <!-- What setup is required prior to executing this step? -->
+
:Precondition: n/a
:Success Criteria: <!-- How will the participants know if the test was successful? -->
+
:Success Criteria: Subscribing client POSTs new subscription resource to FHIR server. FHIR Server persists active subscription resource. Subscribing client can read newly created Subscription.
:Bonus point: <!-- Any additional complexity to make the scenario more challenging -->
+
:Bonus point: Subscribing client updates Subscription instance's status element to _off_ once the subscription is no longer needed. FHIR server respects this setting.
  
 
<!-- Provide a description of each task -->
 
<!-- Provide a description of each task -->

Revision as of 17:44, 17 October 2017


FHIR Subscriptions

Dedicated Zulip chat stream for this track.


Previous Care Plan Connectathons

Submitting WG/Project/Implementer Group

Imaging Integration, FHIR-I, CDS

Justification

The Imaging Integration is sponsoring a project to create a new context synchronization profile using FHIR Subscriptions called FHIRcast (FHIR-I and CDS are co-sponsors).

This track is an important step in advancing the maturity of the interactions and resources associated with both FHIRcast and FHIR Subscriptions in general.

The subscription pub/sub pattern enables FHIR clients to retrieve data from a server without performing a more expensive periodic polling queries. This model also enables workflow event-based notifications that could keep two applications data in sync, but also synchronize their context. We're working within the RIS/PACS community to identify a common, lightweight application synchronization standard.

This track will attempt to prototype this event-based concept on top of the existing FHIR Subscription REST hook and criteria element and prototype this workflow synchronization using FHIR Subscriptions according to the draft FHIRcast specification.


Proposed Track Lead

See Connectathon_Track_Lead_Responsibilities

Expected participants

Agfa, Applicadia, Agfa

Roles

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

FHIR Server

The FHIR Server supports the Subscription resource and pushing relevant FHIR resources to client.

  • Must expose a Subscriptions resource supporting read, create and update.
  • Must also act as a FHIR client to send notifications.

Subscribing client

Subscribes to FHIR server and gets updates.

  • Must create a Subscriptions instance on external FHIR server.
  • Must expose an endpoint to accept notifications.

Create FHIR Subscription

Action: Subscribing client creates a Subscription instance on FHIR Server using the topic extension, as illustrated, below.
Precondition: n/a
Success Criteria: Subscribing client POSTs new subscription resource to FHIR server. FHIR Server persists active subscription resource. Subscribing client can read newly created Subscription.
Bonus point: Subscribing client updates Subscription instance's status element to _off_ once the subscription is no longer needed. FHIR server respects this setting.


TestScript(s)

Security and Privacy Considerations