FHIR Extensions Pack
5.3.0-ballot-tc1 - (September 2025 Ballot) International flag

This page is part of the FHIR Core Extensions Registry (v5.3.0-ballot-tc1: Release 5.3) based on FHIR (HL7® FHIR® Standard) v5.0.0. This version is a pre-release. The current official version is 5.2.0. For a full list of available versions, see the Directory of published versions

Extension: Text Link

Official URL: http://hl7.org/fhir/StructureDefinition/textLink Version: 5.3.0-ballot-tc1
Standards status: Trial-use Maturity Level: 3 Computable Name: TextLink
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1691

Used to denote which portions of the narrative are linked to (usually, generated from) structured data in resources. This information might be used in several different ways, including translating and regenerating narrative in applications that are using/presenting the narrative. Note that there are two related extensions for linking data and narrative: originalText and narrativeLink.

Context of Use

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

Usage info

Usages:

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

You can also check for usages in the FHIR IG Statistics

Changes since version 5.2.0:

  • New Content

    • 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: Used to denote which portions of the narrative are linked to (usually, generated from) structured data in resources. This information might be used in several different ways, including translating and regenerating narrative in applications that are using/presenting the narrative. Note that there are two related extensions for linking data and narrative: originalText and narrativeLink.

    • htmlid: string: The id attribute on an element in the xhtml narrative
    • data: uri: The id attribute on a resource element (#{id}, relative#{id} or https://absolute#{id})
    • selector: string: FHIRPath that selects a subset of the identified data. This sub-extension exists because in some circumstances, the specific data items are in resources where the constructor of the narrative can't introduce specific ids on the relevent elements

    Maturity: 3

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..1 Extension Text Link
    ... Slices for extension Content/Rules for all slices
    .... extension:htmlid 1..* Extension Unique identifier
    ..... extension 0..0
    ..... url 1..1 uri "htmlid"
    ..... value[x] 1..1 string Value of extension
    .... extension:data 1..1 Extension Unique identifier
    ..... extension 0..0
    ..... url 1..1 uri "data"
    ..... value[x] 1..1 uri The actual data element in this resource, or another resource
    .... extension:selector 0..1 Extension FHIRPath that selects a subset of the identified data
    ..... extension 0..0
    ..... url 1..1 uri "selector"
    ..... value[x] 1..1 string Simple FHIRPath that can't use .resolve()
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/textLink"
    ... value[x] 0..0

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Complex Extension: Used to denote which portions of the narrative are linked to (usually, generated from) structured data in resources. This information might be used in several different ways, including translating and regenerating narrative in applications that are using/presenting the narrative. Note that there are two related extensions for linking data and narrative: originalText and narrativeLink.

    • htmlid: string: The id attribute on an element in the xhtml narrative
    • data: uri: The id attribute on a resource element (#{id}, relative#{id} or https://absolute#{id})
    • selector: string: FHIRPath that selects a subset of the identified data. This sub-extension exists because in some circumstances, the specific data items are in resources where the constructor of the narrative can't introduce specific ids on the relevent elements

    Maturity: 3

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..1 Extension Text Link
    ... Slices for extension Content/Rules for all slices
    .... extension:htmlid 1..* Extension Unique identifier
    ..... extension 0..0
    ..... url 1..1 uri "htmlid"
    ..... value[x] 1..1 string Value of extension
    .... extension:data 1..1 Extension Unique identifier
    ..... extension 0..0
    ..... url 1..1 uri "data"
    ..... value[x] 1..1 uri The actual data element in this resource, or another resource
    .... extension:selector 0..1 Extension FHIRPath that selects a subset of the identified data
    ..... extension 0..0
    ..... url 1..1 uri "selector"
    ..... value[x] 1..1 string Simple FHIRPath that can't use .resolve()
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/textLink"
    ... value[x] 0..0

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..1 Extension Text Link
    ... 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:htmlid 1..* Extension Unique identifier
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "htmlid"
    ..... value[x] 1..1 string Value of extension
    .... extension:data 1..1 Extension Unique identifier
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "data"
    ..... value[x] 1..1 uri The actual data element in this resource, or another resource
    .... extension:selector 0..1 Extension FHIRPath that selects a subset of the identified data
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "selector"
    ..... value[x] 1..1 string Simple FHIRPath that can't use .resolve()
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/textLink"

    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()

    R4B

    The extension is unchanged in R4B

    R4

    The extension is unchanged in R4

    R3

    The extension is unchanged in R3

    Search Parameters for this Extension

    (none found)