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

## : Subscription Status Operation - XML Representation

Page standards status: Trial-use | Maturity Level: 0

Raw xml | Download

    <OperationDefinition xmlns="http://hl7.org/fhir">
      <id value="backport-subscription-status"/>
      <text>
        <status value="extensions"/>
        <div xmlns="http://www.w3.org/1999/xhtml"><p>URL: [base]/Subscription/$status</p><p>URL: [base]/Subscription/[id]/$status</p><p>Parameters</p><table class="grid"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>id</td><td/><td>0..*</td><td><a href="http://hl7.org/fhir/R4B/datatypes.html#id">id</a></td><td/><td><div><p>At the Instance level, this parameter is ignored.  At the Resource level, one or more parameters containing a FHIR id for a Subscription to get status information for. In the absence of any specified ids, the server returns the status for all Subscriptions available to the caller. Multiple values are joined via OR (e.g., &quot;id1&quot; OR &quot;id2&quot;).</p>
    </div></td></tr><tr><td>IN</td><td>status</td><td/><td>0..*</td><td><a href="http://hl7.org/fhir/R4B/datatypes.html#code">code</a></td><td/><td><div><p>At the Instance level, this parameter is ignored. At the Resource level, a Subscription status to filter by (e.g., &quot;active&quot;). In the absence of any specified status values, the server does not filter contents based on the status. Multiple values are joined via OR (e.g., &quot;error&quot; OR &quot;off&quot;).</p>
    </div></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4B/bundle.html">Bundle</a></td><td/><td><div><p>The operation returns a bundle containing one or more subscription status resources, one per Subscription being queried. The Bundle type is &quot;searchset&quot;.</p>
    </div></td></tr></table></div>
      </text>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
        <valueInteger value="0"/>
      </extension>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
        <valueCode value="trial-use"/>
      </extension>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
        <valueCode value="fhir"/>
      </extension>
      <url
           value="http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-status"/>
      <version value="1.2.0-ballot"/>
      <name value="R5SubscriptionStatus"/>
      <title value="Subscription Status Operation"/>
      <status value="active"/>
      <kind value="operation"/>
      <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="This operation is used to return the current status information about one or more topic-based Subscriptions in R4."/>
      <jurisdiction>
        <coding>
          <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
          <code value="001"/>
          <display value="World"/>
        </coding>
      </jurisdiction>
      <affectsState value="false"/>
      <code value="status"/>
      <resource value="Subscription"/>
      <system value="false"/>
      <type value="true"/>
      <instance value="true"/>
      <parameter>
        <name value="id"/>
        <use value="in"/>
        <min value="0"/>
        <max value="*"/>
        <documentation
                       value="At the Instance level, this parameter is ignored.  At the Resource level, one or more parameters containing a FHIR id for a Subscription to get status information for. In the absence of any specified ids, the server returns the status for all Subscriptions available to the caller. Multiple values are joined via OR (e.g., &quot;id1&quot; OR &quot;id2&quot;)."/>
        <type value="id"/>
      </parameter>
      <parameter>
        <name value="status"/>
        <use value="in"/>
        <min value="0"/>
        <max value="*"/>
        <documentation
                       value="At the Instance level, this parameter is ignored. At the Resource level, a Subscription status to filter by (e.g., &quot;active&quot;). In the absence of any specified status values, the server does not filter contents based on the status. Multiple values are joined via OR (e.g., &quot;error&quot; OR &quot;off&quot;)."/>
        <type value="code"/>
      </parameter>
      <parameter>
        <name value="return"/>
        <use value="out"/>
        <min value="1"/>
        <max value="1"/>
        <documentation
                       value="The operation returns a bundle containing one or more subscription status resources, one per Subscription being queried. The Bundle type is &quot;searchset&quot;."/>
        <type value="Bundle"/>
      </parameter>
    </OperationDefinition>