FHIR Release 3 (STU) R4 Ballot #1 (Mixed Normative/Trial use)

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

Vocabulary Work Group   Maturity Level : 1 Informative Use Context : Any

URL for this extension: 


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

Status: draft. Extension maintained by: HL7

Human readable names for the codesystem.

Context of Use: Use on element: Element ID CodeSystem

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

Extension Content

Summary

Name Flags Card. Type Description & Constraints doco
. . extension 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/codesystem-otherName
otherName: Human readable names for the codesystem.


Use on element: Element ID CodeSystem
. . . name 1..1 string This 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.

. . . preferred 0..1 boolean Flag that this Name in this Name Language is the preferred human-readable signifier in this language.


doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/codesystem-otherName
otherName: Human readable names for the codesystem.


Use on element: Element ID CodeSystem
. . . extension 1..1 Extension Human readable, short and specific
. . . . url 1..1 uri "name" "name"
. . . . valueString 0..1 string Value of extension
. . . extension 0..1 Extension Which name is preferred for this language
. . . . url 1..1 uri "preferred" "preferred"
. . . . valueBoolean 0..1 boolean Value of extension
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/codesystem-otherName" "http://hl7.org/fhir/StructureDefinition/codesystem-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/codesystem-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 order, Open 

      { // Human readable, short and specific // R! 
        // from Element: extension
        "
        ],

        "extension" : [ //  sliced by value:url  in the specified order, Open ]

        "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 order, Open ]

        "url" : "preferred", // R! 
        "valueBoolean" : <boolean> //Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/codesystem-otherName", // R! 


// value[x]: Value of extension. One of these 48:
  }

Summary

Name Flags Card. Type Description & Constraints doco
. . extension 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/codesystem-otherName
otherName: Human readable names for the codesystem.


Use on element: Element ID CodeSystem
. . . name 1..1 string This 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.

. . . preferred 0..1 boolean Flag that this Name in this Name Language is the preferred human-readable signifier in this language.


doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/codesystem-otherName
otherName: Human readable names for the codesystem.


Use on element: Element ID CodeSystem
. . . extension 1..1 Extension Human readable, short and specific
. . . . url 1..1 uri "name" "name"
. . . . valueString 0..1 string Value of extension
. . . extension 0..1 Extension Which name is preferred for this language
. . . . url 1..1 uri "preferred" "preferred"
. . . . valueBoolean 0..1 boolean Value of extension
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/codesystem-otherName" "http://hl7.org/fhir/StructureDefinition/codesystem-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/codesystem-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 order, Open 

      { // Human readable, short and specific // R! 
        // from Element: extension
        "
        ],

        "extension" : [ //  sliced by value:url  in the specified order, Open ]

        "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 order, Open ]

        "url" : "preferred", // R! 
        "valueBoolean" : <boolean> //Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/codesystem-otherName", // R! 


// value[x]: Value of extension. One of these 48:
  }

 

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