Ancestor: HL7Connect.Cda.ANY

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

Encapsulated data can be present in two forms, inline or by reference. The content is the same whether it is located inline or remote.Inline data is communicated or moved as part of the encapsulated data value, whereas by-reference data may reside at a different location: a URL/URI that provides reference to the information required to locate the data. Inline data may be provided in one of 3 different ways:

Content SHALL be provided if the ED has no nullFlavor. The content may be provided in-line (using only one of value, data or xml), or it may be provided as a reference.Content may be provided in-line and a reference also may be given; in these cases, it is expected that the content of the reference will be exactly the same as the in-line content. Information Processing Entities are not required to check this, but may regard it as an error condition if the content does not matc


string value;
   A simple sequence of characters that contains the content.

If value is used, the mediatype is fixed to text/plain and the charset must be consistent with the String Character Set. Refer to section 6.7.5 for more details

string dataAsString;
   Access the raw bytes of data as a string. This may not work on all platforms

HL7Connect.Cda.TEL reference;
   A URL the target of which provides the binary content.

The semantic value of an encapsulated data value is the same, regardless whether the content is present as inline content or just by reference. However, an encapsulated data value without inline content behaves differently, since any attempt to examine the content requires the data to be downloaded from the reference. An encapsulated data value may have both inline content and a reference.

If data is provded in the value, data or xml attributes, the reference SHALL point to the same data. It is an error if the data resolved through the reference does not match either the integrity check, data as provided, or data that had earlier been retrieved through the reference and then cached. The mediatype of the ED SHALL match the type returned by accessing the reference.

The reference may contain a usablePeriod to indicate that the data may only be available for a limited period of time. Whether the reference is limited by a usablePeriod or not, the content of the reference SHALL be fixed for all time. Any application using the reference SHALL always receive the same data, or an error. The reference cannot be reused to send a different version of the same data, or different data

string mediaType;
   Identifies the type of the encapsulated data and can be used to determine a method to interpret or render the content.

The IANA defined domain of media types is established by the IETF RFCs 2045 and 2046. mediaType has a default value of text/plain and cannot be null. If the media type is different to text/plain, the mediaType attribute SHALL be populated.

If the content is compressed using a specified compression algorithm, the mediaType SHALL refer the mediaType of the uncompressed data, whether the data is accessed by reference or not.

string charset;
   An Internet Assigned Numbers Authority (IANA) Charset Registered character set and character encoding for character-based encoding types.

Whenever the content of the ED is character type data in any form, the charset property needs to be known. If the content is provided directly in the value attribute, then the charset SHALL be a known character set consistent with the String Character Set. Refer to section 6.7.5 for more details. If the content is provided as a reference, and the access method does not provide the charset for the content (such as by a mime header), then the charset SHALL be conveyed as part of the ED

string language;
   The human language of the content. Valid codes are taken from the IETF RFC 3066. If this attribute is null, the language may be inferred from elsewhere, either from the context or from unicode language tags, for example.

Conformance profiles SHOULD define defaulting rules for language for a given usage environment of this specification.

Note: While language attribute usually alters the interpretation of the text, the language attribute does not alter the meaning of the characters in the text.

Tv3Compression compression;
   The compression algorithm, if any, used on the raw byte data.

If the attribute is null, the data is not compressed. Compression only applies to the binary form of the content.

If populated, the value of this attribute SHALL be taken from the HL7 CompressionAlgorithm code system.

Some compression formats allow multiple archive files to be embedded within a single compressed volume. Applications SHALL ensure that the decompressed form of the data conforms to the stated media type -- Possible compression types for content


cDF : Deflate : The deflate compressed data format as specified in IETF RFC 1951

cGZ : GZIP : A compressed data format that is compatible with the widely used GZIP utility as specified in IETF RFC 1952(uses the deflate algorithm)

cZL : ZLIB : A compressed data format that also uses the deflate algorithm. Specified as IETF RFC 1950

