FHIR Release 3 (STU) 5 Preview #3
This page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 4.0.1 . For a full list of available versions, see the Directory of published versions

Extension: otherName

Vocabulary Work Group   Maturity Level : 1 Informative Use 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: Element ID ValueSet

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

Extension Content

Summary

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


Use on element: Element ID ValueSet
. . . 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/valueset-otherName
otherName: Human readable names for the valueset.


Use on element: Element ID ValueSet
. . . extension I 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... extension:name I 1..1 Extension Human readable, short and specific
. . . . id 0..1 string Unique id for inter-element referencing
.... extension I 0..0
.... url 1..1 uri "name"
. . . . valueString value[x] I 0..1 1..1 string Value of extension
. . . extension extension:preferred I 0..1 Extension Which name is preferred for this language
. . . . id 0..1 string Unique id for inter-element referencing
.... extension I 0..0
... . url 1..1 uri "preferred"
. . . valueBoolean . value[x] 0..1 I 1..1 boolean Value of extension
. . . value[x] I 0 .. 0
. . . . valueBase64Binary base64Binary
.... valueBoolean boolean
.... valueCanonical canonical (Any)
.... valueCode code
.... valueDate date
.... valueDateTime dateTime
.... valueDecimal decimal
.... valueId id
.... valueInstant instant
.... valueInteger integer
.... valueInteger64 integer64
.... valueMarkdown markdown
.... valueOid oid
.... 0)"> valuePositiveInt style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class=hierarchy> style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class=hierarchy> style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class=hierarchy> href=datatypes.html#positiveInt> positiveInt style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class=hierarchy>
.... valueString string
.... valueTime time
.... = 0)"> valueUnsignedInt style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class=hierarchy> style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class=hierarchy> style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class=hierarchy> href=datatypes.html#unsignedInt> unsignedInt style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class=hierarchy>
.... valueUri uri
.... valueUrl url
.... valueUuid uuid
.... valueAddress Address
.... valueAge Age
.... valueAnnotation Annotation
.... valueAttachment Attachment
.... valueCodeableConcept CodeableConcept
.... valueCoding Coding
.... valueContactPoint ContactPoint
.... valueCount Count
.... valueDistance Distance
.... valueDuration Duration
.... valueHumanName HumanName
.... valueIdentifier Identifier
.... valueMoney Money
.... valuePeriod Period
.... valueQuantity Quantity
.... valueRange Range
.... valueRatio Ratio
.... 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
.... valueMeta Meta

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]"/><!-- ?? 1..1 Value of extension -->

 </extension>
 <
  <

 <extension url="preferred"> ?? 0..1 Extension  <!-- ?? 0..1 Which name is preferred for this language -->
  <valueBoolean value="[boolean]"/><!-- ?? 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 // C? R! 

        // from Element: extension
        "
        ],

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

        "url" : "name", // R! 
        "

        "valueString" : "<string>" // C? R! Value of extension

      },
      { // 

      { // Which name is preferred for this language // C?

        // from Element: extension
        "
        ],

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

        "url" : "preferred", // R! 
        "

        "valueBoolean" : <boolean> // C? R! Value of extension

      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/valueset-otherName", // R! 
// value[x]: Value of extension. One of these 51:
  }

Summary

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


Use on element: Element ID ValueSet
. . . 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/valueset-otherName
otherName: Human readable names for the valueset.


Use on element: Element ID ValueSet
. . . extension I 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... extension:name I 1..1 Extension Human readable, short and specific
. . . . id 0..1 string Unique id for inter-element referencing
.... extension I 0..0
.... url 1..1 uri "name"
. . . . valueString value[x] I 0..1 1..1 string Value of extension
. . . extension extension:preferred I 0..1 Extension Which name is preferred for this language
. . . . id 0..1 string Unique id for inter-element referencing
.... extension I 0..0
... . url 1..1 uri "preferred"
. . . valueBoolean . value[x] 0..1 I 1..1 boolean Value of extension
. . . value[x] I 0 .. 0
. . . . valueBase64Binary base64Binary
.... valueBoolean boolean
.... valueCanonical canonical (Any)
.... valueCode code
.... valueDate date
.... valueDateTime dateTime
.... valueDecimal decimal
.... valueId id
.... valueInstant instant
.... valueInteger integer
.... valueInteger64 integer64
.... valueMarkdown markdown
.... valueOid oid
.... 0)"> valuePositiveInt style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class=hierarchy> style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class=hierarchy> style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class=hierarchy> href=datatypes.html#positiveInt> positiveInt style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class=hierarchy>
.... valueString string
.... valueTime time
.... = 0)"> valueUnsignedInt style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class=hierarchy> style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class=hierarchy> style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class=hierarchy> href=datatypes.html#unsignedInt> unsignedInt style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class=hierarchy>
.... valueUri uri
.... valueUrl url
.... valueUuid uuid
.... valueAddress Address
.... valueAge Age
.... valueAnnotation Annotation
.... valueAttachment Attachment
.... valueCodeableConcept CodeableConcept
.... valueCoding Coding
.... valueContactPoint ContactPoint
.... valueCount Count
.... valueDistance Distance
.... valueDuration Duration
.... valueHumanName HumanName
.... valueIdentifier Identifier
.... valueMoney Money
.... valuePeriod Period
.... valueQuantity Quantity
.... valueRange Range
.... valueRatio Ratio
.... 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
.... valueMeta Meta

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]"/><!-- ?? 1..1 Value of extension -->

 </extension>
 <
  <

 <extension url="preferred"> ?? 0..1 Extension  <!-- ?? 0..1 Which name is preferred for this language -->
  <valueBoolean value="[boolean]"/><!-- ?? 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 // C? R! 

        // from Element: extension
        "
        ],

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

        "url" : "name", // R! 
        "

        "valueString" : "<string>" // C? R! Value of extension

      },
      { // 

      { // Which name is preferred for this language // C?

        // from Element: extension
        "
        ],

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

        "url" : "preferred", // R! 
        "

        "valueBoolean" : <boolean> // C? R! Value of extension

      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/valueset-otherName", // R! 
// value[x]: Value of extension. One of these 51:
  }

 

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 )