HL7 Version 2 Settings (Using the HL7 Binding Component)

Using the HL7 Binding Component

HL7 Version 2 Settings

The HL7 Version 2 Settings are divided into the following property types:

HL7 Version 2 Properties

The HL7 Version 2 Properties section includes the Acknowledgement Mode property.

Property	Description
Acknowledgement Mode	The type of acknowledgement used with HL7 transaction. Choose one of the following options: Original: An acknowledgement is sent from the receiving system's application layer once the application has successfully processed the message. This is also called the Application Acknowledgement. Enhanced: Both the Application Acknowledgement (Original Acknowledgement) and an Accept Acknowledgement are sent from the receiving system. The Accept Acknowledgement is sent once the message has been committed to safe storage and acknowledges that there is no need to resend the message.

Property

Description

Acknowledgement Mode

The type of acknowledgement used with HL7 transaction. Choose one of the following options:

Original: An acknowledgement is sent from the receiving system's application layer once the application has successfully processed the message. This is also called the Application Acknowledgement.
Enhanced: Both the Application Acknowledgement (Original Acknowledgement) and an Accept Acknowledgement are sent from the receiving system. The Accept Acknowledgement is sent once the message has been committed to safe storage and acknowledges that there is no need to resend the message.

MSH Properties

The MSH Properties section provides the HL7 MSH Header segment settings. It includes the following properties.

Property	Description
Validate MSH	An indicator of whether MSH segment validation is enabled.
Sequence No	An indicator of whether sequence number protocol is enabled.
Processing ID	The Processing ID value by which the MSH-11 segment in the received message is validated when validateMSH is enabled. MSH-11 is used to indicate whether a message is processed as defined in the HL7 Processing rules. The Processing ID options include the following: D - Debugging T- Training P- Production
Version ID	The HL7 Version ID value by which the MSH-12 segment in the received message is validated when validateMSH is enabled. The Version ID options are 2.1, 2.2, 2.3, 2.3.1, 2.4, 2.5, 2.5.1, and 2.6.
Sending Application	The sending application (MSH-03 segment) used to create the NAK for invalid HL7 messages. This is used to help identify this application from other participating applications within the network enterprise.
Sending Facility	The sending facility (MSH-04 segment) responsible for creating the NAK for invalid HL7 messages. This is used to help further identify participating facilities within the network enterprise.
Encoding Characters	The four encoding characters used to create the NAK for an invalid HL7 message. This attribute contains the four characters in the following order: Component separator Repetition separator Escape character Subcomponent separator The recommended value is ^~\& (that is, ASCII 94, 126, 92, and 38, respectively).
Field Separator	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. Enter the value as a decimal ASCII number ranging from 1 to 127. The default value is 124 which is the character "\|".

Message Properties

The Message Properties section contains the SFT configuration settings. HL7 versions 2.5, 2.5.1, and 2.6 add an SFT segment to every message. The binding not only sends and receives messages with the SFT segment, it can automatically create and populate the SFT configuration settings using information from the message properties for outbound mode, and from the ACK sent for inbound mode. This section includes the following properties.

Property	Description
SFT Enabled	An indicator of whether SFT segment processing is enabled.
Journaling	An indicator of whether journaling of the HL7 message and ACK is enabled.
Software Vendor Organization	The Software Vendor Organization field (SFT-1-Software Vendor Organization), which identifies the vendor who is responsible for maintaining the application. This property only applies to HL7 versions 2.5, 2.5.1, and 2.6.
Software Certified Version or Release Number	The Software Certified Version or Release Number, which is the value of the HL7 segment SFT-02. The current software version number or release number for the sending system, helps to provide a more complete profile of the application that is sending or receiving the HL7 messages. For example, if the sending system is Java CAPS 6.1, the value would be 6.1. This property only applies to HL7 versions 2.5, 2.5.1, and 2.6.
Software Product Name	The name of the software product that submitted the transaction, which is the value of the HL7 segment SFT-03. The software product name is a key component for identifying the sending application. This property only applies to HL7 versions 2.5, 2.5.1, and 2.6.
Software Product Information	The software product identification information, which is the value of the HL7 segment SFT-05. This may include a description of the software application, configuration settings, modifications made to the software, and so forth. This information is used for diagnostic purposes to help identify the application software. This property only applies to HL7 versions 2.5, 2.5.1, and 2.6.
Software Binary ID	The Software Binary ID, which is the value of HL7 segment SFT-04. This property is available starting with HL7 version 2.5. Software Binary IDs are issued by a vendor for each unique software version instance. These IDs are used to differentiate between differing versions of the same software. Identical Primary IDs indicate that the software is identical at the binary level, but configuration settings may differ. This property only applies to HL7 versions 2.5, 2.5.1, and 2.6.
Software Install Date	The Software Install Date, which is the value of HL7 segment SFT-06. This is the date on which the submitting software was installed at the sending site. The install date can provide key information in regard to the behavior of an application. The date format is YYYYMMDDHHSS. This property only applies to HL7 versions 2.5, 2.5.1, and 2.6.