cZ : Compress : Original UNIX compress algorithm and file format using the LZC algorithm (a variant of LZW). Patent encumbered and less efficient than deflate

cBZ : BZIP : bzip-2 compression format. See [] for more information.

cZ7 : Z7 : 7z compression file format. See [] for more information.

byte[] integrityCheck;
   A checksum 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 content that the reference resolved to when the encapsulated data value with reference was created. If the attribute is null, there is no integrityCheck.

It is an error if the data resolved through the reference does not match the integrity check.

The integrity check is calculated according to the integrityCheckAlgorithm. By default, the Secure Hash Algorithm-1 (SHA-1) shall be used. The integrity check is binary encoded according to the rules of the integrity check algorithm.

The integrity check is calculated over the raw binary data that is contained in the data component, or that is accessible through the reference. No transformations are made before the integrity check is calculated. If the data is compressed, the Integrity Check is calculated over the compressed data.

Tv3IntegrityCheckAlgorithm integrityCheckAlgorithm;
   The algorithm used to compute the integrityCheck value.

If populated, the value of this attribute SHALL be taken from the HL7 IntegrityCheckAlgorithm code system. -- Possible integrity check alorithms for referenced data


icaSHA1 : Secure Hash Algorithm - 1 : This algorithm is defined in FIPS PUB 180-1: Secure Hash Standard. As of April 17, 1995

icaSHA256 : Secure Hash Algorithm - 256 : This algorithm is defined in FIPS PUB 180-2: Secure Hash Standard

HL7Connect.Cda.ST description;
   An alternative description of the media where the media is not able to be rendered.

E.g. Short text description of an image or sound clip, etc. This attribute is not intended to be a complete substitute for the original. For complete substitutes, use the "translation" property.

The intent of this property is to allow compliance with disability requirements such as those expressed in American's with Disability Act (also known as "Section 508"), where there is a requirement to provide a short text description of included media in some form that can be read by a screen reader. This is similar to a very short thumbnail with mediaType = text/plain.

HL7Connect.Cda.ED thumbnail;
   An abbreviated rendition of the full content.

A thumbnail requires significantly fewer resources than the full content, while still maintaining some distinctive similarity with the full content. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select the appropriate content more efficiently before actually downloading through the reference.

Originally, the term thumbnail refers to an image in a lower resolution (or smaller size) than another image. However, the thumbnail concept can be metaphorically used for media types other than images. For example, a movie may be represented by a shorter clip; an audio-clip may be represented by another audio-clip that is shorter, has a lower sampling rate, or a lossy compression; or an abstract provided for a long document.

A thumbnail itself SHALL NOT contain a thumbnail.

ISet<HL7Connect.Cda.ED> translation;
   Alternate renditions of the same content translated into a different language or a different mediaType.

The translations SHALL convey the same information, but in a different language or mediaType. Translations SHALL not contain translations. The translations do not take part in the test for equality, so SHALL NOT introduce any new semantics to the value.


void LoadDataFromFile(string sFilename);
   Fill out the data from a file. If text or xml is populated, they will be set to null

void SaveDataToFile(string sFilename);
   Save the data to a file. If the data property is not populated, test or xml will be used

void LoadDataFromStream(Stream oStream);
   Fill out the data from a stream (such as a sql.ColMemory). If text or xml is populated, they will be set to null

void SaveDataToStream(Stream oStream);
   Save the data to a stream (use with BindBlob). If the data property is not populated, test or xml will be used

HL7Connect.Cda.ED AddTranslation();
   Shortcut method. Add an ED to the list of translations.

© Kestral Computing P/L 2000 - 2003. HL7Connect v2.00-063 generated on 30-Nov 2015.
Keywords: Compression, Description, Value, AddTranslation, charset, dataAsString, integrityCheck, integrityCheckAlgorithm, language, LoadDataFromFile, LoadDataFromStream, mediaType, reference, SaveDataToFile, SaveDataToStream, thumbnail, translation, ED, HL7Connect.Cda.ED