IBM(R) WebSphere(R) Business Integration Collaborations for Healthcare contains a set of 14 collaboration templates, WebSphere Business Integration Collaboration for Healthcare Transaction. This document describes how to install the current version of WebSphere Business Integration Collaboration for Healthcare Transaction, available for download from Passport Advantage.
This release of the Healthcare Transaction collaboration is available as an installable Electronic Software Distribution (ESD) package and is not directly packaged with IBM WebSphere InterChange Server V4.2.1. This document gives instructions for installing on both Microsoft(R) Windows(R) and AIX(R) UNIX systems.
Note: For this release, WebSphere Business Integration Collaboration for Healthcare Transaction is supported on IBM WebSphere InterChange Server V4.2.1 running on AIX V5.1, AIX V5.2, or Windows 2000.
IBM(R) WebSphere(R) Business Integration Collaboration for Healthcare Transaction is a set of 14 collaboration templates (with 8 supporting and 4 sample collaboration templates) designed to enable healthcare companies and other professional institutions to comply with the Health Level Seven (HL7) Standard Version 2.4. messaging standard. In addition, it contains over 500 generic business objects that support building and using many HL7 message types.
The following collaboration templates are included in WebSphere Business Integration Collaboration for Healthcare Transaction
HL7-based collaboration templates
HL7-supporting collaboration templates
Sample collaboration templates
In order to implement a solution using WebSphere Business Integration Collaboration for Healthcare Transaction, you may need to refer to one or more of the following WebSphere InterChange Server documents (see the WebSphere Business Integration Library):
The following conventions refer to directories, names, IDs, and passwords:
Notation | Description | Example |
---|---|---|
<WICS> | Directory where IBM WebSphere InterChange Server is installed | /usr/IBM/WebSphereICS or C:\IBM\WebSphereICS |
<WBI/Healthcare> | Directory where IBM WebSphere Business Integration Collaboration for Healthcare Transaction is installed | C:\IBM\ESD\HC |
<WICServer> | Server name where IBM WebSphere InterChange Server is installed | wicserver |
<WICSADMINID> | Administrator ID for IBM WebSphere InterChange Server | admin |
<WICSADMINPWD> | Administrator password for IBM WebSphere InterChange Server | null |
IBM WebSphere InterChange Server and its prerequisites should be installed appropriately for the AIX V5.1 or AIX V5.2 platform, as documented in the System Installation Guide for UNIX , or for Windows 2000, as documented in the System Installation Guide for Windows. Prerequisites include the following:
Before following these installation procedures, make sure that you have downloaded the software that you want to install from Passport Advantage (www.lotus.com/passportadvantage) and extracted it into an appropriate directory. Refer to Passport Advantage for downloading instructions. You must follow the InstallShield process for WebSphere Business Integration Collaboration for Healthcare Transaction before continuing with these instructions.
This section lists the contents of WebSphere Business Integration Collaboration for Healthcare Transaction. All the files described in this section should be extracted to the directory that you specified during the Passport Advantage InstallShield process. If you have not already executed the InstallShield installation process, do so before continuing.
Healthcare Transaction files use the following format:
File name | Description |
---|---|
BIA_BO_HealthCare.jar | IBM WebSphere Business Integration Business Object repository files |
BIA_CT_HealthCare.jar | IBM WebSphere Business Integration Collaboration Template repository files |
BIA_ORG_HealthCare.zip | IBM WebSphere Modeler import file containing WebSphere MQ Workflow model definitions |
BIA_FDL_HealthCare.fdl | IBM WebSphere MQ Workflow FDL file containing workflow process definitions |
BIA_Create_HLTHCARE_Databases.txt | DB2 SQL database creation script for Windows |
BIA_Create_HLTHCARE_Tables.txt | DB2 SQL table creation script for Windows |
BIA_Create_HLTHCARE.tar | DB2 TAR file containing SQL database and table creation scripts for Unix |
BIA_Demo_QTurn.zip | Sample code. QTurn application files to support the provided samples |
BIA_Demo_Support.zip | Sample code. QTurn application user input files used to support the provided samples |
BIA_Demo_HealthCare.jar | Sample code. WebSphere Business Integration Collaboration Template repository file containing the 4 sample collaborations |
Healthcare_Passthru.bat | Batch file used by Compliance Report and Cascading Orders workflow processes |
BIA_PortalSample.zip | Sample code. Portal application, with source, used to support the Healthcare samples for use with WebSphere Portal Server |
BIA_BO_X12_HealthCare.jar | Subset of the IBM WebSphere Business Integration Collaboration for HIPAA Transaction generic business objects used in the Healthcare Electronic Medical Record sample |
The following tables list the contents of WebSphere Business Integration Collaboration for Healthcare Transaction:
File name | Description |
---|---|
HC_QBP_Z01.cwt HC_QBP_Z01.java HC_QBP_Z01_en_US.txt |
Collaboration template files |
MTQBP.xsd MQWF_QBP_Z01.xsd | Business object files |
File name | Description |
---|---|
HC_RSP_Z01.cwt HC_RSP_Z01.java HC_RSP_Z01_en_US.txt |
Collaboration template files |
MTRSP_Z01.xsd MQWF_RSP_Z01.xsd | Business object files |
File name | Description |
---|---|
HC_OMP_O09.cwt HC_OMP_O09.java HC_OMP_O09_en_US.txt |
Collaboration template files |
MQWF_OMP_O09.xsd MTOMP.xsd |
Business object files |
File name | Description |
---|---|
HC_ORP_O10.cwt HC_ORP_O10.java HC_ORP_O10_en_US.txt |
Collaboration template files |
MTORP.xsd MQWF_ORP_O10.xsd |
Business object files |
File name | Description |
---|---|
HC_QRY_A19.cwt HC_QRY_A19.java HC_QRY_A19_en_US.txt |
Collaboration template files |
MQWF_QRY_A19.xsd MTQRY.xsd |
Business object files |
File name | Description |
---|---|
HC_ADR_A19.cwt HC_ADR_A19.java HC_ADR_A19_en_US.txt |
Collaboration template files |
MTADR.xsd MQWF_ADR_A19.xsd MTADR_action.xsd |
Business object files |
File name | Description |
---|---|
HC_OMG_O19.cwt HC_OMG_O19.java HC_OMG_O19_en_US.txt |
Collaboration template files |
MQWF_OMG_O19.xsd MTOMG.xsd |
Business object files |
File name | Description |
---|---|
HC_ORG_O20.cwt HC_ORG_O20.java HC_ORG_O20_en_US.txt |
Collaboration template files |
MTORG.xsd MQWF_ORG_O20.xsd |
Business object files |
File name | Description |
---|---|
HC_QBP_Z02.cwt HC_QBP_Z02.java HC_QBP_Z02_en_US.txt |
Collaboration template files |
MQWF_QBP_Z02.xsd MTQBP.xsd | Business object files |
File name | Description |
---|---|
HC_RSP_Z02.cwt HC_RSP_Z02.java HC_RSP_Z02_en_US.txt |
Collaboration template files |
MTRSP_Z02.xsd MQWF_RSP_Z02.xsd | Business object files |
File name | Description |
---|---|
HC_SRM_Resource.cwt HC_SRM_Resource.java HC_SRM_Resource_en_US.txt |
Collaboration template files |
MQWF_SRM_Resource.xsd MTSRM.xsd |
Business object files |
File name | Description |
---|---|
HC_SRM_Service.cwt HC_SRM_Service.java HC_SRM_Service_en_US.txt |
Collaboration template files |
MQWF_SRM_Service.xsd MTSRM.xsd |
Business object files |
File name | Description |
---|---|
HC_SRR.cwt HC_SRR.java HC_SRR_en_US.txt |
Collaboration template files |
MTSRR.xsd MQWF_SRR.xsd |
Business object files |
File name | Description |
---|---|
HC_ACK.cwt HC_ACK.java HC_ACK_en_US.txt |
Collaboration template files |
MTACK.xsd | Business object file |
File name | Description |
---|---|
HC_Z01_Email.cwt HC_Z01_Email.java HC_Z01_Email_en_US.txt |
Collaboration template files |
MQWF_Z01_Email.xsd | Business object file |
File name | Description |
---|---|
HC_SaveOrder.cwt HC_SaveOrder.java HC_SaveOrder_en_US.txt |
Collaboration template files |
EMR_UPDATE.xsd X12_A1_270.xsd |
Business object files |
File name | Description |
---|---|
HC_271RSP.cwt HC_271RSP.java HC_271RSP_en_US.txt |
Collaboration template files |
X12_A1_271.xsd MQWF_EMR.xsd EMR_Struct_OMP_Email.xsd | Business object files |
File name | Description |
---|---|
HC_EMR_Email.cwt HC_EMR_Email.java HC_EMR_Email_en_US.txt |
Collaboration template files |
EMR_Struct_OMP_Email.xsd | Business object file |
File name | Description |
---|---|
HC_EMR_Alert.cwt HC_EMR_Alert.java HC_EMR_Alert_en_US.txt |
Collaboration template files |
MQWF_OMP_Alert.xsd OMP_EMR_ALERT.xsd |
Business object files |
File name | Description |
---|---|
HC_GetTask.cwt HC_GetTask.java HC_GetTask_en_US.txt |
Collaboration template files |
MQWF_HC_GetTask.xsd MQWF_HC_GetTaskResponse.xsd | Business object files |
File name | Description |
---|---|
HC_EMR_Update.cwt HC_EMR_Update.java HC_EMR_Update_en_US.txt |
Collaboration template files |
MQWF_OMP_UpdateEMR.xsd MQWF_UpdateEMR.xsd |
Business object file |
File name | Description |
---|---|
HC_OMP_Email.cwt HC_OMP_Email.java HC_OMP_Email_en_US.txt |
Collaboration template files |
MQWF_OMP_Email.xsd | Business object files |
The following tables list the files included in the sample collaboration templates:
File name | Description |
---|---|
HCDemo_Notify.cwt HCDemo_Notify.java HCDemo_Notify_en_US.txt |
Collaboration template files |
MTADR_action.xsd HCDemo_Notify_xml.xsd |
Business object files |
File name | Description |
---|---|
HCDemo_SRM_Resource.cwt HCDemo_SRM_Resource.java HCDemo_SRM_Resource_en_US.txt |
Collaboration template files |
MTSRM.xsd MTSRM_Resource_Schedule.xsd MTSRM_Resource_Cancel.xsd |
Business object files |
File name | Description |
---|---|
HCDemo_SRM_Service.cwt HCDemo_SRM_Service.java HCDemo_SRM_Service_en_US.txt |
Collaboration template files |
MTSRM.xsd MTSRM_Service_Schedule.xsd MTSRM_Service_Cancel.xsd |
Business object files |
File name | Description |
---|---|
HCDemo_Alert.cwt HCDemo_Alert.java HCDemo_Alert_en_US.txt |
Collaboration template files |
OMP_EMR_ALERT.xsd | Business object file |
To install IBM WebSphere Business Integration Collaboration for Healthcare Transaction, complete the following steps:
fmcibie -iC:\IBM\ESD\HC\BIA_FDL_HealthCare.fdl -uADMIN -ppassword -o -t -l -f
To create the collaboration objects, complete the following steps:
To configure the Healthcare adapter for use with WebSphere Business Integration Collaboration for Healthcare Transaction, complete the following steps:
Name | Type | App Spec Info |
---|---|---|
MTQBP_Create | String | OutputQueue=queue:// HOSTNAME.queue.manager/HCQBP |
MTOMP_Create | String | OutputQueue=queue:// HOSTNAME.queue.manager/HCOMP |
MTSRM_Resource_Cancel_Create | String | OutputQueue=queue:// HOSTNAME.queue.manager/HCSRMRC |
MTSRM_Resource_Schedule_Create | String | OutputQueue=queue:// HOSTNAME.queue.manager/HCSRMRS |
MTSRM_Service_Schedule_Create | String | OutputQueue=queue:// HOSTNAME.queue.manager/HCSRMSS |
MTSRM_Service_Cancel_Create | String | OutputQueue=queue:// HOSTNAME.queue.manager/HCSRMSC |
MTOMG_Create | String | OutputQueue=queue:// HOSTNAME.queue.manager/HCOMG |
MTQRY_Create | String | OutputQueue=queue:// HOSTNAME.queue.manager/HCQRY |
Name | Type | Default |
---|---|---|
ClassName | String | com.ibm.adapters.datahandlers. hl7.HL7DataHandler |
BOPrefix | String | HL7 |
Representation | String | native |
FieldDelimiter | String | | |
ComponentDelimiter | String | ^ |
RepetitionDelimiter | String | ~ |
EscapeDelimiter | String | \ |
SubcomponentDelimiter | String | & |
MTEventMap | String |
file=C:\IBM\WebSphereICS\connectors\Healthcare\ dependencies\hl7\BIA_HL7MTEventMap.cfg |
I18N | String |
file=C:\IBM\WebSphereICS\connectors\Healthcare\ dependencies\hl7\BIA_HL7I18N.cfg |
DummyKey | String | dummy |
DefaultVerb | String | Create |
EnableStackTrace | String | true |
Event codes and corresponding business objects |
---|
Event=Z01 ; MT=RSP ; BOName=MTRSP_Z01 |
Event=Z02 ; MT=RSP ; BOName=MTRSP_Z02 |
Event=S01 ; MT=SRR ; BOName=MTSRR |
Event=S04 ; MT=SRR ; BOName=MTSRR |
Event=A19 ; MT=ADR ; BOName=MTADR |
Event=O10 ; MT=ORP ; BOName=MTORP |
Event=O20 ; MT=ORG ; BOName=MTORG |
Event=O09 ; MT=OMP ; BOName=MTOMP |
Property | Value |
---|---|
AgentConnections | 0 |
AgentTraceLevel | 1 |
ApplicationName | HealthcareConnector |
BrokerType | ICS |
CharacterEncoding | ascii7 |
ConcurrentEventTriggeredFlows | 5 |
ControllerStoreAndForwardMode | true |
ControllerTraceLevel | 0 |
DeliveryTransport | MQ |
JvmMaxHeapSize | 128m |
JvmMaxNativeStackSize | 128k |
JvmMinHeapSize | 1m |
Locale | en_US |
LogAtInterchangeEnd | False |
MaxEventCapacity | 2,147,483,647 |
MessageFileName | BIA_HealthcareConnector.txt |
OADAutoRestartAgent | false |
OADMaxNumRetry | 1000 |
OADRetryTimeInterval | 10 |
PollEndTime | HH:MM |
PollFrequency | 2000 |
PollStartTime | HH:MM |
RepositoryDirectory | <REMOTE> |
RestartRetryCount | 3 |
RestartRetryInterval | 1 |
WireFormat | CwBO |
Property | Value |
---|---|
ApplicationUserName | |
LogFileName | STDOUT |
ArchiveQueue | queue://HOSTNAME.queue.manager/ MQCONNHC.ARCHIVE |
Channel | CHANNEL1 |
InputQueue | queue://HOSTNAME.queue.manager/ MQCONNHC.IN?targetClient=1 |
Port | Port Number of HOSTNAME.queue.manager |
DataHandlerConfigMO | BIA_MO_DataHandler_Healthcare |
DataHandlerMimeType | hl7 |
ReplyToQueue | queue://HOSTNAME.queue.manager/ MQCONNHC.REPLY?targetClient=1 |
DataHandlerClassName | com.ibm.adapters.datahandlers. hl7.HL7DataHandler |
InProgressQueue | queue://HOSTNAME.queue.manager/ MQCONNHC.IN_PROGRESS |
HostName | Host Name of system |
ConfigurationMetaObject | BIA_STATIC_MO_HL7 |
ErrorQueue | queue://HOSTNAME.queue.manager/ MQCONNHC.ERROR |
ApplicationPassword | |
UnsubscribedQueue | queue://HOSTNAME.queue.manager/ MQCONNHC.UNSUBSCRIBED |
TraceFileName | STDOUT |
InDoubtEvents | Reprocess |
PollQuantity | 5 |
To configure the WebSphere MQ Workflow Adapter for use with WebSphere Business Integration Collaboration for Healthcare Transaction, complete the following steps:
Property | Value |
---|---|
AgentConnections | 0 |
AgentTraceLevel | 1 |
ApplicationName | WebSphereMQWorkflowConnector |
BrokerType | ICS |
CharacterEncoding | ascii7 |
ConcurrentEventTriggeredFlows | 5 |
ControllerStoreAndForwardMode | true |
ControllerTraceLevel | 0 |
DeliveryTransport | MQ |
JvmMaxHeapSize | 128m |
JvmMaxNativeStackSize | 128k |
JvmMinHeapSize | 1m |
Locale | en_US |
LogAtInterchangeEnd | False |
MaxEventCapacity | 2,147,483,647 |
MessageFileName | WebSphereMQWorkflowConnector.txt |
OADAutoRestartAgent | false |
OADMaxNumRetry | 1000 |
OADRetryTimeInterval | 10 |
PollEndTime | HH:MM |
PollFrequency | 2000 |
PollStartTime | HH:MM |
RepositoryDirectory | <REMOTE> |
RestartRetryCount | 3 |
RestartRetryInterval | 1 |
WireFormat | CwBO |
Property | Value |
---|---|
MQSeriesChannel | FMCQM.CL.TCP |
BOPrefix | MQWF_ |
WorkflowSystemName | FMCSYS |
MQSeriesAPITraceLevel | 0 |
MQSeriesHostName | Your system hostname |
MQSeriesQueueManager | FMCQM |
ReplyToQueue | MQWFCONN.REPLY |
MQSeriesCCSID | |
JavaCorbaApi | false |
UnsubscribedQueue | MQWFCONN.UNSUBSCRIBED |
WorkflowAgentName | |
InDoubtEvents | Reprocess |
MQSeriesAPITraceFileName | STDOUT |
InProgressQueue | MQWFCONN.IN_PROGRESS |
DataHandlerConfigMO | MO_DataHandler_Default |
ArchiveQueue | MQWFCONN.ARCHIVE |
MQSeriesPort | 5010 |
DataHandlerMimeType | text/xml |
OutputQueue | FMC.FMCGRP.EXE.XML |
WorkflowAgentLocatorPolicy | LOC |
ErrorQueue | MQWFCONN.ERROR |
WorkflowSystemGroup | FMCGRP |
InputQueue | CWLDINPUTQ |
DataHandlerClassName | com.crossworlds.DataHandlers.text.xml |
ApplicationUserID | |
ApplicationPassword | |
PollQuantity | 5 |
Notes:
Most collaborations use a database connection pool. Refer to the WebSphere InterChange Server System Administration Guide for instructions on creating a connection pool. Be sure to define the database connection pool using your appropriate user ID and password. The user ID defined in the connection pool should be the same ID used when creating the HEALTHCARE_DB database and tables. Note that the default connection pool name used by the collaborations is HEALTHCARE_DB.
The following table shows a sample configuration:
Field name | Value |
---|---|
Database Driver | Example: DB2 (Type2) |
DBConnection Name | Example: HLTHCAREDB |
Host name | |
Login | Existing, valid userid |
Database | HLTHCARE |
Password | Valid login password |
Port number | |
Maximum connections | At least 1, if not unlimited |
New Connection Pool | HEALTHCARE_DB |
Minimum connections | 1 |
For the Electronic Medical Record sample, the HIPAADB database connection definition is also required. Refer to Installing the HIPAA solution, located in the WebSphere Business Integration for HIPAA industry solution documentation, for information on creating this database connection pool and the HIPAADB database.
For each supported operating system, Healthcare Transaction supplies two scripts to help you set up your database and tables. The scripts set up the HLTHCARE database, which is used by a variety of collaboration objects to hold specific state data.
To create the database and tables in a Windows environment, complete the following steps:
db2 < BIA_Create_HLTHCARE_Database.txt
db2 < BIA_Create_HLTHCARE_Tables.txt
To create the database and tables in an AIX environment, complete the following steps:
tar -xvf BIA_Create_HLTHCARE.tar
db2 < BIA_Create_HLTHCARE_Database
db2 < BIA_Create_HLTHCARE_Tables
Notes:
Be sure to deploy each of the following Healthcare Transaction components to the WebSphere InterChange Server: