Release 5 Draft Ballot

Operation-subscription-get-ws-binding-token

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.


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

UseNameCardinalityTypeBindingDocumentation
INids0..*id

At the Resource level, one or more parameters containing one or more comma-delimited FHIR ids of Subscriptions to get tokens for. In the absense of any specified ids, the server returns tokens for all Subscriptions available to the caller with a channel-type of websocket. At the Instance level, this parameter is ignored.

OUTreturn1..1Parameters

The returned Parameters MUST include a valueString named "token" and a valueDateTime named "expiration". The returned Parameters MAY include a valueString named "subscriptions" with a comma-delimited list of subscriptions covered by this token.


 

 

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.