Using the HL7 Binding Component

Normalized Message Properties

The HL7 Binding Component uses the General Normalized Message properties, as well as the HL7 Normalized Message properties for outbound and inbound endpoints.

General Normalized Message Properties

The following General NM properties are available to all binding components.

Table 7 General Normalized Message Properties

Property Name 

Type 

Description and Use 

Endpoint Name 

org.glassfish.openesb.exchange.endpointname 

java.lang.String 

Specifies the endpoint name set on the exchange. This represents the endpoint name of the "owner" of the message, and can be made available by JBI runtime. 

Message ID 

org.glassfish.openesb.messaging.messageid 

java.lang.String 

Specifies a unique identifier for a message. This might be a record number (for example, a particular record in a file), or a GUID. 

Last Record 

org.glassfish.openesb.messaging.lastrecord 

java.lang.String 

Specifies the last record in a group, e.g. the last record in an RM sequence for SOAP messages, or the last record in a file when multiple record processing is turned on for File BC. 

Group ID 

org.glassfish.openesb.messaging.groupid 

java.lang.String 

Specifies a unique identifier for a group to which a message belongs. For example, it applies the RM sequence group number for SOAP messages, or a time stamped file name (where the file record message comes from). 

HL7 Binding Component Normalized Message Properties for Outbound Endpoints

The following table defines the HL7 Normalized Messages for outbound endpoints.

Table 8 HL7 NM Properties for Outbound Endpoints

Property Name 

Type 

Description and Use 

Use Dynamic Endpoint 

org.glassfish.openesb.hl7.use.dynamic.endpoint 

java.lang.String 

Specifies if the message uses "DynamicAddressing." This is a mandatory property if you are using NM properties for dynamic addressing. 

This property has no equivalent WSDL attribute. 

Host 

java.lang.String 

Specifies the host part of a URL used to connect to an HL7 external system. 

The equivalent WSDL attribute is hl7:address -> location(host). 

Port 

org.glassfish.openesb.hl7.outbound.address.port 

java.lang.String 

Specifies the port part of a URL used to connect to an HL7 external system. 

The equivalent WSDL attribute is hl7:address -> location(port). 

Lower Layer Protocol Type 

org.glassfish.openesb.hl7.outbound.protocolproperties.llptype 

java.lang.String 

Indicates the Lower Layer Protocol Type as MLLPv1 (Minimal Lower Layer Protocol release 1), MLLPv2 (Minimal Lower Layer Protocol release 2), and HLLP (Hybrid Lower Layer Protocol). 

The equivalent WSDL attribute is hl7:protocolproperties -> llpType. 

Start Block Character 

org.glassfish.openesb.hl7.outbound.protocolproperties.startblockcharacter 

java.lang.String 

Indicates the Start Block Character Value in a decimal ASCII number from 1 to 127. Unless there is a conflict, the value should be ASCII VT, which is decimal 11. 

The equivalent WSDL attribute is hl7:protocolproperties -> startBlockCharacter. 

End block Character 

org.glassfish.openesb.hl7.outbound.protocolproperties.endblockcharacter 

java.lang.String 

Indicates the End Block Character Value in decimal ASCII number from 1 to 127. To be strictly comply with the HL7 standard, this parameter must be set to a carriage Return, which is decimal 13. 

The equivalent WSDL attribute is hl7:protocolproperties -> endBlockCharacter. 

End Data Character 

org.glassfish.openesb.hl7.outbound.protocolproperties.enddatacharacter 

java.lang.String 

Indicates the End Data Character Value in decimal ASCII number from 1 to 127. Unless there is a conflict, the value should be ASCII VT, which is decimal 28. 

The equivalent WSDL attribute is hl7:protocolproperties -> endDataCharacter. 

Enable HLLP Checksum 

org.glassfish.openesb.hl7.outbound.protocolproperties.hllpchecksumenabled 

java.lang.String 

Specifies if HLLP CheckSum is enabled. “true” indicates enabled. 

The equivalent WSDL attribute is hl7:protocolproperties -> hllpChecksumEnabled. 

Enable Sequence Number Protocol 

org.glassfish.openesb.hl7.outbound.protocolproperties.seqnumenabled 

java.lang.String 

Specifies if sequence number protocol is enabled. “true” indicates enabled. 

The equivalent WSDL attribute is hl7:protocolproperties -> seqNumEnabled. 

MSH Processing ID 

org.glassfish.openesb.hl7.outbound.protocolproperties.processingid 

java.lang.String 

Specifies the ProcessingID value against which the MSH-11-ProcessingID field in the received message is validated when validateMSH is set to “true”. Valid values are P (production), D (debugging), or T (training). 

The equivalent WSDL attribute is hl7:protocolproperties -> processingID. 

Enable MSH Validation 

org.glassfish.openesb.hl7.outbound.protocolproperties.validatemsh 

java.lang.String 

