Release 5 Draft Ballot

This page is part of the FHIR Specification (v4.6.0: R5 Draft Ballot). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Operation-subscription-get-ws-binding-token.ttl

FHIR Infrastructure Work GroupMaturity Level: N/AStandards Status: InformativeCompartments: Not linked to any defined compartments

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 "4.6.0"];
  fhir:CanonicalResource.name [ fhir:value "get-ws-binding-token"];
  fhir:CanonicalResource.title [ fhir:value "Get a binding token for use in a websocket connection"];
  fhir:CanonicalResource.status [ fhir:value "draft"];
  fhir:CanonicalResource.date [ fhir:value "2021-04-15T12:25:09+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 "4.6.0"];
  fhir:OperationDefinition.name [ fhir:value "get-ws-binding-token"];
  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.date [ fhir:value "2021-04-15T12:25:09+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 "ids" ];
     fhir:OperationDefinitionParameterComponent.use [ fhir:value "in" ];
     fhir:OperationDefinitionParameterComponent.min [ fhir:value "0" ];
     fhir:OperationDefinitionParameterComponent.max [ fhir:value "*" ];
     fhir:OperationDefinitionParameterComponent.documentation [ fhir:value "At the Resource level, one or more parameters containing one or more comma-delimited FHIR ids of Subscriptions to get tokens for.  In the absense of any specified ids, the server returns tokens for all Subscriptions available to the caller with a channel-type of websocket.  At the Instance level, this parameter is ignored." ];
     fhir:OperationDefinitionParameterComponent.type [ fhir:value "id" ]
  ], [
     fhir:OperationDefinitionParameterComponent.name [ fhir:value "return" ];
     fhir:OperationDefinitionParameterComponent.use [ fhir:value "out" ];
     fhir:OperationDefinitionParameterComponent.min [ fhir:value "1" ];
     fhir:OperationDefinitionParameterComponent.max [ fhir:value "1" ];
     fhir:OperationDefinitionParameterComponent.documentation [ fhir:value "The returned Parameters MUST include a valueString named \"token\" and a valueDateTime named \"expiration\".  The returned Parameters MAY include a valueString named \"subscriptions\" with a comma-delimited list of subscriptions covered by this token." ];
     fhir:OperationDefinitionParameterComponent.type [ fhir:value "Parameters" ]
  ] .

# -------------------------------------------------------------------------------------


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.