Release 5 Draft Ballot

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions

FHIR Infrastructure Work GroupMaturity Level: 0 Trial UseSecurity Category: Business Compartments: Not linked to any 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.

Cardinality0..*
TypeDomainResource
Summaryfalse
SubscriptionStatus.status
Element IdSubscriptionStatus.status
Definition

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

Cardinality0..1
Terminology BindingSubscription State (Required)
Typecode
Summarytrue
SubscriptionStatus.type
Element IdSubscriptionStatus.type
Definition

The type of event being conveyed with this notificaiton.

Cardinality1..1
Terminology BindingSubscriptionNotificationType (Required)
Typecode
Is Modifiertrue (Reason: Not known why this is labelled a modifier)
Summarytrue
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.

Cardinality0..1
Typeinteger64
Summarytrue
SubscriptionStatus.eventsInNotification
Element IdSubscriptionStatus.eventsInNotification
Definition

The total number of actual events represented within this notification. For handshake and heartbeat notifications, this will be zero or not present. For event-notifications, this number may be one or more, depending on server batching.

Cardinality0..1
Typeinteger
Summarytrue
SubscriptionStatus.notificationEvent
Element IdSubscriptionStatus.notificationEvent
Definition

Detailed information about events relevant to this subscription notification.

Cardinality0..*
Summaryfalse
SubscriptionStatus.notificationEvent.eventNumber
Element IdSubscriptionStatus.notificationEvent.eventNumber
Definition

The sequential number of this event in this subscription context.

Cardinality1..1
Typeinteger64
Summaryfalse
SubscriptionStatus.notificationEvent.timestamp
Element IdSubscriptionStatus.notificationEvent.timestamp
Definition

The actual time this event occured on the server.

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.

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.

Cardinality0..*
TypeReference(Any)
Summaryfalse
SubscriptionStatus.subscription
Element IdSubscriptionStatus.subscription
Definition

The reference to the Subscription which generated 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.

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.

Cardinality0..*
Terminology BindingSubscription Error Codes (Example)
TypeCodeableConcept
Summarytrue
Comments

Recommended practice: clear errors when status is updated.