Document Subscription for Mobile (DSUBm)
1.0.1-current - ci-build

Document Subscription for Mobile (DSUBm), published by IHE IT Infrastructure Technical Committee. This guide is not an authorized publication; it is the continuous build for version 1.0.1-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IHE/ITI.DSUBm/ and changes regularly. See the Directory of published versions

## Resource Profile: Subscription for SubmissionSet Multi-Patient

Official URL: https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/DSUBm-SubmissionSet-MultiPatient-Subscription | Version: 1.0.1-current
Active as of 2025-04-28 | Computable Name: DSUBm_SubmissionSet_MultiPatient_Subscription

Resource Subscription for DSUBm profile for SubmissionSet without the indication of the patient

- the criteria element SHALL contain the URL of an instance of SubscriptionTopic for the creation of SubmissionSet type List Resources

Usage:

- Examples for this Resource Profile: Subscription/ex-SubmissionSet-MultiPatient-Subscription
- CapabilityStatements using this Resource Profile: IHE DSUBm ResourceNotificationBroker DocRef FullEvents, IHE DSUBm ResourceNotificationBroker DocRef MinUpd, IHE DSUBm ResourceNotificationBroker Folder Basic, IHE DSUBm ResourceNotificationBroker Folder FullEvents... Show 10 more, IHE DSUBm ResourceNotificationBroker Folder MinUpd, IHE DSUBm ResourceNotificationBroker Folder Upd, IHE DSUBm ResourceNotificationBroker, IHE DSUBm ResourceNotificationSubscriber DocRef FullEvents, IHE DSUBm ResourceNotificationSubscriber DocRef MinUpd, IHE DSUBm ResourceNotificationSubscriber Folder Basic, IHE DSUBm ResourceNotificationSubscriber Folder FullEvents, IHE DSUBm ResourceNotificationSubscriber Folder MinUpd, IHE DSUBm ResourceNotificationSubscriber Folder Upd and IHE DSUBm ResourceNotificationSubscriber

### Formal Views of Profile Content

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

- Differential Table
- Key Elements Table
- Snapshot Table
- Statistics/References
- All

This structure is derived from BackportSubscription

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Subscription |  | 0..* | BackportSubscription | Server push subscription criteria
criteria |  | 1..1 | string | Canonical URL for the SubscriptionTopic. Required Pattern: https://profiles.ihe.net/ITI/DSUBm/SubscriptionTopic/DSUBm-SubscriptionTopic-SubmissionSet-MultiPatient
extension | C | 0..* | Extension | The criteria.extension SHALL NOT have the patient or the patient.identifier parameter as a subscription criteria. The code parameter SHALL be used and SHALL indicates the List of type SubmissionSet. SubmissionSet-MultiPatient: the Subscription for Folder SHALL include the resource LIST and no reference to the patient
channel |  |  |  |
type |  | 1..1 | code | rest-hook | websocket | email | sms | message Required Pattern: rest-hook
endpoint | S | 1..1 | url | The endpoint SHOULD be the endpoint that the Resource Notification Recipient is receiving the notifications.
payload |  | 1..1 | code | MIME type to send, or omit for no payload Binding: DSUBm payload admitted Value Set (required)
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
Subscription.channel.payload | required | DSUBmPayload `https://profiles.ihe.net/ITI/DSUBm/ValueSet/payload-content-value-set` from this IG

#### Constraints

