Ancestor: HL7Connect.Cda.HXIT

Defines the basic properties of every data value. This is conceptually an abstract type, meaning that no proper value can be just a data value without belonging to any concrete type. Every public concrete type is a specialization of this general abstract DataValue type.

However exceptional values (nullFlavored values) may be of type ANY, except for the exceptional values that imply the nullFlavor INV, since this requires a type to be meaningful. Note that not all nullFlavors may be used with the type ANY (see section 7.1.4 for more details


Tv3NullFlavor nullFlavor;
   If the value is not a proper value, indicates the reason.

Though the nullFlavor concept has some relationship with the UML/OCL null, it is not the same thing, and the relationship and differences between the two must be understood to properly implement this specification. For further discussion, see section 7.1.4 (Null and NullFlavor). Note that nullFlavor includes the concept of a UML null value, and also includes potentially fully populated instances that do not conform to the requirements placed on the instance (also known as "exceptional instances"). Both nonNull and nullFlavored values SHALL always be valid according to the rules expressed in this specification.

If populated, the value of this attribute SHALL be taken from the HL7 NullFlavor code system. -- NullFlavor that applies to the property. Note that nfNull means Not Null


nfNI : No Information : The value is exceptional (missing, omitted, incomplete, improper). No information as to the reason for being an exceptional value is provided. This is the most general exceptional value. It is also the default exceptional value

nfINV : Invalid : The value as represented in the instance is not a member of the set of permitted data values in the constrained value domain of a variable

nfOTH : Other : The actual value is not a member of the set of permitted data values in the constrained value domain of a variable. (e.g., concept not provided by required code system)

nfNINF : Negative Infinity : Negative infinity of numbers

nfPINF : Positive Infinity : Positive infinity of numbers

nfUNC : Unencoded : No attempt has been made to encode the information correctly but the raw source information is represented (usually in originalText)

nfDER : Derived : An actual value may exist, but it must be derived from the provided information (usually an expression is provided directly)

nfUNK : Unknown : A proper value is applicable, but not known

nfASKU : Asked But Unknown : Information was sought but not found (e.g., patient was asked but didn't know)

nfNAV : Temporarily Unavailable : Information is not available at this time but it is expected that it will be available later

nfQS : Sufficient Quantity : The specific quantity is not known, but is known to be non-zero and is not specified because it makes up the bulk of the material.'Add 10mg of ingredient X, 50mg of ingredient Y, and sufficient quantity of water to 100mL.' The null flavor would be used to express the quantity of water

nfNASK : Not Asked : This information has not been sought (e.g., patient was not asked)

nfTRC : Trace : The content is greater than zero, but too small to be quantified

nfMSK : Masked : There is information on this item available but it has not been provided by the sender due to security, privacy or other reasons. There may be an alternate mechanism for gaining access to this information.Warning: Using this null flavor does provide information that may be a breach of confidentiality, even though no detail data is provided. Its primary purpose is for those circumstances where it is necessary to inform the receiver that the information does exist without providing any detail

nfNA : Not Applicable : No proper value is applicable in this context (e.g., last menstrual period for a male)

Tv3UpdateMode updateMode;
   This property allows a sending system to identify the role that the attribute plays in processing the instance that is being represented.

If populated, the value of this attribute SHALL be taken from the HL7 UpdateMode code system. -- Update mode. Should always be umNull in a CDA document


umA : Add : The item was (or is to be) added, having not been present immediately before. (If it is already present, this may be treated as an error condition.)

umD : Remove : The item was (or is to be) removed (sometimes referred to as deleted). If the item is part of a collection, delete any matching items.

umR : Replace : The item existed previously and has been (or is to be) revised. (If an item does not already exist, this may be treated as an error condition.)

umAR : Add or Replace : The item was (or is to be) either added or replaced. No assertion is made as to whether the item previously existed

umN : No Change : There was (or is to be) no change to the item. This is primarily used when this element has not changed, but other attributes in the instance have changed.

umU : Unknown : It is not specified whether or what kind of change has occurred to the item, or whether the item is present as a reference or identifying property.

umK : Key : This item is part of the identifying information for the object that contains it

string flavorId;
   Signals the imposition of one or more sets of constraints on the datatype. The sole purpose of specifying that a constraint that has been used to further constrain the datatype is to support validation of the instance: a validation engine can look up the rules expressed for the specified flavors and confirm that the instance conforms to the rules for the flavor. No other processing should depend on the content of the flavor attribute.

No other semantic or computational use SHALL depend on the value of this property. If this value is populated, the datatype flavor(s) SHALL be a valid constraint on the type of the value.

There is further discussion about the use of Data Type flavors and flavorId in section A.3


string Literal();
   A literal string representation of the data, where one is defined in the specification

bool isNonNull();
   Convenience property

bool isNull();
   Convenience property

© Kestral Computing P/L 2000 - 2003. HL7Connect v2.00-063 generated on 30-Nov 2015.
Keywords: IsNull, flavorId, isNonNull, Literal, nullFlavor, updateMode, any, HL7Connect.Cda.ANY