FHIR Release 3 (STU)

This page is part of the FHIR Specification (v3.0.2: STU 3). 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

URL for this extension: 

http://hl7.org/fhir/StructureDefinition/valueset-otherName

Status: draft. Extension maintained by: HL7

Human readable names for the valueset.

Context of Use: Use on element: ValueSet

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

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/valueset-otherName
otherName: Human readable names for the valueset.
Use on element: ValueSet
... name1..1stringThis name is intended to be human readable, short and as specific as possible and to convey the purpose of the value set. It is considered to be the name of the value set.
... preferred0..1booleanFlag that this Name in this Name Language is the preferred human-readable signifier in this language.

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/valueset-otherName
otherName: Human readable names for the valueset.
Use on element: ValueSet
... extension 1..1ExtensionHuman readable, short and specific
.... url 1..1uri"name"
.... valueString 0..1stringValue of extension
... extension 0..1ExtensionWhich name is preferred for this language
.... url 1..1uri"preferred"
.... valueBoolean 0..1booleanValue of extension
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/valueset-otherName"
... 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"> 1..1 Extension  <!-- 1..1 Human readable, short and specific -->
  <valueString value="[string]"/><!-- 0..1 Value of extension -->
 </extension>
 <extension url="preferred"> 0..1 Extension  <!-- 0..1 Which name is preferred for this language -->
  <valueBoolean value="[boolean]"/><!-- 0..1 Value of extension -->
 </extension>
</extension>

JSON Template

{ // otherName
    "extension" : [ //  sliced by value:url  in the specified orderOpen
      { // Human readable, short and specific // R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified orderOpen
        ],
        "url" : "name", // R! 
        "valueString" : "<string>" //Value of extension
      },
      { // Which name is preferred for this language //
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified orderOpen
        ],
        "url" : "preferred", // R! 
        "valueBoolean" : <boolean> //Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/valueset-otherName", // R! 
// value[x]: Value of extension. One of these 38:
  }

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/valueset-otherName
otherName: Human readable names for the valueset.
Use on element: ValueSet
... name1..1stringThis name is intended to be human readable, short and as specific as possible and to convey the purpose of the value set. It is considered to be the name of the value set.
... preferred0..1booleanFlag that this Name in this Name Language is the preferred human-readable signifier in this language.

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/valueset-otherName
otherName: Human readable names for the valueset.
Use on element: ValueSet
... extension 1..1ExtensionHuman readable, short and specific
.... url 1..1uri"name"
.... valueString 0..1stringValue of extension
... extension 0..1ExtensionWhich name is preferred for this language
.... url 1..1uri"preferred"
.... valueBoolean 0..1booleanValue of extension
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/valueset-otherName"
... 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"> 1..1 Extension  <!-- 1..1 Human readable, short and specific -->
  <valueString value="[string]"/><!-- 0..1 Value of extension -->
 </extension>
 <extension url="preferred"> 0..1 Extension  <!-- 0..1 Which name is preferred for this language -->
  <valueBoolean value="[boolean]"/><!-- 0..1 Value of extension -->
 </extension>
</extension>

JSON Template

{ // otherName
    "extension" : [ //  sliced by value:url  in the specified orderOpen
      { // Human readable, short and specific // R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified orderOpen
        ],
        "url" : "name", // R! 
        "valueString" : "<string>" //Value of extension
      },
      { // Which name is preferred for this language //
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified orderOpen
        ],
        "url" : "preferred", // R! 
        "valueBoolean" : <boolean> //Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/valueset-otherName", // R! 
// value[x]: Value of extension. One of these 38:
  }

 

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')]))