Document Subscription for Mobile (DSUBm)
1.0.0 - Trial-Implementation International flag

This page is part of the Document Subscription for Mobile (DSUBm) (v1.0.0: Publication) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

: DSUBm Resource Notification Subscriber Actor implementing DocumentReference Subscription for Update Option - XML Representation

Active as of 2023-10-27

Raw xml | Download



<CapabilityStatement xmlns="http://hl7.org/fhir">
  <id value="IHE.DSUBm.ResourceNotificationSubscriber.Folder.Upd"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><h2 id="title">IHE DSUBm ResourceNotificationSubscriber Folder Upd</h2><ul><li>Implementation Guide Version: 1.0.0</li><li>FHIR Version: 4.0.1</li><li>Supported Formats: <code>application/fhir+xml</code>, <code>application/fhir+json</code></li><li>Supported Patch Formats: </li><li>Published on: Fri Oct 27 00:00:00 CDT 2023</li><li>Published by: IHE IT Infrastructure Technical Committee</li></ul><blockquote class="impl-note"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>Any FHIR capability may be 'allowed' by the system unless explicitly marked as &quot;SHALL NOT&quot;. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.</p></blockquote><h2 id="rest">FHIR RESTful Capabilities</h2><div class="panel panel-default"><div class="panel-heading"><h3 id="mode1" class="panel-title">Mode: <code>client</code></h3></div><div class="panel-body"><div><p>DSUBm Resource Notification subscriber provides capability to create/deactivate subscription and optionally to search for Subscription and SubscritptionTopic resources</p>
