This page is part of the FHIR Specification (v4.2.0: R5 Preview #1). 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

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON

Extension: alternate

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

Extension Content

• Summary
• Full Structure
• XML
• JSON
• All

Summary

Name	Flags	Card.	Type	Description & Constraints
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.
Documentation for this format

Full Structure

Name	Flags	Card.	Type	Description & Constraints
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	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:code	I	1..1	Extension	Code that represents the concept
id		0..1	string	Unique id for inter-element referencing
extension	I	0..0
url		1..1	uri	"code"
value[x]	I	1..1	code	Value of extension
extension:use	I	1..1	Extension	Expected use of the code
id		0..1	string	Unique id for inter-element referencing
extension	I	0..0
url		1..1	uri	"use"
value[x]	I	1..1	Coding	Value of extension Binding: AlternativeCodeKind (extensible)
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/codesystem-alternate"
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
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
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
Documentation for this format

XML Template

<!-- alternate -->

<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]"/><!--  1..1 Value of extension -->
 </extension>
 <extension url="use">  1..1 Extension  <!--  1..1 Expected use of the code -->
  <valueCoding><!--  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 // C? R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "code", // R! 
        "valueCode" : "<code>" // C? R! Value of extension
      },
      { // Expected use of the code // C? R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "use", // R! 
        "valueCoding" : { Coding } // C? R! Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/codesystem-alternate", // R! 
// value[x]: Value of extension. One of these 51:
  }

Summary

Name	Flags	Card.	Type	Description & Constraints
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.
Documentation for this format

Full Structure

Name	Flags	Card.	Type	Description & Constraints
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	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:code	I	1..1	Extension	Code that represents the concept
id		0..1	string	Unique id for inter-element referencing
extension	I	0..0
url		1..1	uri	"code"
value[x]	I	1..1	code	Value of extension
extension:use	I	1..1	Extension	Expected use of the code
id		0..1	string	Unique id for inter-element referencing
extension	I	0..0
url		1..1	uri	"use"
value[x]	I	1..1	Coding	Value of extension Binding: AlternativeCodeKind (extensible)
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/codesystem-alternate"
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
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
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
Documentation for this format

XML Template

<!-- alternate -->

<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]"/><!--  1..1 Value of extension -->
 </extension>
 <extension url="use">  1..1 Extension  <!--  1..1 Expected use of the code -->
  <valueCoding><!--  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 // C? R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "code", // R! 
        "valueCode" : "<code>" // C? R! Value of extension
      },
      { // Expected use of the code // C? R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "use", // R! 
        "valueCoding" : { Coding } // C? R! Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/codesystem-alternate", // 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)