Subscriptions R5 Backport
1.2.0-ballot - ballot

Subscriptions R5 Backport, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 1.2.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-subscription-backport-ig/ and changes regularly. See the Directory of published versions

## OperationDefinition: Get WS Binding Token for Subscription Operation

Official URL: http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-get-ws-binding-token | Version: 1.2.0-ballot
Standards status: Trial-use | Maturity Level: 0 | Computable Name: R5SubscriptionGetWsBindingToken

This operation is used to get a token for a websocket client to use in order to bind to one or more subscriptions.

URL: [base]/Subscription/$get-ws-binding-token

URL: [base]/Subscription/[id]/$get-ws-binding-token

Parameters

Use | Name | Scope | Cardinality | Type | Binding | Documentation
IN | id |  | 0..* | id |  | 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.
OUT | token |  | 1..1 | string |  | An access token that a client may use to show authorization during a websocket connection.
OUT | expiration |  | 1..1 | dateTime |  | The date and time this token is valid until.
OUT | subscription |  | 0..* | string |  | The subscriptions this token is valid for.
OUT | websocket-url |  | 1..1 | url |  | The URL the client should use to connect to Websockets.