Id | Grade | Path(s) | Details | Requirements
SubmissionSet-MultiPatient | error | Subscription.criteria.extension | the Subscription for Folder SHALL include the resource LIST and no reference to the patient : value.contains('List?') and (value.contains('code=submissionset') or value.contains('code=https%3A%2F%2Fprofiles.ihe.net%2FITI%2FDSUBm%2FCodeSystem%2FDSUBmlistTypesR4%7Csubmissionset') ) and value.contains('patient').not() |

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Subscription |  | 0..* | BackportSubscription | Server push subscription criteria dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
status | ?!Σ | 1..1 | code | requested | active | error | off Binding: SubscriptionStatus (required): The status of a subscription. ele-1: All FHIR elements must have a @value or children
reason | Σ | 1..1 | string | Description of why this subscription was created ele-1: All FHIR elements must have a @value or children
criteria | S Σ | 1..1 | string | Canonical URL for the SubscriptionTopic. ele-1: All FHIR elements must have a @value or children Required Pattern: https://profiles.ihe.net/ITI/DSUBm/SubscriptionTopic/DSUBm-SubscriptionTopic-SubmissionSet-MultiPatient
Slices for extension | C | 0..* | Extension | The criteria.extension SHALL NOT have the patient or the patient.identifier parameter as a subscription criteria. The code parameter SHALL be used and SHALL indicates the List of type SubmissionSet. Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both SubmissionSet-MultiPatient: the Subscription for Folder SHALL include the resource LIST and no reference to the patient
extension:filterCriteria | S Σ | 0..* | string | Filtering critiera applied to events URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource ext-1: Must have either extensions or value[x], not both
channel | Σ | 1..1 | BackboneElement | The channel on which to report matches to the criteria ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
Slices for extension |  |  |  | Content/Rules for all slices
extension:heartbeatPeriod |  | 0..1 | unsignedInt | Interval in seconds to send 'heartbeat' notification URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource ext-1: Must have either extensions or value[x], not both
extension:timeout |  | 0..1 | unsignedInt | Timeout in seconds to attempt notification delivery URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource ext-1: Must have either extensions or value[x], not both
extension:maxCount |  | 0..1 | positiveInt | Maximum number of triggering resources included in notification bundles URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource ext-1: Must have either extensions or value[x], not both
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
type | Σ | 1..1 | code | rest-hook | websocket | email | sms | message Binding: SubscriptionChannelType (required): The type of method used to execute a subscription. ele-1: All FHIR elements must have a @value or children Required Pattern: rest-hook
Slices for extension |  |  |  | Content/Rules for all slices
extension:customChannelType | S Σ | 0..1 | Coding | Extended channel type for notifications URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-channel-type ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource ext-1: Must have either extensions or value[x], not both
endpoint | S Σ | 1..1 | url | The endpoint SHOULD be the endpoint that the Resource Notification Recipient is receiving the notifications. ele-1: All FHIR elements must have a @value or children
payload | Σ | 1..1 | code | MIME type to send, or omit for no payload Binding: DSUBm payload admitted Value Set (required) ele-1: All FHIR elements must have a @value or children
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:content | S Σ | 1..1 | code | Notification content level URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content Binding: Backported R5 Subscription Content Value Set (required) ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource ext-1: Must have either extensions or value[x], not both
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Subscription.status | required | SubscriptionStatus `http://hl7.org/fhir/ValueSet/subscription-status|4.0.0` from the FHIR Standard
Subscription.channel.type | required | Pattern: rest-hook `http://hl7.org/fhir/ValueSet/subscription-channel-type|4.0.0` from the FHIR Standard
Subscription.channel.payload | required | DSUBmPayload `https://profiles.ihe.net/ITI/DSUBm/ValueSet/payload-content-value-set` from this IG

#### Constraints

