JavaScript is required to for searching.
Skip Navigation Links
Exit Print View
Oracle Java CAPS Adapter for TCP/IP HL7 User's Guide     Java CAPS Documentation
search filter icon
search icon

Document Information

Oracle Java CAPS Adapter for TCP/IP HL7 User's Guide

Oracle Java CAPS Adapter for TCP/IP HL7 Overview

About Oracle Java CAPS Adapter for TCP/IP HL7

TCP/IP HL7 Features

TCP/IP HL7 Adapter Components

About HL7

The TCP/IP HL7 Adapter Architecture

TCP/IP HL7 Resource Adapter

HL7 Collaborations

Generic HL7 Message Libraries

Oracle Java Composite Application Suite Functionality

Modes and Roles

Standard Mode

HL7 Adapter Sender Role

HL7 Adapter Receiver Role

Delayed ACK Mode

Inbound Functionality

Inbound Adapter Data Flow

Standard Inbound Message Mode Data Flow and Architecture

Inbound Receiver Message Mode

Message Verification

Acknowledgment Processing

Recourse Actions

Outbound Functionality

Outbound Adapter Data Flow

Outbound Standard Messaging Mode

Outbound Adapter Roles for Delayed ACK Scenarios

Outbound Delayed ACK Role

Outbound Forwarder Role

Message Verification

Acknowledgment Processing

Recourse Actions

General Functionality

Non-blocking I/O

HL7 Sequence Numbering Protocol

Failed Message Handling

Recourse Actions

Stopping the Collaboration with a Fatal Alert

TCP/IP HL7 Adapter Operation

Direction

Connection Type

Lower Layer Protocol

MLLP

HLLP

HL7 Acknowledgment Level

Journaling

Error Queues

Alerts and Monitoring

Support for HL7 Version 2.5 SFT Segments

Delayed Acknowledgements

Monitoring the HL7 Adapter

Schematron Support in the HL7 Adapter

Schematron Configuration in HL7 Adapter

API for Schematron Validation

Using the Schematron API

Obtaining the Factory Object

Obtaining the Validator Object

Performing the Validation

Adding and Configuring a TCP/IP HL7 Adapter in a Connectivity Map

Adding a TCP/IP HL7 External Application to a Connectivity Map

To Add a TCP/IP HL7 External Application

Modifying the TCP/IP HL7 Adapter Properties in the Connectivity Map

Modifying Adapter Properties in the Connectivity Map

TCP/IP HL7 V2 Adapter Inbound Connectivity Map Properties

General Inbound Settings - TCP/IP HL7 V2 Inbound Adapter

TCPIP Inbound Settings -- TCP/IP HL7 V2 Inbound Adapter

TCPIP Inbound Settings - Server Port Binding -- TCP/IP HL7 V2 Inbound Adapter

TCPIP Inbound Settings - Client Connection Establishment -- TCP/IP HL7 V2 Inbound Adapter

TCPIP Inbound Settings - Inbound Connection Management -- TCP/IP HL7 V2 Inbound Adapter

TCPIP Inbound Schedules - Listener Schedule -- TCP/IP HL7 V2 Inbound Adapter

TCPIP Inbound Schedules - Service Schedule TCP/IP HL7 V2 Inbound Adapter

HL7 Acknowledgment -- TCP/IP HL7 V2 Inbound Adapter

Lower Layer Protocol -- TCP/IP HL7 V2 Inbound Adapter

Sequence Number Protocol -- TCP/IP HL7 V2 Inbound Adapter

HL7 MSH Segment -- TCP/IP HL7 V2 Inbound Adapter

HL7 SFT Segment -- TCP/IP HL7 V2 Inbound Adapter

Communication Control -- TCP/IP HL7 V2 Inbound Adapter

HL7 Recourse Action -- TCP/IP HL7 V2 Inbound Adapter

TCP/IP HL7 V2 Adapter Outbound Connectivity Map Properties

General Outbound Settings -- TCP/IP HL7 V2 Outbound Adapter

TCPIP Outbound Settings -- TCP/IP HL7 V2 Outbound Adapter

TCPIP Outbound Settings - Client Connection Establishment -- TCP/IP HL7 V2 Outbound Adapter

TCPIP Outbound Settings - Server Port Binding -- TCP/IP HL7 V2 Outbound Adapter

HL7 Acknowledgment -- TCP/IP HL7 V2 Outbound Adapter

Lower Layer Protocol -- TCP/IP HL7 V2 Outbound Adapter

Sequence Number Protocol -- TCP/IP HL7 V2 Outbound Adapter

HL7 MSH Segment -- TCP/IP HL7 V2 Outbound Adapter

HL7 SFT Segment -- TCP/IP HL7 V2 Outbound Adapter

Communication Control -- TCP/IP HL7 V2 Outbound Adapter

