All Rights Reserved. US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corporation."> New Page 1

(C) Copyright IBM Corporation 2003. All Rights Reserved.

Notices and trademarks

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.

Notices and trademarks

Proprietary Information
US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

NOTICES
IBM may not offer the products, services, or features discussed in this document in all countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the user's responsibility to evaluate and verify the operation of any non-IBM product, program, or service.
IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not give you any license to these patents. You can send license inquiries, in writing, to:
IBM Director of Licensing
IBM Corporation
North Castle Drive
Armonk, NY 10504-1785
U.S.A.
The following paragraph does not apply to the United Kingdom or any other country where such provisions are inconsistent with local law:
INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or implied warranties in certain transactions, therefore, this statement may not apply to you.
This information could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. IBM may make improvements and/or changes in the product(s) and/or program(s) described in this publication at any time without notice.
Any references in this information to non-IBM Web sites are provided for convenience only and do not in any manner serve as an endorsement of those Web sites. The materials at those Web sites are not part of the materials for this IBM product and use of those Web sites is at your own risk.
IBM may use or distribute any of the information you supply in any way it believes appropriate without incurring any obligation to you.
Licensees of this program who wish to have information about it for the purpose of enabling: (i) the exchange of information between independently created programs and other programs (including this one) and (ii) the mutual use of the information which has been exchanged, should contact:
IBM Burlingame Laboratory Director
IBM Burlingame Laboratory
577 Airport Blvd., Suite 800
Burlingame, CA 94010
U.S.A
Such information may be available, subject to appropriate terms and conditions, including in some cases, payment of a fee.
The licensed program described in this document and all licensed material available for it are provided by IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement, or any equivalent agreement between us.
Any performance data contained herein was determined in a controlled environment. Therefore, the results obtained in other operating environments may vary significantly. Some measurements may have been made on development-level systems and there is no guarantee that these measurements will be the same on generally available systems. Furthermore, some measurement may have been estimated through extrapolation. Actual results may vary. Users of this document should verify the applicable data for their specific environment.
Information concerning non-IBM products was obtained from the suppliers of those products, their published announcements or other publicly available sources. IBM has not necessarily tested those products and cannot confirm the accuracy of performance, compatibility or any other claims related to non-IBM products. Questions on the capabilities of non-IBM products should be addressed to the suppliers of those products.
This information may contain examples of data and reports used in daily business operations. To illustrate them as completely as possible, the examples may include the names of individuals, companies, brands, and products. All of these names are fictitious and any similarity to the names and addresses used by an actual business enterprise is entirely coincidental.
All statements regarding IBM's future direction or intent are subject to change or withdrawal without notice, and represent goals and objectives only.
COPYRIGHT LICENSE
This information may contain sample application programs in source language, which illustrates programming techniques on various operating platforms. You may copy, modify, and distribute these sample programs in any form without payment to IBM, for the purposes of developing, using, marketing or distributing application programs conforming to the application programming interface for the operating platform for which the sample programs are written. These examples have not been thoroughly tested under all conditions. IBM, therefore, cannot guarantee or imply reliability, serviceability, or function of these programs.

Programming interface information
Programming interface information, if provided, is intended to help you create application software using this program.
General-use programming interfaces allow you to write application software that obtain the services of this program's tools.
However, this information may also contain diagnosis, modification, and tuning information. Diagnosis, modification and tuning information is provided to help you debug your application software.
Warning: Do not use this diagnosis, modification, and tuning information as a programming interface because it is subject to change.

Trademarks and service marks
The following terms are trademarks or registered trademarks of International Business Machines Corporation in the United States or other countries, or both:
IBM
the IBM logo
AIX
CrossWorlds
DB2
DB2 Universal Database
Domino
Lotus
Lotus Notes
MQIntegrator
MQSeries
Tivoli
WebSphere
Microsoft, Windows, Windows NT, and the Windows logo are trademarks of Microsoft Corporation in the United States, other countries, or both.
MMX, Pentium, and ProShare are trademarks or registered trademarks of Intel Corporation in the United States, other countries, or both.
Java and all Java-based trademarks are trademarks of Sun Microsystems, Inc. in the United States, other countries, or both.
Other company, product or service names may be trademarks or service marks of others.

Copyright IBM Corp. 1997, 2003