R4 Ballot #2 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.5.0: R4 Ballot #2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R4B R4 R3

Extension: websocket

FHIR Infrastructure Work Group Maturity Level: 1InformativeUse Context: Any

URL for this extension: 

http://hl7.org/fhir/StructureDefinition/capabilitystatement-websocket

Status: draft. Extension maintained by: Health Level Seven, Inc. - [WG Name] WG

Where the server provides its web socket end-point.

Comment:

Used for web-socket based subscriptions.

Context of Use: Use on Element ID CapabilityStatement.rest

usage info: insert a list of places where this extension is used

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. websocket0..1uriURL = http://hl7.org/fhir/StructureDefinition/capabilitystatement-websocket
websocket: Where the server provides its web socket end-point.


Use on Element ID CapabilityStatement.rest

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/capabilitystatement-websocket
websocket: Where the server provides its web socket end-point.


Use on Element ID CapabilityStatement.rest
... extension 0..0
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/capabilitystatement-websocket"
... valueUri 0..1uriValue of extension

doco Documentation for this format

XML Template

<!-- websocket -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-websocket" >
  <!-- from Element: extension -->
 <valueUri value="[uri]"/><!-- 0..1 Value of extension -->
</extension>

JSON Template

{ // websocket
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-websocket", // R! 
    "valueUri" : "<uri>" //Value of extension
  }

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. websocket0..1uriURL = http://hl7.org/fhir/StructureDefinition/capabilitystatement-websocket
websocket: Where the server provides its web socket end-point.


Use on Element ID CapabilityStatement.rest

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..1ExtensionURL = http://hl7.org/fhir/StructureDefinition/capabilitystatement-websocket
websocket: Where the server provides its web socket end-point.


Use on Element ID CapabilityStatement.rest
... extension 0..0
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/capabilitystatement-websocket"
... valueUri 0..1uriValue of extension

doco Documentation for this format

XML Template

<!-- websocket -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-websocket" >
  <!-- from Element: extension -->
 <valueUri value="[uri]"/><!-- 0..1 Value of extension -->
</extension>

JSON Template

{ // websocket
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-websocket", // R! 
    "valueUri" : "<uri>" //Value of extension
  }

 

Constraints

  • ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div)
  • ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]))