Subscriptions R5 Backport
1.2.0-ballot - ballot

Subscriptions R5 Backport, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 1.2.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-subscription-backport-ig/ and changes regularly. See the Directory of published versions

## : Get WS Binding Token for Subscription Operation - TTL Representation

Page standards status: Trial-use | Maturity Level: 0

Raw ttl | Download

    @prefix fhir: <http://hl7.org/fhir/> .
    @prefix owl: <http://www.w3.org/2002/07/owl#> .
    @prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
    @prefix xsd: <http://www.w3.org/2001/XMLSchema#> .

    # - resource -------------------------------------------------------------------

     a fhir:OperationDefinition ;
      fhir:nodeRole fhir:treeRoot ;
      fhir:id [ fhir:v "backport-subscription-get-ws-binding-token"] ; #
      fhir:text [
    fhir:status [ fhir:v "extensions" ] ;
    fhir:div "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p>URL: [base]/Subscription/$get-ws-binding-token</p><p>URL: [base]/Subscription/[id]/$get-ws-binding-token</p><p>Parameters</p><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>id</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4B/datatypes.html#id\">id</a></td><td/><td><div><p>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.</p>\n</div></td></tr><tr><td>OUT</td><td>token</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4B/datatypes.html#string\">string</a></td><td/><td><div><p>An access token that a client may use to show authorization during a websocket connection.</p>\n</div></td></tr><tr><td>OUT</td><td>expiration</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4B/datatypes.html#dateTime\">dateTime</a></td><td/><td><div><p>The date and time this token is valid until.</p>\n</div></td></tr><tr><td>OUT</td><td>subscription</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4B/datatypes.html#string\">string</a></td><td/><td><div><p>The subscriptions this token is valid for.</p>\n</div></td></tr><tr><td>OUT</td><td>websocket-url</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4B/datatypes.html#url\">url</a></td><td/><td><div><p>The URL the client should use to connect to Websockets.</p>\n</div></td></tr></table></div>"
      ] ; #
      fhir:extension ( [
    fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm"^^xsd:anyURI ] ;
    fhir:value [ fhir:v "0"^^xsd:integer ]
      ] [
    fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"^^xsd:anyURI ] ;
    fhir:value [ fhir:v "trial-use" ]
      ] [
    fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg"^^xsd:anyURI ] ;
    fhir:value [ fhir:v "fhir" ]
      ] ) ; #
      fhir:url [ fhir:v "http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-get-ws-binding-token"^^xsd:anyURI] ; #
      fhir:version [ fhir:v "1.2.0-ballot"] ; #
      fhir:name [ fhir:v "R5SubscriptionGetWsBindingToken"] ; #
      fhir:title [ fhir:v "Get WS Binding Token for Subscription Operation"] ; #
      fhir:status [ fhir:v "active"] ; #
      fhir:kind [ fhir:v "operation"] ; #
      fhir:date [ fhir:v "2020-11-30"^^xsd:date] ; #
      fhir:publisher [ fhir:v "HL7 International / FHIR Infrastructure"] ; #
      fhir:contact ( [
    fhir:name [ fhir:v "HL7 International / FHIR Infrastructure" ] ;
        ( fhir:telecom [
    fhir:system [ fhir:v "url" ] ;
    fhir:value [ fhir:v "http://www.hl7.org/Special/committees/fiwg" ]     ] )
      ] [
    fhir:name [ fhir:v "Gino Canessa" ] ;
        ( fhir:telecom [
    fhir:system [ fhir:v "email" ] ;
    fhir:value [ fhir:v "mailto:gino.canessa@microsoft.com" ]     ] )
      ] ) ; #
      fhir:description [ fhir:v "This operation is used to get a token for a websocket client to use in order to bind to one or more subscriptions."] ; #
      fhir:jurisdiction ( [
        ( fhir:coding [
    fhir:system [ fhir:v "http://unstats.un.org/unsd/methods/m49/m49.htm"^^xsd:anyURI ] ;
    fhir:code [ fhir:v "001" ] ;
    fhir:display [ fhir:v "World" ]     ] )
      ] ) ; #
      fhir:affectsState [ fhir:v "false"^^xsd:boolean] ; #
      fhir:code [ fhir:v "get-ws-binding-token"] ; #
      fhir:resource ( [ fhir:v "Subscription"] ) ; #
      fhir:system [ fhir:v "false"^^xsd:boolean] ; #
      fhir:type [ fhir:v "true"^^xsd:boolean] ; #
      fhir:instance [ fhir:v "true"^^xsd:boolean] ; #
      fhir:parameter ( [
    fhir:name [ fhir:v "id" ] ;
    fhir:use [ fhir:v "in" ] ;
    fhir:min [ fhir:v "0"^^xsd:integer ] ;
    fhir:max [ fhir:v "*" ] ;
    fhir:documentation [ fhir:v "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." ] ;
    fhir:type [ fhir:v "id" ]
      ] [
    fhir:name [ fhir:v "token" ] ;
    fhir:use [ fhir:v "out" ] ;
    fhir:min [ fhir:v "1"^^xsd:integer ] ;
    fhir:max [ fhir:v "1" ] ;
    fhir:documentation [ fhir:v "An access token that a client may use to show authorization during a websocket connection." ] ;
    fhir:type [ fhir:v "string" ]
      ] [
    fhir:name [ fhir:v "expiration" ] ;
    fhir:use [ fhir:v "out" ] ;
    fhir:min [ fhir:v "1"^^xsd:integer ] ;
    fhir:max [ fhir:v "1" ] ;
    fhir:documentation [ fhir:v "The date and time this token is valid until." ] ;
    fhir:type [ fhir:v "dateTime" ]
      ] [
    fhir:name [ fhir:v "subscription" ] ;
    fhir:use [ fhir:v "out" ] ;
    fhir:min [ fhir:v "0"^^xsd:integer ] ;
    fhir:max [ fhir:v "*" ] ;
    fhir:documentation [ fhir:v "The subscriptions this token is valid for." ] ;
    fhir:type [ fhir:v "string" ]
      ] [
    fhir:name [ fhir:v "websocket-url" ] ;
    fhir:use [ fhir:v "out" ] ;
    fhir:min [ fhir:v "1"^^xsd:integer ] ;
    fhir:max [ fhir:v "1" ] ;
    fhir:documentation [ fhir:v "The URL the client should use to connect to Websockets." ] ;
    fhir:type [ fhir:v "url" ]
      ] ) . #