Page tree
Skip to end of metadata
Go to start of metadata


Committee Approval Date:

Eric Haas / Rick Geimer: 10-0-1. 07/27/2020


Publishing Lead:

Eric Haas

Gino Canessa 


Contributing or Reviewing Work Groups:

FHIR-I


FHIR Development Project Insight ID:

1642


Scope of coverage:

Create the Subscription R5 Backport Implementation Guide which will enables servers running version R4 of FHIR to implement a subset of the reworked R5 Subscriptions API in a standardized way.  Other IGs may use this IG to implement the updated subscription API with FHIR API.


Content location:

https://build.fhir.org/ig/HL7/fhir-subscription-backport-ig/


Proposed IG realm and code:

uv/subscription-backport


Maintenance Plan:

FHIR-I


Short Description:

This guide defines a standard method of back-porting the R5 subscriptions API to R4 implementations as to bridge for pre-adopting R5 Subscriptions prior to adoption of the R5 FHIR standard.


Long Description:

In R5, subscriptions are broken into a 1) topic, which defines the resource(s) for the subscription and the events on which they happen, and 2) a subscription, which is the registration of a communication channel optionally with some additional filtering.  This guide defines a standard method of back-porting the R5 subscriptions API to R4 implementations as to bridge to adoption of Subscriptions prior to adoption of the R5 FHIR standard.

Its defines the actors and transactions as well as basic error handling by clients and servers for subscriptions using REST Hooks and e-mail. 



Involved parties:

NA


Expected implementations:

MIcrosoft RI implementation.

Tentative ( Da Vinci, Public Health)  --TBD



Content sources:

FHIR R5 Subscription Resources


Example Scenarios:

1) Subscription to Encounter by patient
query context is already part of the focal resource (Encounter.patient)
can express criteria in FHIR (Encounter?patient=)
unlocks "New data notifications for patient apps" use case
building block for provider-facing access

2) Subscription to Encounter by patient.generalPractitioner
similar (closely related) trigger
query context is one hop away
unlocks "Encounter notifications for primary care" use case (e.g., CMS NPRM)


IG Relationships:

NONE


Timelines:

January 2021

FMG Notes