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

## Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

### Canonical SubscriptionTopic

Artifacts related to Basic resource representing the possible topic used in DSUBm

SubscriptionTopic for DocumentReference Multi-Patient resource | Canonical instance for the resource SubscriptionTopic. It describes the topic for the Subscription. This topic SHALL be used in all DocumentReference subscriptions that have not a specific patient in the criteria element and are just focusing on the create event. Note that: the trigger for this topic SHALL be the resourceTrigger (so the eventTrigger SHALL NOT be used) the resourceTrigger.resource element SHALL be a DocumentReference resource the canFilterBy.filterParameter does not include the patient and patient.identifier parameters this topic only covers the create event of a DocumentReference
SubscriptionTopic for DocumentReference Multi-Patient resource with DocumentReference Subscription for Full Events Option | Canonical instance for the resource SubscriptionTopic. It describes the topic for the Subscription. This topic SHALL be used in all DocumentReference subscriptions that have not a specific patient in the criteria element. Note that: the trigger for this topic SHALL be the resourceTrigger (so the eventTrigger SHALL NOT be used) the resourceTrigger.resource element SHALL be a DocumentReference resource the canFilterBy.filterParameter does not include the patient and patient.identifier parameters this resource SHALL be used when the “DocumentReference Subscription for Full Events Option” is supported the events are creation, update and deletion of a DocumentReference
SubscriptionTopic for DocumentReference Multi-Patient resource with DocumentReference Subscription for Minimal Update Option | Canonical instance for the resource SubscriptionTopic. It describes the topic for the Subscription. This topic SHALL be used in all DocumentReference subscriptions that have not a specific patient in the criteria element. Note that: the trigger for this topic SHALL be the resourceTrigger (so the eventTrigger SHALL NOT be used) the resourceTrigger.resource element SHALL be a DocumentReference resource the canFilterBy.filterParameter does not include the patient and patient.identifier parameters this resource SHALL be used when the “DocumentReference Subscription for Minimal Update Option” is supported the events are creation, deletion and update only in the “status” of a DocumentReference
SubscriptionTopic for DocumentReference Patient-Dependent resource | Canonical instance for the resource SubscriptionTopic. It describes the topic for the Subscription. This topic SHALL be used in all DocumentReference subscriptions that have a specific patient in the criteria element and are just focusing on the create event. Note that: the trigger for this topic SHALL be the resourceTrigger (so the eventTrigger SHALL NOT be used) the resourceTrigger.resource element SHALL be a DocumentReference resource this topic only covers the create event of a DocumentReference
SubscriptionTopic for DocumentReference Patient-Dependent resource with DocumentReference Subscription for Full Events Option | Canonical instance for the resource SubscriptionTopic. It describes the topic for the Subscription. This topic SHALL be used in all DocumentReference subscriptions that have a specific patient in the criteria element. Note that: the trigger for this topic SHALL be the resourceTrigger (so the eventTrigger SHALL NOT be used) the resourceTrigger.resource element SHALL be a DocumentReference resource this resource SHALL be used when the “DocumentReference Subscription for Full Events Option” is supported the events are creation, update and deletion of a DocumentReference
SubscriptionTopic for DocumentReference Patient-Dependent resource with DocumentReference Subscription for Minimal Update Option | Canonical instance for the resource SubscriptionTopic. It describes the topic for the Subscription. This topic SHALL be used in all DocumentReference subscriptions that have a specific patient in the criteria element. Note that: the trigger for this topic SHALL be the resourceTrigger (so the eventTrigger SHALL NOT be used) the resourceTrigger.resource element SHALL be a DocumentReference resource this resource SHALL be used when the “DocumentReference Subscription for Minimal Update Option” is supported the events are creation, deletion and update only in the “status” of a DocumentReference.
SubscriptionTopic for Folder Patient-Dependent resource with Basic Folder Subscription Option | Profile for the resource SubscriptionTopic. The resource describe the topic of a creation of a Folder type List Resource and the update to insert new documents in the Folder. This topic SHALL be used in all Folder subscriptions that have a specific patient in the criteria element and are just focusing on the create event. Note that: the trigger for this topic SHALL be the resourceTrigger (so the eventTrigger SHALL NOT be used) the resourceTrigger.resource element SHALL be a Folder List resource this resource SHALL be used when the “Basic Folder Subscription Option” is supported this topic covers the create and the update to insert new documents in the Folder event
SubscriptionTopic for Folder Subscription for Full Events Option | Profile for the resource SubscriptionTopic. The resource describe the topic of a creation, update or deletion of a Folder type List Resource. This topic SHALL be used in all Folder subscriptions that have a specific patient in the criteria element. Note that: the trigger for this topic SHALL be the resourceTrigger (so the eventTrigger SHALL NOT be used) the resourceTrigger.resource element SHALL be a Folder type List resource this resource SHALL be used when the “Folder Subscription for Full Events Option” is supported the events are creation, update and deletion of a Folder type List resource
SubscriptionTopic for Folder Subscription for Minimal Update Option | Profile for the resource SubscriptionTopic. The resource describe the topic of a creation of a Folder type List Resource, the update to insert or remove documents in the Folder and the update of the status. This topic SHALL be used in all Folder subscriptions that have a specific patient in the criteria element. Note that: the trigger for this topic SHALL be the resourceTrigger (so the eventTrigger SHALL NOT be used) the resourceTrigger.resource element SHALL be a Folder type List resource this resource SHALL be used when the “Folder Subscription for Minimal Update Option” is supported the events are the creation of a Folder type List Resource, the update to insert or remove documents in the Folder and the update of the status
SubscriptionTopic for Folder Subscription for Update Option | Profile for the resource SubscriptionTopic. The resource describe the topic of a creation or update of a Folder type List Resource. This topic SHALL be used in all Folder subscriptions that have a specific patient in the criteria element. Note that: the trigger for this topic SHALL be the resourceTrigger (so the eventTrigger SHALL NOT be used) the resourceTrigger.resource element SHALL be a Folder type List resource this resource SHALL be used when the “Folder Subscription for Update Option” is supported the events are creation and update of a Folder type List resource
SubscriptionTopic for SubmissionSet Multi-Patient resource | Canonical instance for the resource SubscriptionTopic. It describes the topic for the Subscription. This topic SHALL be used in all SubmissionSet type List subscriptions that have not a specific patient in the criteria element and are just focusing on the create event. Note that: the trigger for this topic SHALL be the resourceTrigger (so the eventTrigger SHALL NOT be used) the resourceTrigger.resource element SHALL be a SubmissionSet type List resource the canFilterBy.filterParameter does not include the patient and patient.identifier parameters this topic only covers the create event of a SubmissionSet type List resource
SubscriptionTopic for SubmissionSet PatientDependent resource | Canonical instance for the resource SubscriptionTopic. It describes the topic for the Subscription. This topic SHALL be used in all SubmissionSet subscriptions that have a specific patient in the criteria element and are just focusing on the create event. Note that: the trigger for this topic SHALL be the resourceTrigger (so the eventTrigger SHALL NOT be used) the resourceTrigger.resource element SHALL be a SubmissionSet type List Resource this topic only covers the create event of a SubmissionSet type List resource

