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

Clarifications on SubscriptionStatus

    XMLWordPrintableJSON

Details

    • Icon: Change Request Change Request
    • Resolution: Persuasive with Modification
    • Icon: Medium Medium
    • FHIR R5 Subscriptions Backport (FHIR)
    • 0.1.0 [deprecated]
    • FHIR Infrastructure
    • Backported R5 Subscription Notification Status [deprecated]
    • Topic-Based Subscription Components
    • Notification Types
    • Hide

      Will make the changes as proposed with the highlighted change.

      1. We never mention `query-event` type resources in the section on the status field (2.47.5.6). We should mention this when describing `SubscriptionStatus.eventsSinceSubscriptionStart`, by saying that "In the case of a query-event payload, the count should be the same as the last notification sent."
      2. We never callout what `notificationEvent` in the status documentation (section 2.47.5.6). I think we should add a callout with this language: "The SubscriptionStatus.notificationEvent element contains a list of objects describing the individual events. This element does not need to be ordered, but should contain a contiguous set of events. The number of items of this element should match `eventsInNotification` if provided, and for payloads other than `query-event` types the event number on the latest included event must match SubscriptionStatus.eventsSinceSubscriptionStart."
      3. To help clarify that a server retrying a notification is a resend and not a re-trigger, we should add the following language. The bullet starting with "In the case of an event notification that cannot be delivered" should have a new sentence after that says "In addition, any new events that do trigger an increment should NOT affect the contents of a resent notification. Sending a notification should represent the status at the time the latest included event was generated, and not at the time the notification is (re)sent."
      Show
      Will make the changes as proposed with the highlighted change. We never mention `query-event` type resources in the section on the status field (2.47.5.6). We should mention this when describing `SubscriptionStatus.eventsSinceSubscriptionStart`, by saying that "In the case of a query-event payload, the count should be the same as the last notification sent." We never callout what `notificationEvent` in the status documentation (section 2.47.5.6). I think we should add a callout with this language: "The SubscriptionStatus.notificationEvent element contains a list of objects describing the individual events. This element does not need to be ordered, but should contain a contiguous set of events. The number of items of this element should match `eventsInNotification` if provided, and for payloads other than `query-event` types the event number on the latest included event must match SubscriptionStatus.eventsSinceSubscriptionStart." To help clarify that a server retrying a notification is a resend and not a re-trigger, we should add the following language. The bullet starting with "In the case of an event notification that cannot be delivered" should have a new sentence after that says "In addition, any new events that do trigger an increment should NOT affect the contents of a resent notification. Sending a notification should represent the status at the time the latest included event was generated, and not at the time the notification is (re)sent."
    • Gino Canessa/Bryn Rhodes: 14-0-0
    • Clarification
    • Non-substantive

    Description

      There's a few pieces of missing info I think we should add to the SubscriptionStatus documentation (http://build.fhir.org/branches/R4B/subscriptionstatus.html#subscription-status). These are things we've sort of assumed thus far I think we should call out.

      1. We never mention `query-event` type resources in the section on the status field (2.47.5.6). We should mention this when describing `SubscriptionStatus.eventsSinceSubscriptionStart`, by saying that "In the case of a query-event payload, the count should be the same as the last notification sent."
      2. We never callout what `notificationEvent` in the status documentation (section 2.47.5.6). I think we should add a callout with this language: "The SubscriptionStatus.notificationEvent element contains a list of objects describing the individual events. This element does not need to be ordered, but should contain a contiguous set of events. The number of items of this element should match `eventsInNotification` if provided, and for payloads other than `query-event` types the latest included event must match SubscriptionStatus.eventsSinceSubscriptionStart."
      3. To help clarify that a server retrying a notification is a resend and not a re-trigger, we should add the following language. The bullet starting with "In the case of an event notification that cannot be delivered" should have a new sentence after that says "In addition, any new events that do trigger an increment should NOT affect the contents of a resent notification. Sending a notification should represent the status at the time the latest included event was generated, and not at the time the notification is (re)sent."

      Attachments

        Activity

          People

            ginocanessa Gino Canessa
            adstrick Adam Strickland (Inactive)
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: