The SubscriptionStatus resource describes the state of a Subscription during notifications.

The status of the subscription, which marks the server state for managing the subscription.

The type of event being conveyed with this notification.

The total number of actual events which have been generated since the Subscription was created (inclusive of this notification) - regardless of how many have been successfully communicated. This number is NOT incremented for handshake and heartbeat notifications.

Detailed information about events relevant to this subscription notification.

Either the sequential number of this event in this subscription context or a relative event number for this notification.

In subscriptions where delivery of notifications IS NOT guaranteed (e.g., REST-Hook), this number is a unique and monotonically-increasing event number for a subscription. In channels where delivery of notifications IS guaranteed, this number is a relative index for the events present in the notification (e.g., 1, 2, etc.).

If present, one or more event codes specifying the events which triggered this notification.

If a SubscriptionTopic includes multiple possible triggering events, this element can be used to disambiguate a notification.

The actual time this event occurred on the server.

The focus of this event. While this will usually be a reference to the focus resource of the event, it MAY contain a reference to a non-FHIR object.

Additional context information for this event. Generally, this will contain references to additional resources included with the event (e.g., the Patient relevant to an Encounter), however it MAY refer to non-FHIR objects.

Queries and codes that could be included with notifications of this shape. Servers MAY include these queries if supported and desired in the workflow.

Coded value(s) used to describe the type of information that evaluating this query will provide. Subscribers can use the values to ensure the data they request are relevant and necessary for their use.

Query a subscriber can use to retrieve additional information. The exact contents of the query MAY depend on the value of the queryType, however this SHOULD be a query suitable for use as an HTTP GET request (either fully-qualified or partial).

The reference to the Subscription which generated this notification.

The reference to the SubscriptionTopic for the Subscription which generated this notification.

This value SHOULD NOT be present when using empty payloads, MAY be present when using id-only payloads, and SHOULD be present when using full-resource payloads.

A record of errors that occurred when the server processed a notification.

Recommended practice: clear errors when status is updated.