Subscriptions R5 Backport
1.2.0-ballot - ballot

Subscriptions R5 Backport, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 1.2.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-subscription-backport-ig/ and changes regularly. See the Directory of published versions

## : R4B Topic-Based Subscription Server Capability Statement - XML Representation

Page standards status: Trial-use

Raw xml | Download

    <CapabilityStatement xmlns="http://hl7.org/fhir">
      <id value="backport-subscription-server"/>
      <text>
        <status value="extensions"/>
        <div xmlns="http://www.w3.org/1999/xhtml"><h2 id="title">R4B Topic-Based Subscription Server Capability Statement</h2><ul><li>Implementation Guide Version: 1.2.0-ballot </li><li>FHIR Version: 4.3.0 </li><li>Supported Formats: <code>xml</code>, <code>json</code></li><li>Supported Patch Formats: </li><li>Published on: 2020-11-30 </li><li>Published by: HL7 International / FHIR Infrastructure </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 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.</p></blockquote><h3 id="shallIGs">SHALL Support the Following Implementation Guides</h3><ul><li><a href="index.html">http://hl7.org/fhir/uv/subscriptions-backport/ImplementationGuide/hl7.fhir.uv.subscriptions-backport</a></li></ul><h2 id="rest">FHIR RESTful Capabilities</h2><div class="panel panel-default"><div class="panel-heading"><h3 id="mode1" class="panel-title">Mode: <code>server</code></h3></div><div class="panel-body"><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 class="text-center"><b title="DELETE a resource (delete interaction)">D</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="#SubscriptionTopic1-1">SubscriptionTopic</a></td><td> </td><td>y</td><td class="text-center"></td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td>url, derived-or-self, resource, title, trigger-description</td><td/><td/><td/></tr><tr><td><a href="#Subscription1-2">Subscription</a></td><td>Supported Profiles<br/>  <a href="StructureDefinition-backport-subscription.html">R4/B Topic-Based Subscription</a></td><td>y</td><td class="text-center"></td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td>url, status</td><td/><td/><td><code>$status</code>, <code>$events</code>, <code>$get-ws-binding-token</code></td></tr></tbody></table></div><hr/><div class="panel panel-default"><div class="panel-heading"><h4 id="SubscriptionTopic1-1" class="panel-title"><span style="float: right;">Resource Conformance: SHALL </span>SubscriptionTopic</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/R4B/subscriptiontopic.html">SubscriptionTopic</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><strong>SHALL</strong>support <code>read</code>.</li><li><strong>MAY</strong>support <code>create</code>, <code>update</code>, <code>delete</code>.</li></ul></div></div><p/><p/><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><a href="http://hl7.org/fhir/R4B/subscriptiontopic.html#search">url</a></td><td><code>uri</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4B/subscriptiontopic.html#search">derived-or-self</a></td><td><code>uri</code></td><td><div/></td></tr><tr><td><b>SHOULD</b></td><td><a href="http://hl7.org/fhir/R4B/subscriptiontopic.html#search">resource</a></td><td><code>uri</code></td><td><div/></td></tr><tr><td><b>SHOULD</b></td><td><a href="http://hl7.org/fhir/R4B/subscriptiontopic.html#search">title</a></td><td><code>string</code></td><td><div/></td></tr><tr><td><b>SHOULD</b></td><td><a href="http://hl7.org/fhir/R4B/subscriptiontopic.html#search">trigger-description</a></td><td><code>string</code></td><td><div/></td></tr></tbody></table></div><div class="col-lg-5"> </div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Subscription1-2" class="panel-title"><span style="float: right;">Resource Conformance: SHALL </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/R4B/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><strong>SHALL</strong>support <code>read</code>.</li><li><strong>SHOULD</strong>support <code>create</code>, <code>update</code>, <code>delete</code>.</li></ul></div></div><p/><div class="row"><div class="col-6"><span class="lead">Supported Profiles</span><p><a href="StructureDefinition-backport-subscription.html">http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription</a></p></div></div><p/><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><a href="http://hl7.org/fhir/R4B/subscription.html#search">url</a></td><td><code>uri</code></td><td><div/></td></tr><tr><td><b>SHOULD</b></td><td><a href="http://hl7.org/fhir/R4B/subscription.html#search">status</a></td><td><code>token</code></td><td><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="OperationDefinition-backport-subscription-status.html">$status</a></td><td><div/></td></tr><tr><td><b>MAY</b></td><td><a href="OperationDefinition-backport-subscription-events.html">$events</a></td><td><div/></td></tr><tr><td><b>MAY</b></td><td><a href="OperationDefinition-backport-subscription-get-ws-binding-token.html">$get-ws-binding-token</a></td><td><div/></td></tr></tbody></table></div></div></div></div></div></div>
      </text>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
        <valueCode value="fhir"/>
      </extension>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
        <valueCode value="trial-use">
          <extension
                     url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
            <valueCanonical
                            value="http://hl7.org/fhir/uv/subscriptions-backport/ImplementationGuide/hl7.fhir.uv.subscriptions-backport"/>
          </extension>
        </valueCode>
      </extension>
      <url
           value="http://hl7.org/fhir/uv/subscriptions-backport/CapabilityStatement/backport-subscription-server"/>
      <version value="1.2.0-ballot"/>
      <name value="BackportSubscriptionCapabilityStatement"/>
      <title value="R4B Topic-Based Subscription Server Capability Statement"/>
      <status value="active"/>
      <date value="2020-11-30"/>
      <publisher value="HL7 International / FHIR Infrastructure"/>
      <contact>
        <name value="HL7 International / FHIR Infrastructure"/>
        <telecom>
          <system value="url"/>
          <value value="http://www.hl7.org/Special/committees/fiwg"/>
        </telecom>
      </contact>
      <contact>
        <name value="Gino Canessa"/>
        <telecom>
          <system value="email"/>
          <value value="mailto:gino.canessa@microsoft.com"/>
        </telecom>
      </contact>
      <description
                   value="CapabilityStatement describing the required and optional capabilities of a FHIR Server supporting backported R5 Subscriptions in R4B."/>
      <jurisdiction>
        <coding>
          <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
          <code value="001"/>
          <display value="World"/>
        </coding>
      </jurisdiction>
      <kind value="requirements"/>
      <fhirVersion value="4.3.0"/>
      <format value="xml"/>
      <format value="json"/>
      <implementationGuide
                           value="http://hl7.org/fhir/uv/subscriptions-backport/ImplementationGuide/hl7.fhir.uv.subscriptions-backport"/>
      <rest>
        <mode value="server">
          <extension
                     url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
            <valueCode value="SHALL"/>
          </extension>
        </mode>
        <resource>
          <extension
                     url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
            <valueCode value="SHALL"/>
          </extension>
          <type value="SubscriptionTopic"/>
          <interaction>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHALL"/>
            </extension>
            <code value="read"/>
          </interaction>
          <interaction>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="MAY"/>
            </extension>
            <code value="create"/>
          </interaction>
          <interaction>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="MAY"/>
            </extension>
            <code value="update"/>
          </interaction>
          <interaction>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="MAY"/>
            </extension>
            <code value="delete"/>
          </interaction>
          <searchParam>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHALL"/>
            </extension>
            <name value="url"/>
            <definition
                        value="http://hl7.org/fhir/SearchParameter/SubscriptionTopic-url"/>
            <type value="uri"/>
          </searchParam>
          <searchParam>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHALL"/>
            </extension>
            <name value="derived-or-self"/>
            <definition
                        value="http://hl7.org/fhir/SearchParameter/SubscriptionTopic-derived-or-self"/>
            <type value="uri"/>
          </searchParam>
          <searchParam>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHOULD"/>
            </extension>
            <name value="resource"/>
            <definition
                        value="http://hl7.org/fhir/SearchParameter/SubscriptionTopic-resource"/>
            <type value="uri"/>
          </searchParam>
          <searchParam>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHOULD"/>
            </extension>
            <name value="title"/>
            <definition
                        value="http://hl7.org/fhir/SearchParameter/SubscriptionTopic-title"/>
            <type value="string"/>
          </searchParam>
          <searchParam>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHOULD"/>
            </extension>
            <name value="trigger-description"/>
            <definition
                        value="http://hl7.org/fhir/SearchParameter/SubscriptionTopic-trigger-description"/>
            <type value="string"/>
          </searchParam>
        </resource>
        <resource>
          <extension
                     url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
            <valueCode value="SHALL"/>
          </extension>
          <type value="Subscription"/>
          <supportedProfile
                            value="http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription">🔗
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHOULD"/>
            </extension>
          </supportedProfile>
          <interaction>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHALL"/>
            </extension>
            <code value="read"/>
          </interaction>
          <interaction>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHOULD"/>
            </extension>
            <code value="create"/>
          </interaction>
          <interaction>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHOULD"/>
            </extension>
            <code value="update"/>
          </interaction>
          <interaction>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHOULD"/>
            </extension>
            <code value="delete"/>
          </interaction>
          <searchParam>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHALL"/>
            </extension>
            <name value="url"/>
            <definition
                        value="http://hl7.org/fhir/SearchParameter/Subscription-url"/>
            <type value="uri"/>
          </searchParam>
          <searchParam>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHOULD"/>
            </extension>
            <name value="status"/>
            <definition
                        value="http://hl7.org/fhir/SearchParameter/Subscription-status"/>
            <type value="token"/>
          </searchParam>
          <operation>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHALL"/>
            </extension>
            <name value="status"/>
            <definition
                        value="http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-status"/>
          </operation>
          <operation>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="MAY"/>
            </extension>
            <name value="events"/>
            <definition
                        value="http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-events"/>
          </operation>
          <operation>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="MAY"/>
            </extension>
            <name value="get-ws-binding-token"/>
            <definition
                        value="http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-get-ws-binding-token"/>
          </operation>
        </resource>
      </rest>
    </CapabilityStatement>