Sun Adapter for TCP/IP HL7 User's Guide

HL7 MSH Segment — TCP/IP HL7 V2 Inbound Adapter

The following table lists and describes the properties that appear on the HL7 MSH Segment page of the Properties Editor accessed from the Connectivity Map. These properties define the configuration of the MSH segment of the HL7 message. For more information about this segment, refer to the HL7 specification (http://www.hl7.org).

Table 12 Connectivity Map - HL7 MSH Segment

Name 

Description 

Field Separator

The character that separates the segment ID and the first real field. This value defines the character that is used as a separator for the rest of the message and is the first field in the HL7 MSH segment (MSH-01). 

The value is a decimal ASCII number, and the allowed range is 1 to 127. The default setting is 124, which is the pipe character (|). 

Encoding Characters

Encoding characters in the following order: 

  • Component separator

  • Repetition separator

  • Escape character

  • Subcomponent separator

    This is the second field in the HL7 MSH segment (MSH-02).

The default is ^~\& (ASCII 94, 126, 92, and 38) respectively.

Sending Application

A user-defined value for the sending application among other applications within the network enterprise. The network enterprise consists of the applications that participate in the exchange of HL7 messages within the enterprise. The default is Sun HL7 adapter.

This is the third field in the HL7 MSH segment (MSH-03). 

Sending Facility

A user-defined value that further identifies the sending application among multiple identical instances of the application running on behalf of different organizations. The default is Sun HL7 adapter.

This is the fourth field in the HL7 MSH segment (MSH-04). 

Receiving Application

A user-defined value for the receiving application among other applications within the network enterprise. The default value is Sun HL7 adapter.

This is the fifth field in the HL7 MSH segment (MSH-05). 

Receiving Facility

A user-defined value that further identifies the receiving application among multiple identical instances of the application running on behalf of different organizations. The default value is Sun HL7 adapter.

This is the sixth field in the HL7 MSH segment (MSH-06). 

Security

The implemented application level security features.  

This is the eighth field in the HL7 MSH segment (MSH-08). 

Processing ID

The subcomponent processing ID of the MSH-11 field. MSH-11 is used to indicate whether a message is processed as defined in the HL7 Application processing rules. 

Specify one of the following options:

  • D - The message is part of a debugging system.

  • P - The message is part of a production system.

  • T - The message is part of a training system.

    In some cases there may be an additional value, the processing mode, following the initial value. This value can be A (archive), R (restore from archive), or I (initial load).

Version ID

The HL7 version as displayed in HL7 Table 0104 - Version ID. This value is matched by the receiving system to its own version to ensure that messages are interpreted correctly. The default value is 2.5.

This is the 12th field in the HL7 MSH segment (MSH-12).  

Country Code

A code that indicates the country of origin for the message (see HL7 Table 0399). Use the 3-character (alphabetic) form of ISO 3166. This value is used to specify default elements in a message, such as currency. The default value is USA.

This is the 17th field in the HL7 MSH segment (MSH-17). 

Character Set

The character set(s) used by the messages (see HL7 Table 0211). If the field is left blank, the character set is assumed to be the 7-bit ASCII set. The default value is 8859/1 (printable 7-bit ASCII character set).

This is the 18th field in the HL7 MSH segment (MSH-18). 

Principal Language of Message

The 2-character ISO 639 alphabetic code that specifies the principal language of the message.  

This is the 19th field in the HL7 MSH segment (MSH-19). 

Alternate Character Set Handling Scheme

The value for the alternate character set handling scheme to be used when any alternative character sets are used and a special handling scheme is necessary (see HL7 Table 0356). Possible values are ISO 2022-1994, 2.3, or <null> (blank). Leaving the field blank indicates that no character set switching will occur.

This is the 20th field in the HL7 MSH segment (MSH-20). 

Conformance Statement ID

A unique identifier that applies to a query’s conformance statement. It can also be used as a Message Profile Identifier to assert constancy with a message profile (grammar, syntax, usage, and so on). 

This is the 21st field in the HL7 MSH segment (MSH-21). 

Validate MSH

An indicator of whether to validate the MSH segment of the data message (for inbound) and the MSH segment of the ACK (for outbound). Select true if you want the Collaboration to validate the MSH segment; otherwise select false.

This parameter is used in Collaboration code. 


Note –

This property does not affect structural validation of the entire HL7 message itself. Structural validation is always performed.