Release 4 5 Snapshot #1

This page is part of the FHIR Specification (v4.0.1: R4 - Mixed Normative and STU ) in it's permanent home (it will always be available at this URL). (v5.0.0-snapshot1: Release 5 Snapshot #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

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

Extension Content

Summary

Name Flags Card. Type Description & Constraints doco
. . 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

I I
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
. . . Slices for 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
. . . extension . id I 0..0 0..1 string Unique id for inter-element referencing
.... Slices for 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 string Unique id for inter-element referencing
. . . . Slices for extension I 0..0
. . . . url 1..1 uri "use"
. . . . value[x] I 1..1 Coding Value of extension
Binding: AlternativeCodeKind ( extensible ) ): Indicates the type of use for which the code is defined.

. . . 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
. . . . valueMarkdown valueInteger64 markdown integer64
. . . . valueOid valueMarkdown oid markdown
. . . . valuePositiveInt valueOid positiveInt oid
. . . . valueString valuePositiveInt string positiveInt
. . . . valueTime valueString time string
. . . . valueUnsignedInt valueTime unsignedInt time
. . . . valueUri valueUnsignedInt uri unsignedInt
. . . . valueUrl valueUri url uri
. . . . valueUuid valueUrl url
.... valueUuid uuid
. . . . valueAddress Address
. . . . valueAddress valueAge Address Age
. . . . valueAge valueAnnotation Age Annotation
. . . . valueAnnotation valueAttachment Annotation Attachment
. . . . valueAttachment valueCodeableConcept Attachment CodeableConcept
. . . . valueCodeableConcept valueCodeableReference CodeableConcept 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
. . . valueReference . valueRatioRange Reference RatioRange ()
. . . valueSampledData . valueReference SampledData Reference (Any)
. . . . valueSignature valueSampledData Signature SampledData
. . . . valueTiming valueSignature Timing Signature
. . . . valueContactDetail valueTiming ContactDetail Timing
. . . . valueContributor valueContactDetail Contributor ContactDetail
. . . . valueDataRequirement valueContributor DataRequirement Contributor
. . . . valueExpression valueDataRequirement Expression DataRequirement
. . . . valueParameterDefinition valueExpression ParameterDefinition Expression
. . . . valueRelatedArtifact valueParameterDefinition RelatedArtifact ParameterDefinition
. . . . valueTriggerDefinition valueRelatedArtifact TriggerDefinition RelatedArtifact
. . . . valueUsageContext valueTriggerDefinition UsageContext TriggerDefinition
. . . . valueDosage valueUsageContext Dosage UsageContext
. . . . valueMeta valueDosage Dosage
.... valueMeta Meta

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]"/><!-- ?? 1..1 Value of extension -->

 </extension>
 <extension url="use"> ?? 1..1 Extension  <!-- ?? 1..1 Expected use of the code -->
  <</valueCoding>

  <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 53:
  }

Summary

Name Flags Card. Type Description & Constraints doco
. . 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

I I
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
. . . Slices for 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
. . . extension . id I 0..0 0..1 string Unique id for inter-element referencing
.... Slices for 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 string Unique id for inter-element referencing
. . . . Slices for extension I 0..0
. . . . url 1..1 uri "use"
. . . . value[x] I 1..1 Coding Value of extension
Binding: AlternativeCodeKind ( extensible ) ): Indicates the type of use for which the code is defined.

. . . 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
. . . . valueMarkdown valueInteger64 markdown integer64
. . . . valueOid valueMarkdown oid markdown
. . . . valuePositiveInt valueOid positiveInt oid
. . . . valueString valuePositiveInt string positiveInt
. . . . valueTime valueString time string
. . . . valueUnsignedInt valueTime unsignedInt time
. . . . valueUri valueUnsignedInt uri unsignedInt
. . . . valueUrl valueUri url uri
. . . . valueUuid valueUrl url
.... valueUuid uuid
. . . . valueAddress Address
. . . . valueAddress valueAge Address Age
. . . . valueAge valueAnnotation Age Annotation
. . . . valueAnnotation valueAttachment Annotation Attachment
. . . . valueAttachment valueCodeableConcept Attachment CodeableConcept
. . . . valueCodeableConcept valueCodeableReference CodeableConcept 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
. . . valueReference . valueRatioRange Reference RatioRange ()
. . . valueSampledData . valueReference SampledData Reference (Any)
. . . . valueSignature valueSampledData Signature SampledData
. . . . valueTiming valueSignature Timing Signature
. . . . valueContactDetail valueTiming ContactDetail Timing
. . . . valueContributor valueContactDetail Contributor ContactDetail
. . . . valueDataRequirement valueContributor DataRequirement Contributor
. . . . valueExpression valueDataRequirement Expression DataRequirement
. . . . valueParameterDefinition valueExpression ParameterDefinition Expression
. . . . valueRelatedArtifact valueParameterDefinition RelatedArtifact ParameterDefinition
. . . . valueTriggerDefinition valueRelatedArtifact TriggerDefinition RelatedArtifact
. . . . valueUsageContext valueTriggerDefinition UsageContext TriggerDefinition
. . . . valueDosage valueUsageContext Dosage UsageContext
. . . . valueMeta valueDosage Dosage
.... valueMeta Meta

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]"/><!-- ?? 1..1 Value of extension -->

 </extension>
 <extension url="use"> ?? 1..1 Extension  <!-- ?? 1..1 Expected use of the code -->
  <</valueCoding>

  <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 53:
  }

 

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 )