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
Official URL: https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/DSUBm-DocumentReference-MultiPatient-Subscription | Version: 1.0.1-current | |||
Active as of 2025-04-28 | Computable Name: DSUBm_DocumentReference_MultiPatient_Subscription |
Resource Subscription for DSUBm profile for DocumentReference without the indication of the patient
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from BackportSubscription
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | BackportSubscription | Server push subscription criteria | |
![]() ![]() ![]() |
1..1 | string | Canonical URL for the SubscriptionTopic. Required Pattern: https://profiles.ihe.net/ITI/DSUBm/SubscriptionTopic/DSUBm-SubscriptionTopic-DocumentReference-MultiPatient | |
![]() ![]() ![]() ![]() |
C | 0..* | Extension | The 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 |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
1..1 | code | rest-hook | websocket | email | sms | message Required Pattern: rest-hook | |
![]() ![]() ![]() ![]() |
S | 1..1 | url | The endpoint SHOULD be the endpoint that the Resource Notification Recipient is receiving the notifications. |
![]() ![]() ![]() ![]() |
1..1 | code | MIME type to send, or omit for no payload Binding: DSUBm payload admitted Value Set (required) | |
![]() |
Path | Conformance | ValueSet | URI |
Subscription.channel.payload | required | DSUBmPayloadhttps://profiles.ihe.net/ITI/DSUBm/ValueSet/payload-content-value-set from this IG |
Id | Grade | Path(s) | Details | Requirements |
DocumentReference-MultiPatient | error | Subscription.criteria.extension | the Subscription for DocumentReference SHALL include the resource DocumentReference and no reference to the patient parameter : value.contains('DocumentReference?') and value.contains('patient').not() |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
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 | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?! | 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 |
![]() ![]() ![]() |
?!Σ | 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 |
![]() ![]() ![]() |
Σ | 1..1 | string | Description of why this subscription was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
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-DocumentReference-MultiPatient |
![]() ![]() ![]() ![]() |
C | 0..* | Extension | The criteria.extension SHALL NOT have the patient or the patient.identifier parameter as a subscription criteria. 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 DocumentReference-MultiPatient: the Subscription for DocumentReference SHALL include the resource DocumentReference and no reference to the patient parameter |
![]() ![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() |
Σ | 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 |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() |
?!Σ | 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 |
![]() ![]() ![]() ![]() |
Σ | 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 |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() |
Σ | 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 |
![]() ![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() ![]() ![]() |
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 |
![]() |
Path | Conformance | ValueSet / Code | URI |
Subscription.status | required | SubscriptionStatushttp://hl7.org/fhir/ValueSet/subscription-status|4.0.0 from the FHIR Standard | |
Subscription.channel.type | required | Pattern: rest-hookhttp://hl7.org/fhir/ValueSet/subscription-channel-type|4.0.0 from the FHIR Standard | |
Subscription.channel.payload | required | DSUBmPayloadhttps://profiles.ihe.net/ITI/DSUBm/ValueSet/payload-content-value-set from this IG |
Id | Grade | Path(s) | Details | Requirements |
DocumentReference-MultiPatient | error | Subscription.criteria.extension | the Subscription for DocumentReference SHALL include the resource DocumentReference and no reference to the patient parameter : value.contains('DocumentReference?') and value.contains('patient').not() |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | BackportSubscription | Server push subscription criteria | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | requested | active | error | off Binding: SubscriptionStatus (required): The status of a subscription. | ||||
![]() ![]() ![]() |
Σ | 0..* | ContactPoint | Contact details for source (e.g. troubleshooting) | ||||
![]() ![]() ![]() |
Σ | 0..1 | instant | When to automatically delete the subscription | ||||
![]() ![]() ![]() |
Σ | 1..1 | string | Description of why this subscription was created | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | Canonical URL for the SubscriptionTopic. Required Pattern: https://profiles.ihe.net/ITI/DSUBm/SubscriptionTopic/DSUBm-SubscriptionTopic-DocumentReference-MultiPatient | ||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() |
C | 0..* | Extension | The 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 | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..* | string | Filtering critiera applied to events URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
![]() ![]() ![]() |
Σ | 0..1 | string | Latest error note | ||||
![]() ![]() ![]() |
Σ | 1..1 | BackboneElement | The channel on which to report matches to the criteria | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | unsignedInt | Interval in seconds to send 'heartbeat' notification URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | unsignedInt | Timeout in seconds to attempt notification delivery URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | Maximum number of triggering resources included in notification bundles URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | Coding | Extended channel type for notifications URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-channel-type | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | Primitive value for code | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | url | The endpoint SHOULD be the endpoint that the Resource Notification Recipient is receiving the notifications. | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | MIME type to send, or omit for no payload Binding: DSUBm payload admitted Value Set (required) | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
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) | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | Primitive value for code | |||||
![]() ![]() ![]() ![]() |
Σ | 0..* | string | Usage depends on the channel type | ||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
Subscription.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Subscription.status | required | SubscriptionStatushttp://hl7.org/fhir/ValueSet/subscription-status|4.0.0 from the FHIR Standard | ||||
Subscription.channel.type | required | Pattern: rest-hookhttp://hl7.org/fhir/ValueSet/subscription-channel-type|4.0.0 from the FHIR Standard | ||||
Subscription.channel.payload | required | DSUBmPayloadhttps://profiles.ihe.net/ITI/DSUBm/ValueSet/payload-content-value-set from this IG |
Id | Grade | Path(s) | Details | Requirements |
DocumentReference-MultiPatient | error | Subscription.criteria.extension | the 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
Differential View
This structure is derived from BackportSubscription
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | BackportSubscription | Server push subscription criteria | |
![]() ![]() ![]() |
1..1 | string | Canonical URL for the SubscriptionTopic. Required Pattern: https://profiles.ihe.net/ITI/DSUBm/SubscriptionTopic/DSUBm-SubscriptionTopic-DocumentReference-MultiPatient | |
![]() ![]() ![]() ![]() |
C | 0..* | Extension | The 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 |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
1..1 | code | rest-hook | websocket | email | sms | message Required Pattern: rest-hook | |
![]() ![]() ![]() ![]() |
S | 1..1 | url | The endpoint SHOULD be the endpoint that the Resource Notification Recipient is receiving the notifications. |
![]() ![]() ![]() ![]() |
1..1 | code | MIME type to send, or omit for no payload Binding: DSUBm payload admitted Value Set (required) | |
![]() |
Path | Conformance | ValueSet | URI |
Subscription.channel.payload | required | DSUBmPayloadhttps://profiles.ihe.net/ITI/DSUBm/ValueSet/payload-content-value-set from this IG |
Id | Grade | Path(s) | Details | Requirements |
DocumentReference-MultiPatient | error | Subscription.criteria.extension | the 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
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
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 | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?! | 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 |
![]() ![]() ![]() |
?!Σ | 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 |
![]() ![]() ![]() |
Σ | 1..1 | string | Description of why this subscription was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
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-DocumentReference-MultiPatient |
![]() ![]() ![]() ![]() |
C | 0..* | Extension | The criteria.extension SHALL NOT have the patient or the patient.identifier parameter as a subscription criteria. 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 DocumentReference-MultiPatient: the Subscription for DocumentReference SHALL include the resource DocumentReference and no reference to the patient parameter |
![]() ![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() |
Σ | 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 |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() |
?!Σ | 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 |
![]() ![]() ![]() ![]() |
Σ | 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 |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() |
Σ | 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 |
![]() ![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() ![]() ![]() |
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 |
![]() |
Path | Conformance | ValueSet / Code | URI |
Subscription.status | required | SubscriptionStatushttp://hl7.org/fhir/ValueSet/subscription-status|4.0.0 from the FHIR Standard | |
Subscription.channel.type | required | Pattern: rest-hookhttp://hl7.org/fhir/ValueSet/subscription-channel-type|4.0.0 from the FHIR Standard | |
Subscription.channel.payload | required | DSUBmPayloadhttps://profiles.ihe.net/ITI/DSUBm/ValueSet/payload-content-value-set from this IG |
Id | Grade | Path(s) | Details | Requirements |
DocumentReference-MultiPatient | error | Subscription.criteria.extension | the 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
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | BackportSubscription | Server push subscription criteria | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | requested | active | error | off Binding: SubscriptionStatus (required): The status of a subscription. | ||||
![]() ![]() ![]() |
Σ | 0..* | ContactPoint | Contact details for source (e.g. troubleshooting) | ||||
![]() ![]() ![]() |
Σ | 0..1 | instant | When to automatically delete the subscription | ||||
![]() ![]() ![]() |
Σ | 1..1 | string | Description of why this subscription was created | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | Canonical URL for the SubscriptionTopic. Required Pattern: https://profiles.ihe.net/ITI/DSUBm/SubscriptionTopic/DSUBm-SubscriptionTopic-DocumentReference-MultiPatient | ||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() |
C | 0..* | Extension | The 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 | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..* | string | Filtering critiera applied to events URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
![]() ![]() ![]() |
Σ | 0..1 | string | Latest error note | ||||
![]() ![]() ![]() |
Σ | 1..1 | BackboneElement | The channel on which to report matches to the criteria | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | unsignedInt | Interval in seconds to send 'heartbeat' notification URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | unsignedInt | Timeout in seconds to attempt notification delivery URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | Maximum number of triggering resources included in notification bundles URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | Coding | Extended channel type for notifications URL: http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-channel-type | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | Primitive value for code | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | url | The endpoint SHOULD be the endpoint that the Resource Notification Recipient is receiving the notifications. | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | MIME type to send, or omit for no payload Binding: DSUBm payload admitted Value Set (required) | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
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) | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | Primitive value for code | |||||
![]() ![]() ![]() ![]() |
Σ | 0..* | string | Usage depends on the channel type | ||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
Subscription.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Subscription.status | required | SubscriptionStatushttp://hl7.org/fhir/ValueSet/subscription-status|4.0.0 from the FHIR Standard | ||||
Subscription.channel.type | required | Pattern: rest-hookhttp://hl7.org/fhir/ValueSet/subscription-channel-type|4.0.0 from the FHIR Standard | ||||
Subscription.channel.payload | required | DSUBmPayloadhttps://profiles.ihe.net/ITI/DSUBm/ValueSet/payload-content-value-set from this IG |
Id | Grade | Path(s) | Details | Requirements |
DocumentReference-MultiPatient | error | Subscription.criteria.extension | the 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
Other representations of profile: CSV, Excel, Schematron