Release 4B Ballot #1

This page is part of the FHIR Specification (v4.1.0: Release 4B Ballot #1). 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

Extension: Original Text

FHIR Infrastructure Work Group

Maturity Level: 1

Informative

Use Context: Any

URL for this extension:

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

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

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).

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.

Context of Use: Use on Element ID Element

Summary

Name	Flags	Card.	Type	Description & Constraints
Original Text		0..1	string	URL = http://hl7.org/fhir/StructureDefinition/originalText Original Text: 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). Use on Element ID Element
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/originalText Original Text: 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). Use on Element ID Element
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/originalText"
value[x]	1..1	string	Value of extension
Documentation for this format

XML Template

<!-- Original Text -->

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

JSON Template

{ // Original Text
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/originalText", // R! 
    "valueString" : "<string>" // C? R! Value of extension
  }

Summary

Name	Flags	Card.	Type	Description & Constraints
Original Text		0..1	string	URL = http://hl7.org/fhir/StructureDefinition/originalText Original Text: 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). Use on Element ID Element
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/originalText Original Text: 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). Use on Element ID Element
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/originalText"
value[x]	1..1	string	Value of extension
Documentation for this format

XML Template

<!-- Original Text -->

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

JSON Template

{ // Original Text
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/originalText", // R! 
    "valueString" : "<string>" // C? R! Value of extension
  }

Constraints

ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (xpath: @value|f:*|h:div|self::f:Parameters)
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.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: @value|f:*|h:div)