Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - see ballot notes). 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 R2

Extension: otherName

Vocabulary Work Group Maturity Level: 1InformativeUse Context: Any

Summary

Defining URL:http://hl7.org/fhir/StructureDefinition/valueset-otherName
Version:5.0.0-ballot
Name:otherName
Title:null
Modifier:This extension is not a modifier extension
Status:draft
Definition:Natural language names identifying the value set. These names should be usable as an identifier for the module by machine processing applications such as code generation.
Committee:Vocabulary Work Group

Status: draft. Extension maintained by: HL7

Natural language names identifying the value set. These names should be usable as an identifier for the module by machine processing applications such as code generation.

Context of Use: Use on Element ID ValueSet

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. otherName0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/valueset-otherName
otherName: Natural language names identifying the value set. These names should be usable as an identifier for the module by machine processing applications such as code generation.


Use on Element ID ValueSet
... name1..1stringSupport human navigation and code generation.

... preferred0..1booleanWhich name is preferred for this language


doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/valueset-otherName
otherName: Natural language names identifying the value set. These names should be usable as an identifier for the module by machine processing applications such as code generation.


Use on Element ID ValueSet
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:name 1..1ExtensionSupport human navigation and code generation.
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"name"
.... value[x] 1..1stringValue of extension
... extension:preferred 0..1ExtensionWhich name is preferred for this language
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"preferred"
.... value[x] 1..1booleanValue of extension
... value[x] 0..0

doco Documentation for this format

XML Template

<!-- otherName -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/valueset-otherName" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="name"> I 1..1 Extension  <!-- I 1..1 Support human navigation and code generation. -->
  <valueString value="[string]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="preferred"> I 0..1 Extension  <!-- I 0..1 Which name is preferred for this language -->
  <valueBoolean value="[boolean]"/><!-- I 1..1 Value of extension -->
 </extension>
</extension>

JSON Template

{ // otherName
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // Support human navigation and code generation. // I R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "name", // R! 
        "valueString" : "<string>" // I R! Value of extension
      },
      { // Which name is preferred for this language // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "preferred", // R! 
        "valueBoolean" : <boolean> // I R! Value of extension
      }
    ],
    "extension" : [{ Extension }], // IAdditional content defined by implementations
    "extension" : { Extension }, // I R! Support human navigation and code generation.
    "extension" : { Extension }, // IWhich name is preferred for this language
    "url" : "http://hl7.org/fhir/StructureDefinition/valueset-otherName" // R! 
  // value[x]: Value of extension: Prohibited
  }

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. otherName0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/valueset-otherName
otherName: Natural language names identifying the value set. These names should be usable as an identifier for the module by machine processing applications such as code generation.


Use on Element ID ValueSet
... name1..1stringSupport human navigation and code generation.

... preferred0..1booleanWhich name is preferred for this language


doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/valueset-otherName
otherName: Natural language names identifying the value set. These names should be usable as an identifier for the module by machine processing applications such as code generation.


Use on Element ID ValueSet
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:name 1..1ExtensionSupport human navigation and code generation.
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"name"
.... value[x] 1..1stringValue of extension
... extension:preferred 0..1ExtensionWhich name is preferred for this language
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"preferred"
.... value[x] 1..1booleanValue of extension
... value[x] 0..0

doco Documentation for this format

XML Template

<!-- otherName -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/valueset-otherName" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="name"> I 1..1 Extension  <!-- I 1..1 Support human navigation and code generation. -->
  <valueString value="[string]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="preferred"> I 0..1 Extension  <!-- I 0..1 Which name is preferred for this language -->
  <valueBoolean value="[boolean]"/><!-- I 1..1 Value of extension -->
 </extension>
</extension>

JSON Template

{ // otherName
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // Support human navigation and code generation. // I R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "name", // R! 
        "valueString" : "<string>" // I R! Value of extension
      },
      { // Which name is preferred for this language // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "preferred", // R! 
        "valueBoolean" : <boolean> // I R! Value of extension
      }
    ],
    "extension" : [{ Extension }], // IAdditional content defined by implementations
    "extension" : { Extension }, // I R! Support human navigation and code generation.
    "extension" : { Extension }, // IWhich name is preferred for this language
    "url" : "http://hl7.org/fhir/StructureDefinition/valueset-otherName" // R! 
  // value[x]: Value of extension: Prohibited
  }

 

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.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.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div)
  • ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
  • ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: @value|f:*|h:div)
  • 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.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div)
  • ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
  • ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: @value|f:*|h:div)
  • ele-1: On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: @value|f:*|h:div)

Search

No Search Extensions defined for this resource

Examples of this extension

No examples found.