Subscriptions R5 Backport
1.1.0 - Standard for Trial Use International flag

Subscriptions R5 Backport, published by HL7 FHIR Infrastructure WG. This is not an authorized publication; it is the continuous build for version 1.1.0). This version is based on the current content of https://github.com/HL7/fhir-subscription-backport-ig/ and changes regularly. See the Directory of published versions

Resource Profile: R4/B Topic-Based Subscription

Official URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription Version: 1.1.0
Active as of 2023-01-09 Computable Name: BackportSubscription

Profile on the Subscription resource to enable R5-style topic-based subscriptions in FHIR R4 or R4B.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Subscription

NameFlagsCard.TypeDescription & Constraintsdoco
.. Subscription 0..*SubscriptionServer push subscription criteria
... criteria S1..1stringCanonical URL for the topic used to generate events
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... filterCriteria SΣ0..*stringFiltering critiera applied to events
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria
... channel
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... heartbeatPeriod 0..1unsignedIntInterval in seconds to send 'heartbeat' notification
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period
.... timeout 0..1unsignedIntTimeout in seconds to attempt notification delivery
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout
.... maxCount 0..1positiveIntMaximum number of triggering resources included in notification bundles
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count
.... type
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... customChannelType SΣ0..1CodingExtended channel type for notifications
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-channel-type
.... payload 1..1codeMIME type to send, or omit for no payload
..... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
..... content SΣ1..1codeNotification content level
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content
Binding: Backported R5 Subscription Content Value Set (required)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Subscription 0..*SubscriptionServer push subscription criteria
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1coderequested | active | error | off
Binding: SubscriptionStatusCodes (required): The status of a subscription.

... criteria SΣ1..1stringCanonical URL for the topic used to generate events
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... filterCriteria SΣ0..*stringFiltering critiera applied to events
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria
... channel Σ1..1BackboneElementThe channel on which to report matches to the criteria
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... heartbeatPeriod 0..1unsignedIntInterval in seconds to send 'heartbeat' notification
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period
.... timeout 0..1unsignedIntTimeout in seconds to attempt notification delivery
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout
.... maxCount 0..1positiveIntMaximum number of triggering resources included in notification bundles
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ1..1coderest-hook | websocket | email | sms | message
Binding: SubscriptionChannelType (required): The type of method used to execute a subscription.

..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... customChannelType SΣ0..1CodingExtended channel type for notifications
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-channel-type
.... payload Σ1..1codeMIME type to send, or omit for no payload
Binding: Mime Types (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)

..... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
..... content SΣ1..1codeNotification content level
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content
Binding: Backported R5 Subscription Content Value Set (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Subscription.statusrequiredSubscriptionStatusCodes
Subscription.channel.typerequiredSubscriptionChannelType
Subscription.channel.payloadrequiredMime Types (a valid code from urn:ietf:bcp:13)
NameFlagsCard.TypeDescription & Constraintsdoco
.. Subscription 0..*SubscriptionServer push subscription criteria
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1coderequested | active | error | off
Binding: SubscriptionStatusCodes (required): The status of a subscription.

... contact Σ0..*ContactPointContact details for source (e.g. troubleshooting)
... end Σ0..1instantWhen to automatically delete the subscription
... reason Σ1..1stringDescription of why this subscription was created
... criteria SΣ1..1stringCanonical URL for the topic used to generate events
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... filterCriteria SΣ0..*stringFiltering critiera applied to events
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria
.... value 0..1stringPrimitive value for string
Max Length: 1048576
... error Σ0..1stringLatest error note
... channel Σ1..1BackboneElementThe channel on which to report matches to the criteria
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... heartbeatPeriod 0..1unsignedIntInterval in seconds to send 'heartbeat' notification
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period
.... timeout 0..1unsignedIntTimeout in seconds to attempt notification delivery
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout
.... maxCount 0..1positiveIntMaximum number of triggering resources included in notification bundles
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ1..1coderest-hook | websocket | email | sms | message
Binding: SubscriptionChannelType (required): The type of method used to execute a subscription.

..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... customChannelType SΣ0..1CodingExtended channel type for notifications
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-channel-type
..... value 0..1codePrimitive value for code
.... endpoint Σ0..1urlWhere the channel points to
.... payload Σ1..1codeMIME type to send, or omit for no payload
Binding: Mime Types (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)

..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
..... content SΣ1..1codeNotification content level
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content
Binding: Backported R5 Subscription Content Value Set (required)
..... value 0..1codePrimitive value for code
.... header Σ0..*stringUsage depends on the channel type

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Subscription.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Subscription.statusrequiredSubscriptionStatusCodes
Subscription.channel.typerequiredSubscriptionChannelType
Subscription.channel.payloadrequiredMime Types (a valid code from urn:ietf:bcp:13)

Differential View

This structure is derived from Subscription

NameFlagsCard.TypeDescription & Constraintsdoco
.. Subscription 0..*SubscriptionServer push subscription criteria
... criteria S1..1stringCanonical URL for the topic used to generate events
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... filterCriteria SΣ0..*stringFiltering critiera applied to events
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria
... channel
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... heartbeatPeriod 0..1unsignedIntInterval in seconds to send 'heartbeat' notification
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period
.... timeout 0..1unsignedIntTimeout in seconds to attempt notification delivery
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout
.... maxCount 0..1positiveIntMaximum number of triggering resources included in notification bundles
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count
.... type
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... customChannelType SΣ0..1CodingExtended channel type for notifications
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-channel-type
.... payload 1..1codeMIME type to send, or omit for no payload
..... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
..... content SΣ1..1codeNotification content level
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content
Binding: Backported R5 Subscription Content Value Set (required)

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Subscription 0..*SubscriptionServer push subscription criteria
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1coderequested | active | error | off
Binding: SubscriptionStatusCodes (required): The status of a subscription.

... criteria SΣ1..1stringCanonical URL for the topic used to generate events
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... filterCriteria SΣ0..*stringFiltering critiera applied to events
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria
... channel Σ1..1BackboneElementThe channel on which to report matches to the criteria
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... heartbeatPeriod 0..1unsignedIntInterval in seconds to send 'heartbeat' notification
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period
.... timeout 0..1unsignedIntTimeout in seconds to attempt notification delivery
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout
.... maxCount 0..1positiveIntMaximum number of triggering resources included in notification bundles
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ1..1coderest-hook | websocket | email | sms | message
Binding: SubscriptionChannelType (required): The type of method used to execute a subscription.

..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... customChannelType SΣ0..1CodingExtended channel type for notifications
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-channel-type
.... payload Σ1..1codeMIME type to send, or omit for no payload
Binding: Mime Types (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)

..... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
..... content SΣ1..1codeNotification content level
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content
Binding: Backported R5 Subscription Content Value Set (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Subscription.statusrequiredSubscriptionStatusCodes
Subscription.channel.typerequiredSubscriptionChannelType
Subscription.channel.payloadrequiredMime Types (a valid code from urn:ietf:bcp:13)

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Subscription 0..*SubscriptionServer push subscription criteria
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1coderequested | active | error | off
Binding: SubscriptionStatusCodes (required): The status of a subscription.

... contact Σ0..*ContactPointContact details for source (e.g. troubleshooting)
... end Σ0..1instantWhen to automatically delete the subscription
... reason Σ1..1stringDescription of why this subscription was created
... criteria SΣ1..1stringCanonical URL for the topic used to generate events
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... filterCriteria SΣ0..*stringFiltering critiera applied to events
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria
.... value 0..1stringPrimitive value for string
Max Length: 1048576
... error Σ0..1stringLatest error note
... channel Σ1..1BackboneElementThe channel on which to report matches to the criteria
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... heartbeatPeriod 0..1unsignedIntInterval in seconds to send 'heartbeat' notification
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period
.... timeout 0..1unsignedIntTimeout in seconds to attempt notification delivery
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout
.... maxCount 0..1positiveIntMaximum number of triggering resources included in notification bundles
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ1..1coderest-hook | websocket | email | sms | message
Binding: SubscriptionChannelType (required): The type of method used to execute a subscription.

..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... customChannelType SΣ0..1CodingExtended channel type for notifications
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-channel-type
..... value 0..1codePrimitive value for code
.... endpoint Σ0..1urlWhere the channel points to
.... payload Σ1..1codeMIME type to send, or omit for no payload
Binding: Mime Types (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)

..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
..... content SΣ1..1codeNotification content level
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content
Binding: Backported R5 Subscription Content Value Set (required)
..... value 0..1codePrimitive value for code
.... header Σ0..*stringUsage depends on the channel type

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Subscription.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Subscription.statusrequiredSubscriptionStatusCodes
Subscription.channel.typerequiredSubscriptionChannelType
Subscription.channel.payloadrequiredMime Types (a valid code from urn:ietf:bcp:13)

 

Other representations of profile: CSV, Excel, Schematron