Specifies if the MSH segment in the HL7 message is validated against initiation rules. “true” indicates enabled. 

The equivalent WSDL attribute is hl7:protocolproperties -> validateMSH. 

Enable adding SFT Segment 

org.glassfish.openesb.hl7.outbound.protocolproperties.enablesft 

java.lang.String 

A toggle property to enable/disable SFT segment processing. 

The equivalent WSDL attribute is hl7:protocolproperties -> enabledSFT. 

SFT Field — Software Vendor Organization 

org.glassfish.openesb.hl7.outbound.protocolproperties.softwarevendororganization 

java.lang.String 

Defines the Software Vendor Organization field (SFT-1-Software Vendor Organization) which identifies the vendor who is responsible for maintaining the application. 

The equivalent WSDL attribute is hl7:protocolproperties -> softwareVendorOrganization. 

SFT Field — Software Certified Version Or Release Number 

org.glassfish.openesb.hl7.outbound.protocolproperties.softwarecertifiedversionorreleasenumber 

java.lang.String 

Specifies HL7 segment SFT-02, the Software Certified Version or Release Number. The latest 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 HL7 messages. 

The equivalent WSDL attribute is hl7:protocolproperties -> softwareCertifiedVersionOrReleaseNumber. 

SFT Field — Software Product Name 

org.glassfish.openesb.hl7.outbound.protocolproperties.softwareproductname 

java.lang.String 

Specifies HL7 segment SFT-03, the name of the software product that submitted the transaction. The software product name is a key component for identifying the sending application. 

The equivalent WSDL attribute is hl7:protocolproperties -> softwareProductName. 

SFT Field — Software Binary ID 

org.glassfish.openesb.hl7.outbound.protocolproperties.softwarebinaryid 

java.lang.String 

Specifies HL7 segment SFT-04, the Software Binary ID. 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. 

The equivalent WSDL attribute is hl7:protocolproperties -> softwareBinaryID. 

SFT Field — Software Product Information 

org.glassfish.openesb.hl7.outbound.protocolproperties.softwareproductinformation 

java.lang.String 

Specifies HL7 segment SFT-05, software product identification information. This may include a description of the software application, configuration settings, or modifications made to the software. 

The equivalent WSDL attribute is hl7:protocolproperties -> softwareProductInformation. 

SFT Field — Software Install Date 

org.glassfish.openesb.hl7.outbound.protocolproperties.softwareinstalldate 

java.lang.String 

Specifies HL7 segment SFT-06, the Software Install Date. This is the date, in YYYYMMDDHHSS format, on which the submitting software was installed at the sending site. 

The equivalent WSDL attribute is hl7:protocolproperties -> softwareInstallDate. 

MLLPv2.0 Retries Count On NAK 

org.glassfish.openesb.hl7.protocolproperties.mllpv2retriescountonnak 

java.lang.String 

Specifies the maximum number of retries on receipt of MLLP V2 negative acknowledgement. 

The equivalent WSDL attribute is hl7:protocolproperties -> mllpv2RetriesCountOnNak. 

MLLPv2.0 Retry Interval 

org.glassfish.openesb.hl7.outbound.protocolproperties.mllpv2retryinterval 

java.lang.String 

Specifies the time duration to wait in milliseconds before each retry. 

The equivalent WSDL attribute is hl7:protocolproperties -> mllpv2RetryInterval. 

MLLPv2.0 TimetoWait For ACK/NAK 

org.glassfish.openesb.hl7.outbound.protocolproperties.mllpv2timetowaitforacknak 

java.lang.String 

Specifies the time duration to wait in milliseconds for receiving MLLP V2 commit acknowledgement / negative acknowledgement. 

The equivalent WSDL attribute is hl7:protocolproperties -> mllpv2TimeToWaitForAckNak. 

HL7 Binding Component Normalized Message Properties for Inbound Endpoints

The following table defines the HL7 Normalized Messages for inbound endpoints.

Table 9 HL7 NM Properties for Inbound Endpoints

Property Name 

Type 

Description and Use 

Host 

org.glassfish.openesb.hl7.inbound.address.host 

java.lang.String 

A URL part, which specifies the connectivity information to connect to the HL7 external system. 

The equivalent WSDL attribute is hl7:address -> location (host). 

Port 

org.glassfish.openesb.hl7.inbound.address.port 

java.lang.String 

A URL part, which specifies the connectivity information to connect to the HL7 external system. 

The equivalent WSDL attribute is hl7:address -> location (port). 

Client Address 

org.glassfish.openesb.hl7.inbound.client.address 

java.lang.String 

Represents the client address and port information. 

This property has no equivalent WSDL attribute. 

Enable Sequence Number Protocol 

org.glassfish.openesb.hl7.inbound.protocolproperties.seqnumenabled 

java.lang.String 

Specifies whether sequence number protocol is enabled or not. 

The equivalent WSDL attribute is hl7:protocolproperties -> seqNumEnabled.