HL7 Recourse Action -- TCP/IP HL7 V2 Outbound Adapter

TCP/IP HL7 V3 Adapter Inbound Connectivity Map Properties

General Inbound Settings -- TCP/IP HL7 V3 Inbound Adapter

TCPIP Inbound Settings -- TCP/IP HL7 V3 Inbound Adapter

TCPIP Inbound Settings - Server Port Binding -- TCP/IP HL7 V3 Inbound Adapter

TCPIP Inbound Settings - Client Connection Establishment -- TCP/IP HL7 V3 Inbound Adapter

TCPIP Inbound Settings - Inbound Connection Management -- TCP/IP HL7 V3 Inbound Adapter

TCPIP Inbound Schedules - Listener Schedule -- TCP/IP HL7 V3 Inbound Adapter

TCPIP Inbound Schedules - Service Schedule -- TCP/IP HL7 V3 Inbound Adapter

HL7 Acknowledgment -- TCP/IP HL7 V3 Inbound Adapter

Lower Layer Protocol -- TCP/IP HL7 V3 Inbound Adapter

Sequence Number Protocol -- TCP/IP HL7 V3 Inbound Adapter

HL7v3 Transmission Wrapper -- TCP/IP HL7 V3 Inbound Adapter

Communication Control -- TCP/IP HL7 V3 Inbound Adapter

HL7 Recourse Action -- TCP/IP HL7 V3 Inbound Adapter

Schematron Validation -- TCP/IP HL7 V3 Inbound Adapter

TCP/IP HL7 V3 Adapter Outbound Connectivity Map Properties

General Outbound Settings -- TCP/IP HL7 V3 Outbound Adapter

TCPIP Outbound Settings -- TCP/IP HL7 V3 Outbound Adapter

TCPIP Outbound Settings - Client Connection Establishment -- TCP/IP HL7 V3 Outbound Adapter

TCPIP Outbound Settings - Server Port Binding -- TCP/IP HL7 V3 Outbound Adapter

HL7 Acknowledgment -- TCP/IP HL7 V3 Outbound Adapter

Lower Layer Protocol -- TCP/IP HL7 V3 Outbound Adapter

Sequence Number Protocol -- TCP/IP HL7 V3 Outbound Adapter

HL7v3 Transmission Wrapper -- TCP/IP HL7 V3 Outbound Adapter

Communication Control -- TCP/IP HL7 V3 Outbound Adapter

HL7 Recourse Action -- TCP/IP HL7 V3 Outbound Adapter

Configuring Oracle Java CAPS Adapter for TCP/IP HL7 Environment Properties

Configuring TCP/IP HL7 Adapter Environment Properties

To Configure the Environment Properties

TCP/IP HL7 Inbound Adapter Environment Properties

HL7 Inbound Adapter - TCPIP Inbound Settings

HL7 Inbound Adapter - MDB Pool Settings

HL7 Inbound Adapter - Sequence Number Protocol

HL7 Inbound Adapter - Database Settings

TCP/IP HL7 Inbound Adapter Environment Properties

HL7 Outbound Adapter - TCPIP Outbound Settings

HL7 Outbound Adapter - Connection Pool Settings

HL7 Outbound Adapter - Sequence Number Protocol

Using the TCP/IP HL7 Predefined Templates

Prerequisites for the HL7 V3 Sample Projects

Creating a Copy of an HL7 Sample Project

To Create a Copy of a Project

Customizing Predefined Collaborations for HL7

Creating Copies of HL7 Collaborations

To Create Copies of HL7 Collaborations

Adding an HL7 Message Library to an Existing Collaboration

To Add HL7 Message Library to an Existing Collaboration

About TCP/IP HL7 V2 Collaborations

TCP/IP HL7 V2 Adapter Projects Overview

TCP/IP HL7 V2 Adapter Collaborations

Inbound HL7 V2 Collaboration Overview

Inbound HL7 V2 Collaboration - Part 1

Inbound HL7 V2 Collaboration - Part 2

Inbound HL7 V2 Collaboration - Part 3

Outbound HL7 V2 Collaboration Overview

Outbound HL7 V2 Collaboration - Part 1

Outbound HL7 V2 Collaboration - Part 2

Outbound HL7 V2 Collaboration - Part 3

HL7 V2 Outbound Test Collaboration

About TCP/IP HL7 V3 Collaborations

About HL7 V3

TCP/IP HL7 V3 Adapter Projects Overview

TCP/IP HL7 V3 Adapter Collaborations

Inbound HL7 V3 Immediate Collaboration Overview

HL7 V3 Standard Inbound Message Mode Data Flow (For Immediate Mode of ACK Process) -- Part 1

HL7 V3 Standard Inbound Message Mode Data Flow (For Immediate Mode of ACK Process) -- Part 2

Inbound HL7 V3 Deferred Collaboration Overview

