type: resource-definitionsresource: SubscriptionStatus

SubscriptionStatus Definitions

SubscriptionStatus

Status information about a Subscription provided during event notification

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

Cardinality: 0..*

Mappings: rim=N/A; w5=infrastructure.exchange

SubscriptionStatus.status

requested | active | error | off | entered-in-error

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

Conditions: sst-2

Cardinality: 0..1

Type: code

Binding: required:subscription-status

Summary: true

Mappings: w5=FiveWs.status

SubscriptionStatus.type

handshake | heartbeat | event-notification | query-status | query-event

Definition: The type of event being conveyed with this notification.

Conditions: sst-1, sst-2

Cardinality: 1..1

Type: code

Binding: required:subscription-notification-type

Summary: true

Is Modifier: true (Reason: Not known why this is labelled a modifier)

Mappings: w5=FiveWs.what[x]

SubscriptionStatus.eventsSinceSubscriptionStart

Events since the Subscription was created

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.

Comments: This element is intended to help subscribers determine if any notifications have been missed in Subscriptions where delivery of notifications IS NOT guaranteed. For more information see Event Numbering.

Cardinality: 0..1

Type: integer64

Summary: true

SubscriptionStatus.notificationEvent

Detailed information about any events relevant to this notification

Definition: Detailed information about events relevant to this subscription notification.

Conditions: sst-1

Cardinality: 0..*

Type: BackboneElement

SubscriptionStatus.notificationEvent.eventNumber

Sequencing index of this event

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

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.). For more information see Event Numbering.

Cardinality: 1..1

Type: integer64

Summary: true

SubscriptionStatus.notificationEvent.triggerEvent

Event that triggered this notification

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

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

Cardinality: 0..*

Type: CodeableConcept

SubscriptionStatus.notificationEvent.timestamp

The instant this event occurred

Definition: The actual time this event occurred on the server.

Cardinality: 0..1

Type: instant

SubscriptionStatus.notificationEvent.focus

Reference to the primary resource or information of this event

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(Resource)

SubscriptionStatus.notificationEvent.additionalContext

References related to the focus resource and/or context of this event

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

Comments: Note that servers have discretion on related resources to include. SubscriptionTopic resources can include descriptions of likely or expected shapes in order to set implementer expectations. For details see Notification Shapes.

Cardinality: 0..*

Type: Reference(Resource)

SubscriptionStatus.notificationEvent.relatedQuery

Query describing data relevant to this notification

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

Cardinality: 0..*

Type: BackboneElement

Summary: true

Mappings: rim=N/A (to add?)

SubscriptionStatus.notificationEvent.relatedQuery.queryType

Coded information describing the type of data this query provides

Definition: 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.

Cardinality: 0..1

Type: Coding

Summary: true

Mappings: rim=N/A (to add?)

SubscriptionStatus.notificationEvent.relatedQuery.query

Query to perform

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

Cardinality: 1..1

Type: string

Summary: true

Mappings: rim=N/A (to add?)

SubscriptionStatus.notificationEvent.authorizationHint

Authorization information relevant to a notification

Definition: Authorization context information and value (e.g., token).

Cardinality: 0..*

Type: BackboneElement

Summary: false

Mappings: rim=N/A (to add?)

SubscriptionStatus.notificationEvent.authorizationHint.authorizationType

Classification of the authorization hint, e.g., 'oAuthChallengeToken'

Definition: Used by clients to determine what kind of authorization hint is being suggested by the sender.

Cardinality: 1..1

Type: Coding

Summary: false

Mappings: rim=N/A (to add?)

SubscriptionStatus.notificationEvent.authorizationHint.value

Authorization value, as defined by the 'authorizationType'

Definition: A value related to the authorization (e.g., a token).

Cardinality: 0..1

Type: string

Summary: false

Mappings: rim=N/A (to add?)

SubscriptionStatus.subscription

Reference to the Subscription responsible for this notification

Definition: The reference to the Subscription which generated this notification.

Cardinality: 1..1

Type: Reference(Subscription)

Summary: true

Mappings: w5=FiveWs.why[x]

SubscriptionStatus.topic

Reference to the SubscriptionTopic this notification relates to

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

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.

Cardinality: 0..1

Type: canonical

Summary: true

SubscriptionStatus.error

List of errors on the subscription

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

Comments: Recommended practice: clear errors when status is updated.

Cardinality: 0..*

Type: CodeableConcept

Binding: example:subscription-error

Summary: true