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 in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Extension: Terminology Resource Identifier Metadata

Official URL: http://hl7.org/fhir/StructureDefinition/terminology-resource-identifier-metadata Version: 5.1.0
Standards status: Trial-use Maturity Level: 2 Responsible: HL7 International / Terminology Infrastructure Computable Name: TxResourceIdentifierMetadata
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1141

Additional metadata in identifier elements for terminology resources.

Context of Use

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

  • Element ID CodeSystem.identifier
  • Element ID ValueSet.identifier
  • Element ID ConceptMap.identifier

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: Additional metadata in identifier elements for terminology resources.

    • preferred: boolean: Indicates whether this identifier is a 'preferred' identifier
    • authoritative: boolean: Indicates whether this identifier is an 'authoritative' identifier
    • comment: string: Text to explain the use of the additional metadata values.

    Maturity: 2

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension Additional metadata in identifier elements for terminology resources.
    ... Slices for extension Content/Rules for all slices
    .... extension:preferred 0..1 Extension Whether this an identifier that should be used
    ..... extension 0..0
    ..... url 1..1 uri "preferred"
    ..... value[x] 1..1 boolean Value of extension
    .... extension:authoritative 0..1 Extension Whether this identifier is considered to be authoritative
    ..... extension 0..0
    ..... url 1..1 uri "authoritative"
    ..... value[x] 1..1 boolean Value of extension
    .... extension:comment 0..1 Extension Text to explain the use of the additional metadata values.
    ..... extension 0..0
    ..... url 1..1 uri "comment"
    ..... value[x] 1..1 string Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/terminology-resource-identifier-metadata"
    ... value[x] 0..0

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension Additional metadata in identifier elements for terminology resources.
    ... id 0..1 id Unique id for inter-element referencing
    ... Slices for extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... extension:preferred 0..1 Extension Whether this an identifier that should be used
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "preferred"
    ..... value[x] 1..1 boolean Value of extension
    .... extension:authoritative 0..1 Extension Whether this identifier is considered to be authoritative
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "authoritative"
    ..... value[x] 1..1 boolean Value of extension
    .... extension:comment 0..1 Extension Text to explain the use of the additional metadata values.
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "comment"
    ..... value[x] 1..1 string Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/terminology-resource-identifier-metadata"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Complex Extension: Additional metadata in identifier elements for terminology resources.

    • preferred: boolean: Indicates whether this identifier is a 'preferred' identifier
    • authoritative: boolean: Indicates whether this identifier is an 'authoritative' identifier
    • comment: string: Text to explain the use of the additional metadata values.

    Maturity: 2

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension Additional metadata in identifier elements for terminology resources.
    ... Slices for extension Content/Rules for all slices
    .... extension:preferred 0..1 Extension Whether this an identifier that should be used
    ..... extension 0..0
    ..... url 1..1 uri "preferred"
    ..... value[x] 1..1 boolean Value of extension
    .... extension:authoritative 0..1 Extension Whether this identifier is considered to be authoritative
    ..... extension 0..0
    ..... url 1..1 uri "authoritative"
    ..... value[x] 1..1 boolean Value of extension
    .... extension:comment 0..1 Extension Text to explain the use of the additional metadata values.
    ..... extension 0..0
    ..... url 1..1 uri "comment"
    ..... value[x] 1..1 string Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/terminology-resource-identifier-metadata"
    ... value[x] 0..0

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension Additional metadata in identifier elements for terminology resources.
    ... id 0..1 id Unique id for inter-element referencing
    ... Slices for extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... extension:preferred 0..1 Extension Whether this an identifier that should be used
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "preferred"
    ..... value[x] 1..1 boolean Value of extension
    .... extension:authoritative 0..1 Extension Whether this identifier is considered to be authoritative
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "authoritative"
    ..... value[x] 1..1 boolean Value of extension
    .... extension:comment 0..1 Extension Text to explain the use of the additional metadata values.
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "comment"
    ..... value[x] 1..1 string Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/terminology-resource-identifier-metadata"

    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)