Operation: Get Notification History

Specification

This specification is based on the FHIR R5 Backport specification.

Usage

Get Notification Events Request

The Subscription $events operation retrieves Subscription Notifications on an existing subscription, along with the associated payloads if requested. as a Parameters FHIR R4 resource conformant to R4 Backported R5 SubscriptionStatus.

`Get [base]/Subscription/[id]/$events`, 

where [id] is the logical id of the existing Subscription resource.

Get Notification Events Response

The server returns a 200 OK HTTP status code.

Interaction Sequence Diagram

Example Get Notification Events interaction

While this $events operation is defined in FHIR R5 for the Subscription resource, it has also been backported to FHIR R4, functioning in the same way.

GET [base]/Submission/$event?patient=12345&type=history

Response message body:

{
  "resourceType": "Bundle",
  "type": "history",
  "entry": [
    {
      "fullUrl": "https://example-fhir-server.com/SubscriptionStatus/12345",
      "resource": {
        "resourceType": "SubscriptionStatus",
        "id": "12345",
        "status": "active",
        "type": "event-notification",
        "subscription": {
          "reference": "Subscription/67890"
        },
        "topic": "https://example-fhir-server.com/Topic/encounter-update",
        "notificationEvent": [
          {
            "eventNumber": "1",
            "timestamp": "2025-02-07T12:00:00Z"
          },
          {
            "eventNumber": "2",
            "timestamp": "2025-02-07T12:05:00Z"
          }
        ]
      }
    }
  ]
}

Please see the $events Operation Definition page from the R5 Subscriptions Backport for details on the $events operation used for the Ontario Health Subscriptions service.

Supported Profiles