Release 5 Preview #2

This page is part of the FHIR Specification (v4.4.0: R5 Preview #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: bindingName

FHIR Infrastructure Work Group

Maturity Level: 1

Informative

Use Context: Any

URL for this extension:

http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName

Status: draft. Extension maintained by: Health Level Seven, Inc. - FHIR Core WG

A name that can be used for code generation when generating named enumerations for the binding.

Comment:

There is no need to use this name for conformance to the specification, but implementers may prefer to match e.g. the schema enumeration name.

Context of Use: Use on Element ID ElementDefinition.binding

Summary

Name	Flags	Card.	Type	Description & Constraints
bindingName		0..1	string	URL = http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName bindingName: A name that can be used for code generation when generating named enumerations for the binding. Use on Element ID ElementDefinition.binding
Documentation for this format

Full Structure

Name	Flags	Card.	Type	Description & Constraints
extension		0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName bindingName: A name that can be used for code generation when generating named enumerations for the binding. Use on Element ID ElementDefinition.binding
extension	I	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"
value[x]	I	1..1	string	Value of extension
Documentation for this format

XML Template

<!-- bindingName -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName" >
  <!-- from Element: extension -->
 <valueString value="[string]"/><!--  1..1 Value of extension -->
</extension>

JSON Template

{ // bindingName
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", // R! 
    "valueString" : "<string>" // C? R! Value of extension
  }

Summary

Name	Flags	Card.	Type	Description & Constraints
bindingName		0..1	string	URL = http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName bindingName: A name that can be used for code generation when generating named enumerations for the binding. Use on Element ID ElementDefinition.binding
Documentation for this format

Full Structure

Name	Flags	Card.	Type	Description & Constraints
extension		0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName bindingName: A name that can be used for code generation when generating named enumerations for the binding. Use on Element ID ElementDefinition.binding
extension	I	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"
value[x]	I	1..1	string	Value of extension
Documentation for this format

XML Template

<!-- bindingName -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName" >
  <!-- from Element: extension -->
 <valueString value="[string]"/><!--  1..1 Value of extension -->
</extension>

JSON Template

{ // bindingName
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", // R! 
    "valueString" : "<string>" // 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)