Id | Grade | Path(s) | Details | Requirements
SubmissionSet-MultiPatient | error | Subscription.criteria.extension | the Subscription for Folder SHALL include the resource LIST and no reference to the patient : value.contains('List?') and (value.contains('code=submissionset') or value.contains('code=https%3A%2F%2Fprofiles.ihe.net%2FITI%2FDSUBm%2FCodeSystem%2FDSUBmlistTypesR4%7Csubmissionset') ) and value.contains('patient').not() |

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Subscription |  | 0..* | BackportSubscription | Server push subscription criteria
id | Σ | 0..1 | id | 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): IETF language tag
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
extension |  | 0..* | Extension | Additional content defined by implementations
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 | S Σ | 1..1 | string | Canonical URL for the SubscriptionTopic. Required Pattern: https://profiles.ihe.net/ITI/DSUBm/SubscriptionTopic/DSUBm-SubscriptionTopic-SubmissionSet-MultiPatient
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension | C | 0..* | Extension | The criteria.extension SHALL NOT have the patient or the patient.identifier parameter as a subscription criteria. The code parameter SHALL be used and SHALL indicates the List of type SubmissionSet. Slice: Unordered, Open by value:url SubmissionSet-MultiPatient: the Subscription for Folder SHALL include the resource LIST and no reference to the patient
extension:filterCriteria | S Σ | 0..* | string | Filtering critiera applied to events URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-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
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:heartbeatPeriod |  | 0..1 | unsignedInt | Interval in seconds to send 'heartbeat' notification URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period
extension:timeout |  | 0..1 | unsignedInt | Timeout in seconds to attempt notification delivery URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout
extension:maxCount |  | 0..1 | positiveInt | Maximum number of triggering resources included in notification bundles 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. Required Pattern: rest-hook
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:customChannelType | S Σ | 0..1 | Coding | Extended channel type for notifications URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-channel-type
value |  | 0..1 | code | Primitive value for code
endpoint | S Σ | 1..1 | url | The endpoint SHOULD be the endpoint that the Resource Notification Recipient is receiving the notifications.
payload | Σ | 1..1 | code | MIME type to send, or omit for no payload Binding: DSUBm payload admitted Value Set (required)
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
extension:content | S Σ | 1..1 | code | Notification content level URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content Binding: Backported R5 Subscription Content Value Set (required)
value |  | 0..1 | code | Primitive value for code
header | Σ | 0..* | string | Usage depends on the channel type
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Subscription.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
Subscription.status | required | SubscriptionStatus `http://hl7.org/fhir/ValueSet/subscription-status|4.0.0` from the FHIR Standard
Subscription.channel.type | required | Pattern: rest-hook `http://hl7.org/fhir/ValueSet/subscription-channel-type|4.0.0` from the FHIR Standard
Subscription.channel.payload | required | DSUBmPayload `https://profiles.ihe.net/ITI/DSUBm/ValueSet/payload-content-value-set` from this IG

#### Constraints

Id | Grade | Path(s) | Details | Requirements
SubmissionSet-MultiPatient | error | Subscription.criteria.extension | the Subscription for Folder SHALL include the resource LIST and no reference to the patient : value.contains('List?') and (value.contains('code=submissionset') or value.contains('code=https%3A%2F%2Fprofiles.ihe.net%2FITI%2FDSUBm%2FCodeSystem%2FDSUBmlistTypesR4%7Csubmissionset') ) and value.contains('patient').not() |

This structure is derived from BackportSubscription

Summary

Mandatory: 1 element
Must-Support: 1 element

Differential View

This structure is derived from BackportSubscription

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Subscription |  | 0..* | BackportSubscription | Server push subscription criteria
criteria |  | 1..1 | string | Canonical URL for the SubscriptionTopic. Required Pattern: https://profiles.ihe.net/ITI/DSUBm/SubscriptionTopic/DSUBm-SubscriptionTopic-SubmissionSet-MultiPatient
extension | C | 0..* | Extension | The criteria.extension SHALL NOT have the patient or the patient.identifier parameter as a subscription criteria. The code parameter SHALL be used and SHALL indicates the List of type SubmissionSet. SubmissionSet-MultiPatient: the Subscription for Folder SHALL include the resource LIST and no reference to the patient
channel |  |  |  |
type |  | 1..1 | code | rest-hook | websocket | email | sms | message Required Pattern: rest-hook
endpoint | S | 1..1 | url | The endpoint SHOULD be the endpoint that the Resource Notification Recipient is receiving the notifications.
payload |  | 1..1 | code | MIME type to send, or omit for no payload Binding: DSUBm payload admitted Value Set (required)
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
Subscription.channel.payload | required | DSUBmPayload `https://profiles.ihe.net/ITI/DSUBm/ValueSet/payload-content-value-set` from this IG

