Release 4 5 Preview #3
This page is part of the FHIR Specification (v4.0.1: R4 - Mixed Normative and 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

Extension: websocket

FHIR Infrastructure Work Group   Maturity Level : 1 Informative Use 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

Extension Content

Summary

Name Flags Card. Type Description & Constraints doco
. . websocket 0..1 uri URL = 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

Name Flags Card. Type Description & Constraints doco
. . extension 0..1 Extension URL = http://hl7.org/fhir/StructureDefinition/capabilitystatement-websocket
websocket: Where the server provides its web socket end-point.


Use on Element ID CapabilityStatement.rest
. . . extension I 0..0
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/capabilitystatement-websocket"
. . . value[x] I 1..1 uri Value 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]"/><!-- ?? 1..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>" // C? R! Value of extension

  }

Summary

Name Flags Card. Type Description & Constraints doco
. . websocket 0..1 uri URL = 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

Name Flags Card. Type Description & Constraints doco
. . extension 0..1 Extension URL = http://hl7.org/fhir/StructureDefinition/capabilitystatement-websocket
websocket: Where the server provides its web socket end-point.


Use on Element ID CapabilityStatement.rest
. . . extension I 0..0
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/capabilitystatement-websocket"
. . . value[x] I 1..1 uri Value 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]"/><!-- ?? 1..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>" // C? R! 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')]) )
  • ele-1 : On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div )
  • ext-1 : On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]) )
  • ele-1 : On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: @value|f:*|h:div )