XIG: CapabilityStatement/IHE.DSUBm.ResourceNotificationBroker.DocRef.FullEvents

FHIR IG Statistics: CapabilityStatement/IHE.DSUBm.ResourceNotificationBroker.DocRef.FullEvents

Package	ihe.iti.dsubm
Type	CapabilityStatement
Id	IHE.DSUBm.ResourceNotificationBroker.DocRef.FullEvents
FHIR Version	R4
Source	https://profiles.ihe.net/ITI/DSUBm/https://build.fhir.org/ig/IHE/ITI.DSUBm/CapabilityStatement-IHE.DSUBm.ResourceNotificationBroker.DocRef.FullEvents.html
URL	https://profiles.ihe.net/ITI/DSUBm/CapabilityStatement/IHE.DSUBm.ResourceNotificationBroker.DocRef.FullEvents
Version	1.0.1-current
Status	active
Date	2023-10-27
Name	IHE_DSUBm_ResourceNotificationBroker_DocRef_FullEvents
Title	IHE DSUBm ResourceNotificationBroker DocRef FullEvents
Realm	uv
Authority	ihe
Description	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](https://profiles.ihe.net/ITI/TF/Volume1/ch-9.html), encouraged [IHE-IUA](https://profiles.ihe.net/ITI/IUA/index.html) or [SMART-app-launch](http://www.hl7.org/fhir/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](ITI-110.html#2311041212-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](ITI-113.html#23113412-message-semantics) - _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](ITI-114.html#23114412-message-semantics) - code - _id - resource - derived-or-self - status - url
Kind	requirements

Resources that use this resource

No resources found

Resources that this resource uses

OperationDefinition
backport-subscription-events	Subscription Events Operation
backport-subscription-status	Subscription Status Operation
backport-subscription-events	R5SubscriptionEvents
backport-subscription-status	R5SubscriptionStatus

SearchParameter
Subscription-filter-criteria	SubscriptionFilterCriteriaSearchParameter
Subscription-topic	SubscriptionTopicSearchParameter
Subscription-filter-criteria	SubscriptionFilterCriteriaSearchParameter
Subscription-topic	SubscriptionTopicSearchParameter

StructureDefinition
DSUBm-DocumentReference-MultiPatient-Subscription-AllEvents	Subscription for DocumentReference Multi-Patient with DocumentReference Subscription for Full Events Option
DSUBm-DocumentReference-MultiPatient-Subscription	Subscription for DocumentReference Multi-Patient
DSUBm-DocumentReference-PatientDependent-Subscription-AllEvents	Subscription for DocumentReference Patient-Dependent with DocumentReference Subscription for Full Events Option
DSUBm-DocumentReference-PatientDependent-Subscription	Subscription for DocumentReference Patient-Dependent
DSUBm-SubmissionSet-MultiPatient-Subscription	Subscription for SubmissionSet Multi-Patient
DSUBm-SubmissionSet-PatientDependent-Subscription	Subscription for SubmissionSet Patient-Dependent
IHE.DSUBm.EventNotification	Event Notification Bundle
IHE.DSUBm.HandshakeNotification	Handshake Notification Bundle
IHE.DSUBm.HeartbeatNotification	Heartbeat Notification Bundle
IHE.DSUBm.SubscriptionDeactivationNotification	Subscription Deactivation Notification Bundle

Narrative

Note: links and images are rebased to the (stated) source

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

IHE DSUBm ResourceNotificationBroker DocRef FullEvents

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 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 Full Events Option Subscription for DocumentReference Multi-Patient with DocumentReference Subscription for Full Events 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 Full Events Option
Subscription for DocumentReference Multi-Patient with DocumentReference Subscription for Full Events Option

Documentation

Resource Subscription ITI-110and 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	The Response Bundle SHALL be conformed with https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/DSUBm-EventsOperation-Bundle
SHALL	$status	The Response Bundle SHALL be 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: The Resource Notification Broker Actor SHALL support the canonical instances of SubscriptionTopic presented in the DSUBm profile. See here

Search Parameters

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

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 Type	Profile	R	S	U	C	Searches	`_include`	`_revinclude`	Operations
Bundle	Supported Profiles Event Notification Bundle Handshake Notification Bundle Heartbeat Notification Bundle Subscription Deactivation Notification Bundle

Resource Conformance: supported 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

Source

{
  "resourceType": "CapabilityStatement",
  "id": "IHE.DSUBm.ResourceNotificationBroker.DocRef.FullEvents",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "url": "https://profiles.ihe.net/ITI/DSUBm/CapabilityStatement/IHE.DSUBm.ResourceNotificationBroker.DocRef.FullEvents",
  "version": "1.0.1-current",
  "name": "IHE_DSUBm_ResourceNotificationBroker_DocRef_FullEvents",
  "title": "IHE DSUBm ResourceNotificationBroker DocRef FullEvents",
  "status": "active",
  "experimental": false,
  "date": "2023-10-27",
  "publisher": "IHE IT Infrastructure Technical Committee",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "https://www.ihe.net/ihe_domains/it_infrastructure/"
        }
      ]
    },
    {
      "telecom": [
        {
          "system": "email",
          "value": "iti@ihe.net"
        }
      ]
    },
    {
      "name": "IHE IT Infrastructure Technical Committee",
      "telecom": [
        {
          "system": "email",
          "value": "iti@ihe.net"
        }
      ]
    }
  ],
  "description": "The DSUBm Resource Notification Broker Actor CapabilityStatement requirements expresses the requirements that SHALL be provided when implementing DocumentReference Subscription for Full Events option.\n\n- Using FHIR R4\n- SHALL support both json and xml encoding\n- SHOULD use a security framework. Recommend [ATNA](https://profiles.ihe.net/ITI/TF/Volume1/ch-9.html), encouraged [IHE-IUA](https://profiles.ihe.net/ITI/IUA/index.html) or [SMART-app-launch](http://www.hl7.org/fhir/smart-app-launch/)\n- SHALL support the ITI-110 transaction and support the basic type of Subscription and related SubscriptionTopic\n- 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](ITI-110.html#2311041212-subscription-with-documentreference-subscription-for-full-events-option), and the related SubscriptionTopic\n- MAY support the ITI-111 transaction\n- SHALL support the ITI-112 transaction:\n  - SHALL support Handshake Notification\n  - SHOULD support Heartbeat Notification\n  - SHALL support Event Notification\n  - SHOULD support Subscription Deactivation Notification\n- SHALL support the ITI-113 transaction: \n    - SHALL support the following [Search Parameters](ITI-113.html#23113412-message-semantics)\n      - _id\n      - status\n      - url\n      - filter-criteria\n      - topic\n    - SHALL support the DSUBm $status operation  \n    - SHOULD support the DSUBm $events operation  \n- SHALL support the ITI-114 transaction:\n    - SHALL support the following [Search Parameters](ITI-114.html#23114412-message-semantics)\n      - code\n      - _id\n      - resource\n      - derived-or-self\n      - status\n      - url\n",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "001"
        }
      ]
    }
  ],
  "kind": "requirements",
  "fhirVersion": "4.0.1",
  "format": [
    "application/fhir+xml",
    "application/fhir+json"
  ],
  "rest": [
    {
      "mode": "server",
      "documentation": "DSUBm Resource Notification Broker provides capability to receive subscription, receive the stream of events, receive Subscription and SubscriptionTopic Resource search",
      "security": {
        "description": "Recommend [ATNA](https://profiles.ihe.net/ITI/TF/Volume1/ch-9.html), encouraged [IHE-IUA](https://profiles.ihe.net/ITI/IUA/index.html) or [SMART-app-launch](http://www.hl7.org/fhir/smart-app-launch/)"
      },
      "resource": [
        {
          "type": "Subscription",
          "supportedProfile": [
            "https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/DSUBm-DocumentReference-PatientDependent-Subscription",
            "https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/DSUBm-DocumentReference-MultiPatient-Subscription",
            "https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/DSUBm-SubmissionSet-PatientDependent-Subscription",
            "https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/DSUBm-SubmissionSet-MultiPatient-Subscription",
            "https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/DSUBm-DocumentReference-PatientDependent-Subscription-AllEvents",
            "https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/DSUBm-DocumentReference-MultiPatient-Subscription-AllEvents"
          ],
          "documentation": "Resource Subscription [ITI-110](ITI-110.html)and Resource Subscription Search [ITI-113](ITI-113.html)",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "create"
            },
            {
              "code": "update"
            },
            {
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "name": "_id",
              "type": "string",
              "documentation": "The id of the Subscription"
            },
            {
              "name": "status",
              "type": "token",
              "documentation": "The current state of the subscription"
            },
            {
              "name": "url",
              "type": "uri",
              "documentation": "The URI that will receive the notifications"
            },
            {
              "name": "filter-criteria",
              "definition": "http://hl7.org/fhir/uv/subscriptions-backport/SearchParameter/Subscription-filter-criteria",
              "type": "string",
              "documentation": "This SearchParameter enables query of subscriptions by filter criteria"
            },
            {
              "name": "topic",
              "definition": "http://hl7.org/fhir/uv/subscriptions-backport/SearchParameter/Subscription-topic",
              "type": "uri",
              "documentation": "This SearchParameter enables query of subscriptions by canonical topic-url"
            }
          ],
          "operation": [
            {
              "name": "events",
              "definition": "http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-events",
              "documentation": "The Response Bundle SHALL be conformed with https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/DSUBm-EventsOperation-Bundle "
            },
            {
              "name": "status",
              "definition": "http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-status",
              "documentation": "The Response Bundle SHALL be conformed with https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/DSUBm-StatusOperation-Bundle "
            }
          ]
        },
        {
          "type": "Basic",
          "documentation": "Resource SubscriptionTopic Search [ITI-114](ITI-114.html):\nThe Resource Notification Broker Actor SHALL support the canonical instances of SubscriptionTopic presented in the DSUBm profile.\nSee [here](artifacts.html#canonical-subscriptiontopic)",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "code",
              "type": "token",
              "documentation": "Kind of Resource"
            },
            {
              "name": "_id",
              "type": "string",
              "documentation": "The id of the SubscriptionTopic"
            },
            {
              "name": "resource",
              "type": "uri",
              "documentation": "Allowed Data type or Resource (reference to definition) for this definition, searches resourceTrigger, eventTrigger, and notificationShape for matches."
            },
            {
              "name": "derived-or-self",
              "type": "uri",
              "documentation": "A server defined search that matches either the url or derivedFrom"
            },
            {
              "name": "status",
              "type": "token",
              "documentation": "SHOULD be valued with `active`"
            },
            {
              "name": "url",
              "type": "uri",
              "documentation": "Logical canonical URL to reference this SubscriptionTopic (globally unique)"
            }
          ]
        }
      ],
      "interaction": [
        {
          "code": "transaction",
          "documentation": "https://profiles.ihe.net/ITI/DSUBm/StructureDefinition-IHE.DSUBm.ResourceBundle.html"
        }
      ]
    },
    {
      "mode": "client",
      "documentation": "DSUBm Resource Notification Broker provides capability to send notification",
      "security": {
        "description": "Recommend [ATNA](https://profiles.ihe.net/ITI/TF/Volume1/ch-9.html), encouraged [IHE-IUA](https://profiles.ihe.net/ITI/IUA/index.html) or [SMART-app-launch](http://www.hl7.org/fhir/smart-app-launch/)"
      },
      "resource": [
        {
          "type": "Bundle",
          "supportedProfile": [
            "https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/IHE.DSUBm.EventNotification",
            "https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/IHE.DSUBm.HandshakeNotification",
            "https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/IHE.DSUBm.HeartbeatNotification",
            "https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/IHE.DSUBm.SubscriptionDeactivationNotification"
          ],
          "documentation": "Resource Notify [ITI-112](ITI-112.html)"
        }
      ]
    }
  ]
}

FHIR IG Statistics: CapabilityStatement/IHE.DSUBm.ResourceNotificationBroker.DocRef.FullEvents

Resources that use this resource

Resources that this resource uses

Narrative

IHE DSUBm ResourceNotificationBroker DocRef FullEvents

FHIR RESTful Capabilities

REST Configuration: 1

Mode: server

Capabilities by Resource/Profile

Summary

Resource Conformance: supported Subscription

Resource Conformance: SHALL Basic

REST Configuration: 2

Mode: client

Capabilities by Resource/Profile

Summary

Resource Conformance: supported Bundle

Source

Mode: `server`

Mode: `client`