#### Constraints

Id | Grade | Path(s) | Details | Requirements
SubmissionSet-MultiPatient | error | Subscription.criteria.extension | the Subscription for Folder SHALL include the resource LIST and no reference to the patient : value.contains('List?') and (value.contains('code=submissionset') or value.contains('code=https%3A%2F%2Fprofiles.ihe.net%2FITI%2FDSUBm%2FCodeSystem%2FDSUBmlistTypesR4%7Csubmissionset') ) and value.contains('patient').not() |

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Subscription |  | 0..* | BackportSubscription | Server push subscription criteria dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
status | ?!Σ | 1..1 | code | requested | active | error | off Binding: SubscriptionStatus (required): The status of a subscription. ele-1: All FHIR elements must have a @value or children
reason | Σ | 1..1 | string | Description of why this subscription was created ele-1: All FHIR elements must have a @value or children
criteria | S Σ | 1..1 | string | Canonical URL for the SubscriptionTopic. ele-1: All FHIR elements must have a @value or children Required Pattern: https://profiles.ihe.net/ITI/DSUBm/SubscriptionTopic/DSUBm-SubscriptionTopic-SubmissionSet-MultiPatient
Slices for extension | C | 0..* | Extension | The criteria.extension SHALL NOT have the patient or the patient.identifier parameter as a subscription criteria. The code parameter SHALL be used and SHALL indicates the List of type SubmissionSet. Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both SubmissionSet-MultiPatient: the Subscription for Folder SHALL include the resource LIST and no reference to the patient
extension:filterCriteria | S Σ | 0..* | string | Filtering critiera applied to events URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource ext-1: Must have either extensions or value[x], not both
channel | Σ | 1..1 | BackboneElement | The channel on which to report matches to the criteria ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource
Slices for extension |  |  |  | Content/Rules for all slices
extension:heartbeatPeriod |  | 0..1 | unsignedInt | Interval in seconds to send 'heartbeat' notification URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource ext-1: Must have either extensions or value[x], not both
extension:timeout |  | 0..1 | unsignedInt | Timeout in seconds to attempt notification delivery URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource ext-1: Must have either extensions or value[x], not both
extension:maxCount |  | 0..1 | positiveInt | Maximum number of triggering resources included in notification bundles URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource ext-1: Must have either extensions or value[x], not both
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
type | Σ | 1..1 | code | rest-hook | websocket | email | sms | message Binding: SubscriptionChannelType (required): The type of method used to execute a subscription. ele-1: All FHIR elements must have a @value or children Required Pattern: rest-hook
Slices for extension |  |  |  | Content/Rules for all slices
extension:customChannelType | S Σ | 0..1 | Coding | Extended channel type for notifications URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-channel-type ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource ext-1: Must have either extensions or value[x], not both
endpoint | S Σ | 1..1 | url | The endpoint SHOULD be the endpoint that the Resource Notification Recipient is receiving the notifications. ele-1: All FHIR elements must have a @value or children
payload | Σ | 1..1 | code | MIME type to send, or omit for no payload Binding: DSUBm payload admitted Value Set (required) ele-1: All FHIR elements must have a @value or children
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:content | S Σ | 1..1 | code | Notification content level URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content Binding: Backported R5 Subscription Content Value Set (required) ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource ext-1: Must have either extensions or value[x], not both
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Subscription.status | required | SubscriptionStatus `http://hl7.org/fhir/ValueSet/subscription-status|4.0.0` from the FHIR Standard
Subscription.channel.type | required | Pattern: rest-hook `http://hl7.org/fhir/ValueSet/subscription-channel-type|4.0.0` from the FHIR Standard
Subscription.channel.payload | required | DSUBmPayload `https://profiles.ihe.net/ITI/DSUBm/ValueSet/payload-content-value-set` from this IG

