Uploaded image for project: 'FHIR Specification Feedback'
  1. FHIR Specification Feedback
  2. FHIR-25833

Unsubscribe from the session or Unsubscribe events?

    XMLWordPrintableJSON

    Details

    • Type: Change Request
    • Status: Applied (View Workflow)
    • Priority: Highest
    • Resolution: Persuasive with Modification
    • Specification:
      FHIRCast (FHIR)
    • Raised in Version:
      0.1
    • Work Group:
      Imaging Integration
    • Related Page(s):
      (NA)
    • Related Section(s):
      Subscribing and Unsubscribing
    • Grouping:
    • Scheduling:
    • Resolution Description:
      Hide

      Agreed, an unsubscribe disconnects from the topic altogether. To reduce events to subscribe to a new subscription shall override the previous subscription.

       

      Existing wording:

      hub.topic Required string The identifier of the user's session that the subscriber wishes to subscribe to or unsubscribe from. MAY be a guid.
      hub.events Required string Comma-separated list of event types from the Event Catalog for which the Subscriber no longer wants notifications.
      hub.callback Conditional string Required when hub.channel.type=webhook. SHALL not be present when hub.channel.type=websocket.

      webhook Unsubscribe Request Example

      hub.channel.type=webhook&hub.callback=https%3A%2F%2Fapp.example.com%2Fsession%2Fcallback%2Fv7tfwuk17a&hub.mode=unsubscribe&hub.topic=fdb2f928-
      5546-4f52-87a0-0648e9ded065&hub.secret=shhh-this-is-a-secret&hub.events=patient-open,patient-close&hub.challenge=meu3we944ix80ox

       

      websocket Unsubscribe Request Example

      hub.channel.type=websocket&hub.channel.endpoint=wss%3A%2F%2Fhub.example.com%2Fee30d3b9-1558-464f-a299-cbad6f8135de%0A&hub.mode=unsubscribe&hub.topic=fdb2f928-5546-4f52-87a0-0648e9ded065&hub.events=patient-open,patient-close

      Proposed wording:

       

      hub.topic Required string The identifier of the user's session that the subscriber wishes to subscribe to or unsubscribe from. MAY be a guid.
      - - - -
      hub.callback Conditional string Required when hub.channel.type=webhook. SHALL not be present when hub.channel.type=websocket.

      webhook Unsubscribe Request Example

      hub.channel.type=webhook&hub.callback=https%3A%2F%2Fapp.example.com%2Fsession%2Fcallback%2Fv7tfwuk17a&hub.mode=unsubscribe&hub.topic=fdb2f928-
      5546-4f52-87a0-0648e9ded065&hub.secret=shhh-this-is-a-secret&hub.challenge=meu3we944ix80ox

       

      websocket Unsubscribe Request Example

      hub.channel.type=websocket&hub.channel.endpoint=wss%3A%2F%2Fhub.example.com%2Fee30d3b9-1558-464f-a299-cbad6f8135de%0A&hub.mode=unsubscribe&hub.topic=fdb2f928-5546-4f52-87a0-0648e9ded065

       

      Show
      Agreed, an unsubscribe disconnects from the topic altogether. To reduce events to subscribe to a new subscription shall override the previous subscription.   Existing wording: hub.topic Required string The identifier of the user's session that the subscriber wishes to subscribe to or unsubscribe from. MAY be a guid. hub.events Required string Comma-separated list of event types from the Event Catalog for which the Subscriber no longer wants notifications. hub.callback Conditional string Required when hub.channel.type = webhook . SHALL not be present when hub.channel.type = websocket . webhook Unsubscribe Request Example hub.channel.type=webhook&hub.callback=https%3A%2F%2Fapp.example.com%2Fsession%2Fcallback%2Fv7tfwuk17a&hub.mode=unsubscribe&hub.topic=fdb2f928- 5546 - 4 f52- 87 a 0 - 064 8e9ded065&hub.secret=shhh-this-is-a-secret&hub.events=patient- open ,patient- close &hub.challenge=meu3we944ix80ox   websocket Unsubscribe Request Example hub.channel.type=websocket&hub.channel.endpoint=wss%3A%2F%2Fhub.example.com%2Fee30d3b9- 1558 - 464 f-a299-cbad6f8135de%0A&hub.mode=unsubscribe&hub.topic=fdb2f928- 5546 - 4 f52- 87 a 0 - 064 8e9ded065&hub.events=patient- open ,patient- close Proposed wording:   hub.topic Required string The identifier of the user's session that the subscriber wishes to subscribe to or unsubscribe from. MAY be a guid. - - - - hub.callback Conditional string Required when hub.channel.type = webhook . SHALL not be present when hub.channel.type = websocket . webhook Unsubscribe Request Example hub.channel.type=webhook&hub.callback=https%3A%2F%2Fapp.example.com%2Fsession%2Fcallback%2Fv7tfwuk17a&hub.mode=unsubscribe&hub.topic=fdb2f928- 5546 - 4 f52- 87 a 0 - 064 8e9ded065&hub.secret=shhh-this-is-a-secret &hub.challenge=meu3we944ix80ox   websocket Unsubscribe Request Example hub.channel.type=websocket&hub.channel.endpoint=wss%3A%2F%2Fhub.example.com%2Fee30d3b9- 1558 - 464 f-a299-cbad6f8135de%0A&hub.mode=unsubscribe&hub.topic=fdb2f928- 5546 - 4 f52- 87 a 0 - 064 8e9ded065  
    • Resolution Vote:
      Isaac Vetter / Eric Martin : 5-0-0
    • Change Category:
      Correction
    • Change Impact:
      Compatible, substantive

      Description

      Unsubscribe from the session or Unsubscribe events?

      In the table (Unsubscribe section) the hub.events description is “Comma-separated list of event types from the Event Catalog for which the Subscriber no longer wants notifications.” that in my understanding is different from “Once a subscribing app no longer wants to receive event notifications, it SHALL unsubscribe from the session”

      In my opinion unsubscribe should “disconnect” the app from the session. If the app wants to stop the notification of specific events, it should make a new subscription request (resubscription) with the events it wants to be notified.

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              niklas_svenzen Niklas Svenzen
              Reporter:
              rquintano Ricardo Quintano
              Request in-person:
              Ricardo Quintano
              Watchers:
              3 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:
                Vote Date: