Operation Definition

<?xml version="1.0" encoding="UTF-8"?>

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="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> 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> 0..*</td> 
          <td> 
            <a href="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> 0..*</td> 
          <td> 
            <a href="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> 1..1</td> 
          <td> 
            <a href="bundle.html">Bundle</a> 
          </td> 
          <td/>  
          <td> 
            <div> 
              <p> The operation returns a bundle containing one or more SubscriptionStatus resources,
                 one per Subscription being queried. The Bundle type is &quot;searchset&quot;.</p> 

            </div> 
          </td> 
        </tr> 
      </table> 
      <div/>  
    </div> 
  </text> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="2"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
    <valueCode value="trial-use"/> 
  </extension> 
  <url value="http://hl7.org/fhir/OperationDefinition/Subscription-status"/> 
  <version value="5.0.0-snapshot3"/> 
  <name value="Status"/> 
  <title value="Get Current Subscription Status for One or More Subscriptions"/> 
  <status value="draft"/> 
  <kind value="operation"/> 
  <experimental value="false"/> 
  <date value="2022-12-14T07:12:54+11:00"/> 
  <publisher value="HL7 (FHIR Project)"/> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://hl7.org/fhir"/> 
    </telecom> 
    <telecom> 
      <system value="email"/> 
      <value value="fhir@lists.hl7.org"/> 
    </telecom> 
  </contact> 
  <description value="This operation is used to return the current status information about one or more
   topic-based Subscriptions."/> 
  <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 SubscriptionStatus resources,
     one per Subscription being queried. The Bundle type is &quot;searchset&quot;."/> 
    <type value="Bundle"/> 
  </parameter> 
</OperationDefinition>