### Behavior: Capability Statements

The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.

DSUBm Resource Notification Broker Actor | The DSUBm Resource Notification Broker Actor CapabilityStatement requirements expresses the requirements that SHALL be provided. Using FHIR R4 SHALL support both json and xml encoding SHOULD use a security framework. Recommend ATNA, encouraged IHE-IUA or SMART-app-launch SHALL support the ITI-110 transaction and support the basic type of Subscription and related SubscriptionTopic MAY support the ITI-111 transaction SHALL support the ITI-112 transaction: SHALL support Handshake Notification SHOULD support Heartbeat Notification SHALL support Event Notification SHOULD support Subscription Deactivation Notification SHALL support the ITI-113 transaction: SHALL support the following Search Parameters _id status url filter-criteria topic SHALL support the DSUBm $status operation SHOULD support the DSUBm $events operation SHALL support the ITI-114 transaction: SHALL support the following Search Parameters code _id resource derived-or-self status url
DSUBm Resource Notification Broker Actor implementing Basic Folder Subscription option | The DSUBm Resource Notification Broker Actor CapabilityStatement requirements expresses the requirements that SHALL be provided when implementing Basic Folder Subscription option. Using FHIR R4 SHALL support both json and xml encoding SHOULD use a security framework. Recommend ATNA, encouraged IHE-IUA or SMART-app-launch SHALL support the ITI-110 transaction and support the basic type of Subscription and related SubscriptionTopic SHALL be able to support the Subscription defined in Section 2:3.110.4.1.2.1.3 Subscription with Basic Folder Subscription option, and the related SubscriptionTopic MAY support the ITI-111 transaction SHALL support the ITI-112 transaction: SHALL support Handshake Notification SHOULD support Heartbeat Notification SHALL support Event Notification SHOULD support Subscription Deactivation Notification SHALL support the ITI-113 transaction: SHALL support the following Search Parameters _id status url filter-criteria topic SHALL support the DSUBm $status operation SHOULD support the DSUBm $events operation SHALL support the ITI-114 transaction: SHALL support the following Search Parameters code _id resource derived-or-self status url
DSUBm Resource Notification Broker Actor implementing DocumentReference Subscription for Full Events option | The DSUBm Resource Notification Broker Actor CapabilityStatement requirements expresses the requirements that SHALL be provided when implementing DocumentReference Subscription for Full Events option. Using FHIR R4 SHALL support both json and xml encoding SHOULD use a security framework. Recommend ATNA, encouraged IHE-IUA or SMART-app-launch SHALL support the ITI-110 transaction and support the basic type of Subscription and related SubscriptionTopic SHALL be able to support the Subscription defined in Section 2:3.110.4.1.2.1.2 Subscription with DocumentReference Subscription for Full Events option, and the related SubscriptionTopic MAY support the ITI-111 transaction SHALL support the ITI-112 transaction: SHALL support Handshake Notification SHOULD support Heartbeat Notification SHALL support Event Notification SHOULD support Subscription Deactivation Notification SHALL support the ITI-113 transaction: SHALL support the following Search Parameters _id status url filter-criteria topic SHALL support the DSUBm $status operation SHOULD support the DSUBm $events operation SHALL support the ITI-114 transaction: SHALL support the following Search Parameters code _id resource derived-or-self status url
DSUBm Resource Notification Broker Actor implementing DocumentReference Subscription for Minimal Update Option | The DSUBm Resource Notification Broker Actor CapabilityStatement requirements expresses the requirements that SHALL be provided when implementing DocumentReference Subscription for Minimal Update Option. Using FHIR R4 SHALL support both json and xml encoding SHOULD use a security framework. Recommend ATNA, encouraged IHE-IUA or SMART-app-launch SHALL support the ITI-110 transaction and support the basic type of Subscription and related SubscriptionTopic SHALL be able to support the Subscription defined in Section 2:3.110.4.1.2.1.1 Subscription with DocumentReference Subscription for Minimal Update option, and the related SubscriptionTopic MAY support the ITI-111 transaction SHALL support the ITI-112 transaction: SHALL support Handshake Notification SHOULD support Heartbeat Notification SHALL support Event Notification SHOULD support Subscription Deactivation Notification SHALL support the ITI-113 transaction: SHALL support the following Search Parameters _id status url filter-criteria topic SHALL support the DSUBm $status operation SHOULD support the DSUBm $events operation SHALL support the ITI-114 transaction: SHALL support the following Search Parameters code _id resource derived-or-self status url
DSUBm Resource Notification Broker Actor implementing DocumentReference Subscription for Update Option | The DSUBm Resource Notification Broker Actor CapabilityStatement requirements expresses the requirements that SHALL be provided when implementing DocumentReference Subscription for Update Option. Using FHIR R4 SHALL support both json and xml encoding SHOULD use a security framework. Recommend ATNA, encouraged IHE-IUA or SMART-app-launch SHALL support the ITI-110 transaction and support the basic type of Subscription and related SubscriptionTopic SHALL be able to support the Subscription defined in Section 2:3.110.4.1.2.1.5 Subscription with Folder Subscription for Update option, and the related SubscriptionTopic MAY support the ITI-111 transaction SHALL support the ITI-112 transaction: SHALL support Handshake Notification SHOULD support Heartbeat Notification SHALL support Event Notification SHOULD support Subscription Deactivation Notification SHALL support the ITI-113 transaction: SHALL support the following Search Parameters _id status url filter-criteria topic SHALL support the DSUBm $status operation SHOULD support the DSUBm $events operation SHALL support the ITI-114 transaction: SHALL support the following Search Parameters code _id resource derived-or-self status url
DSUBm Resource Notification Broker Actor implementing Folder Subscription for Full Events option | The DSUBm Resource Notification Broker Actor CapabilityStatement requirements expresses the requirements that SHALL be provided when implementing Folder Subscription for Full Events option. Using FHIR R4 SHALL support both json and xml encoding SHOULD use a security framework. Recommend ATNA, encouraged IHE-IUA or SMART-app-launch SHALL support the ITI-110 transaction and support the basic type of Subscription and related SubscriptionTopic SHALL be able to support the Subscription defined in Section 2:3.110.4.1.2.1.6 Subscription with Folder Subscription for Full Events option, and the related SubscriptionTopic MAY support the ITI-111 transaction SHALL support the ITI-112 transaction: SHALL support Handshake Notification SHOULD support Heartbeat Notification SHALL support Event Notification SHOULD support Subscription Deactivation Notification SHALL support the ITI-113 transaction: SHALL support the following Search Parameters _id status url filter-criteria topic SHALL support the DSUBm $status operation SHOULD support the DSUBm $events operation SHALL support the ITI-114 transaction: SHALL support the following Search Parameters code _id resource derived-or-self status url
DSUBm Resource Notification Broker Actor implementing Folder Subscription for Minimal Update option | The DSUBm Resource Notification Broker Actor CapabilityStatement requirements expresses the requirements that SHALL be provided when implementing Folder Subscription for Minimal Update option. Using FHIR R4 SHALL support both json and xml encoding SHOULD use a security framework. Recommend ATNA, encouraged IHE-IUA or SMART-app-launch SHALL support the ITI-110 transaction and support the basic type of Subscription and related SubscriptionTopic SHALL be able to support the Subscription defined in Section 2:3.110.4.1.2.1.4 Subscription with Folder Subscription for Minimal Update option, and the related SubscriptionTopic MAY support the ITI-111 transaction SHALL support the ITI-112 transaction: SHALL support Handshake Notification SHOULD support Heartbeat Notification SHALL support Event Notification SHOULD support Subscription Deactivation Notification SHALL support the ITI-113 transaction: SHALL support the following Search Parameters _id status url filter-criteria topic SHALL support the DSUBm $status operation SHOULD support the DSUBm $events operation SHALL support the ITI-114 transaction: SHALL support the following Search Parameters code _id resource derived-or-self status url
DSUBm Resource Notification Publisher Actor | The DSUBm Resource Notification Publisher Actor CapabilityStatement requirements expresses the requirements that SHALL be provided. Using FHIR R4 SHALL support both json and xml encoding SHOULD use a security framework. Recommend ATNA, encouraged IHE-IUA or SMART-app-launch SHALL support the ITI-111 transaction for the basic trigger events
DSUBm Resource Notification Publisher Actor implementing Basic Folder Subscription option | The DSUBm Resource Notification Publisher Actor CapabilityStatement requirements expresses the requirements that SHALL be provided when implementing Basic Folder Subscription option. Using FHIR R4 SHALL support both json and xml encoding SHOULD use a security framework. Recommend ATNA, encouraged IHE-IUA or SMART-app-launch SHALL support the ITI-111 transaction for the basic trigger events SHALL be able to support in the Resource Publish [ITI-111] transaction the triggers events defined in Section 2:3.111.4.1.1.3 Basic Folder Subscription option Trigger Events and to comunicate the stream of events to the Resource Notification Broker as defined in Section 2:3.111.4.1.2.3 Subscription with Basic Folder Subscription option Bundle
DSUBm Resource Notification Publisher Actor implementing DocumentReference Subscription for Full Events option | The DSUBm Resource Notification Publisher Actor CapabilityStatement requirements expresses the requirements that SHALL be provided when implementing DocumentReference Subscription for Full Events option. Using FHIR R4 SHALL support both json and xml encoding SHOULD use a security framework. Recommend ATNA, encouraged IHE-IUA or SMART-app-launch SHALL support the ITI-111 transaction for the basic trigger events SHALL be able to support in the Resource Publish [ITI-111] transaction the triggers events defined in Section 2:3.111.4.1.1.2 DocumentReference Subscription for Full Events option Trigger Events and to comunicate the stream of events to the Resource Notification Broker as defined in Section 2:3.111.4.1.2.2 DocumentReference Subscription for Full Events option Bundle
DSUBm Resource Notification Publisher Actor implementing DocumentReference Subscription for Minimal Update Option | The DSUBm Resource Notification Publisher Actor CapabilityStatement requirements expresses the requirements that SHALL be provided when implementing DocumentReference Subscription for Minimal Update Option. Using FHIR R4 SHALL support both json and xml encoding SHOULD use a security framework. Recommend ATNA, encouraged IHE-IUA or SMART-app-launch SHALL support the ITI-111 transaction for the basic trigger events SHALL be able to support in the Resource Publish [ITI-111] transaction the triggers events defined in Section 2:3.111.4.1.1.1 DocumentReference Subscription for Minimal Update option Trigger Events and to comunicate the stream of events to the Resource Notification Broker as defined in Section 2:3.111.4.1.2.1 DocumentReference Subscription for Minimal Update option Bundle
DSUBm Resource Notification Publisher Actor implementing Folder Subscription for Full Events option | The DSUBm Resource Notification Publisher Actor CapabilityStatement requirements expresses the requirements that SHALL be provided when implementing Folder Subscription for Full Events option. Using FHIR R4 SHALL support both json and xml encoding SHOULD use a security framework. Recommend ATNA, encouraged IHE-IUA or SMART-app-launch SHALL support the ITI-111 transaction for the basic trigger events SHALL be able to support in the Resource Publish [ITI-111] transaction the triggers events defined in Section 2:3.111.4.1.1.6 Folder Subscription for Full Events option Trigger Events and to comunicate the stream of events to the Resource Notification Broker as defined in Section 2:3.111.4.1.2.6 Folder Subscription for Full Events option Bundle
DSUBm Resource Notification Publisher Actor implementing Folder Subscription for Minimal Update option | The DSUBm Resource Notification Publisher Actor CapabilityStatement requirements expresses the requirements that SHALL be provided when implementing Folder Subscription for Minimal Update option. Using FHIR R4 SHALL support both json and xml encoding SHOULD use a security framework. Recommend ATNA, encouraged IHE-IUA or SMART-app-launch SHALL support the ITI-111 transaction for the basic trigger events SHALL be able to support in the Resource Publish [ITI-111] transaction the triggers events defined in Section 2:3.111.4.1.1.4 Folder Subscription for Minimal Update option Trigger Events and to comunicate the stream of events to the Resource Notification Broker as defined in Section 2:3.111.4.1.2.4 Folder Subscription for Minimal Update option Bundle
DSUBm Resource Notification Publisher Actor implementing Folder Subscription for Update option | The DSUBm Resource Notification Publisher Actor CapabilityStatement requirements expresses the requirements that SHALL be provided when implementing Folder Subscription for Update option. Using FHIR R4 SHALL support both json and xml encoding SHOULD use a security framework. Recommend ATNA, encouraged IHE-IUA or SMART-app-launch SHALL support the ITI-111 transaction for the basic trigger events SHALL be able to support in the Resource Publish [ITI-111] transaction the triggers events defined in Section 2:3.111.4.1.1.5 Folder Subscription for Update option Trigger Events and to comunicate the stream of events to the Resource Notification Broker as defined in Section 2:3.111.4.1.2.5 Folder Subscription for Update option Bundle
DSUBm Resource Notification Recipient Actor | The DSUBm Resource Notification Recipient Actor CapabilityStatement requirements expresses the requirements that SHALL be provided. Using FHIR R4 SHALL support both json and xml encoding SHOULD use a security framework. Recommend ATNA, encouraged IHE-IUA or SMART-app-launch SHALL support the ITI-112 transaction
DSUBm Resource Notification Subscriber Actor | The DSUBm Resource Notification Subscriber Actor CapabilityStatement requirements expresses the requirements that SHALL be provided. Using FHIR R4 SHALL support both json and xml encoding SHOULD use a security framework. Recommend ATNA, encouraged IHE-IUA or SMART-app-launch SHALL support the ITI-110 transaction and support the basic type of Subscription and related SubscriptionTopic SHOULD implement the ITI-113 transaction; if implemented: Search Parameters that SHOULD be supported _id status url filter-criteria topic SHOULD support the DSUBm $status operation SHOULD support the DSUBm $events operation SHOULD implement the ITI-114 transaction; if implemented: Search Parameters that SHALL be supported code Search Parameters that SHOULD be supported _id resource derived-or-self status url
DSUBm Resource Notification Subscriber Actor DocumentReference Subscription for Minimal Update Option | The DSUBm Resource Notification Subscriber Actor CapabilityStatement requirements expresses the requirements that SHALL be provided when implementing DocumentReference Subscription for Minimal Update Option. Using FHIR R4 SHALL support both json and xml encoding SHOULD use a security framework. Recommend ATNA, encouraged IHE-IUA or SMART-app-launch SHALL support the ITI-110 transaction and support the basic type of Subscription and related SubscriptionTopic SHALL be able to support the Subscription defined in Section 2:3.110.4.1.2.1.1 Subscription with DocumentReference Subscription for Minimal Update option, and the related SubscriptionTopic SHOULD implement the ITI-113 transaction; if implemented: Search Parameters that SHOULD be supported _id status url filter-criteria topic SHOULD support the DSUBm $status operation SHOULD support the DSUBm $events operation SHOULD implement the ITI-114 transaction; if implemented: Search Parameters that SHALL be supported code Search Parameters that SHOULD be supported _id resource derived-or-self status url
DSUBm Resource Notification Subscriber Actor implementing Basic Folder Subscription option | The DSUBm Resource Notification Subscriber Actor CapabilityStatement requirements expresses the requirements that SHALL be provided when implementing Basic Folder Subscription option. Using FHIR R4 SHALL support both json and xml encoding SHOULD use a security framework. Recommend ATNA, encouraged IHE-IUA or SMART-app-launch SHALL support the ITI-110 transaction and support the basic type of Subscription and related SubscriptionTopic SHALL be able to support the Subscription defined in Section 2:3.110.4.1.2.1.3 Subscription with Basic Folder Subscription option, and the related SubscriptionTopic SHOULD implement the ITI-113 transaction; if implemented: Search Parameters that SHOULD be supported _id status url filter-criteria topic SHOULD support the DSUBm $status operation SHOULD support the DSUBm $events operation SHOULD implement the ITI-114 transaction; if implemented: Search Parameters that SHALL be supported code Search Parameters that SHOULD be supported _id resource derived-or-self status url
DSUBm Resource Notification Subscriber Actor implementing DocumentReference Subscription for Full Events option | The DSUBm Resource Notification Subscriber Actor CapabilityStatement requirements expresses the requirements that SHALL be provided when implementing DocumentReference Subscription for Full Events option. Using FHIR R4 SHALL support both json and xml encoding SHOULD use a security framework. Recommend ATNA, encouraged IHE-IUA or SMART-app-launch SHALL support the ITI-110 transaction and support the basic type of Subscription and related SubscriptionTopic SHALL be able to support the Subscription defined in Section 2:3.110.4.1.2.1.2 Subscription with DocumentReference Subscription for Full Events option, and the related SubscriptionTopic SHOULD implement the ITI-113 transaction; if implemented: Search Parameters that SHOULD be supported _id status url filter-criteria topic SHOULD support the DSUBm $status operation SHOULD support the DSUBm $events operation SHOULD implement the ITI-114 transaction; if implemented: Search Parameters that SHALL be supported code Search Parameters that SHOULD be supported _id resource derived-or-self status url
DSUBm Resource Notification Subscriber Actor implementing DocumentReference Subscription for Update Option | The DSUBm Resource Notification Subscriber Actor CapabilityStatement requirements expresses the requirements that SHALL be provided when implementing DocumentReference Subscription for Update Option. Using FHIR R4 SHALL support both json and xml encoding SHOULD use a security framework. Recommend ATNA, encouraged IHE-IUA or SMART-app-launch SHALL support the ITI-110 transaction and support the basic type of Subscription and related SubscriptionTopic SHALL be able to support the Subscription defined in Section 2:3.110.4.1.2.1.5 Subscription with Folder Subscription for Update option, and the related SubscriptionTopic SHOULD implement the ITI-113 transaction; if implemented: Search Parameters that SHOULD be supported _id status url filter-criteria topic SHOULD support the DSUBm $status operation SHOULD support the DSUBm $events operation SHOULD implement the ITI-114 transaction; if implemented: Search Parameters that SHALL be supported code Search Parameters that SHOULD be supported _id resource derived-or-self status url
DSUBm Resource Notification Subscriber Actor implementing Folder Subscription for Full Events option | The DSUBm Resource Notification Subscriber Actor CapabilityStatement requirements expresses the requirements that SHALL be provided when implementing Folder Subscription for Full Events option. Using FHIR R4 SHALL support both json and xml encoding SHOULD use a security framework. Recommend ATNA, encouraged IHE-IUA or SMART-app-launch SHALL support the ITI-110 transaction and support the basic type of Subscription and related SubscriptionTopic SHALL be able to support the Subscription defined in Section 2:3.110.4.1.2.1.6 Subscription with Folder Subscription for Full Events option, and the related SubscriptionTopic SHOULD implement the ITI-113 transaction; if implemented: Search Parameters that SHOULD be supported _id status url filter-criteria topic SHOULD support the DSUBm $status operation SHOULD support the DSUBm $events operation SHOULD implement the ITI-114 transaction; if implemented: Search Parameters that SHALL be supported code Search Parameters that SHOULD be supported _id resource derived-or-self status url
DSUBm Resource Notification Subscriber Actor implementing Folder Subscription for Minimal Update option | The DSUBm Resource Notification Subscriber Actor CapabilityStatement requirements expresses the requirements that SHALL be provided when implementing Folder Subscription for Minimal Update option. Using FHIR R4 SHALL support both json and xml encoding SHOULD use a security framework. Recommend ATNA, encouraged IHE-IUA or SMART-app-launch SHALL support the ITI-110 transaction and support the basic type of Subscription and related SubscriptionTopic SHALL be able to support the Subscription defined in Section 2:3.110.4.1.2.1.4 Subscription with Folder Subscription for Minimal Update option, and the related SubscriptionTopic SHOULD implement the ITI-113 transaction; if implemented: Search Parameters that SHOULD be supported _id status url filter-criteria topic SHOULD support the DSUBm $status operation SHOULD support the DSUBm $events operation SHOULD implement the ITI-114 transaction; if implemented: Search Parameters that SHALL be supported code Search Parameters that SHOULD be supported _id resource derived-or-self status url

