Generated Narrative: StructureDefinition IHE.DSUBm.SubscriptionStatus-StatusOperation Name Flags Card. Type Description & Constraints Parameters BackportSubscriptionStatusR4 parameter 4..* BackboneElement Slices containing subscription status information Slices for parameter Content/Rules for all slices parameter:status 1..1 BackboneElement Current status of the relevant subscription parameter:type 1..1 BackboneElement Parameter containing the type of event for this notification value[x] 1..1 code The type of event being conveyed with this notificaiton. Required Pattern: query-status parameter:eventsSinceSubscriptionStart 1..1 BackboneElement Parameter containing the number of events since this subscription started value[x] 0..1 string This value is REQUIRED because clients MAY use it to know if there are missing notifications. Note: this value SHALL NOT be incremented by sending a query-status notification. parameter:notificationEvent 0..0 Documentation for this format
SubscriptionStatus for the status operation
IHE IT Infrastructure Technical Committee
Profile on the SubscriptionStatus resource for the $status operation
Parameter containing subscription status information
This resource is a non-persisted resource used to pass information into and back from an [operation](http://hl7.org/fhir/R4/operations.html). It has no other use, and there is no RESTful endpoint associated with it.
The parameters that may be used are defined by the OperationDefinition resource.
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
A set of rules under which this content was created
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
The base language in which the resource is written.
Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Slices containing subscription status information
A parameter passed to or received from the operation.
All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
A parameter must have one and only one of (value, resource, part)
(part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))
(exists(f:part) and not(exists(f:*[starts-with(local-name(.), 'value')])) and not(exists(f:resource))) or (not(exists(f:part)) and (exists(f:*[starts-with(local-name(.),'value')]) != exists(f:resource)))
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
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.
Must have either extensions or value[x], not both
exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
Extensions that cannot be ignored even if unrecognized
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).
Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
The name of the parameter (reference to the operation definition).
Conveys the content if the parameter is a data type.
When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.
Only one level of nested parameters is allowed.
Parameter containing the reference to a subscription
Slice discriminator: the reference to a subscription
Reference to the Subscription responsible for this notification
The reference to the Subscription which generated this notification.
Parameter containing the canonical reference to a subscription topic
Slice discriminator: the canonical reference to a subscription topic
Canonical reference to the SubscriptionTopic this notification relates to
Canonical reference to the SubscriptionTopic for the Subscription which generated this notification.
This value SHOULD NOT be present when using `empty` payloads, MAY be present when using id-only payloads, and SHOULD be present when using `full-resource` payloads.
Current status of the relevant subscription
Slice discriminator: the subscription status
Status of the subscription when this notification was generated
The status of the subscription, which marks the server state for managing the subscription.
Parameter containing the type of event for this notification
Slice discriminator: the type of event for this notification
The type of event being conveyed with this notificaiton.
Parameter containing the number of events since this subscription started
Slice discriminator: the number of events since this subscription started
This value is REQUIRED because clients MAY use it to know if there are missing notifications. Note: this value SHALL NOT be incremented by sending a query-status notification.
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.
Parameter containing the event notification details
Parameter containing notification event details
Slice on notification event parameter name
The sequential number of this event in this subscription context.
Parameter containing the event timestamp
Slice discriminator: the event timestamp
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.
Parameter containing additional context for this event
Slice discriminator: additional context for this event
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.
Parameter containing errors on the subscription
Slice discriminator: errors on the subscription
A record of errors that occurred when the server processed a notification.