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

Operation Definition

{
  "resourceType" : "OperationDefinition",
  "id" : "Subscription-get-ws-binding-token",
  "text" : {
    "status" : "extensions",
    "div" : "<div>!-- Snipped for Brevity --></div>"
  },
  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
    "valueInteger" : 2
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
    "valueCode" : "trial-use"
  }],
  "url" : "http://hl7.org/fhir/OperationDefinition/Subscription-get-ws-binding-token",
  "version" : "5.0.0-snapshot1",
  "name" : "get-ws-binding-token",
  "title" : "Get a binding token for use in a websocket connection",
  "status" : "draft",
  "kind" : "operation",
  "date" : "2021-12-19T08:15:41+11:00",
  "publisher" : "HL7 (FHIR Project)",
  "contact" : [{
    "telecom" : [{
      "system" : "url",
      "value" : "http://hl7.org/fhir"
    },
    {
      "system" : "email",
      "value" : "fhir@lists.hl7.org"
    }]
  }],
  "description" : "This operation is used to get a token for a websocket client to use in order to bind to one or more subscriptions.",
  "affectsState" : true,
  "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"
  }]
}