### Behavior: Search Parameters

These define the properties by which a RESTful server can be searched. They can also be used for sorting and including related resources.

SubscriptionTopic-derived-or-self | A server defined search that matches the url or derivedFrom url
SubscriptionTopic-resource | Allowed resource for this definition
SubscriptionTopic-status | A server defined search that matches the url
SubscriptionTopic-url | A server defined search that matches the url

### Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

Audit Event for Resource Publish Transaction at Broker | Defines constraints on the AuditEvent Resource to record when a Resource Publish Transaction happens at the Broker. Import event SHALL have source of itself SHALL have a publisher agent SHALL have a broker agent MAY have user, app, organization agent(s) SHALL have a patient entity
Audit Event for Resource Publish Transaction at Publisher | Defines constraints on the AuditEvent Resource to record when a Resource Publish Transaction happens at the Publisher. Export event SHALL have source of itself SHALL have a publisher agent SHALL have a broker agent MAY have user, app, organization agent(s) SHALL have a patient entity
Audit Event for Resource SubscriptionTopic Search Transaction by the Resource Notification Broker | Defines constraints on the AuditEvent Resource to record when a Resource SubscriptionTopic Read Transaction happens, as recorded by the Resource Notification Broker. Build off of the IHE BasicAudit Read event add the ITI-114 as a subtype client is Resource Notification Subscriber server is Resource Notification Broker entity slices for query is REQUIRED entity slice for transaction is available source is the server
Audit Event for Resource SubscriptionTopic Search Transaction by the Resource Notification Broker | Defines constraints on the AuditEvent Resource to record when a Resource SubscriptionTopic Search Transaction happens, as recorded by the Resource Notification Broker. Build off of the IHE BasicAudit Query event add the ITI-114 as a subtype client is Resource Notification Subscriber server is Resource Notification Broker entity slices for query is REQUIRED entity slice for transaction is available source is the server
Audit Event for Resource SubscriptionTopic Search Transaction by the Resource Notification Subscriber | Defines constraints on the AuditEvent Resource to record when a Resource SubscriptionTopic Read Transaction happens, as recorded by the Resource Notification Subscriber. Build off of the IHE BasicAudit Read event add the ITI-114 as a subtype client is Resource Notification Subscriber server is Resource Notification Broker entity slices for query is REQUIRED entity slice for transaction is available source is the client
Audit Event for Resource SubscriptionTopic Search Transaction by the Resource Notification Subscriber | Defines constraints on the AuditEvent Resource to record when a Resource SubscriptionTopic Search Transaction happens, as recorded by the Resource Notification Subscriber. Build off of the IHE BasicAudit Query event add the ITI-114 as a subtype client is Resource Notification Subscriber server is Resource Notification Broker entity slices for query is REQUIRED entity slice for transaction is available source is the client
Audit Event for Subscription Search message in a Subscription Search transaction made by the Resource Notification Subscriber | Defines constraints on the AuditEvent Resource to record when a Resource Notification Subscriber in a Subscription Search transaction happens, as recorded by the Subscriber. Build off of the IHE BasicAudit Read event add the ITI-113 as a subtype SHALL have a Resource Notification Subscriber agent SHALL have a Resource Notification Broker agent entity slices for the Subscription reference entity slices for query is REQUIRED entity slice for transaction is available source is the client
Audit Event for Subscription Search message in a Subscription Search transaction made by the Resource Notification Subscriber | Defines constraints on the AuditEvent Resource to record when a Resource Notification Subscriber in a Subscription Search transaction happens, as recorded by the Subscriber. Build off of the IHE BasicAudit Query event add the ITI-113 as a subtype SHALL have a Resource Notification Subscriber agent SHALL have a Resource Notification Broker agent entity slices for the Subscription reference entity slices for query is REQUIRED entity slice for transaction is available source is the client
Audit Event for Subscription Search message in a Subscription Search transaction received by the Resource Notification Broker | Defines constraints on the AuditEvent Resource to record when a Resource Notification Subscriber in a Subscription Search transaction happens, as recorded by the Broker. Build off of the IHE BasicAudit Read event add the ITI-113 as a subtype SHALL have a Resource Notification Subscriber agent SHALL have a Resource Notification Broker agent entity slices for query is REQUIRED entity slice for transaction is available source is the server
Audit Event for Subscription Search message in a Subscription Search transaction received by the Resource Notification Broker | Defines constraints on the AuditEvent Resource to record when a Resource Notification Subscriber in a Subscription Search transaction happens, as recorded by the Broker. Build off of the IHE BasicAudit Query event add the ITI-110 as a subtype SHALL have a Resource Notification Subscriber agent SHALL have a Resource Notification Broker agent entity slices for query is REQUIRED entity slice for transaction is available source is the server
Audit Event for a Resource Notify transaction generated by the Resource Notification Recipient | Defines constraints on the AuditEvent Resource to record when a Resource Subscription transaction happens. Build off of the IHE BasicAudit Create event add the ITI-112 as a subtype SHALL have a Resource Notification Recipient agent SHALL have a Resource Notification Broker agent entity slices for the Bundle reference entity slice for transaction is available source is the server
Audit Event for a Resource Notify transaction., generated by the Resource Notification Broker | Defines constraints on the AuditEvent Resource to record when a Resource Notify transaction happens. Build off of the IHE BasicAudit Create event add the ITI-112 as a subtype SHALL have a Resource Notification Recipient agent SHALL have a Resource Notification Broker agent entity slices for the Bundle reference entity slice for transaction is available source is the server
Audit Event for a Subscribe message in a Resource Subscription transaction with a multi-patient Subscription made by the Broker | Defines constraints on the AuditEvent Resource to record when a Subscribe in a Resource Subscription transaction happens, as recorded by the Broker. Build off of the IHE BasicAudit Create event add the ITI-110 as a subtype SHALL have a Resource Notification Subscriber agent SHALL have a Resource Notification Broker agent entity slices for the Subscription reference entity slice for transaction is available source is the server
Audit Event for a Subscribe message in a Resource Subscription transaction with a multi-patient Subscription made by the Subscriber | Defines constraints on the AuditEvent Resource to record when a Subscribe in a Resource Subscription transaction happens, as recorded by the Subscriber. Build off of the IHE BasicAudit Create event add the ITI-110 as a subtype SHALL have a Resource Notification Subscriber agent SHALL have a Resource Notification Broker agent entity slices for the Subscription reference entity slice for transaction is available source is the client
Audit Event for a Subscribe message in a Resource Subscription transaction with a patient-dependent Subscription made by the Broker | Defines constraints on the AuditEvent Resource to record when a Subscribe in a Resource Subscription transaction happens, as recorded by the Broker. Build off of the IHE BasicAudit Create event add the ITI-110 as a subtype SHALL have a Resource Notification Subscriber agent SHALL have a Resource Notification Broker agent entity slices for the Subscription reference entity slice for transaction is available source is the server
Audit Event for a Subscribe message in a Resource Subscription transaction with a patient-dependent Subscription made by the Subscriber | Defines constraints on the AuditEvent Resource to record when a Subscribe in a Resource Subscription transaction happens, as recorded by the Subscriber. Build off of the IHE BasicAudit Create event add the ITI-110 as a subtype SHALL have a Resource Notification Subscriber agent SHALL have a Resource Notification Broker agent entity slices for the Subscription reference entity slice for transaction is available source is the client
Audit Event for a Unsubscribe message in a Resource Subscription transaction with a multi-patient Subscription made by the Broker | Defines constraints on the AuditEvent Resource to record when a Subscribe in a Resource Subscription transaction happens, as recorded by the Broker. Build off of the IHE BasicAudit Update event add the ITI-110 as a subtype SHALL have a Resource Notification Subscriber agent SHALL have a Resource Notification Broker agent entity slices for the Subscription reference entity slice for transaction is available source is the server
Audit Event for a Unsubscribe message in a Resource Subscription transaction with a multi-patient Subscription made by the Subscriber | Defines constraints on the AuditEvent Resource to record when a Unsubscribe in a Resource Subscription transaction happens, as recorded by the Subscriber. Build off of the IHE BasicAudit Update event add the ITI-110 as a subtype SHALL have a Resource Notification Subscriber agent SHALL have a Resource Notification Broker agent entity slices for the Subscription reference entity slice for transaction is available source is the client
Audit Event for a Unsubscribe message in a Resource Subscription transaction with a patient-dependent Subscription made by the Broker | Defines constraints on the AuditEvent Resource to record when a Subscribe in a Resource Subscription transaction happens, as recorded by the Broker. Build off of the IHE BasicAudit Update event add the ITI-110 as a subtype SHALL have a Resource Notification Subscriber agent SHALL have a Resource Notification Broker agent entity slices for the Subscription reference entity slice for transaction is available source is the server
Audit Event for a Unsubscribe message in a Resource Subscription transaction with a patient-dependent Subscription made by the Subscriber | Defines constraints on the AuditEvent Resource to record when a Unsubscribe in a Resource Subscription transaction happens, as recorded by the Subscriber. Build off of the IHE BasicAudit Update event add the ITI-110 as a subtype SHALL have a Resource Notification Subscriber agent SHALL have a Resource Notification Broker agent entity slices for the Subscription reference entity slice for transaction is available source is the client
Bundle response for $events | Profile on the Bundle resource for the response of $events operation.
Bundle response for $status | Profile on the Bundle resource for the response of $status operation.
Event Notification Bundle | Profile on the Bundle resource for transaction ITI-112 Resource Notify for Event Notification.
Handshake Notification Bundle | Profile on the Bundle resource to enable R5-style topic-based subscription Handshake Notification.
Heartbeat Notification Bundle | Profile on the Bundle resource to enable R5-style topic-based subscription Heartbeat Notification.
Resource Publish Bundle | A profile for the Bundle used in the ITI-111 Resource Publish transaction. This profile extends the MHD Minimal.ProvideBundle profile. The DSUBm Actors SHOULD consider the following entry in the Bundle: SubmissionSet DocumentRefs Folders Patient (if present) and the update or delete of DocumentReference and/or Folders
Subscription Deactivation Notification Bundle | Profile on the Bundle resource for Subscription Deactivation Notification.
Subscription for DocumentReference Multi-Patient | Resource Subscription for DSUBm profile for DocumentReference without the indication of the patient the criteria element SHALL contain the URL of an instance of SubscriptionTopic for the creation of DocumentReference Resources
Subscription for DocumentReference Multi-Patient with DocumentReference Subscription for Full Events Option | 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
Subscription for DocumentReference Multi-Patient with DocumentReference Subscription for Minimal Update Option | 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 creation, deletion and update only in the “status” of a DocumentReference
Subscription for DocumentReference Patient-Dependent | Resource Subscription for DSUBm profile for DocumentReference with the indication of the patient the criteria element SHALL contain the URL of a canonical instance of SubscriptionTopic for the creation of DocumentReference Resources
Subscription for DocumentReference Patient-Dependent with DocumentReference Subscription for Full Events Option | Resource Subscription for DSUBm profile for DocumentReference with 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
Subscription for DocumentReference Patient-Dependent with DocumentReference Subscription for Minimal Update Option | Resource Subscription for DSUBm profile for DocumentReference with the indication of the patient the criteria element SHALL contain the URL of a canonical instance of SubscriptionTopic for creation, deletion and update only in the “status” of a DocumentReference
Subscription for Folder Patient-Dependent with Basic Folder Subscription Option | Resource Subscription for DSUBm profile for Folder with the indication of the patient the criteria element SHALL contain the URL of a canonical instance of SubscriptionTopic for creation of a Folder type List Resource and the update to insert new documents in the Folder
Subscription for Folder Patient-Dependent with Folder Subscription for Full Events Option | Resource Subscription for DSUBm profile for Folder with the indication of the patient the criteria element SHALL contain the URL of a canonical instance of SubscriptionTopic for creation, update or deletion of a Folder type List Resource
Subscription for Folder Patient-Dependent with Folder Subscription for Minimal Update Option | Resource Subscription for DSUBm profile for Folder with the indication of the patient the criteria element SHALL contain the URL of a canonical instance of SubscriptionTopic for creation of a Folder type List Resource, the update to insert or remove documents in the Folder and the update of the status
Subscription for Folder Patient-Dependent with Folder Subscription for Update Option | Resource Subscription for DSUBm profile for Folder with the indication of the patient the criteria element SHALL contain the URL of a canonical instance of SubscriptionTopic for creation or update of a Folder type List Resource
Subscription for SubmissionSet Multi-Patient | Resource Subscription for DSUBm profile for SubmissionSet without the indication of the patient the criteria element SHALL contain the URL of an instance of SubscriptionTopic for the creation of SubmissionSet type List Resources
Subscription for SubmissionSet Patient-Dependent | 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
SubscriptionStatus for the $events operation | Profile on the SubscriptionStatus resource for the $events operation
SubscriptionStatus for the Subscription Deactivation Notification event | Profile on the SubscriptionStatus resource the Subscription Deactivation Notification
SubscriptionStatus for the handshake event | Profile on the SubscriptionStatus resource to be used in the handshake notification
SubscriptionStatus for the heartbeat event | Profile on the SubscriptionStatus resource for the heartbeat notification
SubscriptionStatus for the notification event | Profile on the SubscriptionStatus resource for the event notification
SubscriptionStatus for the status operation | Profile on the SubscriptionStatus resource for the $status operation

### Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

DSUBm Update to document sharing resources actions ValueSet | A ValueSet of the allowed actions in a ITI-111 Resource Publish for the Folder List type and the DocumentReference resources.
DSUBm payload admitted Value Set | Codes to represent the admitted payload MIME type chosen when creating subscription

### Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

Audit Example of ITI-110 at Subscriber for Create Interaction when multi-patient | Audit Example for a Resource Subscription Transaction for Create Interaction from Subscriber perspective when multi-patient
Audit Example of ITI-110 at Subscriber for Create Interaction when patient-dependent | Audit Example for a Resource Subscription Transaction for Create Interaction from Subscriber perspective when patient-dependent
Audit Example of ITI-110 at Subscriber for update Interaction when multi-patient | Audit Example for a Resource Subscription Transaction for update Interaction from Subscriber perspective when multi-patient
Audit Example of ITI-110 at Subscriber for update Interaction when patient-dependent | Audit Example for a Resource Subscription Transaction for update Interaction from Subscriber perspective when patient-dependent
Audit Example of ITI-110 for Create Interaction at Broker when multi patient | Audit Example for a Resource Subscription Transaction for Create Interaction from Broker perspective when multi patient
Audit Example of ITI-110 for Create Interaction at Broker when patient-dependent | Audit Example for a Resource Subscription Transaction for Create Interaction from Broker perspective when patient-dependent
Audit Example of ITI-110 for update Interaction at Broker when multi patient | Audit Example for a Resource Subscription Transaction for update Interaction from Broker perspective when multi patient
Audit Example of ITI-110 for update Interaction at Broker when patient-dependent | Audit Example for a Resource Subscription Transaction for update Interaction from Broker perspective when patient-dependent
Audit Example of ITI-111 at Broker | Audit Example for a Resource Publish Transaction from Broker perspective
Audit Example of ITI-111 at Publisher | Audit Example for a Resource Publish Transaction from Publisher perspective
Audit Example of ITI-112 at Broker | Audit Example for a Resource Publish Notify from Broker perspective
Audit Example of ITI-112 at Recipient | Audit Example for a Resource Publish Notify from Recipient perspective
Audit Example of ITI-113 at Broker for Read interaction | Audit Example for a Resource Subscription Search Transaction from Broker perspective for Read interaction
Audit Example of ITI-113 at Broker for Search interaction | Audit Example for a Resource Subscription Search Transaction from Broker perspective for Search interaction
Audit Example of ITI-113 at Subscriber for Read interaction | Audit Example for a Resource Subscription Search Transaction from Subscriber perspective for Read interaction
Audit Example of ITI-113 at Subscriber for Search interaction | Audit Example for a Resource Resource Subscription Search from Subscriber perspective for Search interaction
Audit Example of ITI-114 at Broker for Read interaction | Audit Example for a Resource SubscriptionTopic Search Transaction from Broker perspective for Read interaction
Audit Example of ITI-114 at Broker for Search interaction | Audit Example for a Resource SubscriptionTopic Search Transaction from Broker perspective for Search interaction
Audit Example of ITI-114 at Subscriber for Read interaction | Audit Example for a Resource SubscriptionTopic Search Transaction from Subscriber perspective for Read interaction
Audit Example of ITI-114 at Subscriber for Search interaction | Audit Example for a Resource SubscriptionTopic Search from Subscriber perspective for Search interaction
Deactivation Event Bundle | Example of a Bundle used to perform the Subscription Deactivation Notification
DocumentReference MultiPatient Subscription | Example of a Subscription for Multi-Patient ‘DocumentReference’ resource in active status
DocumentReference MultiPatient Subscription for All Events Opt | Example of a Subscription for Multi-Patient ‘DocumentReference’ resource in active status for All Events Opt
DocumentReference MultiPatient Subscription for Minimal Update Opt | Example of a Subscription for Multi-Patient ‘DocumentReference’ resource in active status for Minimal Update Opt
DocumentReference PatientDependent Subscription | Example of a requested Subscription for PatientDependent ‘DocumentReference’ resource
DocumentReference PatientDependent Subscription for All Events Opt | Example of a requested Subscription for PatientDependent ‘DocumentReference’ resource for All Events Opt
DocumentReference PatientDependent Subscription for Minimal Update Opt | R4 Example of a requested Subscription for PatientDependent ‘DocumentReference’ resource for Minimal Update Opt in status error after connection issue
DocumentReference for Minimal metadata | Example of a minimal DocumentReference resource. This is very unlikely to be acceptable anywhere, but it is the minimum required.
Dummy Device example | Dummy Device example for completeness sake. No actual use of this resource other than an example target
Dummy DocumentReference example | Dummy DocumentReference example for completeness sake. No actual use of this resource other than an example target
Dummy Patient example | Dummy patient example for completeness sake. No actual use of this resource other than an example target
Event HandshakeNotification Bundle | Example of a Bundle used to perform the handshake verification
Event HeartbeatNotification Bundle | Example of a Bundle used to perform the HeartbeatNotification
Event Notification Bundle | Example of a Bundle used to notify a notification event genreated from the creation of a DocumenReference
Events Bundle | Example of a Bundle used as response of a $events operation
Example Minimal Folder | Folder in List resource conforming only to Minimal metadata
Example of SubscriptionStatus to be used in a $events response | Example of a Parameter resource representing a Subscription returned with a events operation. The Subscription has produced 3 events before going in error.
Example of SubscriptionStatus to be used in a $status response | Example of a Parameter resource representing a Subscription returned with a status operation. The Subscription is in error.
Example of SubscriptionStatus to be used in a Deactivation Event | Example of a Parameter resource representing the status of a deactivated Subscription.
Example of SubscriptionStatus to be used in a Handshake Event | Example of a Parameter resource representing the status of a Subscription that has been requested.
Example of SubscriptionStatus to be used in a Heartbeat Event | Example of a Parameter resource representing the status of an active Subscription that using the heartbeat to check the endpoint
Example of SubscriptionStatus to be used in a NotificationEvent | Example of a Parameter resource representing the status of an active Subscription that has produced 1 event.
Folder Subscription for Full Update Option | Example of a Subscription ‘Foder’ resource for Full Update Opt in status error after connection problem
Folder Subscription for Minimal Update Option | Example of a Subscription ‘Foder’ resource for Minimal Update Opt
Folder Subscription for Update Option | Example of a Subscription ‘Foder’ resource for Update Opt in status off after deactivation
Folder Subscription for basic events | Example of a Subscription ‘Foder’ resource for basic events
Resource Publish Bundle | Example of an Bundle used for a publish event genreated from the update of a DocumenReference
Status Event Bundle | Example of a Bundle used as response of a $status operation
SubmissionSet MultiPatient Subscription | Example of a Subscription for MultiPatient ‘SubmissionSet’ resource in active status
SubmissionSet PatientDependent Subscription | Example of a Subscription for PatientDependent ‘SubmissionSet’ resource in active status
SubmissionSet for Minimal metadata | Example of a minimal submissionSet in List resource.