• Content
• Detailed Descriptions
• Mappings
• XML
• JSON

Extension: Original Text

Context of Use: Use on Element ID Element

Definition

A human language representation of the concept (resource/element) as seen/selected/uttered by the user who entered the data and/or which represents the full intended meaning of the user. This can be provided either directly as text, or as a url that is a reference to a portion of the narrative of a resource (DomainResource.text or Composition.section.text). When it a url, the value should end with a #{id} where the id identifies a specific portion of the referenced content (via an XHTML id attribute).

Comment:

The data in the element does not always capture the correct meaning with all the nuances of the original text. In these cases, the text is used to capture the full meaning of the source. This is commonly used to provide "what did the user actually see/type". Note that this extension has the same definition as CodeableConcept.text and SHALL NOT be used on CodeableConcept with type = string in place of CodeableConcept.text but MAY be used with type url. If present on a CodeableConcept with type url as well as CodeableConcept.text, then the CodeableConcept.text SHALL match the referenced narrative.

It's also possible to link to the resource narrative using the narrativeLink extension which does not claim that the data is derived from the text.

Extension Content

• Summary
• Full Structure
• XML
• JSON
• All

Summary

Name	Flags	Card.	Type	Description & Constraints
OriginalText		0..1	string, url	URL = http://hl7.org/fhir/StructureDefinition/originalText OriginalText: A human language representation of the concept (resource/element) as seen/selected/uttered by the user who entered the data and/or which represents the full intended meaning of the user. This can be provided either directly as text, or as a url that is a reference to a portion of the narrative of a resource (DomainResource.text or Composition.section.text). When it a url, the value should end with a #{id} where the id identifies a specific portion of the referenced content (via an XHTML id attribute). Use on Element ID Element
Documentation for this format

Full Structure

Name	Flags	Card.	Type	Description & Constraints
extension		0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/originalText OriginalText: A human language representation of the concept (resource/element) as seen/selected/uttered by the user who entered the data and/or which represents the full intended meaning of the user. This can be provided either directly as text, or as a url that is a reference to a portion of the narrative of a resource (DomainResource.text or Composition.section.text). When it a url, the value should end with a #{id} where the id identifies a specific portion of the referenced content (via an XHTML id attribute). Use on Element ID Element
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/originalText"
value[x]		1..1		Value of extension
valueString			string
valueUrl			url
Documentation for this format

XML Template

<!-- OriginalText -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/originalText" >
  <!-- from Element: extension -->
 <value[x]><!-- I 1..1 string|url Value of extension --></value[x]>
</extension>

JSON Template

{ // OriginalText
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
  // extension: Extension: Prohibited
    "url" : "http://hl7.org/fhir/StructureDefinition/originalText", // R! 
  // value[x]: Value of extension. One of these 2:
    "valueString" : "<string>", // I R! Value of extension
    "valueUrl" : "<url>" // I R! Value of extension
  }

Summary

Name	Flags	Card.	Type	Description & Constraints
OriginalText		0..1	string, url	URL = http://hl7.org/fhir/StructureDefinition/originalText OriginalText: A human language representation of the concept (resource/element) as seen/selected/uttered by the user who entered the data and/or which represents the full intended meaning of the user. This can be provided either directly as text, or as a url that is a reference to a portion of the narrative of a resource (DomainResource.text or Composition.section.text). When it a url, the value should end with a #{id} where the id identifies a specific portion of the referenced content (via an XHTML id attribute). Use on Element ID Element
Documentation for this format

Full Structure

Name	Flags	Card.	Type	Description & Constraints
extension		0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/originalText OriginalText: A human language representation of the concept (resource/element) as seen/selected/uttered by the user who entered the data and/or which represents the full intended meaning of the user. This can be provided either directly as text, or as a url that is a reference to a portion of the narrative of a resource (DomainResource.text or Composition.section.text). When it a url, the value should end with a #{id} where the id identifies a specific portion of the referenced content (via an XHTML id attribute). Use on Element ID Element
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/originalText"
value[x]		1..1		Value of extension
valueString			string
valueUrl			url
Documentation for this format

XML Template

<!-- OriginalText -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/originalText" >
  <!-- from Element: extension -->
 <value[x]><!-- I 1..1 string|url Value of extension --></value[x]>
</extension>

JSON Template

{ // OriginalText
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
  // extension: Extension: Prohibited
    "url" : "http://hl7.org/fhir/StructureDefinition/originalText", // R! 
  // value[x]: Value of extension. One of these 2:
    "valueString" : "<string>", // I R! Value of extension
    "valueUrl" : "<url>" // I R! Value of extension
  }

Constraints

• ele-1: All FHIR elements must have a @value or children (xpath: hasValue() or (children().count() > id.count()))
• ext-1: Must have either extensions or value[x], not both (xpath: extension.exists() != value.exists())
• ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: hasValue() or (children().count() > id.count()))
• ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: extension.exists() != value.exists())
• ele-1: On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: hasValue() or (children().count() > id.count()))

Search

Examples of this extension

No examples found.