Subscriptions R5 Backport
0.1.0 - ballot

This page is part of the Subscriptions R5 Backport (v0.1.0: STU 1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions

: Backport Subscription Status Operation - XML Representation

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"><h2>R5SubscriptionStatus</h2><p>OPERATION: R5SubscriptionStatus</p><p>The official URL for this operation definition is: </p><pre>http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/Backport-subscription-status</pre><div><p>This operation is used to return the current status information about one or more backported R5-Style Subscriptions in R4.</p>
</div><p>URL: [base]/Subscription/$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="http://hl7.org/fhir/R4/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="http://hl7.org/fhir/R4/bundle.html">Bundle</a></td><td/><td><div><p>The bundle type is &quot;searchset&quot;. The operation returns a bundle containing one or more Parameters resources, compliant with &quot;backport-subscriptionstatus&quot;, one per Subscription being queried.</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>
  <url
       value="http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/Backport-subscription-status"/>
  <version value="0.1.0"/>
  <name value="R5SubscriptionStatus"/>
  <status value="active"/>
  <kind value="operation"/>
  <date value="2020-11-30"/>
  <publisher value="HL7 FHIR Infrastructure WG"/>
  <contact>
    <name value="HL7 FHIR Infrastructure WG"/>
    <telecom>
      <system value="url"/>
      <value value="https://hl7.org/Special/committees/fiwg/index.cfm"/>
    </telecom>
  </contact>
  <contact>
    <name value="Gino Canessa"/>
    <telecom>
      <system value="email"/>
      <value value="mailto:gino.canessa@microsoft.com"/>
    </telecom>
  </contact>
  <contact>
    <name value="Eric Haas"/>
    <telecom>
      <system value="email"/>
      <value value="mailto:ehaas@healthedatainc.com"/>
    </telecom>
  </contact>
  <description
               value="This operation is used to return the current status information about one or more backported R5-Style Subscriptions in R4."/>
  <jurisdiction>
    <coding>
      <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
      <code value="001"/>
      <display value="World"/>
    </coding>
  </jurisdiction>
  <code value="status"/>
  <resource value="Subscription"/>
  <system value="false"/>
  <type value="true"/>
  <instance value="false"/>
  <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;. The operation returns a bundle containing one or more Parameters resources, compliant with &quot;backport-subscriptionstatus&quot;, one per Subscription being queried."/>
    <type value="Bundle"/>
  </parameter>
</OperationDefinition>