MergeCOM-3™ Java HL7 Toolkit

 

See:
          Description

API Packages
com.merge.HL7 The com.merge.HL7 package provides the core API that implements version independent HL7 functionality.
com.merge.HL7.v231.fields This package provides classes that model the fields data types defined by the HL7 standard version 2.3.1.
com.merge.HL7.v231.segments This package provides classes that model the segment types defines by the HL7 standard version 2.3.1.
com.merge.HL7.v240.fields This package provides classes that model the fields data types defined by the HL7 standard version 2.4.0.
com.merge.HL7.v240.segments This package provides classes that model the segment types defines by the HL7 standard version 2.4.0.
com.merge.HL7.v251.fields This package provides classes that model the fields data types defined by the HL7 standard version 2.5.1.
com.merge.HL7.v251.segments This package provides classes that model the segment types defines by the HL7 standard version 2.5.1.
com.merge.HL7.v260.fields This package provides classes that model the fields data types defined by the HL7 standard version 2.6.0.
com.merge.HL7.v260.segments This package provides classes that model the segment types defines by the HL7 standard version 2.6.0.

 

 

This Help is targeted toward the developers building HL7 interfaces into their applications. The MergeCOM-3™ Java HL7 Toolkit is a programmer's Application Programming Interface (API) for implementing HL7 interfaces. The major components of the toolkit include sending and receiving HL7 messages; encoding and decoding HL7 streams; translating messages (i.e., mappings); and sample utilities to demonstrate usage and provide useful applications.

Development Platform Requirements

The MergeCOM-3 Java HL7 Toolkit requires the Java™ 2 Platform Standard Edition Development Kit 5.0. Your developement environment (or at a minimum, your target environment) should run on a machine with one of the following operating systems:

Configuration

You can configure the toolkit through a configuration file or, at runtime, through the configuration API in the HL7Toolkit class.

At startup, the toolkit reads its configuration from the hl7toolkit.properties file located in the class path. If this properties file is missing, the toolkit uses default values for each configuration item. At runtime, an application can set or modify configuration items using the setProperties() method of the HL7Toolkit class. You can find a description of configuration items in the documentation of setProperties() method.

In addition to general configuration items, any items defined by the following classes can be defined at the toolkit level:

These items provide the default values for items not explicitly set in instances of the mentioned classes. All default values are documented in this reference, except for the license key which does not have a default and must always be set.

Libraries

The MergeCOM-3 Java HL7 Toolkit is composed of the main toolkit package and the HL7 standard library package.

The main package implements non version-specific HL7 functionalities. It includes all core HL7 functionalities for all version 2.x standards, such as sending and receiving HL7 messages, parsing, constructing segments and fields, and so on. It also includes some additional functionalities, such as logging and configuration, which are also non version-specific.

The HL7 Standard library package included with the toolkit contains v2.x compliant classes. These classes may be utilized for constructing segments and fields and enable developers to address segments and fields in a consistent manner. The Standard library has a dependency on the core toolkit library.

Distribution Structure for Java

The MergeCOM-3 Java HL7 Toolkit is distributed in the following folders and files:

Folder or File
Description
.settings, .classpath and .project
Files of the Eclipse IDE project for building the samples.
bin
Contains compiled samples and scripts for launching them. For details, see The bin Folder.
doc
The doc folder contains the toolkit's documentation.
lib
Contains the HL7 standard libraries (hl7lib2xx.jar) and the main HL7 library (mc3hl7.jar). It also contains the default configuration file (HL7Toolkit.properties).
src
Contains the java source code for the samples. For details, see The src Folder .
read_me
Details the differences between versions of the toolkit.
envsetup.bat
Script that sets up the environment required to run the samples (Windows version).
envsetup.sh
Script that sets up the environment required to run the samples (UNIX version).

The bin Folder

The bin folder contains the following files:

File
Description
hl7samples.jar
Package containing the compiled samples.
hl7samples.er7
A sample HL7 Message file.
SegmentMap.ini
A sample segment map file.
*.bat
Scripts for running the samples on Windows platforms.
*.sh
Scripts for running the samples on UNIX platforms.

The src Folder

The src folder contains the following sample java source files:

File
Description
HL7toRTF.java
Sample application that converts HL7 messages contained in a file into the Rich Text Format (RTF) representation of the message.
MessageHandling.java
Sample that demonstrates simple message and field manipulation operations.
Receiver.java
Sample application that receives HL7 messages and saves them to files in a directory.
Transmitter.java
Sample application that sends HL7 messages to a receiver.
SegmentMapping.java
Sample application that applies the segment mapping defined in a script file to messages read from another file.

Legal Information

This document has been prepared by Merge Healthcare for its customers. The content of this document is confidential. It may be reproduced only with written permission from Merge Merge Healthcare. Specifications contained herein are subject to change, and these changes will be reported in subsequent revisions or editions.

MergeCOM-3™ is a trademark of Merge Healthcare. The names of other products mentioned in this document may be the trademarks or registered trademarks of their respective companies.

Copyright © 2010 by Merge Healthcare

All rights reserved. Unauthorized use, reproduction, or disclosure is prohibited.

Merge OEM
6303 Airport Road, Suite 500, Mississauga, ON, Canada L4V 1R8
Tel. +1-905-364-8000 · Fax +1-905-364-8100
Toll-free in North America: 1-800-724-5970

Customer Support

For assistance, please contact Merge OEM Customer Support:


Copyright © 2010 Merge Healthcare Inc. All Rights Reserved.