R6 Ballot (2nd Draft)

Publish-box (todo)

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

FHIR Infrastructure Work GroupMaturity Level: N/AStandards Status: InformativeCompartments: No 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

Generated Narrative: OperationDefinition Subscription-get-ws-binding-token

URL: [base]/Subscription/$get-ws-binding-token

URL: [base]/Subscription/[id]/$get-ws-binding-token

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
IN id type 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 absence 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. The security details of the token are implementation-dependent and beyond the scope of this operation definition.

OUT expiration 1..1 dateTime

The date and time this token is valid until.

OUT subscription 0..* string

The subscriptions this token is valid for.

OUT websocket-url 1..1 url

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.