HL7 MSH Segment Settings

Provides the HL7 MSH Header segment configuration settings.

Field Separator

Specifies the separator between 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. This is the first field in the HL7 MSH segment (MSH-01).

This is a decimal ASCII number ranging from 1 to 127. The default setting is 124 which is the character '|'.

Encoding Characters

Specifies four encoding characters in the following order:

1. Component separator

2. Repetition separator

3. Escape character

4. Subcomponent separator

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

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

Sending Application

Specifies 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. This is the third field in the HL7 MSH segment (MSH-03).

Sending Facility

Specifies (further identifies) the sending application among multiple identical instances of the application running on behalf of different organizations. This is the forth field in the HL7 MSH segment (MSH-04).

Receiving Application

Specifies the receiving 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. This is the fifth field in the HL7 MSH segment (MSH-05).

Receiving Facility

Specifies (further identifies) the receiving application among multiple identical instances of the application running on behalf of different organizations. This is the sixth field in the HL7 MSH segment (MSH-06).

Security

Specifies the implemented application level security features. This is the eighth field in the HL7 MSH segment (MSH-08).

Processing ID

Specifies the sub-component Processing ID of MSH-11. MSH-11 is used to indicate whether a message is processed as defined in the HL7 Application (level 7) Processing rules.

• D: Debugging

• P: Production

• T: Training

In some cases there may be an additional subcomponent "Processing Mode" following the initial value. The configured default is P.

Version ID

Specifies the particular HL7 version to be matched by the receiving system to its own version. This is the 12th field in the HL7 MSH segment (MSH-12).

The HL7 Standard version value as displayed in HL7 Table 0104 - Version ID. The configured default value is 2.5.

Country Code

Specifies a code that indicates the country of origin for the message (see HL7 Table 0399). Used to specify default elements in a message such as currency. This is the 17th field in the HL7 MSH segment (MSH-17).

The Country Code value uses the 3-character (alphabetic) form of ISO 3166. The default value is USA.

Character Set

Specifies the character sets used by the messages (see HL7 Table 0211). If the field is left blank, the character set used is understood to be the 7-bit ASCII set. This is the 18th field in the HL7 MSH segment (MSH-18).

The configured default is 8859/1 (printable 7-bit ASCII character set). See HL7 Table 0211 for available values and descriptions.

Principal Language Of Message

Specifies the principal language of the message. Codes come from ISO 639. This is the 19th field in the HL7 MSH segment (MSH-19). The value is a 2-character ISO 639 alphabetic code.

Alternate Character Set Handling Scheme

Specifies 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). This is the 20th field in the HL7 MSH segment (MSH-20).

Available values include ISO 2022-1994, 2.3, or (blank). Leaving the field blank indicates that no character set switching will occur.

Conformance Statement ID

The Conformance Statement ID (Message Profile Identifier in V2.5) is a unique identifier that applies to a query's Conformance Statement, or as a Message Profile Identifier, asserts constancy with a message profile (grammar, syntax, usage, and so forth). This is the 21st field in the HL7 MSH segment (MSH-21).

The required value is an HL7 Conformance Statement ID value or leave blank.

Validate MSH

Specifies whether to validate the MSH segment of the data message (for inbound) and the MSH segment of the ACK (for outbound).

The required value is True or False. True indicates that the Collaboration validates the MSH segment. The configured default is True.

Note that this property does not affect structural validation of the whole HL7 message itself. Structural validation is always performed.