Subscriptions R5 Backport
1.0.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.0.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: Backported R5 Subscription

Official URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription Version: 1.0.0
Active as of 2022-07-18 Computable Name: BackportSubscription

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

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..1stringRule for server push
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... backport-filter-criteria SΣ0..*stringBackported R5 FilterBy Criteria
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria
... channel
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... backport-heartbeat-period 0..1unsignedIntBackport R5 Subscription Heartbeat Period
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period
.... backport-timeout 0..1unsignedIntBackport R5 Subscription Timeout
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout
.... backport-max-count 0..1positiveIntBackported R5 Subscription MaxCount
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count
.... type
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... backport-channel-type SΣ0..1CodingBackported R5 Additional Channel Types
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
..... backport-payload-content SΣ1..1codeBackport R5 Subscription Payload Content Information
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
... 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..1stringRule for server push
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... backport-filter-criteria SΣ0..*stringBackported R5 FilterBy Criteria
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
.... backport-heartbeat-period 0..1unsignedIntBackport R5 Subscription Heartbeat Period
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period
.... backport-timeout 0..1unsignedIntBackport R5 Subscription Timeout
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout
.... backport-max-count 0..1positiveIntBackported R5 Subscription MaxCount
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
..... backport-channel-type SΣ0..1CodingBackported R5 Additional Channel Types
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
..... backport-payload-content SΣ1..1codeBackport R5 Subscription Payload Content Information
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
NameFlagsCard.TypeDescription & Constraintsdoco
.. Subscription 0..*SubscriptionServer push subscription criteria
... criteria Σ1..1stringRule for server push
.... backport-filter-criteria Σ0..*stringBackported R5 FilterBy Criteria
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria
... channel Σ1..1BackboneElementThe channel on which to report matches to the criteria
.... type Σ1..1coderest-hook | websocket | email | sms | message
..... backport-channel-type Σ0..1CodingBackported R5 Additional Channel Types
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-channel-type
.... payload Σ1..1codeMIME type to send, or omit for no payload
..... backport-payload-content Σ1..1codeBackport R5 Subscription Payload Content Information
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

Differential View

This structure is derived from Subscription

NameFlagsCard.TypeDescription & Constraintsdoco
.. Subscription 0..*SubscriptionServer push subscription criteria
... criteria S1..1stringRule for server push
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... backport-filter-criteria SΣ0..*stringBackported R5 FilterBy Criteria
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria
... channel
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... backport-heartbeat-period 0..1unsignedIntBackport R5 Subscription Heartbeat Period
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period
.... backport-timeout 0..1unsignedIntBackport R5 Subscription Timeout
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout
.... backport-max-count 0..1positiveIntBackported R5 Subscription MaxCount
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count
.... type
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... backport-channel-type SΣ0..1CodingBackported R5 Additional Channel Types
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
..... backport-payload-content SΣ1..1codeBackport R5 Subscription Payload Content Information
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

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..1stringRule for server push
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... backport-filter-criteria SΣ0..*stringBackported R5 FilterBy Criteria
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
.... backport-heartbeat-period 0..1unsignedIntBackport R5 Subscription Heartbeat Period
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period
.... backport-timeout 0..1unsignedIntBackport R5 Subscription Timeout
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout
.... backport-max-count 0..1positiveIntBackported R5 Subscription MaxCount
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
..... backport-channel-type SΣ0..1CodingBackported R5 Additional Channel Types
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
..... backport-payload-content SΣ1..1codeBackport R5 Subscription Payload Content Information
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

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Subscription.languagepreferredCommonLanguages
Max Binding: AllLanguages
Subscription.statusrequiredSubscriptionStatusCodes
Subscription.channel.typerequiredSubscriptionChannelType
Subscription.channel.payloadrequiredMime Types