Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - see ballot notes). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Example OperationDefinition/Subscription-get-ws-binding-token (Narrative)

FHIR Infrastructure Work GroupMaturity Level: N/AStandards Status: InformativeCompartments: Not linked to any defined compartments

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

Note that this is the formal definition for the get-ws-binding-token operation as an OperationDefinition on Subscription. See the Operation documentation

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..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.

 

 

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.