Subscriptions R5 Backport
1.2.0-ballot - ballot International flag

This page is part of the Subscriptions R5 Backport (v1.2.0-ballot: STU 1.2 Ballot 1) based on FHIR (HL7® FHIR® Standard) v4.3.0. The current version which supersedes this version is 1.1.0. For a full list of available versions, 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

UseNameScopeCardinalityTypeBindingDocumentation
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..1string

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

OUTexpiration1..1dateTime

The date and time this token is valid until.

OUTsubscription0..*string

The subscriptions this token is valid for.

OUTwebsocket-url1..1url

The URL the client should use to connect to Websockets.