Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). 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: 1

Informative

Use Context: Any

Summary

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

Version: 5.0.0-ballot

Name: Translation

Title: Translation

Modifier: This extension is not a modifier extension

Status: draft

Definition: Language translation from base language of resource to another language.

Committee: FHIR Infrastructure Work Group

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 Element ID string, Element ID code or Element ID markdown

Summary

Name	Card.	Type	Description & Constraints
Translation	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/translation Translation: Language translation from base language of resource to another language. Use on Element ID string, Element ID code or Element ID markdown
lang	1..1	code	Code for Language.
content	1..1	string, markdown	Content in other Language.
Documentation for this format

Full Structure

Description & Constraints

extension

0..*

Extension

URL = http://hl7.org/fhir/StructureDefinition/translation
Translation: Language translation from base language of resource to another language.

Use on Element ID string, Element ID code or Element ID markdown

Slices for extension

0..*

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: Common Languages (preferred): IETF language tag

Additional Bindings

Purpose

1..1

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"

value[x]

0..0

valueBase64Binary

base64Binary

valueBoolean

boolean

valueCanonical

canonical(Any)

valueCode

valueDate

valueDateTime

valueDecimal

valueId

valueInstant

valueInteger

valueInteger64

valueMarkdown

valueOid

valuePositiveInt

valueString

valueTime

valueUnsignedInt

valueUri

valueUrl

valueUuid

valueAddress

valueAge

valueAnnotation

valueAttachment

valueCodeableConcept

valueCodeableReference

valueCoding

valueContactPoint

valueCount

valueDistance

valueDuration

valueHumanName

valueIdentifier

valueMoney

valuePeriod

valueQuantity

valueRange

valueRatio

valueRatioRange

valueReference

Reference(Any)

valueSampledData

valueSignature

valueTiming

valueContactDetail

valueDataRequirement

valueExpression

valueParameterDefinition

ParameterDefinition

valueRelatedArtifact

RelatedArtifact

valueTriggerDefinition

TriggerDefinition

valueUsageContext

UsageContext

valueAvailability

Availability

valueExtendedContactDetail

ExtendedContactDetail

valueDosage

Dosage

valueMeta

Meta

Documentation for this format

XML Template

<!-- Translation -->

<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"> I 1..1 Extension  <!-- I 1..1 Code for Language -->
  <valueCode value="[code]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="content"> I 1..1 Extension  <!-- I 1..1 Content in other Language -->
  <value[x]><!-- I 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 // I R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "lang", // R! 
        "valueCode" : "<code>" // I R! Value of extension
      },
      { // Content in other Language // I 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>", // I R! Value of extension
        "valueMarkdown" : "<markdown>", // I R! Value of extension
      },
    ],
    "extension" : [{ Extension }], // IAdditional content defined by implementations
    "extension" : { Extension }, // I R! Code for Language
    "extension" : { Extension }, // I R! Content in other Language
    "url" : "http://hl7.org/fhir/StructureDefinition/translation" // R! 
  // value[x]: Value of extension: Prohibited
  }

Summary

Name	Card.	Type	Description & Constraints
Translation	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/translation Translation: Language translation from base language of resource to another language. Use on Element ID string, Element ID code or Element ID markdown
lang	1..1	code	Code for Language.
content	1..1	string, markdown	Content in other Language.
Documentation for this format

Full Structure

Description & Constraints

extension

0..*

Extension

URL = http://hl7.org/fhir/StructureDefinition/translation
Translation: Language translation from base language of resource to another language.

Use on Element ID string, Element ID code or Element ID markdown

Slices for extension

0..*

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: Common Languages (preferred): IETF language tag

Additional Bindings

Purpose

1..1

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"

value[x]

0..0

valueBase64Binary

base64Binary

valueBoolean

boolean

valueCanonical

canonical(Any)

valueCode

valueDate

valueDateTime

valueDecimal

valueId

valueInstant

valueInteger

valueInteger64

valueMarkdown

valueOid

valuePositiveInt

valueString

valueTime

valueUnsignedInt

valueUri

valueUrl

valueUuid

valueAddress

valueAge

valueAnnotation

valueAttachment

valueCodeableConcept

valueCodeableReference

valueCoding

valueContactPoint

valueCount

valueDistance

valueDuration

valueHumanName

valueIdentifier

valueMoney

valuePeriod

valueQuantity

valueRange

valueRatio

valueRatioRange

valueReference

Reference(Any)

valueSampledData

valueSignature

valueTiming

valueContactDetail

valueDataRequirement

valueExpression

valueParameterDefinition

ParameterDefinition

valueRelatedArtifact

RelatedArtifact

valueTriggerDefinition

TriggerDefinition

valueUsageContext

UsageContext

valueAvailability

Availability

valueExtendedContactDetail

ExtendedContactDetail

valueDosage

Dosage

valueMeta

Meta

Documentation for this format

XML Template

<!-- Translation -->

<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"> I 1..1 Extension  <!-- I 1..1 Code for Language -->
  <valueCode value="[code]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="content"> I 1..1 Extension  <!-- I 1..1 Content in other Language -->
  <value[x]><!-- I 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 // I R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "lang", // R! 
        "valueCode" : "<code>" // I R! Value of extension
      },
      { // Content in other Language // I 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>", // I R! Value of extension
        "valueMarkdown" : "<markdown>", // I R! Value of extension
      },
    ],
    "extension" : [{ Extension }], // IAdditional content defined by implementations
    "extension" : { Extension }, // I R! Code for Language
    "extension" : { Extension }, // I R! Content in other Language
    "url" : "http://hl7.org/fhir/StructureDefinition/translation" // R! 
  // value[x]: Value of extension: Prohibited
  }

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')]))
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: @value|f:*|h:div)
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: @value|f:*|h:div)
ele-1: On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: @value|f:*|h:div)

Search

No Search Extensions defined for this resource

Examples of this extension

No examples found.