FHIR Release 3 (STU)

This page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R4B R4 R3

Extension: Translation

FHIR Infrastructure Work Group Maturity Level: 1InformativeUse Context: Any

URL for this extension: 

http://hl7.org/fhir/StructureDefinition/translation

Status: draft. Extension maintained by: Health Level Seven International (FHIR Infrastructure)

Language translation from base language of resource to another language.

Context of Use: Use on data type: string, code, markdown

usage info: insert a list of places where this extension is used

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/translation
Translation: Language translation from base language of resource to another language.
Use on data type: string, code, markdown
... lang1..1codeCode for Language.
... content1..1string, markdownContent in other Language.

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/translation
Translation: Language translation from base language of resource to another language.
Use on data type: string, code, markdown
... extension 1..1ExtensionCode for Language
.... url 1..1uri"lang"
.... valueCode 0..1codeValue of extension
Binding: Common Languages (extensible)
... extension 1..1ExtensionContent in other Language
.... url 1..1uri"content"
.... value[x] 1..1string, markdownValue of extension
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/translation"
... value[x] 0..0

doco Documentation for this format

XML Template

<!-- Translation -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/translation" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="lang"> 1..1 Extension  <!-- 1..1 Code for Language -->
  <valueCode value="[code]"/><!-- 0..1 Value of extension -->
 </extension>
 <extension url="content"> 1..1 Extension  <!-- 1..1 Content in other Language -->
  <value[x]><!-- 1..1 string|markdown 
      Value of extension --></value[x]>
 </extension>
</extension>

JSON Template

{ // Translation
    "extension" : [ //  sliced by value:url  in the specified orderOpen
      { // Code for Language // R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified orderOpen
        ],
        "url" : "lang", // R! 
        "valueCode" : "<code>" //Value of extension
      },
      { // Content in other Language // R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified orderOpen
        ],
        "url" : "content", // R! 
// value[x]: Value of extension. One of these 2:
        "valueString" : "<string>" // R! Value of extension
        "valueMarkdown" : "<markdown>", // R! Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/translation", // R! 
// value[x]: Value of extension. One of these 38:
  }

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/translation
Translation: Language translation from base language of resource to another language.
Use on data type: string, code, markdown
... lang1..1codeCode for Language.
... content1..1string, markdownContent in other Language.

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/translation
Translation: Language translation from base language of resource to another language.
Use on data type: string, code, markdown
... extension 1..1ExtensionCode for Language
.... url 1..1uri"lang"
.... valueCode 0..1codeValue of extension
Binding: Common Languages (extensible)
... extension 1..1ExtensionContent in other Language
.... url 1..1uri"content"
.... value[x] 1..1string, markdownValue of extension
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/translation"
... value[x] 0..0

doco Documentation for this format

XML Template

<!-- Translation -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/translation" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="lang"> 1..1 Extension  <!-- 1..1 Code for Language -->
  <valueCode value="[code]"/><!-- 0..1 Value of extension -->
 </extension>
 <extension url="content"> 1..1 Extension  <!-- 1..1 Content in other Language -->
  <value[x]><!-- 1..1 string|markdown 
      Value of extension --></value[x]>
 </extension>
</extension>

JSON Template

{ // Translation
    "extension" : [ //  sliced by value:url  in the specified orderOpen
      { // Code for Language // R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified orderOpen
        ],
        "url" : "lang", // R! 
        "valueCode" : "<code>" //Value of extension
      },
      { // Content in other Language // R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified orderOpen
        ],
        "url" : "content", // R! 
// value[x]: Value of extension. One of these 2:
        "valueString" : "<string>" // R! Value of extension
        "valueMarkdown" : "<markdown>", // R! Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/translation", // R! 
// value[x]: Value of extension. One of these 38:
  }

 

Constraints

  • ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div)
  • ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]))