Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). 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

Summary

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

Version: 5.0.0-ballot

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

Summary

Name	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	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
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
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
valueCodeableReference		CodeableReference
valueCoding		Coding
valueContactPoint		ContactPoint
valueCount		Count
valueDistance		Distance
valueDuration		Duration
valueHumanName		HumanName
valueIdentifier		Identifier
valueMoney		Money
valuePeriod		Period
valueQuantity		Quantity
valueRange		Range
valueRatio		Ratio
valueRatioRange		RatioRange
valueReference		Reference(Any)
valueSampledData		SampledData
valueSignature		Signature
valueTiming		Timing
valueContactDetail		ContactDetail
valueDataRequirement		DataRequirement
valueExpression		Expression
valueParameterDefinition		ParameterDefinition
valueRelatedArtifact		RelatedArtifact
valueTriggerDefinition		TriggerDefinition
valueUsageContext		UsageContext
valueAvailability		Availability
valueExtendedContactDetail		ExtendedContactDetail
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"> 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

Name	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	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
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
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
valueCodeableReference		CodeableReference
valueCoding		Coding
valueContactPoint		ContactPoint
valueCount		Count
valueDistance		Distance
valueDuration		Duration
valueHumanName		HumanName
valueIdentifier		Identifier
valueMoney		Money
valuePeriod		Period
valueQuantity		Quantity
valueRange		Range
valueRatio		Ratio
valueRatioRange		RatioRange
valueReference		Reference(Any)
valueSampledData		SampledData
valueSignature		Signature
valueTiming		Timing
valueContactDetail		ContactDetail
valueDataRequirement		DataRequirement
valueExpression		Expression
valueParameterDefinition		ParameterDefinition
valueRelatedArtifact		RelatedArtifact
valueTriggerDefinition		TriggerDefinition
valueUsageContext		UsageContext
valueAvailability		Availability
valueExtendedContactDetail		ExtendedContactDetail
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"> 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.