Subscriptions R5 Backport - Local Development build (v0.1.0). See the Directory of published versions

• Narrative Content
• XML
• JSON
• TTL

: Get WS Binding Token for Subscription Operation - JSON Representation

Raw json | Download

​
{
  "resourceType" : "OperationDefinition",
  "id" : "backport-subscription-get-ws-binding-token",
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><h2>R5SubscriptionGetWsBindingToken</h2><p>OPERATION: R5SubscriptionGetWsBindingToken</p><p>The official URL for this operation definition is: </p><pre>http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-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>\n</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>id</td><td>0..*</td><td><a href=\"http://build.fhir.org/branches/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 a token for. In the absense of any specified ids, the server may either return a token for all Subscriptions available to the caller with a channel-type of websocket or fail the request.</p>\n</div></td></tr><tr><td>OUT</td><td>token</td><td>1..1</td><td><a href=\"http://build.fhir.org/branches/R4B//datatypes.html#string\">string</a></td><td/><td><div><p>An access token that a client may use to show authorization during a websocket connection.</p>\n</div></td></tr><tr><td>OUT</td><td>expiration</td><td>1..1</td><td><a href=\"http://build.fhir.org/branches/R4B//datatypes.html#dateTime\">dateTime</a></td><td/><td><div><p>The date and time this token is valid until.</p>\n</div></td></tr><tr><td>OUT</td><td>subscription</td><td>0..*</td><td><a href=\"http://build.fhir.org/branches/R4B//datatypes.html#string\">string</a></td><td/><td><div><p>The subscriptions this token is valid for.</p>\n</div></td></tr><tr><td>OUT</td><td>websocket-url</td><td>1..1</td><td><a href=\"http://build.fhir.org/branches/R4B//datatypes.html#url\">url</a></td><td/><td><div><p>The URL the client should use to connect to Websockets.</p>\n</div></td></tr></table></div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger" : 0
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode" : "trial-use"
    }
  ],
  "url" : "http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-get-ws-binding-token",
  "version" : "0.1.0",
  "name" : "R5SubscriptionGetWsBindingToken",
  "status" : "active",
  "kind" : "operation",
  "date" : "2020-11-30",
  "publisher" : "HL7 FHIR Infrastructure WG",
  "contact" : [
    {
      "name" : "HL7 FHIR Infrastructure WG",
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://hl7.org/Special/committees/fiwg/index.cfm"
        }
      ]
    },
    {
      "name" : "Gino Canessa",
      "telecom" : [
        {
          "system" : "email",
          "value" : "mailto:gino.canessa@microsoft.com"
        }
      ]
    },
    {
      "name" : "Eric Haas",
      "telecom" : [
        {
          "system" : "email",
          "value" : "mailto:ehaas@healthedatainc.com"
        }
      ]
    }
  ],
  "description" : "This operation is used to get a token for a websocket client to use in order to bind to one or more subscriptions.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code" : "001",
          "display" : "World"
        }
      ]
    }
  ],
  "affectsState" : false,
  "code" : "get-ws-binding-token",
  "resource" : [
    "Subscription"
  ],
  "system" : false,
  "type" : true,
  "instance" : true,
  "parameter" : [
    {
      "name" : "id",
      "use" : "in",
      "min" : 0,
      "max" : "*",
      "documentation" : "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 a token for. In the absense of any specified ids, the server may either return a token for all Subscriptions available to the caller with a channel-type of websocket or fail the request.",
      "type" : "id"
    },
    {
      "name" : "token",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "An access token that a client may use to show authorization during a websocket connection.",
      "type" : "string"
    },
    {
      "name" : "expiration",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "The date and time this token is valid until.",
      "type" : "dateTime"
    },
    {
      "name" : "subscription",
      "use" : "out",
      "min" : 0,
      "max" : "*",
      "documentation" : "The subscriptions this token is valid for.",
      "type" : "string"
    },
    {
      "name" : "websocket-url",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "The URL the client should use to connect to Websockets.",
      "type" : "url"
    }
  ]
}