Document Subscription for Mobile (DSUBm)
1.0.0 - Trial-Implementation International flag

This page is part of the Document Subscription for Mobile (DSUBm) (v1.0.0: Publication) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: Subscription for DocumentReference Multi-Patient with DocumentReference Subscription for Full Events Option

Official URL: https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/DSUBm-DocumentReference-MultiPatient-Subscription-AllEvents Version: 1.0.0
Active as of 2024-02-29 Computable Name: DSUBm_DocumentReference_MultiPatient_Subscription_AllEvents

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

  • the criteria element SHALL contain the URL of a canonical instance of SubscriptionTopic for the creation, update or deletion of DocumentReference 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..*BackportSubscriptionServer push subscription criteria
... criteria 1..1stringCanonical URL for the SubscriptionTopic.
Required Pattern: https://profiles.ihe.net/ITI/DSUBm/SubscriptionTopic/DSUBm-SubscriptionTopic-DocReference-MultiPatient-AllEvents
.... extension C0..*ExtensionThe criteria.extension SHALL NOT have the patient or the patient.identifier parameter as a subscription criteria.
DocumentReference-MultiPatient: the Subscription for DocumentReference SHALL include the resource DocumentReference and no reference to the patient parameter
... channel
.... type 1..1coderest-hook | websocket | email | sms | message
Required Pattern: rest-hook
.... endpoint S1..1urlThe endpoint SHOULD be the endpoint that the Resource Notification Recipient is receiving the notifications.
.... payload 1..1codeMIME 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
DocumentReference-MultiPatienterrorSubscription.criteria.extensionthe Subscription for DocumentReference SHALL include the resource DocumentReference and no reference to the patient parameter
: value.contains('DocumentReference?') and value.contains('patient').not()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Subscription 0..*BackportSubscriptionServer 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: SubscriptionStatus (required): The status of a subscription.

... reason Σ1..1stringDescription of why this subscription was created
... criteria SΣ1..1stringCanonical URL for the SubscriptionTopic.
Required Pattern: https://profiles.ihe.net/ITI/DSUBm/SubscriptionTopic/DSUBm-SubscriptionTopic-DocReference-MultiPatient-AllEvents
.... Slices for extension C0..*ExtensionThe criteria.extension SHALL NOT have the patient or the patient.identifier parameter as a subscription criteria.
Slice: Unordered, Open by value:url
DocumentReference-MultiPatient: the Subscription for DocumentReference SHALL include the resource DocumentReference and no reference to the patient parameter
.... 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
.... 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.


