Message Sets: TDS properties for element reference string types

The TDS wire format properties for attribute reference and element reference string types.

The TDS Format properties described here apply to:

Objects: Element Reference
String schema types: anyURI, ENTITIES, ENTITY, ID, IDREF, IDREFS, language, Name, NCName, NMTOKEN, NMTOKENS, normalizedString, NOTATION, QName, string, token

Physical representation

Property	Type	Meaning
Length Reference	Enumerated type	This property is applicable only if Physical Type is Text, Binary, or TLOG Specific. If set, this property takes precedence over any value in the Length Units property. Specify the identifier of a sibling integer object, the value of which determines the length of the object in question. The sibling object must be defined before the current object within the message structure. For information about reordering elements, see Message Sets: Reordering objects.
Inclusive Length Reference	Check box	This property is applicable only if Length Reference is set. If the check box is selected, the value of the sibling integer object that is identified by Length Reference is the length of the current object plus the length of the sibling integer object. If the check box is not selected, the value of the sibling integer object that is identified by Length Reference is the length of the current object only. If the check box is selected, the Length Units property of the sibling integer object must be the same as that of the current object.

Property

Type

Meaning

Length Reference

Enumerated type

This property is applicable only if Physical Type is Text, Binary, or TLOG Specific. If set, this property takes precedence over any value in the Length Units property.

Specify the identifier of a sibling integer object, the value of which determines the length of the object in question. The sibling object must be defined before the current object within the message structure.

For information about reordering elements, see Message Sets: Reordering objects.

Inclusive Length Reference

Check box

This property is applicable only if Length Reference is set.

If the check box is selected, the value of the sibling integer object that is identified by Length Reference is the length of the current object plus the length of the sibling integer object.

If the check box is not selected, the value of the sibling integer object that is identified by Length Reference is the length of the current object only.

If the check box is selected, the Length Units property of the sibling integer object must be the same as that of the current object.

Occurrences

Property	Type	Meaning
Repeat reference	Enumerated type	Use this property if the object occurs multiple times, and the number of occurrences is given dynamically by a field earlier in the message. Select an integer object from the list of integer objects that occur before this object in the structure of the message. The value of the selected integer specifies the number of occurrences of this object. If no objects are listed, no integer objects exist before this one in the message structure. If a Repeat Reference is specified, it overrides any setting for the Max Occurs logical property when parsing and writing the message, but not for validating the message.
Repeating Element Delimiter	String	Specify the delimiter to use between repeating elements. This delimiter is used only when the element repeats and the Data Element Separation property of the parent group or complex type is set to All Elements Delimited or Variable Length Elements Delimited. A default value is provided if the previous conditions are true; if the messaging standard is HL7, the mnemonic <HL7_RS> is used; if the messaging standard is not HL7, and the maximum number of repeats is fixed, the delimiter of the parent group or complex type is used. If none of the previous conditions are true, a default is not applied.

Property

Type

Meaning

Repeat reference

Enumerated type

Use this property if the object occurs multiple times, and the number of occurrences is given dynamically by a field earlier in the message. Select an integer object from the list of integer objects that occur before this object in the structure of the message. The value of the selected integer specifies the number of occurrences of this object. If no objects are listed, no integer objects exist before this one in the message structure.

If a Repeat Reference is specified, it overrides any setting for the Max Occurs logical property when parsing and writing the message, but not for validating the message.

Repeating Element Delimiter

String

Specify the delimiter to use between repeating elements.

This delimiter is used only when the element repeats and the Data Element Separation property of the parent group or complex type is set to All Elements Delimited or Variable Length Elements Delimited.

A default value is provided if the previous conditions are true; if the messaging standard is HL7, the mnemonic <HL7_RS> is used; if the messaging standard is not HL7, and the maximum number of repeats is fixed, the delimiter of the parent group or complex type is used.

If none of the previous conditions are true, a default is not applied.