R6 Ballot (1st Draft)

This page is part of the FHIR Specification v6.0.0-ballot1: Release 6 Ballot (1st Draft) (see Ballot Notes). The current version is 5.0.0. For a full list of available versions, see the Directory of published versions

2.13.12 Resource SubscriptionStatus - Detailed Descriptions

FHIR Infrastructure icon Work GroupMaturity Level: 2 Trial UseSecurity Category: Business Compartments: No defined compartments

Detailed Descriptions for the elements in the SubscriptionStatus resource.

SubscriptionStatus
Element IdSubscriptionStatus
Definition

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

Short DisplayStatus information about a Subscription provided during event notification
Cardinality0..*
TypeDomainResource
Summaryfalse
Invariants
Defined on this element
sst-1Rule Event notifications must contain events(type = 'event-notification' or type = 'query-event') implies notificationEvent.exists()
sst-2Rule Status messages must contain statustype = 'query-status' implies status.exists()
SubscriptionStatus.status
Element IdSubscriptionStatus.status
Definition

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

Short Displayrequested | active | error | off | entered-in-error
Cardinality0..1
Terminology BindingSubscription Status (Required)
Typecode
Summarytrue
Invariants
Affect this element
sst-2Rule Status messages must contain statustype = 'query-status' implies status.exists()
SubscriptionStatus.type
Element IdSubscriptionStatus.type
Definition

The type of event being conveyed with this notification.

Short Displayhandshake | heartbeat | event-notification | query-status | query-event
Cardinality1..1
Terminology BindingSubscription Notification Type (Required)
Typecode
Is Modifiertrue (Reason: Not known why this is labelled a modifier)
Summarytrue
Invariants
Affect this element
sst-1Rule Event notifications must contain events(type = 'event-notification' or type = 'query-event') implies notificationEvent.exists()
sst-2Rule Status messages must contain statustype = 'query-status' implies status.exists()
SubscriptionStatus.eventsSinceSubscriptionStart
Element IdSubscriptionStatus.eventsSinceSubscriptionStart
Definition

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.

Short DisplayEvents since the Subscription was created
Cardinality0..1
Typeinteger64
Summarytrue
SubscriptionStatus.notificationEvent
Element IdSubscriptionStatus.notificationEvent
Definition

Detailed information about events relevant to this subscription notification.

Short DisplayDetailed information about any events relevant to this notification
Cardinality0..*
Summaryfalse
Invariants
Affect this element
sst-1Rule Event notifications must contain events(type = 'event-notification' or type = 'query-event') implies notificationEvent.exists()
SubscriptionStatus.notificationEvent.eventNumber
Element IdSubscriptionStatus.notificationEvent.eventNumber
Definition

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

Short DisplaySequencing index of this event
Cardinality1..1
Typeinteger64
Summaryfalse
Comments

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.).

SubscriptionStatus.notificationEvent.timestamp
Element IdSubscriptionStatus.notificationEvent.timestamp
Definition

The actual time this event occurred on the server.

Short DisplayThe instant this event occurred
Cardinality0..1
Typeinstant
Summaryfalse
SubscriptionStatus.notificationEvent.focus
Element IdSubscriptionStatus.notificationEvent.focus
Definition

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.

Short DisplayReference to the primary resource or information of this event
Cardinality0..1
TypeReference(Any)
Summaryfalse
SubscriptionStatus.notificationEvent.additionalContext
Element IdSubscriptionStatus.notificationEvent.additionalContext
Definition

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.

Short DisplayReferences related to the focus resource and/or context of this event
Cardinality0..*
TypeReference(Any)
Summaryfalse
SubscriptionStatus.subscription
Element IdSubscriptionStatus.subscription
Definition

The reference to the Subscription which generated this notification.

Short DisplayReference to the Subscription responsible for this notification
Cardinality1..1
TypeReference(Subscription)
Summarytrue
SubscriptionStatus.topic
Element IdSubscriptionStatus.topic
Definition

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

Short DisplayReference to the SubscriptionTopic this notification relates to
Cardinality0..1
Typecanonical(SubscriptionTopic)
Summarytrue
Comments

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.

SubscriptionStatus.error
Element IdSubscriptionStatus.error
Definition

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

Short DisplayList of errors on the subscription
Cardinality0..*
Terminology BindingSubscription Error Codes (Example)
TypeCodeableConcept
Summarytrue
Comments

Recommended practice: clear errors when status is updated.