Release 5 Draft Ballot

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions

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

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.

Context of Use: Use on Element ID ValueSet

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. otherName0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/valueset-otherName
otherName: 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
... name1..1stringA natural language name identifying the value set. This name should be usable as an identifier for the module by machine processing applications such as code generation.

... preferred0..1booleanFlag that this Name in this Name Language is the preferred machine-processing friendly signifier in this language.


doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/valueset-otherName
otherName: 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..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:name 1..1ExtensionSupport human navigation and code generation.
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"name"
.... value[x] 1..1stringValue of extension
... extension:preferred 0..1ExtensionWhich name is preferred for this language
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"preferred"
.... value[x] 1..1booleanValue of extension
... value[x] 0..0
.... valueBase64Binarybase64Binary
.... valueBooleanboolean
.... valueCanonicalcanonical(Any)
.... valueCodecode
.... valueDatedate
.... valueDateTimedateTime
.... valueDecimaldecimal
.... valueIdid
.... valueInstantinstant
.... valueIntegerinteger
.... valueInteger64integer64
.... valueMarkdownmarkdown
.... valueOidoid
.... valuePositiveIntpositiveInt
.... valueStringstring
.... valueTimetime
.... valueUnsignedIntunsignedInt
.... valueUriuri
.... valueUrlurl
.... valueUuiduuid
.... valueAddressAddress
.... valueAgeAge
.... valueAnnotationAnnotation
.... valueAttachmentAttachment
.... valueCodeableConceptCodeableConcept
.... valueCodingCoding
.... valueContactPointContactPoint
.... valueCountCount
.... valueDistanceDistance
.... valueDurationDuration
.... valueHumanNameHumanName
.... valueIdentifierIdentifier
.... valueMoneyMoney
.... valuePeriodPeriod
.... valueQuantityQuantity
.... valueRangeRange
.... valueRatioRatio
.... valueReferenceReference(Any)
.... valueSampledDataSampledData
.... valueSignatureSignature
.... valueTimingTiming
.... valueContactDetailContactDetail
.... valueContributorContributor
.... valueDataRequirementDataRequirement
.... valueExpressionExpression
.... valueParameterDefinitionParameterDefinition
.... valueRelatedArtifactRelatedArtifact
.... valueTriggerDefinitionTriggerDefinition
.... valueUsageContextUsageContext
.... valueDosageDosage
.... valueMetaMeta

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 Support human navigation and code generation. -->
  <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 
      { // Support human navigation and code generation. // 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

NameFlagsCard.TypeDescription & Constraintsdoco
.. otherName0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/valueset-otherName
otherName: 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
... name1..1stringA natural language name identifying the value set. This name should be usable as an identifier for the module by machine processing applications such as code generation.

... preferred0..1booleanFlag that this Name in this Name Language is the preferred machine-processing friendly signifier in this language.


doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/valueset-otherName
otherName: 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..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:name 1..1ExtensionSupport human navigation and code generation.
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"name"
.... value[x] 1..1stringValue of extension
... extension:preferred 0..1ExtensionWhich name is preferred for this language
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"preferred"
.... value[x] 1..1booleanValue of extension
... value[x] 0..0
.... valueBase64Binarybase64Binary
.... valueBooleanboolean
.... valueCanonicalcanonical(Any)
.... valueCodecode
.... valueDatedate
.... valueDateTimedateTime
.... valueDecimaldecimal
.... valueIdid
.... valueInstantinstant
.... valueIntegerinteger
.... valueInteger64integer64
.... valueMarkdownmarkdown
.... valueOidoid
.... valuePositiveIntpositiveInt
.... valueStringstring
.... valueTimetime
.... valueUnsignedIntunsignedInt
.... valueUriuri
.... valueUrlurl
.... valueUuiduuid
.... valueAddressAddress
.... valueAgeAge
.... valueAnnotationAnnotation
.... valueAttachmentAttachment
.... valueCodeableConceptCodeableConcept
.... valueCodingCoding
.... valueContactPointContactPoint
.... valueCountCount
.... valueDistanceDistance
.... valueDurationDuration
.... valueHumanNameHumanName
.... valueIdentifierIdentifier
.... valueMoneyMoney
.... valuePeriodPeriod
.... valueQuantityQuantity
.... valueRangeRange
.... valueRatioRatio
.... valueReferenceReference(Any)
.... valueSampledDataSampledData
.... valueSignatureSignature
.... valueTimingTiming
.... valueContactDetailContactDetail
.... valueContributorContributor
.... valueDataRequirementDataRequirement
.... valueExpressionExpression
.... valueParameterDefinitionParameterDefinition
.... valueRelatedArtifactRelatedArtifact
.... valueTriggerDefinitionTriggerDefinition
.... valueUsageContextUsageContext
.... valueDosageDosage
.... valueMetaMeta

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 Support human navigation and code generation. -->
  <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 
      { // Support human navigation and code generation. // 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)