Components > Industry data service customizer > Message properties
  

Message properties

Messaging standards define the elements and properties that you can configure in the message structure. This section describes the properties for each standard.

HIPAA message properties

HIPAA is an industry standard for administrative and financial health-care transactions. HIPAA is based on the X12 standard.
HIPAA messages use transaction sets, loops, segments, composites, and data elements.

Transaction set

The following table describes the transaction set properties:
Property
Setting Type
Description
ID
Global
Message identifier.
Library type
Global
Messaging standard. Set to HIPAA.
Library version
Global
Version of the messaging standard.
Industry ID
Global
Industry identifier.
Standard name
Global
Message name.
Functional group
Global
The group that the message belongs to.

Loop

The following table describes the loop properties:
Property
Setting Type
Description
ID
Global
Loop identifier.
Repetitions
Positional
Number of times that the loop is repeated such as 1 or 2. For an unlimited number, enter >1.

Segment

The following table describes the segment properties:
Property
Setting Type
Description
ID
Global
Segment identifier.
Standard name
Global
Segment name.
Standard qualifier
Global
Index of the data element that qualifies the segment.
Usage
Positional
Required, optional, conditional, or not used.
Repetitions
Positional
Number of times that the segment is repeated such as 1 or 2. For an unlimited number, enter >1.
Industry name
Positional
Industry-standard descriptive name of the segment.

Composite

The following table describes the composite properties:
Property
Setting Type
Description
ID
Global
Composite identifier.
Standard name
Global
Composite name.
Usage
Positional
Required, optional, conditional, or not used.
Repetitions
Positional
Number of times that the composite is repeated such as 1 or 2. For an unlimited number, enter >1.

Data element

The following table describes the data element properties:
Property
Setting Type
Description
ID
Global
Data element identifier.
Standard name
Global
Data element name.
Type
Global
Data element type.
Min length
Global
Minimum length of the data.
Max length
Global
Maximum length of the data.
Usage
Positional
Required, optional, conditional, or not used.
Repetitions
Positional
Number of times that the data element is repeated such as 1 or 2.
Valid codes
Positional
A list of valid codes.

HL7 message properties

The HL7 messaging standard implements the Health Level Seven version 2.x messaging standard used in the health services industry. The HL7 standard is used world-wide in hospital and medical information systems.
HL7 messages use segment groups, segments, fields, components, and types.

Message

The following table describes the message properties:
Property
Setting Type
Description
ID
Global
Message identifier.
Library type
Global
Messaging standard. Set to HL7.
Library version
Global
Version of the messaging standard.
Description
Global
Description of the message.
Category
Global
Category that the message belongs to, such as patient referral.

Segment group

The following table describes the segment group properties:
Property
Setting Type
Description
ID
Global
Segment group identifier.
Usage
Positional
Mandatory or optional.
Repetitions
Positional
Number of times that the segment is repeated such as 1 or 2. For an unlimited number, enter >1.

Segment

The following table describes the segment properties:
Property
Setting Type
Description
ID
Global
Segment identifier.
Description
Global
Description of the segment.
Usage
Positional
Mandatory or optional.
Repetitions
Positional
Number of times that the segment is repeated such as 1 or 2. For an unlimited number, enter >1.

Field

The following table describes the field properties:
Property
Setting Type
Description
ID
Global
Field identifier. The identifier is usually the ID of the parent element followed by an index number.
Description
Global
Description of the field.
Type
Global
Field type.
Max Length
Global
Maximum length of the data.
Enumerations
Global
A list of permitted data values.
Usage
Positional
Mandatory or optional.
Repetitions
Positional
Number of times that the segment is repeated such as 1 or 2. For an unlimited number, enter >1.

Component

The following table describes the component properties:
Property
Setting Type
Description
ID
Global
Component identifier. The identifier is usually the ID of the parent element followed by an index number.
Description
Global
Description of the component.
Type
Global
Component type.
Usage
Global
Mandatory or optional.

Type

The following table describes the type properties:
Property
Setting Type
Description
ID
Global
Type identifier.
Description
Global
Description of the type.