Clinical Document Architecture V2.0.1
2.1.0-draft1 - 1st Draft
Clinical Document Architecture V2.0.1
2.1.0-draft1 - 1st Draft
This page is part of the CDA: Clinical Document Architecture (v2.1.0-draft1: CDA 2.1 Draft) based on FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions 
| Active as of 2023-01-16 |
XML representation of the ST logical model.
<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/StructureDefinition/elementdefinition-namespace">
<valueUri value="urn:hl7-org:v3"/>
</extension>
<url value="http://hl7.org/fhir/cda/StructureDefinition/ST"/>
<version value="2.1.0-draft1"/>
<name value="ST"/>
<title value="ST: CharacterString (V3 Data Type)"/>
<status value="active"/>
<experimental value="false"/>
<date value="2023-01-16T16:39:50+11:00"/>
<publisher value="Health Level 7"/>
<contact>
<name value="HL7 International - Cross-Group Projects"/>
<telecom>
<system value="url"/>
<value value="http://www.hl7.org/Special/committees/cgp"/>
</telecom>
<telecom>
<system value="email"/>
<value value="cgp@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-snapshot3"/>
<mapping>
<identity value="rim"/>
<uri value="http://hl7.org/v3"/>
<name value="RIM Mapping"/>
</mapping>
<kind value="logical"/>
<abstract value="false"/>
<type value="ED"/>
<baseDefinition value="http://hl7.org/fhir/cda/StructureDefinition/ED"/>
<derivation value="constraint"/>
<snapshot>
<element id="ED">
<path value="ED"/>
<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="ele-1"/>
<severity value="error"/>
<human value="All FHIR elements must have a @value or children"/>
<expression
value="hasValue() or (children().count() > id.count())"/>
<source value="http://hl7.org/fhir/StructureDefinition/Element"/>
</constraint>
<isModifier value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="ED.nullFlavor">
<path value="ED.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"/>
</type>
<binding>
<strength value="required"/>
<valueSet value="http://terminology.hl7.org/ValueSet/v3-NullFlavor"/>
</binding>
</element>
<element id="ED.charset">
<path value="ED.charset"/>
<representation value="xmlAttr"/>
<label value="Charset"/>
<definition
value="For character-based encoding types, this property specifies the character set and character encoding used. The charset shall be identified by an Internet Assigned Numbers Authority (IANA) Charset Registration [] in accordance with RFC 2978 []."/>
<min value="0"/>
<max value="1"/>
<base>
<path value="ED.charset"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
</type>
</element>
<element id="ED.compression">
<path value="ED.compression"/>
<representation value="xmlAttr"/>
<label value="Compression"/>
<definition
value="Indicates whether the raw byte data is compressed, and what compression algorithm was used."/>
<min value="0"/>
<max value="0"/>
<base>
<path value="ED.compression"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
</type>
<binding>
<strength value="required"/>
<valueSet
value="http://terminology.hl7.org/ValueSet/v3-CompressionAlgorithm"/>
</binding>
</element>
<element id="ED.integrityCheck">
<path value="ED.integrityCheck"/>
<representation value="xmlAttr"/>
<label value="Integrity Check"/>
<definition
value="The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created."/>
<min value="0"/>
<max value="0"/>
<base>
<path value="ED.integrityCheck"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="base64Binary"/>
</type>
</element>
<element id="ED.integrityCheckAlgorithm">
<path value="ED.integrityCheckAlgorithm"/>
<representation value="xmlAttr"/>
<label value="Integrity Check Algorithm"/>
<definition
value="Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage."/>
<min value="0"/>
<max value="0"/>
<base>
<path value="ED.integrityCheckAlgorithm"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
</type>
<binding>
<strength value="required"/>
<valueSet
value="http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm"/>
</binding>
</element>
<element id="ED.language">
<path value="ED.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="ED.language"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
</type>
</element>
<element id="ED.mediaType">
<path value="ED.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="ED.mediaType"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
</type>
<fixedCode value="text/plain"/>
</element>
<element id="ED.representation">
<path value="ED.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="ED.representation"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
</type>
<fixedCode value="TXT"/>
</element>
<element id="ED.data[x]">
<path value="ED.data[x]"/>
<representation value="xmlText"/>
<definition value="The string value"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="ED.data[x]"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
</element>
<element id="ED.reference">
<path value="ED.reference"/>
<label value="Reference"/>
<definition
value="A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data."/>
<min value="0"/>
<max value="0"/>
<base>
<path value="ED.reference"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="http://hl7.org/fhir/cda/StructureDefinition/TEL"/>
</type>
</element>
<element id="ED.thumbnail">
<path value="ED.thumbnail"/>
<label value="Thumbnail"/>
<definition
value="An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference."/>
<min value="0"/>
<max value="0"/>
<base>
<path value="ED.thumbnail"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="http://hl7.org/fhir/cda/StructureDefinition/ED"/>
</type>
</element>
</snapshot>
<differential>
<element id="ED">
<path value="ED"/>
<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="*"/>
</element>
<element id="ED.compression">
<path value="ED.compression"/>
<representation value="xmlAttr"/>
<label value="Compression"/>
<definition
value="Indicates whether the raw byte data is compressed, and what compression algorithm was used."/>
<min value="0"/>
<max value="0"/>
</element>
<element id="ED.integrityCheck">
<path value="ED.integrityCheck"/>
<representation value="xmlAttr"/>
<label value="Integrity Check"/>
<definition
value="The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created."/>
<min value="0"/>
<max value="0"/>
</element>
<element id="ED.integrityCheckAlgorithm">
<path value="ED.integrityCheckAlgorithm"/>
<representation value="xmlAttr"/>
<label value="Integrity Check Algorithm"/>
<definition
value="Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage."/>
<min value="0"/>
<max value="0"/>
</element>
<element id="ED.mediaType">
<path value="ED.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"/>
</type>
<fixedCode value="text/plain"/>
</element>
<element id="ED.representation">
<path value="ED.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"/>
</type>
<fixedCode value="TXT"/>
</element>
<element id="ED.data[x]">
<path value="ED.data[x]"/>
<representation value="xmlText"/>
<definition value="The string value"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="string"/>
</type>
</element>
<element id="ED.reference">
<path value="ED.reference"/>
<label value="Reference"/>
<definition
value="A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data."/>
<min value="0"/>
<max value="0"/>
</element>
<element id="ED.thumbnail">
<path value="ED.thumbnail"/>
<label value="Thumbnail"/>
<definition
value="An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference."/>
<min value="0"/>
<max value="0"/>
</element>
</differential>
</StructureDefinition>
IG © 2019+ Health Level 7. Package hl7.cda.uv.core#2.1.0-draft1 based on FHIR 5.0.0-snapshot3. Generated 2023-01-16
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change