6 Health Care Tutorial

The OracleAS Integration B2B tutorials guide you through the steps to design, deploy, and verify B2B scenarios. After using this tutorial, you should be able to create and deploy your own HL7 over MLLP transaction.

This chapter contains the following topics:

• About the Health Care Tutorial

• Before You Begin the Tutorial

• Tutorial: Setting Up an HL7 over MLLP Transaction

• Summary

6.1 About the Health Care Tutorial

This tutorial depicts a scenario in which the admitting unit of a hospital, Acme, sends a notification message of a patient admission to the hospital's central data repository, GlobalChips. GlobalChips then sends an acknowledgment of the admission notification to Acme.

Note:

For this tutorial, you set up OracleAS Integration B2B on servers at both Acme and GlobalChips "sites;" that is, on:

• The Acme server, where Acme is the host trading partner and GlobalChips is the remote trading partner.

• The GlobalChips server, where GlobalChips is the host trading partner and Acme is the remote trading partner.

With this setup, you can verify that the admission notification and acknowledgment are actually sent and received.

On both servers, Acme is the buyer and GlobalChips is the seller.

Note for MLLP Transactions:

For every client and server socket, a listener polls the socket for new messages. If no message is present, the listener sleeps for the interval set in the variable in tip.properties:

oracle.tip.adapter.b2b.mllp.pollInterval

The default value is 1000 milliseconds.

6.2 Before You Begin the Tutorial

Before you begin the tutorial, see the following sections:

• "Installing OracleAS Integration B2B"

• "Setting Up the CLASSPATH Environment"

• "Logging In to OracleAS Integration B2B"

• "Changing the Host Trading Partner Name"

Table 6-1 lists the configuration and run-time files that are used in this tutorial. You use these files to verify the transaction in task 5 of this tutorial. See "Both Servers, Task 5: Verifying the ADT_A01 Transaction" for instructions.

Table 6-1 Run-Time and Configuration Files Used in the Tutorial

Run-Time Files	Configuration Files
a01.xml deq.sh deq.bat enq_a01.sh enq_a01.bat enq_a01.properties ipdequeue.properties	ACK_A01.ecs ACK_A01.xsd ADT_A01.ecs ADT_A01.xsd hl7_buyer.xml hl7_seller.xml

The files are found at

Oracle_Home/ip/tutorial/protocolname

Note:

The path name delimiter used in this documentation, /, is for UNIX. If you are using Windows, assume that the path name delimiter is \.

6.3 Tutorial: Setting Up an HL7 over MLLP Transaction

In the following tasks, you set up the Acme server first and then the GlobalChips server. If you are working through this tutorial with a partner, one person can do the tasks on the Acme server while the other does the tasks on the GlobalChips server.

One person does the following tasks:

• Acme Server, Task 1: Creating the Business Actions

• Acme Server, Task 2: Setting Up the Trading Partners

• Acme Server, Task 3: Creating the Trading Partner Agreement

• Acme Server, Task 4: Creating and Deploying the Configuration

In parallel, the other person does the following tasks:

• GlobalChips Server, Task 1: Creating the Business Actions

• GlobalChips Server, Task 2: Setting Up the Trading Partners

• GlobalChips Server, Task 3: Creating the Trading Partner Agreement

• GlobalChips Server, Task 4: Creating and Deploying the Configuration

After each partner finishes tasks 1 through 4 on the respective server, work together to do task 5:

• Both Servers, Task 5: Verifying the ADT_A01 Transaction

Note:

Fields and checkboxes that you should accept default values for, or leave blank, are omitted in the following steps, although they appear on the screen. This is done to simplify the instructions and move you through the tutorial more quickly.

6.3.1 Acme Server, Task 1: Creating the Business Actions

In the following set of tasks, Acme is the host trading partner. You create the following business actions for this transaction.

• Process_A01—Acme uses the Process_A01 business action to send an admission notification to GlobalChips.

• Process_ACK—GlobalChips uses the Process_ACK business action to send an acknowledgment of the admission notification to Acme.

See "Creating a Business Action" for more information.

6.3.1.1 Creating the Process_A01 Business Action—Acme Sends an ADT_A01 Message

1. Click Partners, then Protocols.

2. Click HL7 over MLLP Exchange.

3. From Shortcut, click Create Business Action.

4. On the Create Business Action: General page, provide the following information and click Next.

   Field	Value
   Name	Process_A01
   Revision	1.0
   Is Nonrepudiation of Receipt Required	No
   Is Nonrepudiation of Origin Required	No
   Acknowledgement Mode	None

   
   

5. On the Create Business Action: Document Protocol Revision page, provide the following information and click Next.

   Field	Value
   Name	HL7
   Revision	2.3.1
   Translation Enabled	Yes
   Validation Enabled	Yes

   
   

   Document Protocol Parameters Field	Override ValueFoot 1
   [Sending App ID]	ACME APP
   [Sending Facility]	ACME FAC
   [Receiving App ID]	ACME APP
   [Receiving Facility]	ACME FAC
   Processing ID	P
   Accept Acknowledgement Type	AL
   Application Acknowledgement Type	AL
   Country Code	US
   Character Set	ASCII

   
   
   ^Footnote 1 If you are working on the GlobalChips server, use GC instead of ACME in the override value.
   

   Note:

   The values in the Document Protocol Parameter fields replace the macros in the MSH segment of the payload.

6. On the Create Business Action: Document Type page, provide the following information and click Next.

   General Field	Value
   Name	ADT_A01
   Revision	2.3.1

   
   

   Document Definition Field	Value
   Name	A01 Definition
   Definition	ADT_A01.xsd

   
   

   Document Type Parameters Field	Override Value
   Message Set ecs File	ADT_A01.ecs

   
   

7. Review the data and click Finish, or make changes using Back.

   You should see Business Action Process_A01 : 1.0 successfully created at the top of the page.

6.3.1.2 Creating the Process_ACK Business Action—Acknowledgment

You create the Process_ACK business action for the seller, GlobalChips, to send an acknowledgment to Acme.

1. Click Partners, then Protocols.

2. Click HL7 over MLLP Exchange.

3. From Shortcut, click Create Business Action.

4. On the Create Business Action: General page, provide the following information and click Next.

   Field	Value
   Name	Process_ACK
   Revision	1.0
   Acknowledgement Mode	None

   
   

5. On the Create Business Action: Document Protocol Revision page, provide the following information and click Next.

   Field	Value
   Create Mode	Use Existing
   Document Protocol Revision	HL7 - 2.3.1

   
   

6. On the Create Business Action: Document Type page, provide the following information and click Next.

   General Field	Override Value
   Name	ACK_A01
   Revision	2.3.1

   
   

   Document Definition Field	Value
   Name	ACK Definition
   Definition	ACK_A01.xsd

   
   

   Document Type Parameters Field	Override Value
   Message Set ecs File	ACK_A01.ecs

   
   

7. Review the data and click Finish, or make changes using Back.

   You should see Business Action Process_ACK : 1.0 successfully created at the top of the page.

6.3.2 Acme Server, Task 2: Setting Up the Trading Partners

On the Acme server, Acme is the host trading partner and GlobalChips is the remote trading partner.

This section contains these topics:

• Setting Up the Remote Trading Partner (GlobalChips)

• Setting Up the Host Trading Partner (Acme)

If you have not already done so, change the default host trading partner name from MyCompany to:

• Acme, if you are working on the Acme server

• GlobalChips, if you are working on the GlobalChips server

See the following for more information:

• "Changing the Host Trading Partner Name"

• "Creating and Assigning All Capabilities During a Single Wizard Session"

• "Creating Business Protocol Communication Capabilities for the Host and Remote Trading Partners"

6.3.2.1 Setting Up the Remote Trading Partner (GlobalChips)

As you set up GlobalChips, you associate it with the following business actions:

• Process_A01-Responder. GlobalChips responds to the Process_A01 business action after it receives the admission notification.

• Process_ACK-Initiator. GlobalChips initiates the Process_ACK business action when it sends an acknowledgment to Acme.

1. Click Partners.

2. From Shortcuts, click Create Trading Partner.

3. On the Create Trading Partner: General page, provide the remote trading partner name, GlobalChips, and click Next.

4. On the Create Trading Partner: Identification page, for the MLLP ID value, enter the fully qualified domain name of the GlobalChips host machine and click Next.

