Configuring Field Settings - HL7 Module - English - Foundation 22.1 - OnBase - Premier - external - Standard - Essential - Premier - Standard - Essential

HL7 Module

Platform
OnBase
Product
HL7 Module
Release
Foundation 22.1
License
Premier
Standard
Essential

HL7 messages transmit data within fields, field components, and subcomponents. To configure the HL7 module to handle data within an HL7 field, you must configure settings for the field in the appropriate HL7 message template.

To configure a field in a message template, use the HL7 Field Settings dialog box. To access this dialog box, see Configuring Message Templates.

For information about each field setting, see the following table:

HL7 Field Setting

Description

Field ID

The location of the data within the segment.

If the field ID contains two numbers separated by a decimal point, it represents a component. For example, if the field ID is 3.1, the data is expected in the first component of the third field.

If the field ID contains three numbers separated by decimal points, it represents a subcomponent. For example, if the field ID is 3.1.2, the data is expected in the second subcomponent of the first component of the third field.

See Examples of Mapped Fields, Components, and Subcomponents.

Field Name

A short description of the data expected in this field.

Keyword Type

Allows you to map a Keyword Type mapped to this field, component, or subcomponent. Keyword Type mapping can be used for populating AutoFill Keyword Sets, indexing documents and folders, and populating outbound messages.

If the selected Keyword Type is configured with a mask, see Considerations for Masked Keyword Types.

Use as secondary search keyword

For AutoFill processing, indicates the field contains a secondary value that should be used to distinguish between AutoFill Keyword Sets that have the same primary value. See Using Secondary Values to Differentiate AutoFill Keyword Sets.

Chart Field Override

Allows the field to populate the selected chart data field, overriding the default chart data field mapping. See Overriding Chart Data Fields.

If no override is selected, the default chart data field is displayed enclosed in <>(angle brackets).

Translation Table

Allows field values to be translated using the selected translation table. See Translation Tables.

Predefined

Allows you to map a predefined value to the field. Message actions use predefined default values to find certain types of information in an HL7 message. The HL7 Sender uses predefined default values to dynamically populate HL7 messages with non-keyword data. See Predefined Default Values.

User Defined

Allows you to manually enter a default value for the field. This value may be used in different ways. For examples, see Mapping E-Form Fields to Non-Keyword Data, Configuring HL7 Filter Fields, and Outbound Default Value Options.

Use text value for field filtering

Allows you to filter import process execution based on whether the value in the HL7 message matches any of the values provided in the User Defined field. See Configuring HL7 Filter Fields.

Merge Source Identifier

Allows the field to be used for merging AutoFill Keyword Sets. This should be configured only for the field containing the source (old) value for the primary Keyword Type. See Configuring Message Templates for AutoFill Merging.

Optional

This option does not affect processing for inbound or outbound messages.

Required

This option does not affect processing for inbound or outbound messages.

Repeating

Allows the field to repeat in outbound messages. This option is useful when documents have multiple values for a Keyword Type.

For fields with multiple components, the Repeating option is respected only if it is set on the first component and the first component is also mapped to a Keyword Type.

See Sending Messages with Repeating Fields for more information.

General

Indicates the field is for general use. Select this setting if the expected values are not exclusively dates, times, or timestamps. See the HL7 standard specification for more information about data types.

Date

Indicates the field contains only date values.

Time

Indicates the field contains only time values.

TimeStamp

Indicates the field contains both the date and time of the event.