This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
| FHIR Infrastructure Work Group | Maturity Level: N/A | Standards Status: Informative |
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:Resource.id [ fhir:value "Subscription-get-ws-binding-token"];
fhir:DomainResource.text [
fhir:Narrative.status [ fhir:value "extensions" ]
];
fhir:DomainResource.extension [
fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm" ];
fhir:Extension.value [ fhir:value "2" ]
], [
fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status" ];
fhir:Extension.value [ fhir:value "trial-use" ]
];
fhir:CanonicalResource.url [ fhir:value "http://hl7.org/fhir/OperationDefinition/Subscription-get-ws-binding-token"];
fhir:CanonicalResource.version [ fhir:value "5.0.0-ballot"];
fhir:CanonicalResource.name [ fhir:value "GetWsBindingToken"];
fhir:CanonicalResource.title [ fhir:value "Get a binding token for use in a websocket connection"];
fhir:CanonicalResource.status [ fhir:value "draft"];
fhir:CanonicalResource.experimental [ fhir:value "false"];
fhir:CanonicalResource.date [ fhir:value "2022-09-07T10:58:29+10:00"];
fhir:CanonicalResource.publisher [ fhir:value "HL7 (FHIR Project)"];
fhir:CanonicalResource.contact [
fhir:ContactDetail.telecom [
fhir:ContactPoint.system [ fhir:value "url" ];
fhir:ContactPoint.value [ fhir:value "http://hl7.org/fhir" ]
], [
fhir:ContactPoint.system [ fhir:value "email" ];
fhir:ContactPoint.value [ fhir:value "fhir@lists.hl7.org" ]
]
];
fhir:CanonicalResource.description [ fhir:value "This operation is used to get a token for a websocket client to use in order to bind to one or more subscriptions."];
fhir:OperationDefinition.url [ fhir:value "http://hl7.org/fhir/OperationDefinition/Subscription-get-ws-binding-token"];
fhir:OperationDefinition.version [ fhir:value "5.0.0-ballot"];
fhir:OperationDefinition.name [ fhir:value "GetWsBindingToken"];
fhir:OperationDefinition.title [ fhir:value "Get a binding token for use in a websocket connection"];
fhir:OperationDefinition.status [ fhir:value "draft"];
fhir:OperationDefinition.kind [ fhir:value "operation"];
fhir:OperationDefinition.experimental [ fhir:value "false"];
fhir:OperationDefinition.date [ fhir:value "2022-09-07T10:58:29+10:00"];
fhir:OperationDefinition.publisher [ fhir:value "HL7 (FHIR Project)"];
fhir:OperationDefinition.contact [
fhir:ContactDetail.telecom [
fhir:ContactPoint.system [ fhir:value "url" ];
fhir:ContactPoint.value [ fhir:value "http://hl7.org/fhir" ]
], [
fhir:ContactPoint.system [ fhir:value "email" ];
fhir:ContactPoint.value [ fhir:value "fhir@lists.hl7.org" ]
]
];
fhir:OperationDefinition.description [ fhir:value "This operation is used to get a token for a websocket client to use in order to bind to one or more subscriptions."];
fhir:OperationDefinition.affectsState [ fhir:value "true"];
fhir:OperationDefinition.code [ fhir:value "get-ws-binding-token"];
fhir:OperationDefinition.resource [ fhir:value "Subscription"];
fhir:OperationDefinition.system [ fhir:value "false"];
fhir:OperationDefinition.type [ fhir:value "true"];
fhir:OperationDefinition.instance [ fhir:value "true"];
fhir:OperationDefinition.parameter [
fhir:OperationDefinitionParameterComponent.name [ fhir:value "id" ];
fhir:OperationDefinitionParameterComponent.use [ fhir:value "in" ];
fhir:OperationDefinitionParameterComponent.min [ fhir:value "0" ];
fhir:OperationDefinitionParameterComponent.max [ fhir:value "*" ];
fhir:OperationDefinitionParameterComponent.documentation [ fhir: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 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:OperationDefinitionParameterComponent.type [ fhir:value "id" ]
], [
fhir:OperationDefinitionParameterComponent.name [ fhir:value "token" ];
fhir:OperationDefinitionParameterComponent.use [ fhir:value "out" ];
fhir:OperationDefinitionParameterComponent.min [ fhir:value "1" ];
fhir:OperationDefinitionParameterComponent.max [ fhir:value "1" ];
fhir:OperationDefinitionParameterComponent.documentation [ fhir:value "An access token that a client may use to show authorization during a websocket connection." ];
fhir:OperationDefinitionParameterComponent.type [ fhir:value "string" ]
], [
fhir:OperationDefinitionParameterComponent.name [ fhir:value "expiration" ];
fhir:OperationDefinitionParameterComponent.use [ fhir:value "out" ];
fhir:OperationDefinitionParameterComponent.min [ fhir:value "1" ];
fhir:OperationDefinitionParameterComponent.max [ fhir:value "1" ];
fhir:OperationDefinitionParameterComponent.documentation [ fhir:value "The date and time this token is valid until." ];
fhir:OperationDefinitionParameterComponent.type [ fhir:value "dateTime" ]
], [
fhir:OperationDefinitionParameterComponent.name [ fhir:value "subscription" ];
fhir:OperationDefinitionParameterComponent.use [ fhir:value "out" ];
fhir:OperationDefinitionParameterComponent.min [ fhir:value "0" ];
fhir:OperationDefinitionParameterComponent.max [ fhir:value "*" ];
fhir:OperationDefinitionParameterComponent.documentation [ fhir:value "The subscriptions this token is valid for." ];
fhir:OperationDefinitionParameterComponent.type [ fhir:value "string" ]
], [
fhir:OperationDefinitionParameterComponent.name [ fhir:value "websocket-url" ];
fhir:OperationDefinitionParameterComponent.use [ fhir:value "out" ];
fhir:OperationDefinitionParameterComponent.min [ fhir:value "1" ];
fhir:OperationDefinitionParameterComponent.max [ fhir:value "1" ];
fhir:OperationDefinitionParameterComponent.documentation [ fhir:value "The URL the client should use to connect to Websockets." ];
fhir:OperationDefinitionParameterComponent.type [ fhir:value "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.