Extension: ValueSet Other Name

Vocabulary Work Group

Maturity Level: 1

Trial Use

Use Context: Any

Official URL: `http://hl7.org/fhir/StructureDefinition/valueset-otherName`				Version: 5.0.0-snapshot3
draft as of 2020-12-28				Computable Name: VSOtherName
Flags: Non-Modifier				OID: 2.16.840.1.113883.4.642.5.1196

Context of Use: Use on Element ID ValueSet

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.

Summary

Name	Card.	Type	Description & Constraints
VSOtherName	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/valueset-otherName VSOtherName: 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
name	1..1	string	Support human navigation and code generation.
preferred	0..1	boolean	Which name is preferred for this language
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/valueset-otherName VSOtherName: 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..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:name	1..1	Extension	Support human navigation and code generation.
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"name"
value[x]	1..1	string	Value of extension
extension:preferred	0..1	Extension	Which name is preferred for this language
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"preferred"
value[x]	1..1	boolean	Value of extension
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/valueset-otherName"
value[x]	0..0
Documentation for this format

XML Template

<!-- VSOtherName -->

<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

{ // VSOtherName
    "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

Name	Card.	Type	Description & Constraints
VSOtherName	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/valueset-otherName VSOtherName: 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
name	1..1	string	Support human navigation and code generation.
preferred	0..1	boolean	Which name is preferred for this language
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/valueset-otherName VSOtherName: 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..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:name	1..1	Extension	Support human navigation and code generation.
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"name"
value[x]	1..1	string	Value of extension
extension:preferred	0..1	Extension	Which name is preferred for this language
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"preferred"
value[x]	1..1	boolean	Value of extension
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/valueset-otherName"
value[x]	0..0
Documentation for this format

XML Template

<!-- VSOtherName -->

<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

{ // VSOtherName
    "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: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (xpath: extension.exists() != value.exists())
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: hasValue() or (children().count() > id.count()))
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: extension.exists() != value.exists())
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: hasValue() or (children().count() > id.count()))
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: extension.exists() != value.exists())
ele-1: On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: hasValue() or (children().count() > id.count()))
ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: extension.exists() != value.exists())
ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: hasValue() or (children().count() > id.count()))
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: hasValue() or (children().count() > id.count()))
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: extension.exists() != value.exists())
ele-1: On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: hasValue() or (children().count() > id.count()))
ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: extension.exists() != value.exists())
ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: hasValue() or (children().count() > id.count()))
ele-1: On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: hasValue() or (children().count() > id.count()))

Search

No Search Extensions defined for this resource

Examples of this extension

No examples found.