Current Build

Extension-originaltext.xml

FHIR Infrastructure Work GroupMaturity Level: N/AStandards Status: Informative

Raw XML (canonical form + also see XML Format Specification)

Original Text

<?xml version="1.0" encoding="UTF-8"?>

<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="originalText"/> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="fhir"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="1"/> 
  </extension> 
  <url value="http://hl7.org/fhir/StructureDefinition/originalText"/> 
  <version value="4.1.0"/> 
  <name value="Original Text"/> 
  <title value="Original Text"/> 
  <status value="draft"/> 
  <date value="2013-12-05"/> 
  <publisher value="Health Level Seven International (FHIR Infrastructure)"/> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://www.hl7.org/Special/committees/fiwg"/> 
    </telecom> 
  </contact> 
  <description value="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](narrative.html))."/> 
  <fhirVersion value="4.1.0"/> 
  <mapping> 
    <identity value="rim"/> 
    <uri value="http://hl7.org/v3"/> 
    <name value="RIM Mapping"/> 
  </mapping> 
  <kind value="complex-type"/> 
  <abstract value="false"/> 
  <context> 
    <type value="element"/> 
    <expression value="Element"/> 
  </context> 
  <type value="Extension"/> 
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension"/> 
  <derivation value="constraint"/> 
  <snapshot> 
    <element id="Extension">
      <path value="Extension"/> 
      <short value="Original Text that represents the data as seen/selected/uttered originally"/> 
      <definition value="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](narrative.html))."/> 
      <comment value="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 &quot;what did the user actually see/type&quot;.
       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](extension-n
      arrativelink.html) which does not claim that the data is derived from the text."/> 
      <min value="0"/> 
      <max value="1"/> 
      <base> 
        <path value="Extension"/> 
        <min value="0"/> 
        <max value="*"/> 
      </base> 
      <condition value="ele-1"/> 
      <constraint> 
        <key value="ele-1"/> 
        <severity value="error"/> 
        <human value="All FHIR elements must have a @value or children"/> 
        <expression value="hasValue() or (children().count() &gt; id.count())"/> 
        <xpath value="@value|f:*|h:div"/> 
        <source value="Element"/> 
      </constraint> 
      <constraint> 
        <key value="ext-1"/> 
        <severity value="error"/> 
        <human value="Must have either extensions or value[x], not both"/> 
        <expression value="extension.exists() != value.exists()"/> 
        <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"/> 
        <source value="Extension"/> 
      </constraint> 
      <isModifier value="false"/> 
    </element> 
    <element id="Extension.id">
      <path value="Extension.id"/> 
      <representation value="xmlAttr"/> 
      <short value="Unique id for inter-element referencing"/> 
      <definition value="Unique id for the element within a resource (for internal references). This may be any
       string value that does not contain spaces."/> 
      <min value="0"/> 
      <max value="1"/> 
      <base> 
        <path value="Element.id"/> 
        <min value="0"/> 
        <max value="1"/> 
      </base> 
      <type> 
        <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
          <valueCode value="string"/> 
        </extension> 
        <code value="http://hl7.org/fhirpath/System.String"/> 
      </type> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
      <mapping> 
        <identity value="rim"/> 
        <map value="n/a"/> 
      </mapping> 
    </element> 
    <element id="Extension.extension">
      <path value="Extension.extension"/> 
      <slicing> 
        <discriminator> 
          <type value="value"/> 
          <path value="url"/> 
        </discriminator> 
        <description value="Extensions are always sliced by (at least) url"/> 
        <rules value="open"/> 
      </slicing> 
      <short value="Extension"/> 
      <definition value="An Extension"/> 
      <min value="0"/> 
      <max value="0"/> 
      <base> 
        <path value="Element.extension"/> 
        <min value="0"/> 
        <max value="*"/> 
      </base> 
      <type> 
        <code value="Extension"/> 
      </type> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
    </element> 
    <element id="Extension.url">
      <path value="Extension.url"/> 
      <representation value="xmlAttr"/> 
      <short value="identifies the meaning of the extension"/> 
      <definition value="Source of the definition for the extension code - a logical name or a URL."/> 
      <comment value="The definition may point directly to a computable or human-readable definition of the
       extensibility codes, or it may be a logical URI as declared in some other specification.
       The definition SHALL be a URI for the Structure Definition defining the extension."/> 
      <min value="1"/> 
      <max value="1"/> 
      <base> 
        <path value="Extension.url"/> 
        <min value="1"/> 
        <max value="1"/> 
      </base> 
      <type> 
        <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
          <valueCode value="url"/> 
        </extension> 
        <code value="http://hl7.org/fhirpath/System.String"/> 
      </type> 
      <fixedUri value="http://hl7.org/fhir/StructureDefinition/originalText"/> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
      <mapping> 
        <identity value="rim"/> 
        <map value="N/A"/> 
      </mapping> 
    </element> 
    <element id="Extension.value[x]">
      <path value="Extension.value[x]"/> 
      <slicing> 
        <discriminator> 
          <type value="type"/> 
          <path value="$this"/> 
        </discriminator> 
        <ordered value="false"/> 
        <rules value="closed"/> 
      </slicing> 
      <short value="Value of extension"/> 
      <definition value="Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensi
      bility.html) for a list)."/> 
      <min value="0"/> 
      <max value="1"/> 
      <base> 
        <path value="Extension.value[x]"/> 
        <min value="0"/> 
        <max value="1"/> 
      </base> 
      <type> 
        <code value="string"/> 
      </type> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
      <mapping> 
        <identity value="rim"/> 
        <map value="N/A"/> 
      </mapping> 
    </element> 
    <element id="Extension.value[x]:valueString">
      <path value="Extension.value[x]"/> 
      <sliceName value="valueString"/> 
      <short value="Value of extension"/> 
      <definition value="Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensi
      bility.html) for a list)."/> 
      <min value="0"/> 
      <max value="1"/> 
      <base> 
        <path value="Extension.value[x]"/> 
        <min value="0"/> 
        <max value="1"/> 
      </base> 
      <type> 
        <code value="string"/> 
      </type> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
      <mapping> 
        <identity value="rim"/> 
        <map value="N/A"/> 
      </mapping> 
    </element> 
  </snapshot> 
  <differential> 
    <element id="Extension">
      <path value="Extension"/> 
      <short value="Original Text that represents the data as seen/selected/uttered originally"/> 
      <definition value="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](narrative.html))."/> 
      <comment value="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 &quot;what did the user actually see/type&quot;.
       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](extension-n
      arrativelink.html) which does not claim that the data is derived from the text."/> 
      <min value="0"/> 
      <max value="1"/> 
    </element> 
    <element id="Extension.extension">
      <path value="Extension.extension"/> 
      <max value="0"/> 
    </element> 
    <element id="Extension.url">
      <path value="Extension.url"/> 
      <fixedUri value="http://hl7.org/fhir/StructureDefinition/originalText"/> 
    </element> 
    <element id="Extension.valueString">
      <path value="Extension.valueString"/> 
      <type> 
        <code value="string"/> 
      </type> 
    </element> 
  </differential> 
</StructureDefinition> 

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.