SubscriptionStatus - FHIR v4.3.0-snapshot1

Release 4B Snapshot #1

This page is part of the FHIR Specification v4.3.0-snapshot1: R4B Snapshot to support the Jan 2022 Connectathon. About the R4B version of FHIR. The current officially released version is 4.3.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B

2.47.10 Resource SubscriptionStatus - Detailed Descriptions

FHIR Infrastructure

Work Group

Maturity Level: 0

Draft

Security Category: Business

Compartments: Not linked to any defined compartments

Detailed Descriptions for the elements in the SubscriptionStatus resource.

SubscriptionStatus
Element Id	SubscriptionStatus
Definition	The SubscriptionStatus resource describes the state of a Subscription during notifications.
Cardinality	0..*
Type	DomainResource
Summary	false
SubscriptionStatus.status
Element Id	SubscriptionStatus.status
Definition	The status of the subscription, which marks the server state for managing the subscription.
Cardinality	0..1
Terminology Binding	SubscriptionStatus (Required)
Type	code
Summary	true
SubscriptionStatus.type
Element Id	SubscriptionStatus.type
Definition	The type of event being conveyed with this notificaiton.
Cardinality	1..1
Terminology Binding	SubscriptionNotificationType (Required)
Type	code
Is Modifier	true (Reason: Not known why this is labelled a modifier)
Summary	true
SubscriptionStatus.eventsSinceSubscriptionStart
Element Id	SubscriptionStatus.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.
Cardinality	0..1
Type	string
Summary	true
SubscriptionStatus.eventsInNotification
Element Id	SubscriptionStatus.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.
Cardinality	0..1
Type	integer
Summary	true
SubscriptionStatus.notificationEvent
Element Id	SubscriptionStatus.notificationEvent
Definition	Detailed information about events relevant to this subscription notification.
Cardinality	0..*
Summary	false
SubscriptionStatus.notificationEvent.eventNumber
Element Id	SubscriptionStatus.notificationEvent.eventNumber
Definition	The sequential number of this event in this subscription context. Note that this value is a 64-bit integer value, encoded as a string.
Cardinality	1..1
Type	string
Summary	false
SubscriptionStatus.notificationEvent.timestamp
Element Id	SubscriptionStatus.notificationEvent.timestamp
Definition	The actual time this event occured on the server.
Cardinality	0..1
Type	instant
Summary	false
SubscriptionStatus.notificationEvent.focus
Element Id	SubscriptionStatus.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.
Cardinality	0..1
Type	Reference(Any)
Summary	false
SubscriptionStatus.notificationEvent.additionalContext
Element Id	SubscriptionStatus.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.
Cardinality	0..*
Type	Reference(Any)
Summary	false
SubscriptionStatus.subscription
Element Id	SubscriptionStatus.subscription
Definition	The reference to the Subscription which generated this notification.
Cardinality	1..1
Type	Reference(Subscription)
Summary	true
SubscriptionStatus.topic
Element Id	SubscriptionStatus.topic
Definition	The reference to the SubscriptionTopic for the Subscription which generated this notification.
Cardinality	0..1
Type	canonical(SubscriptionTopic)
Summary	true
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 Id	SubscriptionStatus.error
Definition	A record of errors that occurred when the server processed a notification.
Cardinality	0..*
Terminology Binding	Subscription Error Codes (Example)
Type	CodeableConcept
Summary	true
Comments	Recommended practice: clear errors when status is updated.