Operation-subscription-status.xml

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">
      <h2> Get Current Subscription Status for One or More Subscriptions</h2> 
      <p> OPERATION: Get Current Subscription Status for One or More Subscriptions</p> 
      <p> The official URL for this operation definition is: </p> 
      <pre> http://hl7.org/fhir/OperationDefinition/Subscription-status</pre> 
      <div> 
        <p> This operation is used to return the current SubscriptionStatus information about one
           or more Subscriptions.</p> 

      </div> 
      <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> ids</td> 
          <td> 0..*</td> 
          <td> 
            <a href="datatypes.html#id">id</a> 
          </td> 
          <td/>  
          <td> 
            <div> 
              <p> At the Resource level, one or more parameters containing one or more comma-delimited FHIR
                 ids of Subscriptions to get status information for.  In the absense of any specified ids,
                 the server returns the status for all Subscriptions available to the caller.  At the Instance
                 level, this parameter is ignored.</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 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="0"/> 
  </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="4.5.0"/> 
  <name value="Get Current Subscription Status for One or More Subscriptions"/> 
  <status value="draft"/> 
  <kind value="operation"/> 
  <date value="2020-08-20T17:41:31+10: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 SubscriptionStatus information about one
   or more Subscriptions."/> 
  <code value="status"/> 
  <resource value="Subscription"/> 
  <system value="false"/> 
  <type value="true"/> 
  <instance value="true"/> 
  <parameter> 
    <name value="ids"/> 
    <use value="in"/> 
    <min value="0"/> 
    <max value="*"/> 
    <documentation value="At the Resource level, one or more parameters containing one or more comma-delimited FHIR
     ids of Subscriptions to get status information for.  In the absense of any specified ids,
     the server returns the status for all Subscriptions available to the caller.  At the Instance
     level, this parameter is ignored."/> 
    <type value="id"/> 
  </parameter> 
  <parameter> 
    <name value="return"/> 
    <use value="out"/> 
    <min value="1"/> 
    <max value="1"/> 
    <documentation value="The bundle type is &quot;searchset&quot;"/> 
    <type value="Bundle"/> 
  </parameter> 
</OperationDefinition>