#### Constraints

Id | Grade | Path(s) | Details | Requirements
SubmissionSet-MultiPatient | error | Subscription.criteria.extension | the Subscription for Folder SHALL include the resource LIST and no reference to the patient : value.contains('List?') and (value.contains('code=submissionset') or value.contains('code=https%3A%2F%2Fprofiles.ihe.net%2FITI%2FDSUBm%2FCodeSystem%2FDSUBmlistTypesR4%7Csubmissionset') ) and value.contains('patient').not() |

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Subscription |  | 0..* | BackportSubscription | Server push subscription criteria
id | Σ | 0..1 | id | 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): IETF language tag
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
extension |  | 0..* | Extension | Additional content defined by implementations
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 | S Σ | 1..1 | string | Canonical URL for the SubscriptionTopic. Required Pattern: https://profiles.ihe.net/ITI/DSUBm/SubscriptionTopic/DSUBm-SubscriptionTopic-SubmissionSet-MultiPatient
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension | C | 0..* | Extension | The criteria.extension SHALL NOT have the patient or the patient.identifier parameter as a subscription criteria. The code parameter SHALL be used and SHALL indicates the List of type SubmissionSet. Slice: Unordered, Open by value:url SubmissionSet-MultiPatient: the Subscription for Folder SHALL include the resource LIST and no reference to the patient
extension:filterCriteria | S Σ | 0..* | string | Filtering critiera applied to events URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-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
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:heartbeatPeriod |  | 0..1 | unsignedInt | Interval in seconds to send 'heartbeat' notification URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period
extension:timeout |  | 0..1 | unsignedInt | Timeout in seconds to attempt notification delivery URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout
extension:maxCount |  | 0..1 | positiveInt | Maximum number of triggering resources included in notification bundles 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. Required Pattern: rest-hook
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:customChannelType | S Σ | 0..1 | Coding | Extended channel type for notifications URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-channel-type
value |  | 0..1 | code | Primitive value for code
endpoint | S Σ | 1..1 | url | The endpoint SHOULD be the endpoint that the Resource Notification Recipient is receiving the notifications.
payload | Σ | 1..1 | code | MIME type to send, or omit for no payload Binding: DSUBm payload admitted Value Set (required)
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
extension:content | S Σ | 1..1 | code | Notification content level URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content Binding: Backported R5 Subscription Content Value Set (required)
value |  | 0..1 | code | Primitive value for code
header | Σ | 0..* | string | Usage depends on the channel type
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Subscription.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
Subscription.status | required | SubscriptionStatus `http://hl7.org/fhir/ValueSet/subscription-status|4.0.0` from the FHIR Standard
Subscription.channel.type | required | Pattern: rest-hook `http://hl7.org/fhir/ValueSet/subscription-channel-type|4.0.0` from the FHIR Standard
Subscription.channel.payload | required | DSUBmPayload `https://profiles.ihe.net/ITI/DSUBm/ValueSet/payload-content-value-set` from this IG

#### Constraints

Id | Grade | Path(s) | Details | Requirements
SubmissionSet-MultiPatient | error | Subscription.criteria.extension | the Subscription for Folder SHALL include the resource LIST and no reference to the patient : value.contains('List?') and (value.contains('code=submissionset') or value.contains('code=https%3A%2F%2Fprofiles.ihe.net%2FITI%2FDSUBm%2FCodeSystem%2FDSUBmlistTypesR4%7Csubmissionset') ) and value.contains('patient').not() |

This structure is derived from BackportSubscription

Summary

Mandatory: 1 element
Must-Support: 1 element

Other representations of profile: CSV, Excel, Schematron