FHIR Extensions Pack
5.2.0 - February 2025 International flag

This page is part of the FHIR Core Extensions Registry (v5.2.0: Release 5.2) 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 KeyWord

Official URL: http://hl7.org/fhir/StructureDefinition/codesystem-keyWord Version: 5.2.0
Standards status: Deprecated Maturity Level: 3 Responsible: HL7 International / Terminology Infrastructure Computable Name: CSKeyWord
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1132

Word or words used in an information retrieval system to indicate the content of the code system.

Context of Use

This extension is deprecated and should no longer be used

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

Usage info

Usage:

  • Search Parameters using this Extension: Keyword
  • 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

    Simple Extension of type string: Word or words used in an information retrieval system to indicate the content of the code system.

    Maturity: 3

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension Descriptors and key terms for search
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/codesystem-keyWord"
    ... value[x] 1..1 string Value of extension

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension Descriptors and key terms for search
    ... id 0..1 id Unique id for inter-element referencing
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/codesystem-keyWord"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Simple Extension of type string: Word or words used in an information retrieval system to indicate the content of the code system.

    Maturity: 3

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension Descriptors and key terms for search
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/codesystem-keyWord"
    ... value[x] 1..1 string Value of extension

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension Descriptors and key terms for search
    ... id 0..1 id Unique id for inter-element referencing
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/codesystem-keyWord"

    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