Get a binding token for use in a websocket connection

$get-ws-binding-tokenoperation

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

TypeInstanceAffects State

Metadata

URL: http://hl7.org/fhir/OperationDefinition/Subscription-get-ws-binding-token
ID: Subscription-get-ws-binding-token
Applies to Resources: Subscription

Input Parameters (1)

id0..*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 absence 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.

Output Parameters (4)

token1..1stringrequired

An access token that a client may use to show authorization during a websocket connection. The security details of the token are implementation-dependent and beyond the scope of this operation definition.

expiration1..1dateTimerequired

The date and time this token is valid until.

subscription0..*string

The subscriptions this token is valid for.

websocket-url1..1urlrequired

The URL the client should use to connect to Websockets.