FHIR IG Statistics: OperationDefinition/backport-subscription-get-ws-binding-token

Resources that use this resource

Resources that this resource uses

No resources found

Narrative

Note: links and images are rebased to the (stated) source

Source

{
  "resourceType": "OperationDefinition",
  "id": "backport-subscription-get-ws-binding-token",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 0
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode": "trial-use"
    }
  ],
  "url": "http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-get-ws-binding-token",
  "version": "1.1.0",
  "name": "R5SubscriptionGetWsBindingToken",
  "status": "active",
  "kind": "operation",
  "date": "2020-11-30",
  "publisher": "HL7 FHIR Infrastructure WG",
  "contact": [
    {
      "name": "HL7 FHIR Infrastructure WG",
      "telecom": [
        {
          "system": "url",
          "value": "https://hl7.org/Special/committees/fiwg"
        }
      ]
    },
    {
      "name": "Gino Canessa",
      "telecom": [
        {
          "system": "email",
          "value": "mailto:gino.canessa@microsoft.com"
        }
      ]
    },
    {
      "name": "Eric Haas",
      "telecom": [
        {
          "system": "email",
          "value": "mailto:ehaas@healthedatainc.com"
        }
      ]
    }
  ],
  "description": "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": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "001",
          "display": "World"
        }
      ]
    }
  ],
  "affectsState": false,
  "code": "get-ws-binding-token",
  "resource": [
    "Subscription"
  ],
  "system": false,
  "type": true,
  "instance": true,
  "parameter": [
    {
      "name": "id",
      "use": "in",
      "min": 0,
      "max": "*",
      "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.",
      "type": "id"
    },
    {
      "name": "token",
      "use": "out",
      "min": 1,
      "max": "1",
      "documentation": "An access token that a client may use to show authorization during a websocket connection.",
      "type": "string"
    },
    {
      "name": "expiration",
      "use": "out",
      "min": 1,
      "max": "1",
      "documentation": "The date and time this token is valid until.",
      "type": "dateTime"
    },
    {
      "name": "subscription",
      "use": "out",
      "min": 0,
      "max": "*",
      "documentation": "The subscriptions this token is valid for.",
      "type": "string"
    },
    {
      "name": "websocket-url",
      "use": "out",
      "min": 1,
      "max": "1",
      "documentation": "The URL the client should use to connect to Websockets.",
      "type": "url"
    }
  ]
}