</div><div class="lead"><em>Security</em></div><blockquote><div><p>Recommend <a href="https://profiles.ihe.net/ITI/TF/Volume1/ch-9.html">ATNA</a>, encouraged <a href="https://profiles.ihe.net/ITI/IUA/index.html">IHE-IUA</a> or <a href="http://www.hl7.org/fhir/smart-app-launch/">SMART-app-launch</a></p>
</div></blockquote><div class="lead"><em>Summary of System-wide Interactions</em></div></div></div><h3 id="resourcesCap1">Capabilities by Resource/Profile</h3><h4 id="resourcesSummary1">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class="bg-info">R</span></b>ead, <b><span class="bg-info">S</span></b>earch, <b><span class="bg-info">U</span></b>pdate, and <b><span class="bg-info">C</span></b>reate, are always shown, while <b><span class="bg-info">VR</span></b>ead, <b><span class="bg-info">P</span></b>atch, <b><span class="bg-info">D</span></b>elete, <b><span class="bg-info">H</span></b>istory on <b><span class="bg-info">I</span></b>nstance, or <b><span class="bg-info">H</span></b>istory on <b><span class="bg-info">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class="table-responsive"><table class="table table-condensed table-hover"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class="text-center"><b title="GET a resource (read interaction)">R</b></th><th class="text-center"><b title="GET all set of resources of the type (search interaction)">S</b></th><th class="text-center"><b title="PUT a new resource version (update interaction)">U</b></th><th class="text-center"><b title="POST a new resource (create interaction)">C</b></th><th><b title="Required and recommended search parameters">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href="#Subscription1-1">Subscription</a></td><td>Supported profiles:<br/>  <a href="StructureDefinition-DSUBm-DocumentReference-PatientDependent-Subscription.html">Subscription for DocumentReference Patient-Dependent</a><br/>  <a href="StructureDefinition-DSUBm-DocumentReference-MultiPatient-Subscription.html">Subscription for DocumentReference Multi-Patient</a><br/>  <a href="StructureDefinition-DSUBm-SubmissionSet-PatientDependent-Subscription.html">Subscription for SubmissionSet Patient-Dependent</a><br/>  <a href="StructureDefinition-DSUBm-SubmissionSet-MultiPatient-Subscription.html">Subscription for SubmissionSet Multi-Patient</a><br/>  <a href="StructureDefinition-DSUBm-Folder-Subscription-UpdateOpt.html">Subscription for Folder Patient-Dependent with Folder Subscription for Update Option</a></td><td>y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td>_id, status, url, filter-criteria, topic</td><td/><td/><td/></tr><tr><td><a href="#Basic1-2">Basic</a></td><td> </td><td>y</td><td class="text-center">y</td><td class="text-center"></td><td class="text-center"></td><td>code, _id, resource, derived-or-self, status, url</td><td/><td/><td/></tr></tbody></table></div><hr/><div class="panel panel-default"><div class="panel-heading"><h4 id="Subscription1-1" class="panel-title"><span style="float: right;">Resource Conformance: supported</span>Subscription</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-4"><span class="lead">Core FHIR Resource</span><br/><a href="http://hl7.org/fhir/R4/subscription.html">Subscription</a></div><div class="col-lg-4"><span class="lead">Reference Policy</span><br/></div><div class="col-lg-4"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>create</code>, <code>update</code>, <code>search-type</code>.</li></ul></div></div><p/><div class="row"><div class="col-6"><span class="lead">Supported Profiles</span><p><a href="StructureDefinition-DSUBm-DocumentReference-PatientDependent-Subscription.html">https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/DSUBm-DocumentReference-PatientDependent-Subscription</a><br/><a href="StructureDefinition-DSUBm-DocumentReference-MultiPatient-Subscription.html">https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/DSUBm-DocumentReference-MultiPatient-Subscription</a><br/><a href="StructureDefinition-DSUBm-SubmissionSet-PatientDependent-Subscription.html">https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/DSUBm-SubmissionSet-PatientDependent-Subscription</a><br/><a href="StructureDefinition-DSUBm-SubmissionSet-MultiPatient-Subscription.html">https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/DSUBm-SubmissionSet-MultiPatient-Subscription</a><br/><a href="StructureDefinition-DSUBm-Folder-Subscription-UpdateOpt.html">https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/DSUBm-Folder-Subscription-UpdateOpt</a></p></div></div><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><p>Resource Subscription [ITI-110] and Resource Subscription Search [ITI-113]</p>
</div></blockquote></div></div><div class="row"><div class="col-lg-7"><span class="lead">Search Parameters</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td>_id</td><td><code>string</code></td><td><div><p>The id of the Subscription</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>status</td><td><code>token</code></td><td><div><p>The current state of the subscription</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>url</td><td><code>uri</code></td><td><div><p>The URI that will receive the notifications</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/uv/subscriptions-backport/STU1.1/SearchParameter-Subscription-filter-criteria.html">filter-criteria</a></td><td><code>string</code></td><td><div><p>This SearchParameter enables query of subscriptions by filter criteria</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/uv/subscriptions-backport/STU1.1/SearchParameter-Subscription-topic.html">topic</a></td><td><code>uri</code></td><td><div><p>This SearchParameter enables query of subscriptions by canonical topic-url</p>
</div></td></tr></tbody></table></div><div class="col-lg-5"> </div></div><div class="row"><div class="col-12"><span class="lead">Extended Operations</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Operation</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/uv/subscriptions-backport/STU1.1/OperationDefinition-backport-subscription-events.html">$$events</a></td><td><div><p>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</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/uv/subscriptions-backport/STU1.1/OperationDefinition-backport-subscription-status.html">$$status</a></td><td><div><p>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</p>
</div></td></tr></tbody></table></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Basic1-2" class="panel-title"><span style="float: right;">Resource Conformance: SHALL</span>Basic</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-4"><span class="lead">Core FHIR Resource</span><br/><a href="http://hl7.org/fhir/R4/basic.html">Basic</a></div><div class="col-lg-4"><span class="lead">Reference Policy</span><br/></div><div class="col-lg-4"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><p>Resource SubscriptionTopic Search [ITI-114]</p>
</div></blockquote></div></div><div class="row"><div class="col-lg-7"><span class="lead">Search Parameters</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td>code</td><td><code>token</code></td><td><div><p>Kind of Resource</p>
</div></td></tr><tr><td><b>SHOULD</b></td><td>_id</td><td><code>string</code></td><td><div><p>The id of the SubscriptionTopic</p>
</div></td></tr><tr><td><b>SHOULD</b></td><td>resource</td><td><code>uri</code></td><td><div><p>Allowed Data type or Resource (reference to definition) for this definition, searches resourceTrigger, eventTrigger, and notificationShape for matches.</p>
</div></td></tr><tr><td><b>SHOULD</b></td><td>derived-or-self</td><td><code>uri</code></td><td><div><p>A server defined search that matches either the url or derivedFrom</p>
</div></td></tr><tr><td><b>SHOULD</b></td><td>status</td><td><code>token</code></td><td><div><p>SHOULD be valued with <code>active</code></p>
</div></td></tr><tr><td><b>SHOULD</b></td><td>url</td><td><code>uri</code></td><td><div><p>Logical canonical URL to reference this SubscriptionTopic (globally unique)</p>
</div></td></tr></tbody></table></div><div class="col-lg-5"> </div></div></div></div></div></div>
  </text>
  <url
       value="https://profiles.ihe.net/ITI/DSUBm/CapabilityStatement/IHE.DSUBm.ResourceNotificationSubscriber.Folder.Upd"/>
  <version value="1.0.0"/>
  <name value="IHE_DSUBm_ResourceNotificationSubscriber_Folder_Upd"/>
  <title value="IHE DSUBm ResourceNotificationSubscriber Folder Upd"/>
  <status value="active"/>
  <experimental value="false"/>
  <date value="2023-10-27"/>
  <publisher value="IHE IT Infrastructure Technical Committee"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="https://www.ihe.net/ihe_domains/it_infrastructure/"/>
    </telecom>
  </contact>
  <contact>
    <telecom>
      <system value="email"/>
      <value value="iti@ihe.net"/>
    </telecom>
  </contact>
  <contact>
    <name value="IHE IT Infrastructure Technical Committee"/>
    <telecom>
      <system value="email"/>
      <value value="iti@ihe.net"/>
    </telecom>
  </contact>
  <description
               value="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](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.5 Subscription with Folder Subscription for Update option](ITI-110.html#2311041215-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](ITI-113.html#23113412-message-semantics)
    - _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](ITI-114.html#23114412-message-semantics)
    - code
  - [Search Parameters that SHOULD be supported](ITI-114.html#23114412-message-semantics)
    - _id
    - resource
    - derived-or-self
    - status
    - url

"/>
  <jurisdiction>
    <coding>
      <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
      <code value="001"/>
    </coding>
  </jurisdiction>
  <kind value="requirements"/>
  <fhirVersion value="4.0.1"/>
  <format value="application/fhir+xml"/>
  <format value="application/fhir+json"/>
  <rest>
    <mode value="client"/>
    <documentation
                   value="DSUBm Resource Notification subscriber provides capability to create/deactivate subscription and optionally to search for Subscription and SubscritptionTopic resources"/>
    <security>
      <description
                   value="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/)"/>
    </security>
    <resource>
      <type value="Subscription"/>
      <supportedProfile
                        value="https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/DSUBm-DocumentReference-PatientDependent-Subscription"/>
      <supportedProfile
                        value="https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/DSUBm-DocumentReference-MultiPatient-Subscription"/>
      <supportedProfile
                        value="https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/DSUBm-SubmissionSet-PatientDependent-Subscription"/>
      <supportedProfile
                        value="https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/DSUBm-SubmissionSet-MultiPatient-Subscription"/>
      <supportedProfile
                        value="https://profiles.ihe.net/ITI/DSUBm/StructureDefinition/DSUBm-Folder-Subscription-UpdateOpt"/>
      <documentation
                     value="Resource Subscription [ITI-110] and Resource Subscription Search [ITI-113]"/>
      <interaction>
        <code value="read"/>
      </interaction>
      <interaction>
        <code value="create"/>
      </interaction>
      <interaction>
        <code value="update"/>
      </interaction>
      <interaction>
        <code value="search-type"/>
      </interaction>
      <searchParam>
        <name value="_id"/>
        <type value="string"/>
        <documentation value="The id of the Subscription"/>
      </searchParam>
      <searchParam>
        <name value="status"/>
        <type value="token"/>
        <documentation value="The current state of the subscription"/>
      </searchParam>
      <searchParam>
        <name value="url"/>
        <type value="uri"/>
        <documentation value="The URI that will receive the notifications"/>
      </searchParam>
      <searchParam>
        <name value="filter-criteria"/>
        <definition
                    value="http://hl7.org/fhir/uv/subscriptions-backport/SearchParameter/Subscription-filter-criteria"/>
        <type value="string"/>
        <documentation
                       value="This SearchParameter enables query of subscriptions by filter criteria"/>
      </searchParam>
      <searchParam>
        <name value="topic"/>
        <definition
                    value="http://hl7.org/fhir/uv/subscriptions-backport/SearchParameter/Subscription-topic"/>
        <type value="uri"/>
        <documentation
                       value="This SearchParameter enables query of subscriptions by canonical topic-url"/>
      </searchParam>
      <operation>
        <name value="$events"/>
        <definition
                    value="http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-events"/>
        <documentation
                       value="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 "/>
      </operation>
      <operation>
        <name value="$status"/>
        <definition
                    value="http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-status"/>
        <documentation
                       value="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 "/>
      </operation>
    </resource>
    <resource>
      <type value="Basic"/>
      <documentation value="Resource SubscriptionTopic Search [ITI-114]"/>
      <interaction>
        <code value="read"/>
      </interaction>
      <interaction>
        <code value="search-type"/>
      </interaction>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="code"/>
        <type value="token"/>
        <documentation value="Kind of Resource"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <name value="_id"/>
        <type value="string"/>
        <documentation value="The id of the SubscriptionTopic"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <name value="resource"/>
        <type value="uri"/>
        <documentation
                       value="Allowed Data type or Resource (reference to definition) for this definition, searches resourceTrigger, eventTrigger, and notificationShape for matches."/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <name value="derived-or-self"/>
        <type value="uri"/>
        <documentation
                       value="A server defined search that matches either the url or derivedFrom"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <name value="status"/>
        <type value="token"/>
        <documentation value="SHOULD be valued with `active`"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <name value="url"/>
        <type value="uri"/>
        <documentation
                       value="Logical canonical URL to reference this SubscriptionTopic (globally unique)"/>
      </searchParam>
    </resource>
  </rest>
</CapabilityStatement>