Subscriptions R5 Backport
0.1.0 - ballot
Subscriptions R5 Backport
0.1.0 - ballot
This page is part of the Subscriptions R5 Backport (v0.1.0: STU 1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions 
| Defining URL: | http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription |
| Version: | 0.1.0 |
| Name: | BackportSubscription |
| Title: | Backported R5 Subscription |
| Status: | Active as of 2020-12-16T17:37:01+00:00 |
| Definition: | Profile on the R4 Subscription resource to enable R5-style topic-based subscriptions in FHIR R4. |
| Publisher: | HL7 FHIR Infrastructure WG |
| Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Subscription
Summary
Mandatory: 5 elements
Must-Support: 2 elements
Extensions
This structure refers to these extensions:
This structure is derived from Subscription
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Subscription | 0..* | Subscription | Server push subscription criteria | |
  id | Σ | 0..1 | string | Logical id of this artifact |
 meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
 backport-topic-canonical | SΣ | 1..1 | uri | Optional Extensions Element URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-topic-canonical |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!Σ | 1..1 | code | requested | active | error | off Binding: SubscriptionStatus (required): The status of a subscription. |
| contact | Σ | 0..* | ContactPoint | Contact details for source (e.g. troubleshooting) |
| end | Σ | 0..1 | instant | When to automatically delete the subscription |
| reason | Σ | 1..1 | string | Description of why this subscription was created |
 criteria | Σ | 1..1 | string | Rule for server push |
 id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| backport-additional-criteria | 0..* | string | Extension URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-additional-criteria | |
 value | 0..1 | string | Primitive value for string Max Length: 1048576 | |
| error | Σ | 0..1 | string | Latest error note |
 channel | Σ | 1..1 | BackboneElement | The channel on which to report matches to the criteria |
 id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| backport-heartbeat-period | 0..1 | unsignedInt | Extension URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period | |
| backport-timeout | 0..1 | unsignedInt | Optional Extensions Element URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout | |
| backport-notification-url-location | 0..1 | code | Extension URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-notification-url-location Binding: Backported R5 Subscription Notification URL Location Value Set (required) | |
| backport-max-count | 0..1 | positiveInt | Extension URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | Σ | 1..1 | code | rest-hook | websocket | email | sms | message Binding: SubscriptionChannelType (required): The type of method used to execute a subscription. |
| endpoint | Σ | 0..1 | url | Where the channel points to |
| payload | Σ | 1..1 | code | MIME type to send, or omit for no payload Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| backport-payload-content | SΣ | 1..1 | code | Extension URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content Binding: Backported R5 Subscription Content Value Set (required) |
| value | 0..1 | string | Primitive value for code | |
| header | Σ | 0..* | string | Usage depends on the channel type |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Subscription | 0..* | Subscription | Server push subscription criteria | |
| backport-topic-canonical | Σ | 1..1 | uri | Optional Extensions Element URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-topic-canonical |
| channel | Σ | 1..1 | BackboneElement | The channel on which to report matches to the criteria |
| payload | Σ | 1..1 | code | MIME type to send, or omit for no payload |
| backport-payload-content | Σ | 1..1 | code | Extension URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content Binding: Backported R5 Subscription Content Value Set (required) |
| Documentation for this format | ||||
This structure is derived from Subscription
Summary
Mandatory: 5 elements
Must-Support: 2 elements
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from Subscription
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Subscription | 0..* | Subscription | Server push subscription criteria | |
| id | Σ | 0..1 | string | Logical id of this artifact |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| backport-topic-canonical | SΣ | 1..1 | uri | Optional Extensions Element URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-topic-canonical |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!Σ | 1..1 | code | requested | active | error | off Binding: SubscriptionStatus (required): The status of a subscription. |
| contact | Σ | 0..* | ContactPoint | Contact details for source (e.g. troubleshooting) |
| end | Σ | 0..1 | instant | When to automatically delete the subscription |
| reason | Σ | 1..1 | string | Description of why this subscription was created |
| criteria | Σ | 1..1 | string | Rule for server push |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| backport-additional-criteria | 0..* | string | Extension URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-additional-criteria | |
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |
| error | Σ | 0..1 | string | Latest error note |
| channel | Σ | 1..1 | BackboneElement | The channel on which to report matches to the criteria |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| backport-heartbeat-period | 0..1 | unsignedInt | Extension URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period | |
| backport-timeout | 0..1 | unsignedInt | Optional Extensions Element URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout | |
| backport-notification-url-location | 0..1 | code | Extension URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-notification-url-location Binding: Backported R5 Subscription Notification URL Location Value Set (required) | |
| backport-max-count | 0..1 | positiveInt | Extension URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | Σ | 1..1 | code | rest-hook | websocket | email | sms | message Binding: SubscriptionChannelType (required): The type of method used to execute a subscription. |
| endpoint | Σ | 0..1 | url | Where the channel points to |
| payload | Σ | 1..1 | code | MIME type to send, or omit for no payload Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| backport-payload-content | SΣ | 1..1 | code | Extension URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content Binding: Backported R5 Subscription Content Value Set (required) |
| value | 0..1 | string | Primitive value for code | |
| header | Σ | 0..* | string | Usage depends on the channel type |
| Documentation for this format | ||||
Other representations of profile: Schematron
| Path | Conformance | ValueSet |
| Subscription.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Subscription.status | required | SubscriptionStatus |
| Subscription.channel.type | required | SubscriptionChannelType |
| Subscription.channel.payload | required | Mime Types |
IG © 2020+ HL7 FHIR Infrastructure WG. Package hl7.fhir.uv.subscriptions-backport#0.1.0 based on FHIR 4.0.1. Generated 2020-12-16
Links: Table of Contents |
QA Report
| Version History |
Search |
|
Propose a change
