Document Subscription for Mobile (DSUBm)
1.0.1-current - ci-build International flag

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 Broker Actor implementing DocumentReference Subscription for Minimal Update Option

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

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

Raw OpenAPI-Swagger Definition file | Download

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

IHE DSUBm ResourceNotificationBroker 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

REST Configuration: 1

Mode: server

DSUBm Resource Notification Broker provides capability to receive subscription, receive the stream of events, receive Subscription and SubscriptionTopic Resource search

Security

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

Summary of System-wide Interactions
  • Supports the transactioninteraction described as follows:

    https://profiles.ihe.net/ITI/DSUBm/StructureDefinition-IHE.DSUBm.ResourceBundle.html

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 TypeProfileRSUCSearches_include_revincludeOperations
SubscriptionSupported 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		yyyycode, _id, status, url, filter-criteria, topic$events, $status
Basic yy_id, resource, derived-or-self, status, url
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
ConformanceParameterTypeDocumentation
SHALLcodetoken

Kind of Resource

SHALL_idstring

The id of the Subscription

SHALLstatustoken

The current state of the subscription

SHALLurluri

The URI that will receive the notifications

SHALLfilter-criteriastring

This SearchParameter enables query of subscriptions by filter criteria

SHALLtopicuri

This SearchParameter enables query of subscriptions by canonical topic-url

 
Extended Operations
ConformanceOperationDocumentation
SHALL$status

The Response Bundle SHALL be conformed with https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/DSUBm-StatusOperation-Bundle

SHOULD$events

The Response Bundle SHALL be conformed with https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/DSUBm-EventsOperation-Bundle

Core FHIR Resource
Basic
Reference Policy
Interaction summary
  • Supports read, search-type.

Documentation

Resource SubscriptionTopic Search ITI-114: The Resource Notification Broker Actor SHALL support the canonical instances of SubscriptionTopic presented in the DSUBm profile. See here

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idstring

The id of the SubscriptionTopic

SHALLresourceuri

Allowed Data type or Resource (reference to definition) for this definition, searches resourceTrigger, eventTrigger, and notificationShape for matches.

SHALLderived-or-selfuri

A server defined search that matches either the url or derivedFrom

SHALLstatustoken

SHOULD be valued with active

SHALLurluri

Logical canonical URL to reference this SubscriptionTopic (globally unique)

 

REST Configuration: 2

Mode: client

DSUBm Resource Notification Broker provides capability to send notification

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 TypeProfileRSUCSearches_include_revincludeOperations
BundleSupported Profiles
  Event Notification Bundle
  Handshake Notification Bundle
  Heartbeat Notification Bundle
  Subscription Deactivation Notification Bundle
Core FHIR Resource
Bundle
Reference Policy
Interaction summary

    Supported Profiles

    Event Notification Bundle
    Handshake Notification Bundle
    Heartbeat Notification Bundle
    Subscription Deactivation Notification Bundle

    Documentation

    Resource Notify ITI-112