Clinical Document Architecture
2.0.0-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.0-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: ED - Detailed Descriptions

Active as of 2024-10-25

Definitions for the ED logical model.

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

0. ED
Definition

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.

Control1..*
Logical ContainerClinicalDocument (CDA Class)
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
Invariantsed-base64: If @representation='B64', then xmlText SHALL be a base64binary string. ((representation.empty() or representation != 'B64') or xmlText.empty() or xmlText.matches('^(?:[A-Za-z0-9+//]{4})*(?:[A-Za-z0-9+//]{2}==|[A-Za-z0-9+//]{3}=)?$'))
2. ED.compression
Definition

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

Control0..1
BindingThe codes SHALL be taken from CDACompressionAlgorithm
(required to http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelCompression
4. 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..1
Typebase64Binary(bin: Binary Data)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelIntegrity Check
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..1
BindingThe codes SHALL be taken from IntegrityCheckAlgorithm (2.0.0)
(required to http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelIntegrity Check Algorithm
8. ED.language
Definition

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

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelLanguage
10. ED.mediaType
Definition

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

Control0..1
BindingFor example codes, see MediaType
(example to http://terminology.hl7.org/ValueSet/v3-MediaType)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelMedia Type
12. ED.representation
Control0..1
BindingThe codes SHALL be taken from CDABinaryDataEncoding
(required to http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
14. ED.xmlText
Definition

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

ShortAllows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
Comments

This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

Control0..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as unadorned text.
16. 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..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
LabelReference
18. 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..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
LabelThumbnail

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

0. ED
Definition

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.


Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Control10..*
Is Modifierfalse
Logical ContainerClinicalDocument (CDA Class)
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
Invariantsed-base64: If @representation='B64', then xmlText SHALL be a base64binary string. ((representation.empty() or representation != 'B64') or xmlText.empty() or xmlText.matches('^(?:[A-Za-z0-9+//]{4})*(?:[A-Za-z0-9+//]{2}==|[A-Za-z0-9+//]{3}=)?$'))
2. ED.compression
Definition

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

Control0..1
BindingThe codes SHALL be taken from CDACompressionAlgorithm
(required to http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelCompression
4. 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..1
Typebase64Binary(bin: Binary Data)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelIntegrity Check
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..1
BindingThe codes SHALL be taken from IntegrityCheckAlgorithm (2.0.0)
(required to http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelIntegrity Check Algorithm
8. ED.language
Definition

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

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelLanguage
10. ED.mediaType
Definition

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

Control0..1
BindingFor example codes, see MediaType
(example to http://terminology.hl7.org/ValueSet/v3-MediaType)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelMedia Type
12. ED.representation
Control0..1
BindingThe codes SHALL be taken from CDABinaryDataEncoding
(required to http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
14. ED.xmlText
Definition

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

ShortAllows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
Comments

This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

Control0..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as unadorned text.
16. 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..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
LabelReference
18. 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..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
LabelThumbnail

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

0. ED
Definition

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.

ShortBase for all types and resources
Control1..*
Is Modifierfalse
Logical ContainerClinicalDocument (CDA Class)
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
Invariantsed-base64: If @representation='B64', then xmlText SHALL be a base64binary string. ((representation.empty() or representation != 'B64') or xmlText.empty() or xmlText.matches('^(?:[A-Za-z0-9+//]{4})*(?:[A-Za-z0-9+//]{2}==|[A-Za-z0-9+//]{3}=)?$'))
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 CDANullFlavor
(required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
4. ED.compression
Definition

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

Control0..1
BindingThe codes SHALL be taken from CDACompressionAlgorithm
(required to http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelCompression
6. 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..1
Typebase64Binary(bin: Binary Data)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelIntegrity Check
8. 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..1
BindingThe codes SHALL be taken from IntegrityCheckAlgorithm (2.0.0)
(required to http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelIntegrity Check Algorithm
10. ED.language
Definition

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

Control0..1
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelLanguage
12. ED.mediaType
Definition

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

Control0..1
BindingFor example codes, see MediaType
(example to http://terminology.hl7.org/ValueSet/v3-MediaType)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelMedia Type
14. ED.representation
Control0..1
BindingThe codes SHALL be taken from CDABinaryDataEncoding
(required to http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
16. ED.xmlText
Definition

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

ShortAllows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
Comments

This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.

Control0..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as unadorned text.
18. 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..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
LabelReference
20. 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..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
LabelThumbnail