This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
Example OperationDefinition/Subscription-get-ws-binding-token (Turtle)
Raw Turtle (+ also see Turtle/RDF Format Specification)
Operation Definition
@prefix fhir: <http://hl7.org/fhir/> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
# - resource -------------------------------------------------------------------
[] a fhir:OperationDefinition ;
fhir:id [ fhir:v "Subscription-get-ws-binding-token"] ;
fhir:text [
fhir:status [ fhir:v "extensions" ]
] ;
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm" ] ;
fhir:value [ fhir:v "2" ]
] [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status" ] ;
fhir:value [ fhir:v "trial-use" ]
] ) ;
fhir:url [ fhir:v "http://hl7.org/fhir/OperationDefinition/Subscription-get-ws-binding-token"], [ fhir:v "http://hl7.org/fhir/OperationDefinition/Subscription-get-ws-binding-token"] ;
fhir:version [ fhir:v "5.0.0"], [ fhir:v "5.0.0"] ;
fhir:name [ fhir:v "GetWsBindingToken"], [ fhir:v "GetWsBindingToken"] ;
fhir:title [ fhir:v "Get a binding token for use in a websocket connection"], [ fhir:v "Get a binding token for use in a websocket connection"] ;
fhir:status [ fhir:v "draft"], [ fhir:v "draft"] ;
fhir:experimental [ fhir:v "false"], [ fhir:v "false"] ;
fhir:date [ fhir:v "2023-03-26T15:21:02+11:00"], [ fhir:v "2023-03-26T15:21:02+11:00"] ;
fhir:publisher [ fhir:v "HL7 (FHIR Project)"], [ fhir:v "HL7 (FHIR Project)"] ;
fhir:contact ( [
fhir:telecom ( [
fhir:system [ fhir:v "url" ] ;
fhir:value [ fhir:v "http://hl7.org/fhir" ]
] [
fhir:system [ fhir:v "email" ] ;
fhir:value [ fhir:v "fhir@lists.hl7.org" ]
] )
] [
fhir:telecom ( [
fhir:system [ fhir:v "url" ] ;
fhir:value [ fhir:v "http://hl7.org/fhir" ]
] [
fhir:system [ fhir:v "email" ] ;
fhir:value [ fhir:v "fhir@lists.hl7.org" ]
] )
] ) ;
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: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" ] ;
fhir:code [ fhir:v "001" ] ;
fhir:display [ fhir:v "World" ]
] )
] [
fhir:coding ( [
fhir:system [ fhir:v "http://unstats.un.org/unsd/methods/m49/m49.htm" ] ;
fhir:code [ fhir:v "001" ] ;
fhir:display [ fhir:v "World" ]
] )
] ) ;
fhir:kind [ fhir:v "operation"] ;
fhir:affectsState [ fhir:v "true"] ;
fhir:code [ fhir:v "get-ws-binding-token"] ;
fhir:resource ( [ fhir:v "Subscription"] ) ;
fhir:system [ fhir:v "false"] ;
fhir:type [ fhir:v "true"] ;
fhir:instance [ fhir:v "true"] ;
fhir:parameter ( [
fhir:name [ fhir:v "id" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:scope ( [ fhir:v "type" ] ) ;
fhir:min [ fhir:v "0" ] ;
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 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." ] ;
fhir:type [ fhir:v "id" ]
] [
fhir:name [ fhir:v "token" ] ;
fhir:use [ fhir:v "out" ] ;
fhir:min [ fhir:v "1" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "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." ] ;
fhir:type [ fhir:v "string" ]
] [
fhir:name [ fhir:v "expiration" ] ;
fhir:use [ fhir:v "out" ] ;
fhir:min [ fhir:v "1" ] ;
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" ] ;
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" ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "The URL the client should use to connect to Websockets." ] ;
fhir:type [ fhir:v "url" ]
] ) .
# -------------------------------------------------------------------------------------
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.