Release 4B 5 Ballot

This page is part of the FHIR Specification (v4.3.0: R4B (v5.0.0-ballot: R5 Ballot - STU 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

Extension: otherName

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

URL for this extension: http://hl7.org/fhir/StructureDefinition/codesystem-otherName Summary

Defining URL: http://hl7.org/fhir/StructureDefinition/codesystem-otherName
Version: 5.0.0-ballot
Name: otherName
Title: null
Modifier: This extension is not a modifier extension
Status: draft
Definition: Human readable names for the codesystem.
Committee: Vocabulary Work Group

Status: draft. Extension maintained by: HL7

Human readable names for the codesystem.

Context of Use: Use on Element ID CodeSystem

Extension Content

Summary

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


Use on Element ID CodeSystem
. . . name 1..1 string This name is intended to be human 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 Which name is the preferred human-readable signifier in for this language. language


doco Documentation for this format

Full Structure

valueBase64Binary base64Binary valueBoolean boolean valueCanonical canonical (Any) valueCode code valueDate date valueDateTime dateTime valueDecimal decimal valueId id valueInstant instant valueInteger integer valueMarkdown markdown valueOid oid valuePositiveInt positiveInt valueString string valueTime time valueUnsignedInt unsignedInt valueUri uri valueUrl url valueUuid uuid valueAddress Address valueAge Age valueAnnotation Annotation valueAttachment Attachment valueCodeableConcept CodeableConcept valueCodeableReference CodeableReference valueCoding Coding valueContactPoint ContactPoint valueCount Count valueDistance Distance valueDuration Duration valueHumanName HumanName valueIdentifier Identifier valueMoney Money valuePeriod Period valueQuantity Quantity valueRange Range valueRatio Ratio valueRatioRange RatioRange valueReference Reference (Any) valueSampledData SampledData valueSignature Signature valueTiming Timing valueContactDetail ContactDetail valueContributor Contributor valueDataRequirement DataRequirement valueExpression Expression valueParameterDefinition ParameterDefinition valueRelatedArtifact RelatedArtifact valueTriggerDefinition TriggerDefinition valueUsageContext UsageContext valueDosage Dosage
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 ID CodeSystem
. . . Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
. . . extension:name 1..1 Extension Human readable, short and specific
. . . . 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
. . . 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"> I 1..1 Extension  <!-- I 1..1 Human readable, short and specific -->
  <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 
      { //  

      { // Human readable, short and specific // 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! Human readable, short and specific
    "extension" : { Extension }, // IWhich name is preferred for this language
    "url" : "http://hl7.org/fhir/StructureDefinition/codesystem-otherName" // R! 
  // value[x]: Value of extension: Prohibited
  }

Summary

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


Use on Element ID CodeSystem
. . . name 1..1 string This name is intended to be human 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 Which name is the preferred human-readable signifier in for this language. language


doco Documentation for this format

Full Structure

valueBase64Binary base64Binary valueBoolean boolean valueCanonical canonical (Any) valueCode code valueDate date valueDateTime dateTime valueDecimal decimal valueId id valueInstant instant valueInteger integer valueMarkdown markdown valueOid oid valuePositiveInt positiveInt valueString string valueTime time valueUnsignedInt unsignedInt valueUri uri valueUrl url valueUuid uuid valueAddress Address valueAge Age valueAnnotation Annotation valueAttachment Attachment valueCodeableConcept CodeableConcept valueCodeableReference CodeableReference valueCoding Coding valueContactPoint ContactPoint valueCount Count valueDistance Distance valueDuration Duration valueHumanName HumanName valueIdentifier Identifier valueMoney Money valuePeriod Period valueQuantity Quantity valueRange Range valueRatio Ratio valueRatioRange RatioRange valueReference Reference (Any) valueSampledData SampledData valueSignature Signature valueTiming Timing valueContactDetail ContactDetail valueContributor Contributor valueDataRequirement DataRequirement valueExpression Expression valueParameterDefinition ParameterDefinition valueRelatedArtifact RelatedArtifact valueTriggerDefinition TriggerDefinition valueUsageContext UsageContext valueDosage Dosage
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 ID CodeSystem
. . . Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
. . . extension:name 1..1 Extension Human readable, short and specific
. . . . 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
. . . 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"> I 1..1 Extension  <!-- I 1..1 Human readable, short and specific -->
  <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 
      { //  

      { // Human readable, short and specific // 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! Human readable, short and specific
    "extension" : { Extension }, // IWhich name is preferred for this language
    "url" : "http://hl7.org/fhir/StructureDefinition/codesystem-otherName" // R! 
  // value[x]: Value of extension: Prohibited
  }

 

Constraints

  • ele-1 : All FHIR elements must have a @value or children unless an empty Parameters resource (xpath: @value|f:*|h:div|self::f:Parameters @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.