5. On the Create Trading Partner: Operational Capability page, provide the following information and click Next.

   General Field	Value
   Business Protocol	HL7 over MLLP Exchange
   Business Action	Process_A01
   Is Initiator	False
   Functional acknowledgement required?	Yes
   Is acknowledgement handled by Integration B2B?	Yes

   
   

   Document Information Field	Value
   Document Type	ADT_A01
   Use Existing Document Protocol Parameter Values	Uncheck the box.
   Use Default Document Definition	Check the box.

   
   

6. Continuing on the next Create Trading Partner: Operational Capability page, provide the following override values and click Next.

   Document Protocol Parameters Field	Override Value
   [Sending App ID]	GC APP
   [Sending Facility]	GC FAC
   [Receiving App ID]	GC APP
   [Receiving Facility]	GC FAC
   Processing ID	P
   Accept Acknowledgement Type	AL
   Application Acknowledgement Type	AL
   Country Code	US
   Character Set	ASCII

   
   

7. On the Create Trading Partner: Delivery Channel page, provide the following information and click Next.

   Field	Value
   Name	GlobalChips Permanent MLLP
   Acknowledgement Mode	None

   
   

8. On the Create Trading Partner: Document Exchange page, provide the following information and click Next.

   Field	Value
   Name	GlobalChips Permanent DocEx
   Exchange Protocol Revision	MLLP - 1.0

   
   

9. On the Create Trading Partner: Transport page, provide the following information.

   General Field	Value
   Name	GlobalChips MLLP Perm Transport

   
   

   Transport Protocol Field	Value
   Transport Protocol	TCP - 1.0

   
   

   Transport Server Field	Value
   Name	GlobalChips MLLP Perm Transport Server
   Host Name	GlobalChips_hostname The transport server host exchanging messages at the GlobalChips site.

   
   

   Parameters Field	Current Value
   Port	MLLP_server_portnumber
   Permanent Connection Type	True

   
   

   1. Click Create New, provide the following information, and click Next.

   Endpoint Field	Value
   URI	any_string1Foot 1

   
   
   ^Footnote 1 Provide any string because this is a required field.
   

10. Review the data and click Finish, or make changes using Back.

    You should see Trading Partner GlobalChips successfully created at the top of the page.

11. Click Capabilities.

12. Click HL7 over MLLP Exchange.

13. Click Create Operational Capability.

14. On the Create Trading Partner: Operational Capability page, provide the following information and click Apply.

    General Field	Value
    Business Action	Process_ACK
    Is Initiator	True
    Functional acknowledgement required?	No
    Is acknowledgement handled by Integration B2B?	Yes

    
    

    Document Information Field	Value
    Document Type	ACK_A01

    
    

    You should see Supported business action created successfully at the top of the page, for Process_ACK - Initiator.

6.3.2.2 Setting Up the Host Trading Partner (Acme)

In the following steps, you set up the host trading partner's MLLP ID and communication capabilities. The host is automatically assigned a business protocol and operational capabilities that are compatible with the remote trading partner.

1. Click Partners, then Trading Partners.

2. Click Acme (Host).

3. Under Trading Partner Identifications, click Create.

4. For Trading Partner Identification Type, select MLLP ID.

5. For Value, enter the fully qualified domain name of the Acme host machine (for example, myhost.example.com.).

6. Click Apply.

7. Click Capabilities.

8. Click HL7 over MLLP Exchange.

9. Click Create Communication Capability.

10. On the Create Trading Partner: Delivery Channel page, provide the following information and click Next.

    Field	Value
    Name	Acme Permanent MLLP
    Acknowledgement Mode	None

    
    

11. On the Create Trading Partner: Document Exchange page, click Create New.

    1. Provide the following information and click Next.

    Field	Value
    Name	Acme Permanent DocEx
    Exchange Protocol Revision	MLLP - 1.0

    
    

