{ "description": "This operation is used to get a token for a websocket client to use in order to bind to one or more subscriptions.", "_filename": "OperationDefinition-backport-subscription-get-ws-binding-token.json", "package_name": "hl7.fhir.uv.subscriptions-backport.r4", "date": "2020-11-30", "system": false, "publisher": "HL7 FHIR Infrastructure WG", "instance": true, "jurisdiction": [ { "coding": [ { "code": "001", "system": "http://unstats.un.org/unsd/methods/m49/m49.htm", "display": "World" } ] } ], "name": "R5SubscriptionGetWsBindingToken", "type": "true", "experimental": null, "resourceType": "OperationDefinition", "title": null, "package_version": "1.1.0", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger": 0 }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "trial-use" } ], "status": "active", "id": "528ce48c-9cfe-4f8f-84bd-262f443368c0", "resource": [ "Subscription" ], "affectsState": false, "kind": "operation", "url": "http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-get-ws-binding-token", "code": "get-ws-binding-token", "version": "1.1.0", "contact": [ { "name": "HL7 FHIR Infrastructure WG", "telecom": [ { "value": "https://hl7.org/Special/committees/fiwg", "system": "url" } ] }, { "name": "Gino Canessa", "telecom": [ { "value": "mailto:gino.canessa@microsoft.com", "system": "email" } ] }, { "name": "Eric Haas", "telecom": [ { "value": "mailto:ehaas@healthedatainc.com", "system": "email" } ] } ], "parameter": [ { "max": "*", "min": 0, "use": "in", "name": "id", "type": "id", "documentation": "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." }, { "max": "1", "min": 1, "use": "out", "name": "token", "type": "string", "documentation": "An access token that a client may use to show authorization during a websocket connection." }, { "max": "1", "min": 1, "use": "out", "name": "expiration", "type": "dateTime", "documentation": "The date and time this token is valid until." }, { "max": "*", "min": 0, "use": "out", "name": "subscription", "type": "string", "documentation": "The subscriptions this token is valid for." }, { "max": "1", "min": 1, "use": "out", "name": "websocket-url", "type": "url", "documentation": "The URL the client should use to connect to Websockets." } ] }