FHIR Extensions Pack
5.2.0-ballot - 5.2.0 Ballot - September 2024) International flag

This page is part of the FHIR Core Extensions Registry (v5.2.0-ballot: Release 5.2) based on FHIR (HL7® FHIR® Standard) v5.0.0. The current version which supersedes this version is 5.1.0. For a full list of available versions, see the Directory of published versions

Extension: CodeSystem Usage

Official URL: http://hl7.org/fhir/StructureDefinition/codesystem-usage Version: 5.2.0-ballot
Standards status: Trial-use Maturity Level: 3 Responsible: HL7 International / Terminology Infrastructure Computable Name: CSUsage
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1131

Consumers of the code system and the implementations, projects or standards that the author has used the code system in. The use of this extension in no way restricts the use of the code system.

Context of Use

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

  • Element ID CodeSystem

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, description)
  • The data elements list has changed
  • One or more text definitions, invariants or bindings have changed

    • 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: Consumers of the code system and the implementations, projects or standards that the author has used the code system in. The use of this extension in no way restricts the use of the code system.

    • user: string: This is most likely to be an organization but can be an individual. It would not be a program, that information should be recorded in the usage.use.
    • use: string: A descriptive name of the project or standard in which the code system is used.

    Maturity: 3

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension Who has used and how?
    ... Slices for extension Content/Rules for all slices
    .... extension:user 1..1 Extension A consumer of or client for the code system
    ..... extension 0..0
    ..... url 1..1 uri "user"
    ..... value[x] 1..1 string Value of extension
    .... extension:use 1..1 Extension Implementation/project/standard that uses the code system
    ..... extension 0..0
    ..... url 1..1 uri "use"
    ..... value[x] 1..1 string Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/codesystem-usage"
    ... value[x] 0..0

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension Who has used and how?
    ... 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:user 1..1 Extension A consumer of or client for the code system
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "user"
    ..... value[x] 1..1 string Value of extension
    .... extension:use 1..1 Extension Implementation/project/standard that uses the code system
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "use"
    ..... value[x] 1..1 string Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/codesystem-usage"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Complex Extension: Consumers of the code system and the implementations, projects or standards that the author has used the code system in. The use of this extension in no way restricts the use of the code system.

    • user: string: This is most likely to be an organization but can be an individual. It would not be a program, that information should be recorded in the usage.use.
    • use: string: A descriptive name of the project or standard in which the code system is used.

    Maturity: 3

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension Who has used and how?
    ... Slices for extension Content/Rules for all slices
    .... extension:user 1..1 Extension A consumer of or client for the code system
    ..... extension 0..0
    ..... url 1..1 uri "user"
    ..... value[x] 1..1 string Value of extension
    .... extension:use 1..1 Extension Implementation/project/standard that uses the code system
    ..... extension 0..0
    ..... url 1..1 uri "use"
    ..... value[x] 1..1 string Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/codesystem-usage"
    ... value[x] 0..0

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension Who has used and how?
    ... 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:user 1..1 Extension A consumer of or client for the code system
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "user"
    ..... value[x] 1..1 string Value of extension
    .... extension:use 1..1 Extension Implementation/project/standard that uses the code system
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "use"
    ..... value[x] 1..1 string Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/codesystem-usage"

    doco Documentation for this format

     

    Other representations of profile: CSV, Excel, Schematron

    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)