12. On the Create Trading Partner: Transport page, do the following and click Next.

    1. Select Create New and provide the following information:

       General Field	Value
       Name	Acme MLLP Perm Transport

       
       

       Transport Protocol Field	Value
       Transport Protocol	TCP - 1.0

       
       

    2. Select Create New and provide the following information:

       Transport Server Field	Value
       Name	Acme MLLP Perm Transport Server
       Host Name	Acme_hostname The transport server host exchanging messages at the Acme site.

       
       

       Parameters Field	Value
       Port	MLLP_server_portnumber
       Permanent Connection Type	True

       
       

    3. Select Create New and provide the following information:

    Endpoint Field	Value
    URI	any_string2Foot 1

    
    
    ^Footnote 1 Provide any string because this is a required field. Do not use the same string you entered previously.
    

13. Review the data and click Finish, or make changes using Back.

    You should see Communication Capability created successfully at the top of the page.

6.3.3 Acme Server, Task 3: Creating the Trading Partner Agreement

As the host trading partner, Acme is automatically included in the trading partner agreement. So, in the following steps, select GlobalChips as the remote trading partner in the agreement. Acme is also automatically assigned a business action that is compatible with the one assigned to GlobalChips.

Note:

You cannot create a trading partner agreement between more than two trading partners.

1. Click Partners.

2. From Shortcuts, click Create Trading Partner Agreement.

3. From Trading Partner, select GlobalChips.

4. From Supported Business Protocol, select HL7 over MLLP Exchange.

5. From Supported Business Action, select Process_A01 - Responder.

6. For Trading Partner Identification, select MLLP ID - hostname for both GlobalChips and Acme.

7. For Trading Partner Delivery Channel, select GlobalChips Permanent MLLP and Acme Permanent MLLP.

8. In the Name field, enter HL7 MLLP Permanent Agreement.

9. In the Agreement ID field, enter 1800.

10. Click Apply.

    You should see Agreement HL7 MLLP Permanent Agreement successfully created at the top of the page.

11. Under Trading Partner Participants, click Add.

12. From Supported Business Protocol, select HL7 over MLLP Exchange.

13. From Supported Business Action, select Process_ACK - Initiator.

14. Repeat Steps 6 and 7.

15. Click Apply.

    You should see Trading partner participant successfully added.

16. Click Validate.

    You should see Agreement HL7 MLLP Permanent Agreement is valid. The agreement is approved as part of the validation.

See "Creating a Trading Partner Agreement" for more information.

6.3.4 Acme Server, Task 4: Creating and Deploying the Configuration

After you have created the trading partner agreement, you are ready to create the configuration. A configuration consists of the data you defined in the previous tasks in this tutorial. A configuration enforces validation rules, ensuring that only valid, complete, and consistent data is available for deployment in a production environment.

1. Click Deployment.

2. Click Create.

3. For Configuration Name, enter HL7 MLLP Permanent Configuration.

4. Select HL7 MLLP Permanent Agreement.

5. Click Apply.

   You should see Creation and validation of configuration HL7 MLLP Permanent Configuration successful.

6. For HL7 MLLP Permanent Configuration, click Deploy.

7. Review the list of configurations and click Deploy.

   You should see Deployment finished successfully for configuration HL7 MLLP Permanent Configuration.

See Chapter 13, "Creating and Deploying a Configuration" for more information.

6.3.5 Task 5: Verifying the Purchase Order Transaction

See "Both Servers, Task 5: Verifying the ADT_A01 Transaction" for instructions.

6.3.6 GlobalChips Server, Task 1: Creating the Business Actions

Acme and GlobalChips use the same set of business actions. So, on the GlobalChips server, create the same business actions that were created on the Acme server. See "Acme Server, Task 1: Creating the Business Actions" for instructions. As you follow the instructions, substitute GlobalChips for Acme in the override values for the document protocol parameters (as footnoted).

6.3.7 GlobalChips Server, Task 2: Setting Up the Trading Partners

On the GlobalChips server, GlobalChips is the host trading partner and Acme is the remote trading partner.

This section contains these topics:

• Setting Up the Remote Trading Partner (Acme)

• Setting Up the Host Trading Partner (GlobalChips)

If you have not already done so, change the default host trading partner name from MyCompany to:

• Acme, if you are working on the Acme server

• GlobalChips, if you are working on the GlobalChips server

See the following for more information:

• "Changing the Host Trading Partner Name"

• "Creating and Assigning All Capabilities During a Single Wizard Session"

• "Creating Business Protocol Communication Capabilities for the Host and Remote Trading Partners"

