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

Logical Model: ST - Detailed Descriptions

Active as of 2023-01-16

Definitions for the ST logical model.

Guidance on how to interpret the contents of this table can be found here.

1. ED
Definition

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.

Data that is primarily intended for human interpretation or for further machine processing is outside the scope of HL7. This includes unformatted or formatted written language, multimedia data, or structured information as defined by a different standard (e.g., XML-signatures.) Instead of the data itself, an ED may contain only a reference (see TEL.) Note that the ST data type is a specialization of when the is text/plain.

XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:v3.
2. ED.compression
Control0..01
XML RepresentationIn the XML format, this property is represented as an attribute.
3. ED.integrityCheck
Control0..01
XML RepresentationIn the XML format, this property is represented as an attribute.
4. ED.integrityCheckAlgorithm
Control0..01
XML RepresentationIn the XML format, this property is represented as an attribute.
5. ED.mediaType
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed Valuetext/plain
6. ED.representation
Definition

Specifies the representation of the binary data that is the content of the binary data value

XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueTXT
7. ED.data[x]
Definition

The string value

Data that is primarily intended for human interpretation or for further machine processing is outside the scope of HL7. This includes unformatted or formatted written language, multimedia data, or structured information as defined by a different standard (e.g., XML-signatures.)

TypeChoice of: , base64Binary
[x] NoteSee Choice of Data Types for further information about how to use [x]
XML RepresentationIn the XML format, this property is represented as unadorned text.
8. ED.reference
Control0..01
9. ED.thumbnail
Control0..01

Guidance on how to interpret the contents of this table can be found here.

1. ED
Definition

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.

Base definition for all types defined in FHIR type system.

Control10..*
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:v3.
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
2. ED.compression
Definition

Indicates whether the raw byte data is compressed, and what compression algorithm was used.

Control0..0
BindingThe codes SHALL be taken from CompressionAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
3. ED.integrityCheck
Definition

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.

Control0..0
Typebase64Binary
XML RepresentationIn the XML format, this property is represented as an attribute.
4. ED.integrityCheckAlgorithm
Definition

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.

Control0..0
BindingThe codes SHALL be taken from IntegrityCheckAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
5. ED.mediaType
Definition

Identifies the type of the encapsulated data and identifies a method to interpret or render the data.

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed Valuetext/plain
6. ED.representation
Definition

Specifies the representation of the binary data that is the content of the binary data value

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueTXT
7. ED.data[x]
Definition

The string value

Control0..1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
XML RepresentationIn the XML format, this property is represented as unadorned text.
8. ED.reference
Definition

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.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
9. ED.thumbnail
Definition

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.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED

Guidance on how to interpret the contents of this table can be found here.

1. ED
Definition

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.

Control1..*
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:v3.
2. ED.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
3. ED.charset
Definition

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 [].

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
4. ED.compression
Definition

Indicates whether the raw byte data is compressed, and what compression algorithm was used.

Control0..0
BindingThe codes SHALL be taken from CompressionAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
5. ED.integrityCheck
Definition

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.

Control0..0
Typebase64Binary
XML RepresentationIn the XML format, this property is represented as an attribute.
6. ED.integrityCheckAlgorithm
Definition

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.

Control0..0
BindingThe codes SHALL be taken from IntegrityCheckAlgorithm
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
7. ED.language
Definition

For character based information the language property specifies the human language of the text.

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
8. ED.mediaType
Definition

Identifies the type of the encapsulated data and identifies a method to interpret or render the data.

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed Valuetext/plain
9. ED.representation
Definition

Specifies the representation of the binary data that is the content of the binary data value

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueTXT
10. ED.data[x]
Definition

The string value

Control0..1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
XML RepresentationIn the XML format, this property is represented as unadorned text.
11. ED.reference
Definition

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.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
12. ED.thumbnail
Definition

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.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED