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: Translation

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

Language translation from base language of resource to another language, used to provide translations for strings, including markdown. Generally, the type of the translation extension SHOULD match that of the element being extended.

It is also allowed to provide translations of elements of type code, which may be appropriate to use for rendering when the code itself is a natural language word (usually in English). In such cases, the translation is not provided as an alternative code, and is not intended for machine interpretation. This extension should never appear on a code that is part of a Coding, as placing the translation on Coding.display is more appropriate.

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:

  • The resource metadata has changed (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: Language translation from base language of resource to another language, used to provide translations for strings, including markdown. Generally, the type of the translation extension SHOULD match that of the element being extended. It is also allowed to provide translations of elements of type code, which may be appropriate to use for rendering when the code itself is a natural language word (usually in English). In such cases, the translation is not provided as an alternative code, and is not intended for machine interpretation. This extension should never appear on a code that is part of a Coding, as placing the translation on Coding.display is more appropriate.

    • lang: code: Code for Language.
    • content: string, markdown: Content in other Language.

    Maturity: 3

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..* Extension Language Translation (Localization)
    ... Slices for extension Content/Rules for all slices
    .... extension:lang 1..1 Extension Code for Language
    ..... extension 0..0
    ..... url 1..1 uri "lang"
    ..... value[x] 1..1 code Value of extension
    Binding: AllLanguages (required): IETF language tag for a human language
    Additional BindingsPurpose
    CommonLanguages Starter
    .... extension:content 1..1 Extension Content in other Language
    ..... extension 0..0
    ..... url 1..1 uri "content"
    ..... value[x] 1..1 Value of extension
    ...... valueString string
    ...... valueMarkdown markdown
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/translation"
    ... value[x] 0..0

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..* Extension Language Translation (Localization)
    ... 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:lang 1..1 Extension Code for Language
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "lang"
    ..... value[x] 1..1 code Value of extension
    Binding: AllLanguages (required): IETF language tag for a human language
    Additional BindingsPurpose
    CommonLanguages Starter
    .... extension:content 1..1 Extension Content in other Language
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "content"
    ..... value[x] 1..1 Value of extension
    ...... valueString string
    ...... valueMarkdown markdown
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/translation"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Complex Extension: Language translation from base language of resource to another language, used to provide translations for strings, including markdown. Generally, the type of the translation extension SHOULD match that of the element being extended. It is also allowed to provide translations of elements of type code, which may be appropriate to use for rendering when the code itself is a natural language word (usually in English). In such cases, the translation is not provided as an alternative code, and is not intended for machine interpretation. This extension should never appear on a code that is part of a Coding, as placing the translation on Coding.display is more appropriate.

    • lang: code: Code for Language.
    • content: string, markdown: Content in other Language.

    Maturity: 3

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..* Extension Language Translation (Localization)
    ... Slices for extension Content/Rules for all slices
    .... extension:lang 1..1 Extension Code for Language
    ..... extension 0..0
    ..... url 1..1 uri "lang"
    ..... value[x] 1..1 code Value of extension
    Binding: AllLanguages (required): IETF language tag for a human language
    Additional BindingsPurpose
    CommonLanguages Starter
    .... extension:content 1..1 Extension Content in other Language
    ..... extension 0..0
    ..... url 1..1 uri "content"
    ..... value[x] 1..1 Value of extension
    ...... valueString string
    ...... valueMarkdown markdown
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/translation"
    ... value[x] 0..0

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..* Extension Language Translation (Localization)
    ... 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:lang 1..1 Extension Code for Language
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "lang"
    ..... value[x] 1..1 code Value of extension
    Binding: AllLanguages (required): IETF language tag for a human language
    Additional BindingsPurpose
    CommonLanguages Starter
    .... extension:content 1..1 Extension Content in other Language
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "content"
    ..... value[x] 1..1 Value of extension
    ...... valueString string
    ...... valueMarkdown markdown
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/translation"

    doco Documentation for this format

     

    Other representations of profile: CSV, Excel, Schematron

    Terminology Bindings

    PathConformanceValueSetURI
    Extension.extension:lang.value[x]requiredAllLanguages
    http://hl7.org/fhir/ValueSet/all-languages
    From the FHIR Standard

    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)