Document Subscription for Mobile (DSUBm)
1.0.0 - Trial-Implementation
Document Subscription for Mobile (DSUBm)
1.0.0 - Trial-Implementation
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
| Official URL: https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/DSUBm-DocumentReference-PatientDependent-Subscription-AllEvents | Version: 1.0.0 | |||
| Active as of 2024-02-29 | Computable Name: DSUBm_DocumentReference_PatientDependent_Subscription_AllEvents | |||
Resource Subscription for DSUBm profile for DocumentReference with 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 |
|---|---|---|---|---|
  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-DocReference-PatientDependent-AllEvents | |
   extension | C | 0..* | Extension | The criteria.extension SHALL have at least one of the patient or patient.identifier parameter as a subscription criteria. DocumentReference-PatientDependent: the Subscription for DocumentReference SHALL include the resource DocumentReference and the patient parameter |
| 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 | ||||
| Path | Conformance | ValueSet | URI |
| Subscription.channel.payload | required | DSUBmPayloadhttps://profiles.ihe.net/ITI/DSUBm/ValueSet/payload-content-value-setfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| DocumentReference-PatientDependent | error | Subscription.criteria.extension | the Subscription for DocumentReference SHALL include the resource DocumentReference and the patient parameter : value.contains('DocumentReference?') and value.contains('patient') |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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-DocReference-PatientDependent-AllEvents |
| 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. Slice: Unordered, Open by value:url DocumentReference-PatientDependent: the Subscription for DocumentReference SHALL include the resource DocumentReference and the patient parameter |
 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 |
| 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 |
| 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) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Subscription.status | required | SubscriptionStatushttp://hl7.org/fhir/ValueSet/subscription-status|4.0.0from the FHIR Standard | |
| Subscription.channel.type | required | Pattern: rest-hookhttp://hl7.org/fhir/ValueSet/subscription-channel-type|4.0.0from the FHIR Standard | |
| Subscription.channel.payload | required | DSUBmPayloadhttps://profiles.ihe.net/ITI/DSUBm/ValueSet/payload-content-value-setfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| DocumentReference-PatientDependent | error | Subscription.criteria.extension | the Subscription for DocumentReference SHALL include the resource DocumentReference and the patient parameter : value.contains('DocumentReference?') and value.contains('patient') |
| 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
| |||||
| 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-DocReference-PatientDependent-AllEvents | ||||
| 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. Slice: Unordered, Open by value:url DocumentReference-PatientDependent: the Subscription for DocumentReference SHALL include the resource DocumentReference and the patient parameter | ||||
| 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 | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Subscription.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Subscription.status | required | SubscriptionStatushttp://hl7.org/fhir/ValueSet/subscription-status|4.0.0from the FHIR Standard | ||||
| Subscription.channel.type | required | Pattern: rest-hookhttp://hl7.org/fhir/ValueSet/subscription-channel-type|4.0.0from the FHIR Standard | ||||
| Subscription.channel.payload | required | DSUBmPayloadhttps://profiles.ihe.net/ITI/DSUBm/ValueSet/payload-content-value-setfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| DocumentReference-PatientDependent | error | Subscription.criteria.extension | the Subscription for DocumentReference SHALL include the resource DocumentReference and the patient parameter : value.contains('DocumentReference?') and value.contains('patient') |
This structure is derived from BackportSubscription
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-DocReference-PatientDependent-AllEvents | |
| extension | C | 0..* | Extension | The criteria.extension SHALL have at least one of the patient or patient.identifier parameter as a subscription criteria. DocumentReference-PatientDependent: the Subscription for DocumentReference SHALL include the resource DocumentReference and the patient parameter |
| 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 | ||||
| Path | Conformance | ValueSet | URI |
| Subscription.channel.payload | required | DSUBmPayloadhttps://profiles.ihe.net/ITI/DSUBm/ValueSet/payload-content-value-setfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| DocumentReference-PatientDependent | error | Subscription.criteria.extension | the Subscription for DocumentReference SHALL include the resource DocumentReference and the patient parameter : value.contains('DocumentReference?') and value.contains('patient') |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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-DocReference-PatientDependent-AllEvents |
| 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. Slice: Unordered, Open by value:url DocumentReference-PatientDependent: the Subscription for DocumentReference SHALL include the resource DocumentReference and the patient parameter |
| 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 |
| 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 |
| 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) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Subscription.status | required | SubscriptionStatushttp://hl7.org/fhir/ValueSet/subscription-status|4.0.0from the FHIR Standard | |
| Subscription.channel.type | required | Pattern: rest-hookhttp://hl7.org/fhir/ValueSet/subscription-channel-type|4.0.0from the FHIR Standard | |
| Subscription.channel.payload | required | DSUBmPayloadhttps://profiles.ihe.net/ITI/DSUBm/ValueSet/payload-content-value-setfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| DocumentReference-PatientDependent | error | Subscription.criteria.extension | the Subscription for DocumentReference SHALL include the resource DocumentReference and the patient parameter : value.contains('DocumentReference?') and value.contains('patient') |
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
| |||||
| 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-DocReference-PatientDependent-AllEvents | ||||
| 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. Slice: Unordered, Open by value:url DocumentReference-PatientDependent: the Subscription for DocumentReference SHALL include the resource DocumentReference and the patient parameter | ||||
| 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 | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Subscription.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Subscription.status | required | SubscriptionStatushttp://hl7.org/fhir/ValueSet/subscription-status|4.0.0from the FHIR Standard | ||||
| Subscription.channel.type | required | Pattern: rest-hookhttp://hl7.org/fhir/ValueSet/subscription-channel-type|4.0.0from the FHIR Standard | ||||
| Subscription.channel.payload | required | DSUBmPayloadhttps://profiles.ihe.net/ITI/DSUBm/ValueSet/payload-content-value-setfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| DocumentReference-PatientDependent | error | Subscription.criteria.extension | the Subscription for DocumentReference SHALL include the resource DocumentReference and the patient parameter : value.contains('DocumentReference?') and value.contains('patient') |
This structure is derived from BackportSubscription
Other representations of profile: CSV, Excel, Schematron
IG © 2023+ IHE IT Infrastructure Technical Committee. Package ihe.iti.dsubm#1.0.0 based on FHIR 4.0.1. Generated 2024-02-29
Links: Table of Contents |
QA Report
| New Issue | Issues
Version History |
|
Propose a change