6.3.7.1 Setting Up the Remote Trading Partner (Acme)

As you set up Acme, you associate it with the following business actions:

• Process_A01-Initiator. Acme is the initiator of the Process_A01 business action when it sends the admission notification to GlobalChips.

• Process_ACK-Responder. Acme receives an acknowledgment from GlobalChips.

1. Click Partners.

2. From Shortcuts, click Create Trading Partner.

3. On the Create Trading Partner: General page, provide the remote trading partner name, Acme, and click Next.

4. On the Create Trading Partner: Identification page, for the MLLP ID value, enter the fully qualified domain name of the Acme host machine and click Next.

5. On the Create Trading Partner: Operational Capability page, provide the following information and click Next.

   General Field	Value
   Business Protocol	HL7 over MLLP Exchange
   Business Action	Process_A01
   Is Initiator	True
   Functional acknowledgement required?	Yes
   Is acknowledgement handled by Integration B2B?	Yes

   
   

   Document Information Field	Value
   Document Type	ADT_A01
   Use Existing Document Protocol Parameter Values	Uncheck the box.
   Use Default Document Definition	Check the box.

   
   

6. Continuing on the next Create Trading Partner: Operational Capability page, provide the following override values and click Next.

   Document Protocol Parameters Field	Override Value
   [Sending App ID]	ACME APP
   [Sending Facility]	ACME FAC
   [Receiving App ID]	ACME APP
   [Receiving Facility]	ACME FAC
   Processing ID	P
   Accept Acknowledgement Type	AL
   Application Acknowledgement Type	AL
   Country Code	US
   Character Set	ASCII

   
   

7. On the Create Trading Partner: Delivery Channel page, provide the following information and click Next.

   Field	Value
   Name	Acme Permanent MLLP
   Acknowledgement Mode	None

   
   

8. On the Create Trading Partner: Document Exchange page, provide the following information and click Next.

   Field	Value
   Name	Acme Permanent DocEx
   Exchange Protocol Revision	MLLP - 1.0

   
   

9. On the Create Trading Partner: Transport page, provide the following information.

   General Field	Value
   Name	Acme MLLP Perm Transport

   
   

   Transport Protocol Field	Value
   Transport Protocol	TCP - 1.0

   
   

   Transport Server Field	Value
   Name	Acme MLLP Perm Transport Server
   Host Name	Acme_hostname The transport server host exchanging messages at the Acme site.

   
   

   Parameters Field	Value
   Port	MLLP_server_portnumber
   Permanent Connection Type	True

   
   

   1. Click Create New, provide the following information, and click Next.

   Endpoint Field	Value
   URI	None

   
   

10. Review the data and click Finish, or make changes using Back.

    You should see Trading Partner Acme created successfully at the top of the page.

11. Click Capabilities.

12. Click HL7 over MLLP Exchange.

13. Click Create Operational Capability.

14. On the Create Trading Partner: Operational Capability page, provide the following information and click Apply.

    General Field	Value
    Business Action	Process_ACK
    Is Initiator	False
    Functional acknowledgement required?	No
    Is acknowledgement handled by Integration B2B?	Yes

    
    

    Document Information Field	Value
    Document Type	ACK_A01

    
    

    You should see Supported business action created successfully at the top of the page, for Process_ACK - Responder.

6.3.7.2 Setting Up the Host Trading Partner (GlobalChips)

In the following steps, you set up the host trading partner's MLLP ID and communication capabilities. The host is automatically assigned a business protocol and operational capabilities that are compatible with the remote trading partner.

1. Click Partners, then Trading Partners.

2. Click GlobalChips (Host).

3. Under Trading Partner Identifications, click Create.

4. For Trading Partner Identification Type, select MLLP ID.

5. For Value, enter the fully qualified domain name of the GlobalChips host machine.

6. Click Apply.

7. Click Capabilities.

8. Click HL7 over MLLP Exchange.

9. Click Create Communication Capability.

10. On the Create Trading Partner: Delivery Channel page, provide the following information and click Next.

    Field	Value
    Name	GlobalChips Permanent MLLP
    Acknowledgement Mode	None

    
    

