Generated Narrative: StructureDefinition ext-R4B-SubscriptionStatus Name Flags Card. Type Description & Constraints Extension 0..* Extension(4.0.1) Status information about a Subscription provided during event notification #xD; Slices for extension 2..* Extension Extension Slice: Unordered, Closed by value:url #xD; extension:status 0..1 Extension requested | active | error | off | entered-in-error #xD; url 1..1 uri "status" #xD; value[x] 0..1 code requested | active | error | off | entered-in-error Binding: SubscriptionStatus (required): The status of a subscription at the time this notification was generated. #xD; extension:type 1..1 Extension handshake | heartbeat | event-notification | query-status | query-event #xD; url 1..1 uri "type" #xD; value[x] 0..1 code handshake | heartbeat | event-notification | query-status | query-event Binding: R4B_subscription_notification_type_for_R4 (0.0.1-snapshot-2) (required): The type of notification represented by the status message. #xD; <a href="StructureDefinition-ext-R4B-SubscriptionStatus-definitions.html#Extension.extension:eventsSinceSubscriptionStart" title="Slice eventsSinceSubscriptionStart: 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.">extension:eventsSinceSubscriptionStart 0..1 Extension Events since the Subscription was created #xD; url 1..1 uri "eventsSinceSubscriptionStart" #xD; value[x] 0..1 string Events since the Subscription was created #xD; extension:notificationEvent 0..* Extension Detailed information about any events relevant to this notification #xD; Slices for extension 1..* Extension Extension Slice: Unordered, Closed by value:url #xD; extension:eventNumber 1..1 Extension Event number #xD; url 1..1 uri "eventNumber" #xD; value[x] 0..1 string Event number #xD; extension:timestamp 0..1 Extension The instant this event occurred #xD; url 1..1 uri "timestamp" #xD; value[x] 0..1 instant The instant this event occurred #xD; extension:focus 0..1 Extension The focus of this event #xD; url 1..1 uri "focus" #xD; value[x] 0..1 Reference() The focus of this event #xD; extension:additionalContext 0..* Extension Additional context for this event #xD; url 1..1 uri "additionalContext" #xD; value[x] 0..1 Reference() Additional context for this event #xD; url 1..1 uri "notificationEvent" #xD; extension:subscription 1..1 Extension Reference to the Subscription responsible for this notification #xD; url 1..1 uri "subscription" #xD; value[x] 0..1 Reference() Reference to the Subscription responsible for this notification #xD; extension:topic 0..1 Extension Reference to the SubscriptionTopic this notification relates to #xD; url 1..1 uri "topic" #xD; value[x] 0..1 canonical() Reference to the SubscriptionTopic this notification relates to #xD; extension:error 0..* Extension List of errors on the subscription #xD; url 1..1 uri "error" #xD; value[x] 0..1 CodeableConcept List of errors on the subscription Binding: R4B_subscription_error_for_R4 (0.0.1-snapshot-2) (example): Codes to represent subscription error details. #xD; url 1..1 uri "http://hl7.org/fhir/4.3/StructureDefinition/extension-SubscriptionStatus" #xD; Documentation for this format
Cross-version Extension for R4B.SubscriptionStatus for use in FHIR R4
This cross-version extension represents SubscriptionStatus from http://hl7.org/fhir/StructureDefinition/SubscriptionStatus|4.3.0 for use in FHIR R4.
Status information about a Subscription provided during event notification
The SubscriptionStatus resource describes the state of a Subscription during notifications.
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Must have either extensions or value[x], not both
exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Extensions are always sliced by (at least) url
exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
requested | active | error | off | entered-in-error
The status of the subscription, which marks the server state for managing the subscription.
Additional content defined by implementations
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Source of the definition for the extension code - a logical name or a URL.
The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
The status of a subscription at the time this notification was generated.
handshake | heartbeat | event-notification | query-status | query-event
The type of event being conveyed with this notificaiton.
The type of notification represented by the status message.
Events since the Subscription was created
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.
Detailed information about any events relevant to this notification
Detailed information about events relevant to this subscription notification.
The sequential number of this event in this subscription context. Note that this value is a 64-bit integer value, encoded as a string.
The actual time this event occured on the server.
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.
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.
Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list).
Reference to the Subscription responsible for this notification
The reference to the Subscription which generated this notification.
Reference to the SubscriptionTopic this notification relates to
The reference to the SubscriptionTopic for the Subscription which generated this notification.
A record of errors that occurred when the server processed a notification.
Codes to represent subscription error details.