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

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 Patient-Dependent

Official URL: https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/DSUBm-SubmissionSet-PatientDependent-Subscription Version: 1.0.1-current
Active as of 2024-10-21 Computable Name: DSUBm_SubmissionSet_PatientDependent_Subscription

Resource Subscription for DSUBm profile for SubmissionSet with 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:

Formal Views of Profile Content

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

This structure is derived from BackportSubscription

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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-PatientDependent
.... extension C 0..* Extension The criteria.extension SHALL have at least one of the patient or patient.identifier parameter as a subscription criteria. The code parameter SHALL be used and SHALL indicates the List of type SubmissionSet.
SubmissionSet-PatientDependent: the Subscription for SubmissionSet SHALL include the resource LIST and 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)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Subscription.channel.payloadrequiredDSUBmPayload
https://profiles.ihe.net/ITI/DSUBm/ValueSet/payload-content-value-set
from this IG

Constraints

IdGradePath(s)DetailsRequirements
SubmissionSet-PatientDependenterrorSubscription.criteria.extensionthe Subscription for SubmissionSet SHALL include the resource LIST and 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')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Subscription 0..* BackportSubscription Server push subscription criteria
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code requested | active | error | off
Binding: SubscriptionStatus (required): The status of a 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-PatientDependent
.... Slices for extension C 0..* Extension The criteria.extension SHALL have at least one of the patient or 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-PatientDependent: the Subscription for SubmissionSet SHALL include the resource LIST and the patient
..... filterCriteria SΣ 0..* string Filtering critiera applied to events
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria
... channel Σ 1..1 BackboneElement The channel on which to report matches to the criteria
.... Slices for extension Content/Rules for all slices
..... heartbeatPeriod 0..1 unsignedInt Interval in seconds to send 'heartbeat' notification
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period
..... timeout 0..1 unsignedInt Timeout in seconds to attempt notification delivery
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout
..... 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
..... Slices for extension Content/Rules for all slices
...... customChannelType SΣ 0..1 Coding Extended channel type for notifications
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-channel-type
.... 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)
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... 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)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Subscription.statusrequiredSubscriptionStatus
http://hl7.org/fhir/ValueSet/subscription-status|4.0.0
from the FHIR Standard
Subscription.channel.typerequiredPattern: rest-hook
http://hl7.org/fhir/ValueSet/subscription-channel-type|4.0.0
from the FHIR Standard
Subscription.channel.payloadrequiredDSUBmPayload
https://profiles.ihe.net/ITI/DSUBm/ValueSet/payload-content-value-set
from this IG

Constraints

IdGradePath(s)DetailsRequirements
SubmissionSet-PatientDependenterrorSubscription.criteria.extensionthe Subscription for SubmissionSet SHALL include the resource LIST and 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')
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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 BindingsPurpose
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-PatientDependent
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension C 0..* Extension The criteria.extension SHALL have at least one of the patient or 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-PatientDependent: the Subscription for SubmissionSet SHALL include the resource LIST and the patient
..... 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
..... heartbeatPeriod 0..1 unsignedInt Interval in seconds to send 'heartbeat' notification
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period
..... timeout 0..1 unsignedInt Timeout in seconds to attempt notification delivery
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout
..... 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
...... 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
...... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Subscription.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Subscription.statusrequiredSubscriptionStatus
http://hl7.org/fhir/ValueSet/subscription-status|4.0.0
from the FHIR Standard
Subscription.channel.typerequiredPattern: rest-hook
http://hl7.org/fhir/ValueSet/subscription-channel-type|4.0.0
from the FHIR Standard
Subscription.channel.payloadrequiredDSUBmPayload
https://profiles.ihe.net/ITI/DSUBm/ValueSet/payload-content-value-set
from this IG

Constraints

IdGradePath(s)DetailsRequirements
SubmissionSet-PatientDependenterrorSubscription.criteria.extensionthe Subscription for SubmissionSet SHALL include the resource LIST and 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')