11. On the Create Trading Partner: Document Exchange page, click Create New.

    1. Provide the following information and click Next.

    Field	Value
    Name	GlobalChips Permanent DocEx
    Exchange Protocol Revision	MLLP - 1.0

    
    

12. On the Create Trading Partner: Transport page, do the following information and click Next.

    1. Select Create New and provide the following information:

       General Field	Value
       Name	GlobalChips MLLP Perm Transport

       
       

       Transport Protocol Field	Value
       Transport Protocol	TCP - 1.0

       
       

    2. Select Create New and provide the following information:

       Transport Server Field	Value
       Name	GlobalChips MLLP Perm Transport Server
       Host Name	GlobalChips_hostname The transport server host exchanging messages at the GlobalChips site.

       
       

       Parameters Field	Value
       Port	MLLP_server_portnumber
       Permanent Collection Type	True

       
       

    3. Select Create New and provide the following information:

    Endpoint Field	Value
    URI	any_stringFoot 1

    
    
    ^Footnote 1 Provide any string in this required field. Do not use the same string you entered previously.
    

13. Review the data and click Finish, or make changes using Back.

    You should see Communication Capability created successfully at the top of the page.

6.3.8 GlobalChips Server, Task 3: Creating the Trading Partner Agreement

As the host trading partner, GlobalChips is automatically included in the trading partner agreement. So, in the following steps, select Acme as the remote trading partner in the agreement. GlobalChips is also automatically assigned a business action that is compatible with the one assigned to Acme.

Note:

You cannot create a trading partner agreement between more than two trading partners.

1. Click Partners.

2. From Shortcuts, click Create Trading Partner Agreement.

3. From Trading Partner, select Acme.

4. From Supported Business Protocol, select HL7 over MLLP Exchange.

5. From Supported Business Action, select Process_A01-Initiator.

6. For Trading Partner Identification, select MLLP ID - hostname for both Acme and Globalchips.

7. For Trading Partner Delivery Channel, select Acme Permanent MLLP and GlobalChips Permanent MLLP.

8. In the Name field, enter HL7 Permanent Agreement.

9. In the Agreement ID field, enter 1900.

10. Click Apply.

    You should see Agreement HL7 Permanent Agreement successfully created at the top of the page.

11. Under Trading Partner Participants, click Add.

12. From Supported Business Protocol, select HL7 over MLLP Exchange.

13. From Supported Business Action, select Process_ACK - Responder.

14. Repeat Steps 6 and 7.

15. Click Apply.

    You should see Trading partner participant successfully added.

16. Click Validate.

    You should see Agreement HL7 Permanent Agreement is valid. The agreement is approved as part of the validation.

See "Creating a Trading Partner Agreement" for more information.

6.3.9 GlobalChips Server, Task 4: Creating and Deploying the Configuration

This step is the same on both servers. See "Acme Server, Task 4: Creating and Deploying the Configuration" for instructions.

6.3.10 Both Servers, Task 5: Verifying the ADT_A01 Transaction

To verify the transmission and receipt of the ADT_A01 and ACK messages, use the run-time files at

Oracle_Home/ip/tutorial/hl7/runtime

Table 6-1 lists the run-time files. On UNIX platforms, you must grant execute permission using chmod +x to run the scripts.

Note:

You must run the setenv script to set up the CLASSPATH environment before running the following enqueue and dequeue scripts. See "Setting Up the CLASSPATH Environment" if you have not already done so.

1. On the GlobalChips server, run one of the following files:

   • In a Bourne or Korn shell—deq.sh

   • In Windows—deq.bat

   This dequeues the ADT_A01 message on the GlobalChips server.

2. On the Acme server, run one of the following files:

   • In a Bourne or Korn shell—enq_a01.sh

   • In Windows—enq_a01.bat

   This enqueues the ADT_A01 message and translates it into a native Hl7 message to send to GlobalChips. Wait a minute or two before proceeding to the next step.

   On the GlobalChips server, the message is dequeued, which you can see in the trace file, t1.trc. The trace file which shows the message that the application receives from OracleAS Integration B2B.

3. Click Reports in the user interface to view the acknowledgment generated by GlobalChips.

6.4 Summary

This chapter provides a tutorial for creating an HL7 over MLLP configuration. The tutorial guides you through the steps to design, deploy, and verify the configuration.