Release Notes for Version 1.0.0 of the IBM WebSphere Business Integration Adapter for Healthcare Data Protocols

These release notes cover release information for version 1.0.0 of the IBM WebSphere Business Integration Adapter for Healthcare Data Protocols. They contain the following sections:
Features Limitations
Hardware and software requirements Known problems and workarounds
Installation and configuration information Documentation
WebSphere Business Integration Adapters API and run time

Note: Important information about this product may be available in Technical Support Flashes issued after these release notes were published. These can be found on the WebSphere Business Integration support Web site, http://www.ibm.com/websphere/integration/wbiserver/support. Select the component area of interest and search the flashes section.

Features

The Adapter for Healthcare Data Protocols allows the integration broker in a WebSphere business integration system to exchange business objects with business processes using HL7 messages, NCPDP messages, or both.

The adapter provides the following functionality:

The adapter supports MQ Series queue connectivity to HL7 version 2.4 and NCPDP version 5 release 1. This adapter is double byte character set (DBCS) enabled for HL7. It is available on Windows NT, Windows 2000, Solaris, and AIX platforms.

Refer to the Adapter for Healthcare Data Protocols User Guide for detailed information about the adapter.

Hardware and software requirements

Hardware and software requirements are included in the product documentation. See Installation and configuration information for links to those guides.

Installation and configuration information

Whether you are installing the software from the CD or downloading it from Passport Advantage and installing it from a local directory, refer to the appropriate guide:

These guides also include general configuration information.

For hardware and software requirements and configuration information specific to this adapter, refer to the Adapter for Healthcare Data Protocols User Guide. 

WebSphere Business Integration Adapters API and run time

Make sure that you run adapters with WebSphere Business Integration Adapters (WBIA) run-time version 1.5.0 or later.

Verifying the version of WBIA run time

To check the version of WBIA run time, locate the manifest file (ProductDir\lib\WBIA.jar) and open it in a suitable Java JAR editor. Look for the following lines:

Implementation-Title: "CWConnectorAPI"
Implementation-Version: 1.5.0
Implementation version indicates the current version of WBIA API.

If the version is not 1.5.0 or later, you must download the latest WBIA run time.

Downloading the WBIA run time

To download the latest version of the WBIA run time:

  1. Go to http://www.ibm.com.
  2. Click the Support and downloads tab.
  3. Under the Downloads heading, click All downloads & drivers.
  4. In the Enter search terms field, type "wbia api" and click Submit.

After you download and install the the run time, you should see the following files:

lib\WBIA.jar
lib\WBIA\3.0.0\WBIA.jar
lib\WBIA\4.0.0\WBIA.jar
lib\WBIA\4.1.1\WBIA.jar
bin\CWConnEnv.bat (Windows)
bin/CWConnEnv.sh (UNIX)
bin\CWODAEnv.bat (Windows)
bin/CWODAEnv.sh (UNIX)
connectors\messages\CwConnectorAgentMessages.txt

Enabling adapters for earlier versions of Adapter Development Kit and InterChange Server

To enable an adapter to work with various versions of ADK or InterChange Server, follow the appropriate procedure below:

InterChange Server versions 4.1.x (except 4.1.0), ADK version 2.1.x

Windows: In CWConnEnv.bat, set the CWVERSION variable to 4.1.X.

set CWVERSION="4.1.X"

UNIX: In CWConnEnv.sh, set the CWVERSION variable to 4.1.X.

set CWVERSION="4.1.X"
Running an Object Discovery Agent (ODA) against InterChange Server versions 4.1.x, ADK versions 2.1.x

Windows: In bin\CWODAEnv.bat, set the CWVERSION variable to 4.1.X.

set CWVERSION="4.1.X"

UNIX: In bin/CWODAEnv.sh, set the CWVERSION variable to 4.1.X.

set CWVERSION="4.1.X"

Limitations

HL7 data handler

NCPDP data handler

Reflecting the NCPDP protocol itself, this adapter supports data encoded only in ascii7.

Known problems and workarounds

Problem: You might encounter problems with the business object definitions file BIA_ISBOForHL7.txt.

Workaround: Modify the file \connectors\Healthcare\samples\BIA_ISBOForHL7.txt as follows:

Note: Attribute definitions are contained between [Attribute]and [End].

  1. Change all instances of the text string "Type = Integer" to "Type = Float".
  2. For all attributes that have "Cardinality = N" (except the "CharacterSet" attribute of the HL7_SGMSH object and the "PrimarykeyValueType" attribute of the HL7_SGMFE object), change the text string "Type = String" to "Type = CW_Array_String".
  3. For the "CharacterSet" attribute of the HL7_SGMSH object and the "PrimarykeyValueType" attribute of the HL7_SGMFE object, keep "Type = String", but change "Cardinality = N" to "Cardinality = 1".

    This change prevents the CharacterSet and PrimarykeyValueType attributes from repeating. Because alternate encoding is not supported in this release, the change to the CharacterSet attribute does not affect the connector's functionality.

  4. For all attributes that have "Cardinality = N", change the text string "Type = Float" to "Type = CW_Array_Float".
  5. Save this file.
  6. Copy the definitions of ISBO "CW_Array_Float" and "CW_Array_String", which are provided below, into a new file (for example, ArrayObject.txt).
  7. From Business Object Designer, select File > Open From File > ArrayObject.txt.
  8. From the same instance of Business Object Designer, select File > Open From File > BIA_ISBOForHL7.txt

    Note: This is the modified file you saved in step 5.

  9. Use File > Save Copy to File to export the business object definitions using xsd format.
Business object definitions for "CW_Array_Float" and "CW_Array_String"

[BusinessObjectDefinition]
Name = CW_Array_Float
Version = 1.0.0

[Attribute]
Name = UnitData
Type = Float
MaxLength = 255
IsKey = true
IsForeignKey = false
IsRequired = false
IsRequiredServerBound = false
Cardinality = 1
AppSpecificInfo = DataTypeID=NM
[End]
[Attribute]
Name = ObjectEventId
Type = String
MaxLength = 1
IsKey = false
IsForeignKey = false
IsRequired = false
IsRequiredServerBound = false
[End]

[Verb]
Name = Create
[End]

[Verb]
Name = Delete
[End]

[Verb]
Name = Retrieve
[End]

[Verb]
Name = Update
[End]
[End]

[BusinessObjectDefinition]
Name = CW_Array_String
Version = 1.0.0

[Attribute]
Name = UnitData
Type = String
MaxLength = 255
IsKey = true
IsForeignKey = false
IsRequired = false
IsRequiredServerBound = false
Cardinality = 1
AppSpecificInfo = DataTypeID=ST
[End]
[Attribute]
Name = ObjectEventId
Type = String
MaxLength = 1
IsKey = false
IsForeignKey = false
IsRequired = false
IsRequiredServerBound = false
[End]

[Verb]
Name = Create
[End]

[Verb]
Name = Delete
[End]

[Verb]
Name = Retrieve
[End]

[Verb]
Name = Update
[End]
[End]

Documentation

Product documentation is not included as part of the product package, either by CD or electronic product distribution. The documentation for this product can be found in the following InfoCenters:

To obtain the product documentation, visit the Web site and download the current documentation set for the release that you are using. Follow the instructions provided on the InfoCenter page to complete the installation.

Copyright IBM Corp. 1997, 2003