FHIR Extensions Pack
5.1.0 - 5.1.0 (April 2024) International flag

This page is part of the FHIR Core Extensions Registry (v5.1.0: Release 5.1) based on FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version. For a full list of available versions, see the Directory of published versions

Extension: CodeSystem Alternate

Official URL: http://hl7.org/fhir/StructureDefinition/codesystem-alternate Version: 5.1.0
Standards status: Trial-use Maturity Level: 3 Responsible: HL7 International / Terminology Infrastructure Computable Name: CSAlternate
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1130

An additional code that may be used to represent the concept.

Context of Use

This extension may be used on the following element(s):

  • Element ID CodeSystem.concept

Usage info

Usage:

  • This Extension is not used by any profiles in this Implementation Guide

Changes since version 1.0.0:

  • The resource metadata has changed (publisher)

    • Formal Views of Extension Content

    Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

    This structure is derived from Extension

    Summary

    Complex Extension: An additional code that may be used to represent the concept.

    • code: code: The code that may be used to represent the concept.
    • use: Coding: Defines why this additional code is defined.

    Maturity: 3

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension Additional code for the concept
    ... Slices for extension Content/Rules for all slices
    .... extension:code 1..1 Extension Code that represents the concept
    ..... 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
    ..... 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

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension Additional code for the concept
    ... id 0..1 id Unique id for inter-element referencing
    ... Slices for extension 2..* 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"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Complex Extension: An additional code that may be used to represent the concept.

    • code: code: The code that may be used to represent the concept.
    • use: Coding: Defines why this additional code is defined.

    Maturity: 3

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension Additional code for the concept
    ... Slices for extension Content/Rules for all slices
    .... extension:code 1..1 Extension Code that represents the concept
    ..... 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
    ..... 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

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension Additional code for the concept
    ... id 0..1 id Unique id for inter-element referencing
    ... Slices for extension 2..* 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"

    doco Documentation for this format

     

    Other representations of profile: CSV, Excel, Schematron

    Terminology Bindings

    PathConformanceValueSetURI
    Extension.extension:use.value[x]extensibleAlternativeCodeKind (a valid code from alternative code kind code system)
    http://hl7.org/fhir/ValueSet/codesystem-altcode-kind
    from this IG

    Constraints

    IdGradePath(s)DetailsRequirements
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()

    Search Parameters for this Extension

    (none found)