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

Redundant text in Subscription Request Format - last box related to websockets

    XMLWordPrintableJSON

Details

    • Change Request
    • Status: Triaged (View Workflow)
    • Medium
    • Resolution: Persuasive with Modification
    • FHIRCast (FHIR)
    • 0.1 [deprecated]
    • Imaging Integration
    • (many)
    • Hide

      This table is the relevant content: https://build.fhir.org/ig/HL7/fhircast-docs/2-4-Subscribing.html#subscription-request 

      The "Required when/for" sentences clarify the use of the word Conditional meaning. 

      >hub.events: Required for subscribe requests, SHALL NOT be present for unsubscribe requests.

      >hub.channel.endpoint: Required when hub.channel.type=websocket for re-subscribes and unsubscribes. 

      Arguably, both of the following sentences aid the reader; however, we need to remove webhooks, which will make this issue moot. 

       

      We will remove this sentence, and the "Channel" column as part of removing support for webhooks.

      Show
      This table is the relevant content: https://build.fhir.org/ig/HL7/fhircast-docs/2-4-Subscribing.html#subscription-request   The "Required when/for" sentences clarify the use of the word Conditional meaning.  >hub.events: Required for  subscribe  requests, SHALL NOT be present for  unsubscribe  requests. >hub.channel.endpoint: Required when  hub.channel.type = websocket  for re-subscribes and unsubscribes.  Arguably, both of the following sentences aid the reader; however, we need to remove webhooks, which will make this issue moot.    We will remove this sentence, and the "Channel" column as part of removing support for webhooks.
    • Enhancement
    • Non-compatible

    Description

      Subscription request format - last box related to websockets - "Required when hub.channel.type=websocket for re-subscribes and unsubscribes." is a duplication of the column that states it is conditional for webscockets. The sentence on its own is not wrong - remove it or make it an issue for STU3.

      Comment Isaac Vetter :

      Will you please log this as a jira issue? I'm likely misunderstanding, because I'm uncertain you're right. Note that not only is hub.channel.type required for websockets and not for webhooks, but more specifically is not required for initial subscribes when using websockets. Elsewhere, when we use CONDITIONAL, it typically means that websockets always requires and webhooks doesn't or vice-versa.

       See also https://github.com/HL7/fhircast-docs/pull/353

      Attachments

        Issue Links

          Activity

            People

              Unassigned Unassigned
              bvdh Bas van den Heuvel
              Bas van den Heuvel, Isaac Vetter
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: