FHIR CI-Build

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

Extension: alternate

Vocabulary Work Group Maturity Level: 1InformativeUse Context: Any

Summary

Defining URL:http://hl7.org/fhir/StructureDefinition/codesystem-alternate
Version:5.0.0-cibuild
Name:alternate
Title:null
Modifier:This extension is not a modifier extension
Status:draft
Definition:An additional code that may be used to represent the concept.
Committee:Vocabulary Work Group

Status: draft. Extension maintained by: HL7

An additional code that may be used to represent the concept.

Comment:

Few coding systems define synonyms. A few more define alternate codes for special case use.

Context of Use: Use on Element ID CodeSystem.concept

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. alternate0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/codesystem-alternate
alternate: An additional code that may be used to represent the concept.


Use on Element ID CodeSystem.concept
... code1..1codeCode that represents the concept

... use1..1CodingExpected use of the code

Binding: AlternativeCodeKind (extensible): Indicates the type of use for which the code is defined.



doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/codesystem-alternate
alternate: An additional code that may be used to represent the concept.


Use on Element ID CodeSystem.concept
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:code 1..1ExtensionCode that represents the concept
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"code"
.... value[x] 1..1codeValue of extension
... extension:use 1..1ExtensionExpected use of the code
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"use"
.... value[x] 1..1CodingValue of extension
Binding: AlternativeCodeKind (extensible): Indicates the type of use for which the code is defined.

... value[x] 0..0

doco Documentation for this format

XML Template

<!-- alternate -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/codesystem-alternate" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="code"> I 1..1 Extension  <!-- I 1..1 Code that represents the concept -->
  <valueCode value="[code]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="use"> I 1..1 Extension  <!-- I 1..1 Expected use of the code -->
  <valueCoding><!-- I 1..1 Coding Value of extension --></valueCoding>
 </extension>
</extension>

JSON Template

{ // alternate
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // Code that represents the concept // I R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "code", // R! 
        "valueCode" : "<code>" // I R! Value of extension
      },
      { // Expected use of the code // I R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "use", // R! 
        "valueCoding" : { Coding } // I R! Value of extension
      }
    ],
    "extension" : [{ Extension }], // IAdditional content defined by implementations
    "extension" : { Extension }, // I R! Code that represents the concept
    "extension" : { Extension }, // I R! Expected use of the code
    "url" : "http://hl7.org/fhir/StructureDefinition/codesystem-alternate" // R! 
  // value[x]: Value of extension: Prohibited
  }

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. alternate0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/codesystem-alternate
alternate: An additional code that may be used to represent the concept.


Use on Element ID CodeSystem.concept
... code1..1codeCode that represents the concept

... use1..1CodingExpected use of the code

Binding: AlternativeCodeKind (extensible): Indicates the type of use for which the code is defined.



doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/codesystem-alternate
alternate: An additional code that may be used to represent the concept.


Use on Element ID CodeSystem.concept
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:code 1..1ExtensionCode that represents the concept
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"code"
.... value[x] 1..1codeValue of extension
... extension:use 1..1ExtensionExpected use of the code
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"use"
.... value[x] 1..1CodingValue of extension
Binding: AlternativeCodeKind (extensible): Indicates the type of use for which the code is defined.

... value[x] 0..0

doco Documentation for this format

XML Template

<!-- alternate -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/codesystem-alternate" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="code"> I 1..1 Extension  <!-- I 1..1 Code that represents the concept -->
  <valueCode value="[code]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="use"> I 1..1 Extension  <!-- I 1..1 Expected use of the code -->
  <valueCoding><!-- I 1..1 Coding Value of extension --></valueCoding>
 </extension>
</extension>

JSON Template

{ // alternate
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // Code that represents the concept // I R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "code", // R! 
        "valueCode" : "<code>" // I R! Value of extension
      },
      { // Expected use of the code // I R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "use", // R! 
        "valueCoding" : { Coding } // I R! Value of extension
      }
    ],
    "extension" : [{ Extension }], // IAdditional content defined by implementations
    "extension" : { Extension }, // I R! Code that represents the concept
    "extension" : { Extension }, // I R! Expected use of the code
    "url" : "http://hl7.org/fhir/StructureDefinition/codesystem-alternate" // R! 
  // value[x]: Value of extension: Prohibited
  }

 

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)

Search

No Search Extensions defined for this resource

Examples of this extension

No examples found.