R4 Ballot #1 #2 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.3.0: (v3.5.0: R4 Ballot 2). #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

Extension: alternate

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

URL for this extension: 


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

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

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

Extension Content

Summary

Name Flags Card. Type Description & Constraints doco
. . extension alternate 0..* Extension URL = 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
. . . code 1..1 code The code that may be used to represent the concept.

. . . use 1..1 Coding Defines why this additional code is defined.


doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..* Extension URL = 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
. . . extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
. . . extension 1..1 Extension Code that represents the concept
. . . . extension 0..0
. . . . url 1..1 uri "code"
. . . . valueCode 0..1 code Value of extension
. . . extension 1..1 Extension Expected use of the code
. . . . extension 0..0
. . . . url 1..1 uri "use"
. . . . valueCoding 0..1 Coding Value of extension
Binding: AlternativeCodeKind ( extensible )
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/codesystem-alternate"
. . . 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"> 1..1 Extension  <!-- 1..1 Code that represents the concept -->
  <valueCode value="[code]"/><!-- 0..1 Value of extension -->
 </extension>
 <extension url="use"> 1..1 Extension  <!-- 1..1 Expected use of the code -->
  <valueCoding><!-- 0..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 // R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "code", // R! 
        "valueCode" : "<code>" //Value of extension
      },
      { // Expected use of the code // R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "use", // R! 
        "valueCoding" : { Coding } //Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/codesystem-alternate", // R! 


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

Summary

Name Flags Card. Type Description & Constraints doco
. . extension alternate 0..* Extension URL = 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
. . . code 1..1 code The code that may be used to represent the concept.

. . . use 1..1 Coding Defines why this additional code is defined.


doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..* Extension URL = 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
. . . extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
. . . extension 1..1 Extension Code that represents the concept
. . . . extension 0..0
. . . . url 1..1 uri "code"
. . . . valueCode 0..1 code Value of extension
. . . extension 1..1 Extension Expected use of the code
. . . . extension 0..0
. . . . url 1..1 uri "use"
. . . . valueCoding 0..1 Coding Value of extension
Binding: AlternativeCodeKind ( extensible )
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/codesystem-alternate"
. . . 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"> 1..1 Extension  <!-- 1..1 Code that represents the concept -->
  <valueCode value="[code]"/><!-- 0..1 Value of extension -->
 </extension>
 <extension url="use"> 1..1 Extension  <!-- 1..1 Expected use of the code -->
  <valueCoding><!-- 0..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 // R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "code", // R! 
        "valueCode" : "<code>" //Value of extension
      },
      { // Expected use of the code // R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "use", // R! 
        "valueCoding" : { Coding } //Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/codesystem-alternate", // R! 


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

 

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