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

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

Parameters

Use Name Scope Cardinality Type Binding Documentation
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.
<status value="draft"/> <kind value="operation"/> <experimental value="false"/> <date value="2023-03-26T15:21:02+11:00"/> <publisher value="HL7 (FHIR Project)"/> <contact> <telecom> <system value="url"/> <value value="http://hl7.org/fhir"/> </telecom> <telecom> <system value="email"/> <value value="fhir@lists.hl7.org"/> </telecom> </contact> <description value="This operation is used to get a token for a websocket client to use in order to bind to one or more subscriptions."/> <jurisdiction> <coding> <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/> <code value="001"/> <display value="World"/> </coding> </jurisdiction> <affectsState value="true"/> <code value="get-ws-binding-token"/> <resource value="Subscription"/> <system value="false"/> <type value="true"/> <instance value="true"/> <parameter> <name value="id"/> <use value="in"/> <scope value="type"/> <min value="0"/> <max value="*"/> <documentation value="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."/> <type value="id"/> </parameter> <parameter> <name value="token"/> <use value="out"/> <min value="1"/> <max value="1"/> <documentation value="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."/> <type value="string"/> </parameter> <parameter> <name value="expiration"/> <use value="out"/> <min value="1"/> <max value="1"/> <documentation value="The date and time this token is valid until."/> <type value="dateTime"/> </parameter> <parameter> <name value="subscription"/> <use value="out"/> <min value="0"/> <max value="*"/> <documentation value="The subscriptions this token is valid for."/> <type value="string"/> </parameter> <parameter> <name value="websocket-url"/> <use value="out"/> <min value="1"/> <max value="1"/> <documentation value="The URL the client should use to connect to Websockets."/> <type value="url"/> </parameter> </OperationDefinition>