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 |
Definitions for the ED logical model.
Guidance on how to interpret the contents of this table can be found here.
1. 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. |
Control | 1..* |
XML Representation | In the XML format, this property has the namespace urn:hl7-org:v3 . |
2. 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 []. |
Control | 0..1 |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
3. ED.compression | |
Definition | Indicates whether the raw byte data is compressed, and what compression algorithm was used. |
Control | 0..1 |
Binding | The codes SHALL be taken from CompressionAlgorithm |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
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. |
Control | 0..1 |
Type | base64Binary |
XML Representation | In the XML format, this property is represented as an attribute. |
5. 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. |
Control | 0..1 |
Binding | The codes SHALL be taken from IntegrityCheckAlgorithm |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
6. ED.language | |
Definition | For character based information the language property specifies the human language of the text. |
Control | 0..1 |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
7. ED.mediaType | |
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
Control | 0..1 |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
8. ED.representation | |
Control | 0..1 |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
9. ED.data[x] | |
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.) |
Control | 0..1 |
Type | Choice of: string, base64Binary |
[x] Note | See Choice of Data Types for further information about how to use [x] |
XML Representation | In the XML format, this property is represented as unadorned text. |
10. 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. |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
11. 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. |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
Guidance on how to interpret the contents of this table can be found here.
1. 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. |
Control | 10..* |
XML Representation | In the XML format, this property has the namespace urn:hl7-org:v3 . |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
2. 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 []. |
Control | 0..1 |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
3. ED.compression | |
Definition | Indicates whether the raw byte data is compressed, and what compression algorithm was used. |
Control | 0..1 |
Binding | The codes SHALL be taken from CompressionAlgorithm |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
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. |
Control | 0..1 |
Type | base64Binary |
XML Representation | In the XML format, this property is represented as an attribute. |
5. 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. |
Control | 0..1 |
Binding | The codes SHALL be taken from IntegrityCheckAlgorithm |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
6. ED.language | |
Definition | For character based information the language property specifies the human language of the text. |
Control | 0..1 |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
7. ED.mediaType | |
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
Control | 0..1 |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
8. ED.representation | |
Control | 0..1 |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
9. ED.data[x] | |
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.) |
Control | 0..1 |
Type | Choice of: string, base64Binary |
[x] Note | See Choice of Data Types for further information about how to use [x] |
XML Representation | In the XML format, this property is represented as unadorned text. |
10. 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. |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
11. 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. |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
Guidance on how to interpret the contents of this table can be found here.
1. 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. |
Control | 1..* |
XML Representation | In 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. |
Control | 0..1 |
Binding | The codes SHALL be taken from NullFlavor |
Type | code |
XML Representation | In 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 []. |
Control | 0..1 |
Type | code |
XML Representation | In 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. |
Control | 0..1 |
Binding | The codes SHALL be taken from CompressionAlgorithm |
Type | code |
XML Representation | In 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. |
Control | 0..1 |
Type | base64Binary |
XML Representation | In 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. |
Control | 0..1 |
Binding | The codes SHALL be taken from IntegrityCheckAlgorithm |
Type | code |
XML Representation | In 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. |
Control | 0..1 |
Type | code |
XML Representation | In 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. |
Control | 0..1 |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
9. ED.representation | |
Control | 0..1 |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
10. ED.data[x] | |
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.) |
Control | 0..1 |
Type | Choice of: string, base64Binary |
[x] Note | See Choice of Data Types for further information about how to use [x] |
XML Representation | In 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. |
Control | 0..1 |
Type | http://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. |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/ED |