Release 5 Ballot
FoundationThis page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - see ballot notes). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B
| FHIR Infrastructure Work Group | Maturity Level: 0 | Trial Use | 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. | ||||||||
| 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 | ||||||||
| SubscriptionStatus.type | |||||||||
| Element Id | SubscriptionStatus.type | ||||||||
| Definition | The type of event being conveyed with this notificaiton. | ||||||||
| Short Display | handshake | heartbeat | event-notification | query-status | query-event | ||||||||
| 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. | ||||||||
| 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 | ||||||||
| SubscriptionStatus.notificationEvent.eventNumber | |||||||||
| Element Id | SubscriptionStatus.notificationEvent.eventNumber | ||||||||
| Definition | The sequential number of this event in this subscription context. | ||||||||
| Short Display | Event number | ||||||||
| Cardinality | 1..1 | ||||||||
| Type | integer64 | ||||||||
| Summary | false | ||||||||
| SubscriptionStatus.notificationEvent.timestamp | |||||||||
| Element Id | SubscriptionStatus.notificationEvent.timestamp | ||||||||
| Definition | The actual time this event occured 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 | The focus 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 | Additional context for this event | ||||||||
| Cardinality | 0..* | ||||||||
| Type | Reference(Any) | ||||||||
| Summary | false | ||||||||
| 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. | ||||||||
FHIR ®© HL7.org 2011+. FHIR R5 Ballot hl7.fhir.core#5.0.0-ballot generated on Sat, Sep 10, 2022 05:06+1000.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R4B |
Compare to R5 Draft |
|
Propose a change