Snapshot 3: Connectathon 32 Base

This is Snapshot #3 for FHIR R5, released to support Connectathon 32. For a full list of available versions, see the Directory of published versions.

Extension: CodeSystem Alternate

Vocabulary Work Group

Maturity Level: 1

Trial Use

Use Context: Any

Official URL: `http://hl7.org/fhir/StructureDefinition/codesystem-alternate`				Version: 5.0.0-snapshot3
draft as of 2021-01-02				Computable Name: CSAlternate
Flags: Non-Modifier				OID: 2.16.840.1.113883.4.642.5.1130

Context of Use: Use on Element ID CodeSystem.concept

Definition

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.

Summary

Name	Card.	Type	Description & Constraints
CSAlternate	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/codesystem-alternate CSAlternate: An additional code that may be used to represent the concept. Use on Element ID CodeSystem.concept
code	1..1	code	Code that represents the concept
use	1..1	Coding	Expected use of the code Binding: AlternativeCodeKind (extensible): Indicates the type of use for which the code is defined.
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/codesystem-alternate CSAlternate: An additional code that may be used to represent the concept. Use on Element ID CodeSystem.concept
Slices for extension	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:code	1..1	Extension	Code that represents the concept
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"code"
value[x]	1..1	code	Value of extension
extension:use	1..1	Extension	Expected use of the code
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"use"
value[x]	1..1	Coding	Value of extension Binding: AlternativeCodeKind (extensible): Indicates the type of use for which the code is defined.
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/codesystem-alternate"
value[x]	0..0
Documentation for this format

XML Template

<!-- CSAlternate -->

<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

{ // CSAlternate
    "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

Name	Card.	Type	Description & Constraints
CSAlternate	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/codesystem-alternate CSAlternate: An additional code that may be used to represent the concept. Use on Element ID CodeSystem.concept
code	1..1	code	Code that represents the concept
use	1..1	Coding	Expected use of the code Binding: AlternativeCodeKind (extensible): Indicates the type of use for which the code is defined.
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/codesystem-alternate CSAlternate: An additional code that may be used to represent the concept. Use on Element ID CodeSystem.concept
Slices for extension	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:code	1..1	Extension	Code that represents the concept
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"code"
value[x]	1..1	code	Value of extension
extension:use	1..1	Extension	Expected use of the code
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"use"
value[x]	1..1	Coding	Value of extension Binding: AlternativeCodeKind (extensible): Indicates the type of use for which the code is defined.
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/codesystem-alternate"
value[x]	0..0
Documentation for this format

XML Template

<!-- CSAlternate -->

<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

{ // CSAlternate
    "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: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (xpath: extension.exists() != value.exists())
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: hasValue() or (children().count() > id.count()))
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: extension.exists() != value.exists())
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: hasValue() or (children().count() > id.count()))
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: extension.exists() != value.exists())
ele-1: On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: hasValue() or (children().count() > id.count()))
ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: extension.exists() != value.exists())
ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: hasValue() or (children().count() > id.count()))
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: hasValue() or (children().count() > id.count()))
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: extension.exists() != value.exists())
ele-1: On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: hasValue() or (children().count() > id.count()))
ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: extension.exists() != value.exists())
ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: hasValue() or (children().count() > id.count()))
ele-1: On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: hasValue() or (children().count() > id.count()))

Search

No Search Extensions defined for this resource

Examples of this extension

No examples found.