$get-ws-binding-token

R5SubscriptionGetWsBindingToken

activeSubscriptions Backport1.1.0operation1 input4 outputs

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

Metadata

Canonical URL: http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-get-ws-binding-token
Code: $get-ws-binding-token
Kind: operation
Affects State: No
Publisher: HL7 FHIR Infrastructure WG

Can be invoked at:

Type LevelInstance Level

Target Resources:

Subscription

Affects State:No

Name	Type	Card.	Description
`id`	id	0..*	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.

Name	Type	Card.	Description
`token`	string	1..1	An access token that a client may use to show authorization during a websocket connection.
`expiration`	dateTime	1..1	The date and time this token is valid until.
`subscription`	string	0..*	The subscriptions this token is valid for.
`websocket-url`	url	1..1	The URL the client should use to connect to Websockets.