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

## CapabilityStatement: DSUBm Resource Notification Subscriber Actor DocumentReference Subscription for Minimal Update Option

Official URL: https://profiles.ihe.net/ITI/DSUBm/CapabilityStatement/IHE.DSUBm.ResourceNotificationSubscriber.DocRef.MinUpd | Version: 1.0.1-current
Active as of 2023-10-27 | Computable Name: IHE_DSUBm_ResourceNotificationSubscriber_DocRef_MinUpd

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

Raw OpenAPI-Swagger Definition file | Download

Generated Narrative: CapabilityStatement IHE.DSUBm.ResourceNotificationSubscriber.DocRef.MinUpd

## IHE DSUBm ResourceNotificationSubscriber DocRef MinUpd

- Implementation Guide Version: 1.0.1-current
- FHIR Version: 4.0.1
- Supported Formats: `application/fhir+xml`, `application/fhir+json`
- Supported Patch Formats:
- Published on: 2023-10-27
- Published by: IHE IT Infrastructure Technical Committee

> Note to Implementers: FHIR Capabilities

> Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

## FHIR RESTful Capabilities

### Mode: `client`

DSUBm Resource Notification subscriber provides capability to create/deactivate subscription and optionally to search for Subscription and SubscritptionTopic resources

Security

> Recommend ATNA, encouraged IHE-IUA or SMART-app-launch

Summary of System-wide Interactions

### Capabilities by Resource/Profile

#### Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

- The relevant profiles (if any)
- The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
- The required, recommended, and some optional search parameters (if any).
- The linked resources enabled for `_include`
- The other resources enabled for `_revinclude`
- The operations on the resource (if any)

Resource Type | Profile | R | S | U | C | Searches | `_include` | `_revinclude` | Operations
--- | --- | --- | --- | --- | --- | --- | --- | --- | ---
Subscription | Supported Profiles Subscription for DocumentReference Patient-Dependent Subscription for DocumentReference Multi-Patient Subscription for SubmissionSet Patient-Dependent Subscription for SubmissionSet Multi-Patient Subscription for DocumentReference Patient-Dependent with DocumentReference Subscription for Minimal Update Option Subscription for DocumentReference Multi-Patient with DocumentReference Subscription for Minimal Update Option | y | y | y | y | _id, status, url, filter-criteria, topic |  |  | `$$events`, `$$status`
Basic |  | y | y |  |  | code, _id, resource, derived-or-self, status, url |  |  |

#### Resource Conformance: supported Subscription

Core FHIR Resource
Subscription
Reference Policy
Interaction summary

- Supports `read`, `create`, `update`, `search-type`.

Supported Profiles

Subscription for DocumentReference Patient-Dependent
Subscription for DocumentReference Multi-Patient
Subscription for SubmissionSet Patient-Dependent
Subscription for SubmissionSet Multi-Patient
Subscription for DocumentReference Patient-Dependent with DocumentReference Subscription for Minimal Update Option
Subscription for DocumentReference Multi-Patient with DocumentReference Subscription for Minimal Update Option

Documentation

> Resource Subscription [ITI-110] and Resource Subscription Search [ITI-113]

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `string` | The id of the Subscription
SHALL | status | `token` | The current state of the subscription
SHALL | url | `uri` | The URI that will receive the notifications
SHALL | filter-criteria | `string` | This SearchParameter enables query of subscriptions by filter criteria
SHALL | topic | `uri` | This SearchParameter enables query of subscriptions by canonical topic-url

Extended Operations

Conformance | Operation | Documentation
--- | --- | ---
SHALL | $$events | This operation is OPTIONAL for the RESOURCE NOTIFICATION SUBSCRIBER; if supported, the Resource Notification Subscriber SHALL support in response a Bundle that is conformed with https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/DSUBm-EventsOperation-Bundle
SHALL | $$status | This operation is OPTIONAL for the RESOURCE NOTIFICATION SUBSCRIBER; if supported, the Resource Notification Subscriber SHALL support in response a Bundle that is conformed with https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/DSUBm-StatusOperation-Bundle

#### Resource Conformance: SHALL Basic

Core FHIR Resource
Basic
Reference Policy
Interaction summary

- Supports `read`, `search-type`.

Documentation

> Resource SubscriptionTopic Search [ITI-114]

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | code | `token` | Kind of Resource
SHOULD | _id | `string` | The id of the SubscriptionTopic
SHOULD | resource | `uri` | Allowed Data type or Resource (reference to definition) for this definition, searches resourceTrigger, eventTrigger, and notificationShape for matches.
SHOULD | derived-or-self | `uri` | A server defined search that matches either the url or derivedFrom
SHOULD | status | `token` | SHOULD be valued with `active`
SHOULD | url | `uri` | Logical canonical URL to reference this SubscriptionTopic (globally unique)