Operation-subscription-get-ws-binding-token.xml

Operation Definition

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

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="Subscription-get-ws-binding-token"/> 
  <text> 
    <status value="extensions"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <h2> get-ws-binding-token</h2> 
      <p> OPERATION: get-ws-binding-token</p> 
      <p> The official URL for this operation definition is: </p> 
      <pre> http://hl7.org/fhir/OperationDefinition/Subscription-get-ws-binding-token</pre> 
      <div> 
        <p> This operation is used to get a token for a websocket client to use in order to bind to
           one or more subscriptions.</p> 

      </div> 
      <p> URL: [base]/Subscription/$get-ws-binding-token</p> 
      <p> URL: [base]/Subscription/[id]/$get-ws-binding-token</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 tokens for.  In the absense of any specified ids, the server
                 returns tokens for all Subscriptions available to the caller with a channel-type of websocket.
                  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="parameters.html">Parameters</a> 
          </td> 
          <td/>  
          <td> 
            <div> 
              <p> The returned Parameters MUST include a valueString named &quot;token&quot; and a valueDateTime
                 named &quot;expiration&quot;.  The returned Parameters MAY include a valueString named
                 &quot;subscriptions&quot; with a comma-delimited list of subscriptions covered by this
                 token.</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-get-ws-binding-token"/> 
  <version value="4.6.0"/> 
  <name value="get-ws-binding-token"/> 
  <title value="Get a binding token for use in a websocket connection"/> 
  <status value="draft"/> 
  <kind value="operation"/> 
  <date value="2021-04-15T12:25:09+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 get a token for a websocket client to use in order to bind to
   one or more subscriptions."/> 
  <affectsState value="true"/> 
  <code value="get-ws-binding-token"/> 
  <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 tokens for.  In the absense of any specified ids, the server
     returns tokens for all Subscriptions available to the caller with a channel-type of websocket.
      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 returned Parameters MUST include a valueString named &quot;token&quot; and a valueDateTime
     named &quot;expiration&quot;.  The returned Parameters MAY include a valueString named
     &quot;subscriptions&quot; with a comma-delimited list of subscriptions covered by this
     token."/> 
    <type value="Parameters"/> 
  </parameter> 
</OperationDefinition>