FHIR Release 3 (STU) Current Build
This page is part of FHIR STU 3 (v3.0.1) in it's permanent home (it will always be available at this URL). It has been superceded by R4 . For a full list of available versions, see the Directory of published versions .

Extension: Translation

FHIR Infrastructure Work Group   Maturity Level : 1 Informative Use 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: Element ID string, code, Element ID code or Element ID markdown

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

Extension Content

Summary

Name Flags Card. Type Description & Constraints doco
. . extension Translation 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/translation
Translation: Language translation from base language of resource to another language.


Use on data type: Element ID string, code, Element ID code or Element ID markdown
. . . lang 1..1 code Code for Language.

. . . content 1..1 string , markdown Content in other Language.


doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/translation
Translation: Language translation from base language of resource to another language.


Use on data type: Element ID string, code, Element ID code or Element ID markdown
. . . extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
. . . extension 1..1 Extension Code for Language
. . . . extension 0..0
... . url 1..1 uri "lang"
. . . . valueCode 0..1 code Value of extension
Binding: Common Languages ( extensible preferred )
Max Binding: All Languages
. . . extension 1..1 Extension Content in other Language
. . . . extension 0..0
... . url 1..1 uri "content"
. . . . value[x] 1..1 string , markdown Value of extension
. . . url 1..1 uri "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 order, Open 

      { // Code for Language // R! 
        // from Element: extension
        "
        ],

        "extension" : [ //  sliced by value:url  in the specified order, Open ]

        "url" : "lang", // R! 
        "

        "valueCode" : "<code>" //Value of extension

      },
      { // Content in other Language // R! 
        // from Element: extension
        "
        ],

        "extension" : [ //  sliced by value:url  in the specified order, Open ]

        "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 49:
  }

Summary

Name Flags Card. Type Description & Constraints doco
. . extension Translation 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/translation
Translation: Language translation from base language of resource to another language.


Use on data type: Element ID string, code, Element ID code or Element ID markdown
. . . lang 1..1 code Code for Language.

. . . content 1..1 string , markdown Content in other Language.


doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/translation
Translation: Language translation from base language of resource to another language.


Use on data type: Element ID string, code, Element ID code or Element ID markdown
. . . extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
. . . extension 1..1 Extension Code for Language
. . . . extension 0..0
... . url 1..1 uri "lang"
. . . . valueCode 0..1 code Value of extension
Binding: Common Languages ( extensible preferred )
Max Binding: All Languages
. . . extension 1..1 Extension Content in other Language
. . . . extension 0..0
... . url 1..1 uri "content"
. . . . value[x] 1..1 string , markdown Value of extension
. . . url 1..1 uri "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 order, Open 

      { // Code for Language // R! 
        // from Element: extension
        "
        ],

        "extension" : [ //  sliced by value:url  in the specified order, Open ]

        "url" : "lang", // R! 
        "

        "valueCode" : "<code>" //Value of extension

      },
      { // Content in other Language // R! 
        // from Element: extension
        "
        ],

        "extension" : [ //  sliced by value:url  in the specified order, Open ]

        "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 49:
  }

 

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')]) )