This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions
FHIR Infrastructure Work Group | Maturity Level: 2 | Trial Use | Security Category: Business | Compartments: No 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. | ||||||||||||
Short Display | Status information about a Subscription provided during event notification | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | DomainResource | ||||||||||||
Summary | false | ||||||||||||
Invariants |
| ||||||||||||
SubscriptionStatus.status | |||||||||||||
Element Id | SubscriptionStatus.status | ||||||||||||
Definition | The status of the subscription, which marks the server state for managing the subscription. | ||||||||||||
Short Display | requested | active | error | off | entered-in-error | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Terminology Binding | Subscription Status (Required) | ||||||||||||
Type | code | ||||||||||||
Summary | true | ||||||||||||
Invariants |
| ||||||||||||
SubscriptionStatus.type | |||||||||||||
Element Id | SubscriptionStatus.type | ||||||||||||
Definition | The type of event being conveyed with this notification. | ||||||||||||
Short Display | handshake | heartbeat | event-notification | query-status | query-event | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Terminology Binding | Subscription Notification Type (Required) | ||||||||||||
Type | code | ||||||||||||
Is Modifier | true (Reason: Not known why this is labelled a modifier) | ||||||||||||
Summary | true | ||||||||||||
Invariants |
| ||||||||||||
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. | ||||||||||||
Short Display | Events since the Subscription was created | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | integer64 | ||||||||||||
Summary | true | ||||||||||||
SubscriptionStatus.notificationEvent | |||||||||||||
Element Id | SubscriptionStatus.notificationEvent | ||||||||||||
Definition | Detailed information about events relevant to this subscription notification. | ||||||||||||
Short Display | Detailed information about any events relevant to this notification | ||||||||||||
Cardinality | 0..* | ||||||||||||
Summary | false | ||||||||||||
Invariants |
| ||||||||||||
SubscriptionStatus.notificationEvent.eventNumber | |||||||||||||
Element Id | SubscriptionStatus.notificationEvent.eventNumber | ||||||||||||
Definition | Either the sequential number of this event in this subscription context or a relative event number for this notification. | ||||||||||||
Short Display | Sequencing index of this event | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | integer64 | ||||||||||||
Summary | true | ||||||||||||
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.triggerEvent | |||||||||||||
Element Id | SubscriptionStatus.notificationEvent.triggerEvent | ||||||||||||
Definition | If present, one or more event codes specifying the events which triggered this notification. | ||||||||||||
Short Display | Event that triggered this notification | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | CodeableConcept | ||||||||||||
Summary | false | ||||||||||||
Comments | If a SubscriptionTopic includes multiple possible triggering events, this element can be used to disambiguate a notification. | ||||||||||||
SubscriptionStatus.notificationEvent.timestamp | |||||||||||||
Element Id | SubscriptionStatus.notificationEvent.timestamp | ||||||||||||
Definition | The actual time this event occurred on the server. | ||||||||||||
Short Display | The instant this event occurred | ||||||||||||
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. | ||||||||||||
Short Display | Reference to the primary resource or information of this event | ||||||||||||
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. | ||||||||||||
Short Display | References related to the focus resource and/or context of this event | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | Reference(Any) | ||||||||||||
Summary | false | ||||||||||||
SubscriptionStatus.notificationEvent.relatedQuery | |||||||||||||
Element Id | SubscriptionStatus.notificationEvent.relatedQuery | ||||||||||||
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. | ||||||||||||
Short Display | Query describing data relevant to this notification | ||||||||||||
Cardinality | 0..* | ||||||||||||
Summary | true | ||||||||||||
SubscriptionStatus.notificationEvent.relatedQuery.queryType | |||||||||||||
Element Id | SubscriptionStatus.notificationEvent.relatedQuery.queryType | ||||||||||||
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. | ||||||||||||
Short Display | Coded information describing the type of data this query provides | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | Coding | ||||||||||||
Summary | true | ||||||||||||
SubscriptionStatus.notificationEvent.relatedQuery.query | |||||||||||||
Element Id | SubscriptionStatus.notificationEvent.relatedQuery.query | ||||||||||||
Definition | Query a subscriber can use to retrieve additional information. The exact contents of the query MAY depend on the value of the | ||||||||||||
Short Display | Query to perform | ||||||||||||
Cardinality | 1..1 | ||||||||||||
Type | string | ||||||||||||
Summary | true | ||||||||||||
SubscriptionStatus.subscription | |||||||||||||
Element Id | SubscriptionStatus.subscription | ||||||||||||
Definition | The reference to the Subscription which generated this notification. | ||||||||||||
Short Display | Reference to the Subscription responsible for 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. | ||||||||||||
Short Display | Reference to the SubscriptionTopic this notification relates to | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | canonical(SubscriptionTopic) | ||||||||||||
Summary | true | ||||||||||||
Comments | This value SHOULD NOT be present when using | ||||||||||||
SubscriptionStatus.error | |||||||||||||
Element Id | SubscriptionStatus.error | ||||||||||||
Definition | A record of errors that occurred when the server processed a notification. | ||||||||||||
Short Display | List of errors on the subscription | ||||||||||||
Cardinality | 0..* | ||||||||||||
Terminology Binding | Subscription Error Codes (Example) | ||||||||||||
Type | CodeableConcept | ||||||||||||
Summary | true | ||||||||||||
Comments | Recommended practice: clear errors when status is updated. |