HL7 V3 Standard Inbound Message Mode Data Flow (For Deferred Mode of ACK Process) -- Part 1

HL7 V3 Standard Inbound Message Mode Data Flow (For Deferred Mode of ACK Process) -- Part 2

HL7 V3 Standard Inbound Message Mode Data Flow (For Deferred Mode of ACK Process) -- Part 3

Outbound HL7 V3 Collaboration Overview

HL7 V3 Standard Outbound Message Mode Data Flow (For Immediate and Deferred Mode of ACK Process) -- Part 1

HL7 V3 Standard Outbound Message Mode Data Flow (For Immediate and Deferred Mode of ACK Process) -- Part 2

HL7 V3 Standard Outbound Message Mode Data Flow (For Immediate and Deferred Mode of ACK Process) -- Part 3

HL7 V3 Outbound Test Collaboration

MLLP V2 and the Sample Projects

Creating and Configuring the MLLP V2.0 Database

To Create and Connect to the Database

To Run the MLLP V2.0 Database Scripts

To Create the Connection Pool and JDBC Resource

Associating the MLLP Database With the Adapter

MLLP V2 Content Exchange Model

Standard Inbound HL7 V2 Collaboration Overview over MLLPV2

HL7 V2 Standard Inbound Message Mode Data Flow over MLLPV2 -- Part 1

HL7 V2 Standard Inbound Message Mode Data Flow over MLLPV2 -- Part 2

HL7 V2 Standard Inbound Message Mode Data Flow over MLLPV2 -- Part 3

Adding and Configuring a TCP/IP HL7 Adapter in a Connectivity Map

All Adapters contain a set of properties that are unique to that Adapter type. When you add a TCP/IP HL7 Adapter to a Connectivity Map, you can modify the properties for that specific Adapter. When you add a TCP/IP HL7 External System in the Project’s Environment, you can modify the properties for that Adapter type for all Projects that use that Environment.

You can configure the TCP/IP HL7 Adapter properties in the following locations:

Adding a TCP/IP HL7 External Application to a Connectivity Map

To create a TCP/IP HL7 Adapter you must first add a TCP/IP HL7 External Application to the Connectivity Map. A TCP/IP HL7 Adapter is automatically created when you link a TCP/IP HL7 External Application and a Service. Services are containers for Java Collaborations, Business Processes, Data Integrator processes, and so on.

To Add a TCP/IP HL7 External Application

  1. Create a Connectivity Map for the Project, and add a Service to the Connectivity Map.
  2. On the Connectivity Map toolbar, click the External Applications icon.
  3. Select HL7 External Application from the menu.

    A TCP/IP HL7 External Application icon appears on the Connectivity Map toolbar.

  4. Drag the new HL7 External Application icon from the toolbar onto the Connectivity Map canvas.
  5. To bind the External Application with the Service, do one of the following:
    • If messages are entering from the HL7 system, drag a link from the HL7 External Application to the Service.
    • If messages are being sent from the Service to the HL7 system, drag a link from the Service to the HL7 External Application.

      The TCP/IP HL7 Adapter appears on the link.


      Figure 1 Adapter Location

      image:HL7 External System and Adapter in Connectivity Map.
  6. Modify the Adapter properties, as described in Modifying the TCP/IP HL7 Adapter Properties in the Connectivity Map.

Modifying the TCP/IP HL7 Adapter Properties in the Connectivity Map

You can modify an Adapter's properties after it is created in the Connectivity Map. The properties you modify in the Connectivity Map apply only to the specific Adapter you are configuring. For information on modifying system-wide Adapter properties, see Configuring Oracle Java CAPS Adapter for TCP/IP HL7 Environment Properties.


Tip - A description of each parameter is displayed in the Description box when that parameter is selected, providing an explanation of any required settings or options. Properties are also described in the following topics:


Modifying Adapter Properties in the Connectivity Map

  1. From the Connectivity Map, double-click the Adapter icon located in the link between the TCP/IP HL7 External Application and the Service.

    The Adapter Properties Editor appears, and displays either inbound or outbound properties depending on the link to the Service.

  2. In the explorer panel on the left of the Properties Editor, expand the tree until you see the category you want to modify and then select that category.

    For example, to modify server port binding properties, expand TCPIP Inbound Settings and then select Server Port Binding.

  3. Modify a property by either selecting a new value from a drop-down list (if available) or by typing a new value in the property field.

    Tip - Click on the ellipsis button next to a property field to open a separate configuration dialog box. This is helpful for large values that cannot be fully displayed in the property field. Enter the property value in the dialog box and click OK. The value appears in the parameter’s property field.


  4. (Optional) To record notes and information about the currently selected property, click inside the Comments box in the lower left of the editor and enter the text.

    This information is saved for future reference.

  5. When you are done configuring the properties, click OK.