FHIR Release 3 (STU) 4

This page is part of the FHIR Specification (v3.0.2: (v4.0.1: R4 - Mixed Normative and STU 3). ) in it's permanent home (it will always be available at this URL). 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 R4 R3

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

Value of extension
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 I 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
. . . extension extension:lang I 1..1 Extension Code for Language
. . . . extension I 0..0
. . . . url 1..1 uri "lang" "lang"
. . . valueCode . value[x] I 0..1 1..1 code Value of extension
Binding: Common Languages ( extensible preferred )
Max Binding: All Languages
. . . extension extension:content I 1..1 Extension Content in other Language
. . . . extension I 0..0
. . . . url 1..1 uri "content" "content"
. . . . value[x] I 1..1 Value of extension
..... valueString string ,
. . . . . valueMarkdown markdown
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/translation" "http://hl7.org/fhir/StructureDefinition/translation"
. . . value[x] I 0 .. 0
. . . . valueBase64Binary base64Binary
.... valueBoolean boolean
.... valueCanonical canonical ()
.... valueCode code
.... valueDate date
.... valueDateTime dateTime
.... valueDecimal decimal
.... valueId id
.... valueInstant instant
.... valueInteger integer
.... valueMarkdown markdown
.... valueOid oid
.... valuePositiveInt positiveInt
.... valueString string
.... valueTime time
.... valueUnsignedInt unsignedInt
.... valueUri uri
.... valueUrl url
.... valueUuid uuid
.... valueAddress Address
.... valueAge Age
.... valueAnnotation Annotation
.... valueAttachment Attachment
.... valueCodeableConcept CodeableConcept
.... valueCoding Coding
.... valueContactPoint ContactPoint
.... valueCount Count
.... valueDistance Distance
.... valueDuration Duration
.... valueHumanName HumanName
.... valueIdentifier Identifier
.... valueMoney Money
.... valuePeriod Period
.... valueQuantity Quantity
.... valueRange Range
.... valueRatio Ratio
.... valueReference Reference ()
.... valueSampledData SampledData
.... valueSignature Signature
.... valueTiming Timing
.... valueContactDetail ContactDetail
.... valueContributor Contributor
.... valueDataRequirement DataRequirement
.... valueExpression Expression
.... valueParameterDefinition ParameterDefinition
.... valueRelatedArtifact RelatedArtifact
.... valueTriggerDefinition TriggerDefinition
.... valueUsageContext UsageContext
.... valueDosage Dosage
.... valueMeta Meta

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]"/><!-- ?? 1..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 // C? R! 

        // from Element: extension
        "
        ],

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

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

        "valueCode" : "<code>" // C? R! Value of extension

      },
      { //  

      { // Content in other Language // C? 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>" // C? R! Value of extension
        "valueMarkdown" : "<markdown>", // C? R! Value of extension

      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/translation", // R! 


// value[x]: Value of extension. One of these 50:
  }

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

Value of extension
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 I 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
. . . extension extension:lang I 1..1 Extension Code for Language
. . . . extension I 0..0
. . . . url 1..1 uri "lang" "lang"
. . . valueCode . value[x] I 0..1 1..1 code Value of extension
Binding: Common Languages ( extensible preferred )
Max Binding: All Languages
. . . extension extension:content I 1..1 Extension Content in other Language
. . . . extension I 0..0
. . . . url 1..1 uri "content" "content"
. . . . value[x] I 1..1 Value of extension
..... valueString string ,
. . . . . valueMarkdown markdown
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/translation" "http://hl7.org/fhir/StructureDefinition/translation"
. . . value[x] I 0 .. 0
. . . . valueBase64Binary base64Binary
.... valueBoolean boolean
.... valueCanonical canonical ()
.... valueCode code
.... valueDate date
.... valueDateTime dateTime
.... valueDecimal decimal
.... valueId id
.... valueInstant instant
.... valueInteger integer
.... valueMarkdown markdown
.... valueOid oid
.... valuePositiveInt positiveInt
.... valueString string
.... valueTime time
.... valueUnsignedInt unsignedInt
.... valueUri uri
.... valueUrl url
.... valueUuid uuid
.... valueAddress Address
.... valueAge Age
.... valueAnnotation Annotation
.... valueAttachment Attachment
.... valueCodeableConcept CodeableConcept
.... valueCoding Coding
.... valueContactPoint ContactPoint
.... valueCount Count
.... valueDistance Distance
.... valueDuration Duration
.... valueHumanName HumanName
.... valueIdentifier Identifier
.... valueMoney Money
.... valuePeriod Period
.... valueQuantity Quantity
.... valueRange Range
.... valueRatio Ratio
.... valueReference Reference ()
.... valueSampledData SampledData
.... valueSignature Signature
.... valueTiming Timing
.... valueContactDetail ContactDetail
.... valueContributor Contributor
.... valueDataRequirement DataRequirement
.... valueExpression Expression
.... valueParameterDefinition ParameterDefinition
.... valueRelatedArtifact RelatedArtifact
.... valueTriggerDefinition TriggerDefinition
.... valueUsageContext UsageContext
.... valueDosage Dosage
.... valueMeta Meta

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]"/><!-- ?? 1..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 // C? R! 

        // from Element: extension
        "
        ],

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

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

        "valueCode" : "<code>" // C? R! Value of extension

      },
      { //  

      { // Content in other Language // C? 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>" // C? R! Value of extension
        "valueMarkdown" : "<markdown>", // C? R! Value of extension

      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/translation", // R! 


// value[x]: Value of extension. One of these 50:
  }

 

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 )