Required Pattern: rest-hook
..... customChannelType SΣ0..1CodingExtended channel type for notifications
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-channel-type
.... endpoint SΣ1..1urlThe endpoint SHOULD be the endpoint that the Resource Notification Recipient is receiving the notifications.
.... payload Σ1..1codeMIME type to send, or omit for no payload
Binding: DSUBm payload admitted Value Set (required)
..... 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 / 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
DocumentReference-MultiPatienterrorSubscription.criteria.extensionthe Subscription for DocumentReference SHALL include the resource DocumentReference and no reference to the patient parameter
: value.contains('DocumentReference?') and value.contains('patient').not()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Subscription 0..*BackportSubscriptionServer 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
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): IETF language tag

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1coderequested | active | error | off
Binding: SubscriptionStatus (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 SubscriptionTopic.
Required Pattern: https://profiles.ihe.net/ITI/DSUBm/SubscriptionTopic/DSUBm-SubscriptionTopic-DocReference-MultiPatient-AllEvents
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension C0..*ExtensionThe criteria.extension SHALL NOT have the patient or the patient.identifier parameter as a subscription criteria.
Slice: Unordered, Open by value:url
DocumentReference-MultiPatient: the Subscription for DocumentReference SHALL include the resource DocumentReference and no reference to the patient parameter
.... 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.


Required Pattern: rest-hook
..... 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 SΣ1..1urlThe endpoint SHOULD be the endpoint that the Resource Notification Recipient is receiving the notifications.
.... payload Σ1..1codeMIME type to send, or omit for no payload
Binding: DSUBm payload admitted Value Set (required)
..... 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 / 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
DocumentReference-MultiPatienterrorSubscription.criteria.extensionthe Subscription for DocumentReference SHALL include the resource DocumentReference and no reference to the patient parameter
: value.contains('DocumentReference?') 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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Subscription 0..*BackportSubscriptionServer push subscription criteria
... criteria 1..1stringCanonical URL for the SubscriptionTopic.
Required Pattern: https://profiles.ihe.net/ITI/DSUBm/SubscriptionTopic/DSUBm-SubscriptionTopic-DocReference-MultiPatient-AllEvents
.... extension C0..*ExtensionThe criteria.extension SHALL NOT have the patient or the patient.identifier parameter as a subscription criteria.
DocumentReference-MultiPatient: the Subscription for DocumentReference SHALL include the resource DocumentReference and no reference to the patient parameter
... channel
.... type 1..1coderest-hook | websocket | email | sms | message
Required Pattern: rest-hook
.... endpoint S1..1urlThe endpoint SHOULD be the endpoint that the Resource Notification Recipient is receiving the notifications.
.... payload 1..1codeMIME 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
DocumentReference-MultiPatienterrorSubscription.criteria.extensionthe Subscription for DocumentReference SHALL include the resource DocumentReference and no reference to the patient parameter
: value.contains('DocumentReference?') and value.contains('patient').not()

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Subscription 0..*BackportSubscriptionServer 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: SubscriptionStatus (required): The status of a subscription.

... reason Σ1..1stringDescription of why this subscription was created
... criteria SΣ1..1stringCanonical URL for the SubscriptionTopic.
Required Pattern: https://profiles.ihe.net/ITI/DSUBm/SubscriptionTopic/DSUBm-SubscriptionTopic-DocReference-MultiPatient-AllEvents
.... Slices for extension C0..*ExtensionThe criteria.extension SHALL NOT have the patient or the patient.identifier parameter as a subscription criteria.
Slice: Unordered, Open by value:url
DocumentReference-MultiPatient: the Subscription for DocumentReference SHALL include the resource DocumentReference and no reference to the patient parameter
.... 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
.... 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.


Required Pattern: rest-hook
..... customChannelType SΣ0..1CodingExtended channel type for notifications
URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-channel-type
.... endpoint SΣ1..1urlThe endpoint SHOULD be the endpoint that the Resource Notification Recipient is receiving the notifications.
.... payload Σ1..1codeMIME type to send, or omit for no payload
Binding: DSUBm payload admitted Value Set (required)
..... 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 / 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
DocumentReference-MultiPatienterrorSubscription.criteria.extensionthe Subscription for DocumentReference SHALL include the resource DocumentReference and no reference to the patient parameter
: value.contains('DocumentReference?') and value.contains('patient').not()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Subscription 0..*BackportSubscriptionServer 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
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): IETF language tag

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1coderequested | active | error | off
Binding: SubscriptionStatus (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 SubscriptionTopic.
Required Pattern: https://profiles.ihe.net/ITI/DSUBm/SubscriptionTopic/DSUBm-SubscriptionTopic-DocReference-MultiPatient-AllEvents
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension C0..*ExtensionThe criteria.extension SHALL NOT have the patient or the patient.identifier parameter as a subscription criteria.
Slice: Unordered, Open by value:url
DocumentReference-MultiPatient: the Subscription for DocumentReference SHALL include the resource DocumentReference and no reference to the patient parameter
.... 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.


Required Pattern: rest-hook
..... 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 SΣ1..1urlThe endpoint SHOULD be the endpoint that the Resource Notification Recipient is receiving the notifications.
.... payload Σ1..1codeMIME type to send, or omit for no payload
Binding: DSUBm payload admitted Value Set (required)
..... 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 / 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
DocumentReference-MultiPatienterrorSubscription.criteria.extensionthe Subscription for DocumentReference SHALL include the resource DocumentReference and no reference to the patient parameter
: value.contains('DocumentReference?') 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