Clinical Document Architecture
2.0.1-sd - release

Clinical Document Architecture, published by Health Level 7. This guide is not an authorized publication; it is the continuous build for version 2.0.1-sd built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-core-sd/ and changes regularly. See the Directory of published versions

Logical Model: ST - XML Profile

Active as of 2024-12-18

XML representation of the ST logical model.

Raw xml | Download


<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="ST"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p>The character string data type stands for text data, primarily intended for machine processing (e.g., sorting, querying, indexing, etc.) Used for names, symbols, and formal expressions.</p>
    </div>
  </text>
  <extension
             url="http://hl7.org/fhir/tools/StructureDefinition/logical-target">
    <valueBoolean>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/data-absent-reason">
        <valueCode value="not-applicable"/>
      </extension>
    </valueBoolean>
  </extension>
  <extension
             url="http://hl7.org/fhir/tools/StructureDefinition/xml-namespace">
    <valueUri value="urn:hl7-org:v3"/>
  </extension>
  <extension
             url="http://hl7.org/fhir/tools/StructureDefinition/logical-container">
    <valueUri
              value="http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument"/>
  </extension>
  <url value="http://hl7.org/cda/stds/core/StructureDefinition/ST"/>
  <version value="2.0.1-sd"/>
  <name value="ST"/>
  <title value="ST: CharacterString (V3 Data Type)"/>
  <status value="active"/>
  <experimental value="false"/>
  <date value="2024-12-18T02:39:25+00:00"/>
  <publisher value="Health Level 7"/>
  <contact>
    <name value="HL7 International - Structured Documents"/>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/structure"/>
    </telecom>
    <telecom>
      <system value="email"/>
      <value value="structdog@lists.HL7.org"/>
    </telecom>
  </contact>
  <description
               value="The character string data type stands for text data, primarily intended for machine processing (e.g., sorting, querying, indexing, etc.) Used for names, symbols, and formal expressions."/>
  <fhirVersion value="5.0.0"/>
  <mapping>
    <identity value="rim"/>
    <uri value="http://hl7.org/v3"/>
    <name value="RIM Mapping"/>
  </mapping>
  <kind value="logical"/>
  <abstract value="false"/>
  <type value="http://hl7.org/cda/stds/core/StructureDefinition/ST"/>
  <baseDefinition
                  value="http://hl7.org/cda/stds/core/StructureDefinition/ANY"/>
  <derivation value="specialization"/>
  <snapshot>
    <element id="ST">
      <path value="ST"/>
      <short value="Base for all types and resources"/>
      <definition
                  value="The character string data type stands for text data, primarily intended for machine processing (e.g., sorting, querying, indexing, etc.) Used for names, symbols, and formal expressions."/>
      <min value="1"/>
      <max value="*"/>
      <base>
        <path value="Base"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <constraint>
        <key value="text-null"/>
        <severity value="error"/>
        <human
               value="xmlText and nullFlavor are mutually exclusive (one must be present)"/>
        <expression value="(xmlText | nullFlavor).count() = 1"/>
      </constraint>
      <isModifier value="false"/>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element id="ST.nullFlavor">
      <path value="ST.nullFlavor"/>
      <representation value="xmlAttr"/>
      <label value="Exceptional Value Detail"/>
      <definition
                  value="If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="ANY.nullFlavor"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="code"/>
        <profile
                 value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
      </type>
      <binding>
        <strength value="required"/>
        <valueSet
                  value="http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"/>
      </binding>
    </element>
    <element id="ST.representation">
      <path value="ST.representation"/>
      <representation value="xmlAttr"/>
      <definition
                  value="Specifies the representation of the binary data that is the content of the binary data value"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="ST.representation"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="code"/>
        <profile
                 value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
      </type>
      <fixedCode value="TXT"/>
    </element>
    <element id="ST.mediaType">
      <path value="ST.mediaType"/>
      <representation value="xmlAttr"/>
      <label value="Media Type"/>
      <definition
                  value="Identifies the type of the encapsulated data and identifies a method to interpret or render the data."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="ST.mediaType"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="code"/>
        <profile
                 value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
      </type>
      <fixedCode value="text/plain"/>
    </element>
    <element id="ST.language">
      <path value="ST.language"/>
      <representation value="xmlAttr"/>
      <label value="Language"/>
      <definition
                  value="For character based information the language property specifies the human language of the text."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="ST.language"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="code"/>
        <profile
                 value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
      </type>
    </element>
    <element id="ST.xmlText">
      <path value="ST.xmlText"/>
      <representation value="xmlText"/>
      <short value="Allows for mixed text content"/>
      <comment
               value="This element is represented in XML as textual content. The actual name &quot;xmlText&quot; will not appear in a CDA instance."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="ST.xmlText"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
        <profile
                 value="http://hl7.org/cda/stds/core/StructureDefinition/st-simple"/>
      </type>
    </element>
  </snapshot>
  <differential>
    <element id="ST">
      <path value="ST"/>
      <definition
                  value="The character string data type stands for text data, primarily intended for machine processing (e.g., sorting, querying, indexing, etc.) Used for names, symbols, and formal expressions."/>
      <min value="1"/>
      <max value="*"/>
      <constraint>
        <key value="text-null"/>
        <severity value="error"/>
        <human
               value="xmlText and nullFlavor are mutually exclusive (one must be present)"/>
        <expression value="(xmlText | nullFlavor).count() = 1"/>
      </constraint>
    </element>
    <element id="ST.representation">
      <path value="ST.representation"/>
      <representation value="xmlAttr"/>
      <definition
                  value="Specifies the representation of the binary data that is the content of the binary data value"/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="code"/>
        <profile
                 value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
      </type>
      <fixedCode value="TXT"/>
    </element>
    <element id="ST.mediaType">
      <path value="ST.mediaType"/>
      <representation value="xmlAttr"/>
      <label value="Media Type"/>
      <definition
                  value="Identifies the type of the encapsulated data and identifies a method to interpret or render the data."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="code"/>
        <profile
                 value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
      </type>
      <fixedCode value="text/plain"/>
    </element>
    <element id="ST.language">
      <path value="ST.language"/>
      <representation value="xmlAttr"/>
      <label value="Language"/>
      <definition
                  value="For character based information the language property specifies the human language of the text."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="code"/>
        <profile
                 value="http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"/>
      </type>
    </element>
    <element id="ST.xmlText">
      <path value="ST.xmlText"/>
      <representation value="xmlText"/>
      <short value="Allows for mixed text content"/>
      <comment
               value="This element is represented in XML as textual content. The actual name &quot;xmlText&quot; will not appear in a CDA instance."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="string"/>
        <profile
                 value="http://hl7.org/cda/stds/core/StructureDefinition/st-simple"/>
      </type>
    </element>
  </differential>
</StructureDefinition>