Release 5 Preview #2

This page is part of the FHIR Specification (v4.4.0: R5 Preview #2). 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

2.48 Resource SubscriptionStatus - Content

FHIR Infrastructure

Work Group

Maturity Level: 0

Trial Use

Security Category: Business

Compartments: Not linked to any defined compartments

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

2.48.1 Scope and Usage

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

2.48.2 References

No resources refer to this resource directly.

This resource does not implement any patterns.

Structure

Name	Flags	Card.	Type	Description & Constraints
SubscriptionStatus	TU		DomainResource	Status information about a Subscription provided during event notification Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
notificationType	?!Σ	1..1	code	handshake \| heartbeat \| event-notification SubscriptionNotificationType (Required)
eventsSinceSubscriptionStart	Σ	0..1	integer64	Events since the Subscription was created
eventsInNotification	Σ	0..1	integer	Events in this notification
subscription	Σ	1..1	Reference(Subscription)	Reference to the Subscription responsible for this notification
status	Σ	0..1	code	requested \| active \| error \| off Subscription State (Required)
topic	Σ	1..1	Reference(SubscriptionTopic)	Reference to the SubscriptionTopic this notification relates to
Documentation for this format

UML Diagram (Legend)

XML Template

<SubscriptionStatus xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <notificationType value="[code]"/><!-- 1..1 handshake | heartbeat | event-notification -->
 <eventsSinceSubscriptionStart value="[integer64]"/><!-- 0..1 Events since the Subscription was created -->
 <eventsInNotification value="[integer]"/><!-- 0..1 Events in this notification -->
 <subscription><!-- 1..1 Reference(Subscription) Reference to the Subscription responsible for this notification --></subscription>
 <status value="[code]"/><!-- 0..1 requested | active | error | off -->
 <topic><!-- 1..1 Reference(SubscriptionTopic) Reference to the SubscriptionTopic this notification relates to --></topic>
</SubscriptionStatus>

JSON Template

{
  "resourceType" : "SubscriptionStatus",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "notificationType" : "<code>", // R!  handshake | heartbeat | event-notification
  "eventsSinceSubscriptionStart" : "<integer64>", // Events since the Subscription was created
  "eventsInNotification" : <integer>, // Events in this notification
  "subscription" : { Reference(Subscription) }, // R!  Reference to the Subscription responsible for this notification
  "status" : "<code>", // requested | active | error | off
  "topic" : { Reference(SubscriptionTopic) } // R!  Reference to the SubscriptionTopic this notification relates to
}

Turtle Template

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


[ 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.notificationType [ code ]; # 1..1 handshake | heartbeat | event-notification
  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 [ Reference(SubscriptionTopic) ]; # 1..1 Reference to the SubscriptionTopic this notification relates to
]

Changes since R3

This resource did not exist in Release 2

This analysis is available as XML or JSON.

Structure

Name	Flags	Card.	Type	Description & Constraints
SubscriptionStatus	TU		DomainResource	Status information about a Subscription provided during event notification Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
notificationType	?!Σ	1..1	code	handshake \| heartbeat \| event-notification SubscriptionNotificationType (Required)
eventsSinceSubscriptionStart	Σ	0..1	integer64	Events since the Subscription was created
eventsInNotification	Σ	0..1	integer	Events in this notification
subscription	Σ	1..1	Reference(Subscription)	Reference to the Subscription responsible for this notification
status	Σ	0..1	code	requested \| active \| error \| off Subscription State (Required)
topic	Σ	1..1	Reference(SubscriptionTopic)	Reference to the SubscriptionTopic this notification relates to
Documentation for this format

UML Diagram (Legend)

XML Template

<SubscriptionStatus xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <notificationType value="[code]"/><!-- 1..1 handshake | heartbeat | event-notification -->
 <eventsSinceSubscriptionStart value="[integer64]"/><!-- 0..1 Events since the Subscription was created -->
 <eventsInNotification value="[integer]"/><!-- 0..1 Events in this notification -->
 <subscription><!-- 1..1 Reference(Subscription) Reference to the Subscription responsible for this notification --></subscription>
 <status value="[code]"/><!-- 0..1 requested | active | error | off -->
 <topic><!-- 1..1 Reference(SubscriptionTopic) Reference to the SubscriptionTopic this notification relates to --></topic>
</SubscriptionStatus>

JSON Template

{
  "resourceType" : "SubscriptionStatus",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "notificationType" : "<code>", // R!  handshake | heartbeat | event-notification
  "eventsSinceSubscriptionStart" : "<integer64>", // Events since the Subscription was created
  "eventsInNotification" : <integer>, // Events in this notification
  "subscription" : { Reference(Subscription) }, // R!  Reference to the Subscription responsible for this notification
  "status" : "<code>", // requested | active | error | off
  "topic" : { Reference(SubscriptionTopic) } // R!  Reference to the SubscriptionTopic this notification relates to
}

Turtle Template

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


[ 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.notificationType [ code ]; # 1..1 handshake | heartbeat | event-notification
  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 [ Reference(SubscriptionTopic) ]; # 1..1 Reference to the SubscriptionTopic this notification relates to
]

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

2.48.3.1 Terminology Bindings

Path	Definition	Type	Reference
SubscriptionStatus.notificationType	The type of notification represented by the status message.	Required	SubscriptionNotificationType
SubscriptionStatus.status	The status of a subscription at the time this notification was generated.	Required	SubscriptionState

Path

Definition

Type

Reference

SubscriptionStatus.notificationType

The type of notification represented by the status message.

Required

SubscriptionNotificationType

SubscriptionStatus.status

The status of a subscription at the time this notification was generated.

Required

SubscriptionState