Release 5 Preview #2

2.48 Resource SubscriptionStatus - Content

FHIR Infrastructure Work GroupMaturity Level: 0 Trial UseSecurity Category: Business Compartments: Not linked to any defined compartments

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

The SubscriptionStatus resource is used to convey information about the current state of a Subscription during client notifications.

No resources refer to this resource directly.

This resource does not implement any patterns.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. SubscriptionStatus TUDomainResourceStatus information about a Subscription provided during event notification
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... type ?!Σ1..1codehandshake | heartbeat | event-notification | query-status
SubscriptionNotificationType (Required)
... eventsSinceSubscriptionStart Σ0..1integer64Events since the Subscription was created
... eventsInNotification Σ0..1integerEvents in this notification
... status Σ0..1coderequested | active | error | off
Subscription State (Required)
... topic Σ1..1canonical(SubscriptionTopic)Reference to the SubscriptionTopic this notification relates to
... error Σ0..*CodeableConceptList of errors on the subscription
Subscription Error Codes (Example)

doco Documentation for this format

UML Diagram (Legend)

SubscriptionStatus (DomainResource)The type of event being conveyed with this notificaiton (this element modifies the meaning of other elements)type : code [1..1] « The type of notification represented by the status message. (Strength=Required)SubscriptionNotificationType! »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 notificationseventsSinceSubscriptionStart : integer64 [0..1]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 batchingeventsInNotification : integer [0..1]The reference to the Subscription which generated this notificationsubscription : Reference [1..1] « Subscription »The status of the subscription, which marks the server state for managing the subscriptionstatus : code [0..1] « The status of a subscription at the time this notification was generated. (Strength=Required)SubscriptionState! »The reference to the SubscriptionTopic for the Subscription which generated this notificationtopic : canonical [1..1] « SubscriptionTopic »A record of errors that occurred when the server processed a notificationerror : CodeableConcept [0..*] « Codes to represent subscription error details. (Strength=Example)SubscriptionErrorCodes?? »

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:SubscriptionStatus;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:SubscriptionStatus.type [ code ]; # 1..1 handshake | heartbeat | event-notification | query-status
  fhir:SubscriptionStatus.eventsSinceSubscriptionStart [ integer64 ]; # 0..1 Events since the Subscription was created
  fhir:SubscriptionStatus.eventsInNotification [ integer ]; # 0..1 Events in this notification
  fhir:SubscriptionStatus.subscription [ Reference(Subscription) ]; # 1..1 Reference to the Subscription responsible for this notification
  fhir:SubscriptionStatus.status [ code ]; # 0..1 requested | active | error | off
  fhir:SubscriptionStatus.topic [ canonical(SubscriptionTopic) ]; # 1..1 Reference to the SubscriptionTopic this notification relates to
  fhir:SubscriptionStatus.error [ CodeableConcept ], ... ; # 0..* List of errors on the subscription
]

Changes since R3

This resource did not exist in Release 2

This analysis is available as XML or JSON.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. SubscriptionStatus TUDomainResourceStatus information about a Subscription provided during event notification
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... type ?!Σ1..1codehandshake | heartbeat | event-notification | query-status
SubscriptionNotificationType (Required)
... eventsSinceSubscriptionStart Σ0..1integer64Events since the Subscription was created
... eventsInNotification Σ0..1integerEvents in this notification
... status Σ0..1coderequested | active | error | off
Subscription State (Required)
... topic Σ1..1canonical(SubscriptionTopic)Reference to the SubscriptionTopic this notification relates to
... error Σ0..*CodeableConceptList of errors on the subscription
Subscription Error Codes (Example)

doco Documentation for this format

UML Diagram (Legend)

SubscriptionStatus (DomainResource)The type of event being conveyed with this notificaiton (this element modifies the meaning of other elements)type : code [1..1] « The type of notification represented by the status message. (Strength=Required)SubscriptionNotificationType! »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 notificationseventsSinceSubscriptionStart : integer64 [0..1]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 batchingeventsInNotification : integer [0..1]The reference to the Subscription which generated this notificationsubscription : Reference [1..1] « Subscription »The status of the subscription, which marks the server state for managing the subscriptionstatus : code [0..1] « The status of a subscription at the time this notification was generated. (Strength=Required)SubscriptionState! »The reference to the SubscriptionTopic for the Subscription which generated this notificationtopic : canonical [1..1] « SubscriptionTopic »A record of errors that occurred when the server processed a notificationerror : CodeableConcept [0..*] « Codes to represent subscription error details. (Strength=Example)SubscriptionErrorCodes?? »

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:SubscriptionStatus;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:SubscriptionStatus.type [ code ]; # 1..1 handshake | heartbeat | event-notification | query-status
  fhir:SubscriptionStatus.eventsSinceSubscriptionStart [ integer64 ]; # 0..1 Events since the Subscription was created
  fhir:SubscriptionStatus.eventsInNotification [ integer ]; # 0..1 Events in this notification
  fhir:SubscriptionStatus.subscription [ Reference(Subscription) ]; # 1..1 Reference to the Subscription responsible for this notification
  fhir:SubscriptionStatus.status [ code ]; # 0..1 requested | active | error | off
  fhir:SubscriptionStatus.topic [ canonical(SubscriptionTopic) ]; # 1..1 Reference to the SubscriptionTopic this notification relates to
  fhir:SubscriptionStatus.error [ CodeableConcept ], ... ; # 0..* List of errors on the subscription
]

Changes since Release 3

This resource did not exist in Release 2

This analysis is available as XML or JSON.

 

See the Profiles & Extensions and the alternate definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions, the spreadsheet version & the dependency analysis a

PathDefinitionTypeReference
SubscriptionStatus.type The type of notification represented by the status message.RequiredSubscriptionNotificationType
SubscriptionStatus.status The status of a subscription at the time this notification was generated.RequiredSubscriptionState
SubscriptionStatus.error Codes to represent subscription error details.ExampleSubscriptionErrorCodes