Subscriptions R5 Backport
0.1.0 - ballot

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

OperationDefinition: Get WS Binding Token for Subscription Operation

R5SubscriptionGetWsBindingToken

OPERATION: R5SubscriptionGetWsBindingToken

The official URL for this operation definition is: 

http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-get-ws-binding-token

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

UseNameCardinalityTypeBindingDocumentation
INid0..*​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.

OUTtoken1..1​string

An access token that a client may use to show authorization during a websocket connection.

OUTexpiration1..1​dateTime

The date and time this token is valid until.

OUTsubscription0..*​string

The subscriptions this token is valid for.

OUTwebsocket-url1..1​url

The URL the client should use to connect to Websockets.