This structure is derived from BackportSubscription

Summary

Mandatory: 1 element
Must-Support: 1 element

Differential View

This structure is derived from BackportSubscription

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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-PatientDependent
.... extension C 0..* Extension The criteria.extension SHALL have at least one of the patient or patient.identifier parameter as a subscription criteria. The code parameter SHALL be used and SHALL indicates the List of type SubmissionSet.
SubmissionSet-PatientDependent: the Subscription for SubmissionSet SHALL include the resource LIST and 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)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Subscription.channel.payloadrequiredDSUBmPayload
https://profiles.ihe.net/ITI/DSUBm/ValueSet/payload-content-value-set
from this IG

Constraints

IdGradePath(s)DetailsRequirements
SubmissionSet-PatientDependenterrorSubscription.criteria.extensionthe Subscription for SubmissionSet SHALL include the resource LIST and 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')

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Subscription 0..* BackportSubscription Server push subscription criteria
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code requested | active | error | off
Binding: SubscriptionStatus (required): The status of a 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-PatientDependent
.... Slices for extension C 0..* Extension The criteria.extension SHALL have at least one of the patient or 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-PatientDependent: the Subscription for SubmissionSet SHALL include the resource LIST and the patient
..... filterCriteria SΣ 0..* string Filtering critiera applied to events
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria
... channel Σ 1..1 BackboneElement The channel on which to report matches to the criteria
.... Slices for extension Content/Rules for all slices
..... heartbeatPeriod 0..1 unsignedInt Interval in seconds to send 'heartbeat' notification
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period
..... timeout 0..1 unsignedInt Timeout in seconds to attempt notification delivery
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout
..... 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
..... Slices for extension Content/Rules for all slices
...... customChannelType SΣ 0..1 Coding Extended channel type for notifications
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-channel-type
.... 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)
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... 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)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Subscription.statusrequiredSubscriptionStatus
http://hl7.org/fhir/ValueSet/subscription-status|4.0.0
from the FHIR Standard
Subscription.channel.typerequiredPattern: rest-hook
http://hl7.org/fhir/ValueSet/subscription-channel-type|4.0.0
from the FHIR Standard
Subscription.channel.payloadrequiredDSUBmPayload
https://profiles.ihe.net/ITI/DSUBm/ValueSet/payload-content-value-set
from this IG

Constraints

IdGradePath(s)DetailsRequirements
SubmissionSet-PatientDependenterrorSubscription.criteria.extensionthe Subscription for SubmissionSet SHALL include the resource LIST and 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')

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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 BindingsPurpose
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-PatientDependent
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension C 0..* Extension The criteria.extension SHALL have at least one of the patient or 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-PatientDependent: the Subscription for SubmissionSet SHALL include the resource LIST and the patient
..... 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
..... heartbeatPeriod 0..1 unsignedInt Interval in seconds to send 'heartbeat' notification
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period
..... timeout 0..1 unsignedInt Timeout in seconds to attempt notification delivery
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout
..... 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
...... 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
...... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Subscription.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Subscription.statusrequiredSubscriptionStatus
http://hl7.org/fhir/ValueSet/subscription-status|4.0.0
from the FHIR Standard
Subscription.channel.typerequiredPattern: rest-hook
http://hl7.org/fhir/ValueSet/subscription-channel-type|4.0.0
from the FHIR Standard
Subscription.channel.payloadrequiredDSUBmPayload
https://profiles.ihe.net/ITI/DSUBm/ValueSet/payload-content-value-set
from this IG

Constraints

IdGradePath(s)DetailsRequirements
SubmissionSet-PatientDependenterrorSubscription.criteria.extensionthe Subscription for SubmissionSet SHALL include the resource LIST and 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')

This structure is derived from BackportSubscription

Summary

Mandatory: 1 element
Must-Support: 1 element

 

Other representations of profile: CSV, Excel, Schematron