eCW HL7 Message Structure

In the Main Menu, click Setup, Advanced Setup, HL7.

There are three internal eClinicalWorks HL7 message definitions that exactly match the HL7 message structure for the three eCW bridge modes: Full, Standalone, and Tight. These message definitions are automatically enabled when the eCW bridge is turned on for a specific bridge mode. To set up generic HL7 messages, see Generic HL7 Message Structure.

Usually users will not modify message definitions here, but if users do (enable and modify), the options set here will override HL7 options defined on the eClinicalWorks Setup window. See eCW HL7 under HL7 Field Documentation and HL7 Unit Tests for more information.

Only Custom definitions can be edited.

For internal definitions, only information in the top portion of the window can be modified. Messages/Segment structure cannot be changed.

Hint: If using TCP/IP mode, we recommend using version 14.1.8 or greater. The incoming and outgoing ports need not match, but the ports will have to be available for use by the OpenDentalHL7 service.

  1. For Mode TX, select TcpIp.
  2. Enter an Incoming Port.
  3. Enter an Outgoing IP: Port (outgoing IP address followed by a colon and a port number). It should match the IP address of the computer Open Dental will send HL7 messages to.

Editing Messages/Segments

For custom definitions, users can modify the incoming and outgoing message structure (shown in the Messages / Segments grid). To add a new message, click Add. To modify an existing message, double-click the message or one of its segments.

Message Type: For a description of all message types, see HL7 Inbound and Outbound Message Types

Event Type:


Item Order: Determines the order the message will show in the Message / Segment grid.

Segments: Double-click on a segment to modify, or click Add to create a new segment.

Segment Name: Can be selected from a list of available segment names supported by Open Dental.

Item Order: For outgoing messages, affects the message structure. For incoming messages, only determines the order the segment shows in the Message Edit window.

Fields: Double-click a field to modify, or click Add to create a new field.

Data Type: Linked to fields internally defined by Open Dental, so users will only have the option to select a data type for fixed text fields.

Table ID: For informational purposes only and is not used by Open Dental or inserted into outgoing messages.

Item Order:

Fixed Text: Fixed text fields are ignored for incoming messages, and simply inserted in the proper item order for outgoing messages.

Field Names: Lists only fields that Open Dental will process for incoming messages, or fill in with data from the database when constructing outgoing messages.

Message History

To view a log history of HL7 messages, click History on the HL7 Defs window.

Filtering options: