Release 5 Snapshot #1

This page is part of the FHIR Specification (v5.0.0-snapshot1: Release 5 Snapshot #1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Operation-subscription-get-ws-binding-token

FHIR Infrastructure Work Group

Maturity Level: N/A

Standards Status: Informative

Compartments: Not linked to any defined compartments

This is the narrative for the resource. See also the XML, JSON or Turtle format.

get-ws-binding-token

OPERATION: get-ws-binding-token

The official URL for this operation definition is:

http://hl7.org/fhir/OperationDefinition/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

Use

Name

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