Difference between revisions of "OHF IHE"

Revision as of 18:44, 27 June 2007

Intro

The IHE Client plugins are a set of plugins implementing IHE actors and data models. The code is based on the code IBM used to successfully pass the IHE Connectathon 2006 held in Chicago. The IHE Clients code has been migrated to the Eclipse environment and is available as Eclipse Plugins, Web Services (through the OHF Bridge), and as regular jar files in a non RCP environment. In this open source version of the IHE actors, we are using the OHF HL7 and security plugins.

Here is a page specifies some of the Healthcare Services we use to test the plugins with.

PIX/PDQ

Patient Identifier Cross-Referencing (PIX)

From the IHE IT Infrastructure Technical Framework,
The Patient Identifier Cross-referencing Integration Profile (PIX) is targeted at healthcare enterprises of a broad range of sizes (hospital, a clinic, a physician office, etc.). It supports the cross-referencing of patient identifiers from multiple Patient Identifier Domains via the following interactions:
• The transmission of patient identity information from an identity source to the Patient Identifier Cross-reference Manager.
• The ability to access the list(s) of cross-referenced patient identifiers either via a query/ response or via update notification.

This documentation addresses the beta release of the Eclipse OHF plugin implementation of the IHE ITI Technical Framework actor Patient Identity Source for the implementation of the ITI-8 Patient Identity Feed Transaction.

OHF Patient Identity Source Client

This documentation addresses the beta release of the Eclipse OHF plugin implementation of the IHE ITI Technical Framework actor Patient Identifier Cross-reference Consumer for the implementation of the ITI-9 PIX Query Transaction.

OHF Patient Identifer Cross-reference Consumer Client

Patient Demographics Query (PDQ)

The Patient Demographics Query (PDQ) supports querying the Patient Demographics Supplier Actor for patients matching the demographic data in the query message.

This documentation addresses the beta release of the Eclipse OHF plugin implementation of the IHE ITI Technical Framework actor Patient Demographics Consumer for the implementation of the ITI-21 Patient Demographics Query Transaction.

• PDf Version: OHF Patient Demographics Consumer Client
• HTML Version: OHF IHE Patient Demographics Consumer Client

XDS

OHF provides plugin implementation to support the "client" side of IHE IT Infrastructure Technical Framework Cross Enterprise Document Sharing (XDS) Profile. In our context, the "client" side refers to the XDS Document Source and XDS Document Consumer Actors. These actors are supported by the XDS SOAP Client (used to encapsulate SOAP messaging) and the XDS Metadata Model (a conceptual representation of XDS Metadata along with companion extraction and transformation functions).

Details regarding the Version_0_2_0 (CVS tagged April 17, 2007) implementation of these plugins can be found in the following documents.

• OHF XDS Document Consumer (PDF), (HTML)
• OHF XDS Document Source
• OHF XDS Metadata Model

ATNA Audit and Network Authentication Client

OHF provides a preliminary version of the IT Infrastructure Technical Framework Audit Trail and Node Authentication, Audit Client API. This API is intended for use with any IHE Actor needing to send audit information to an Audit Record Repository.

Network Authentication

The network authentication portion of ATNA provides mutual authentication between the "Secure nodes" running IHE Actors using X.509 certificates and TLSv1. In addition there is also the option to encrypt the network communication for the session. Network authentication is directly integrated with the OHF XDS Document Source, XDS Document Consumer, PIX Client, PIX Source, and PDQ Client. The OHF Bridge also supports it.

TLS Configuration

The X.509 certificates need by the plugin must be in the JKS (Java Key Store) format files.

To enable TLSv1 you must configure the plugin. This can be done programmatically using the org.eclipse.ohf.ihf.common.atna.ConfigurationManager class, or via environment variables.

Environment variables for the private keystore holding the private certificate of the node

javax.net.ssl.keyStore=<fullpath/keystore-file>.jks
javax.net.sll.keyStorePassword=XXXX (password for the above file)

Environment variables for the public certificates used to validate the remote node's certificiate

javax.net.ssl.trustStore=<fullpath/truststore-file>.jks
javax.net.ssl.trustStorePassword=XXXX (password for the above file)

(optional) Environment variables for debugging options

javax.net.debug=YYYY

Two common debugging options

javax.net.debug=all  or javax.net.debug=sslhandshake   

(optional) Environment variables for selecting the Ciphe Suites used by TLS

https.cipherSuites= common seperated list of ciphers.   

if not specified the plugin will by default use:

https.cipherSuites=SSL_RSA_WITH_NULL_SHA,TLS_RSA_WITH_AES_128_CBC_SHA

Note: Java uses the name SSL_RSA_WITH_NULL_SHA for the ciphe TLS_RSA_WITH_NULL_SHA. These are the same cipher.

AUDIT Messages

Audit Messages Reference information

ATNA uses DICOM supplement 95 as the source for its audit message content.

ATNA plugins

ATNA is composed of the following plugins:

• org.eclipse.ohf.ihe.atna.agent <-- the main visible package for users
• org.eclipse.ohf.ihe.atna.audit <-- auditing
• org.eclipse.ohf.ihe.atna.payload
• org.eclipse.ohf.ihe.atna.transport<-- open and TLS transport
• org.eclipse.ohf.ihe.common.atna <-- configuration management for TLS properties

User Guide

Documentation regarding OHF ATNA Agent will appear here shortly

• OHF ATNA Agent

Dependencies

AXIS 2.0

The XDS Consumer, XDS Source and ATNA plugins depend on Axis 2.0. Please see Bugzilla 181354. For an important note regarding Axis 2.0

AXIS 1.3

OHF code prior to April 2007 was dependent on AXIS 1.3 with a needed patch to get SOAP transport working. Documentation for this patch can be found in the org.eclipse.ohf.ihe.xds.soap plugin in resources/doc/README.txt

IHE Client plugins in the CVS

For general instractions for the OHF CVS take a look at this page.

In order to use the IHE Client plugins, you will need to download the folowing projects from the CVS:

• org.apache.commons
• org.apache.commons.lang
• org.apache.log4j
• org.apache.xerces
• org.apache.axis2
• org.eclipse.ohf.hl7v2.core
• org.eclipse.ohf.ihe.atna.agent
• org.eclipse.ohf.ihe.atna.audit
• org.eclipse.ohf.ihe.atna.payload
• org.eclipse.ohf.ihe.atna.transport
• org.eclipse.ohf.ihe.common.atna
• org.eclipse.ohf.ihe.common.cdar2
• org.eclipse.ohf.ihe.common.ebXML._2._1
• org.eclipse.ohf.ihe.common.ebXML._3._0
• org.eclipse.ohf.ihe.common.hl7v2
• org.eclipse.ohf.ihe.common.hl7v2.client
• org.eclipse.ohf.ihe.common.mllp
• org.eclipse.ohf.ihe.pdq.consumer
• org.eclipse.ohf.ihe.pix.consumer
• org.eclipse.ohf.ihe.pix.source
• org.eclipse.ohf.ihe.xds.consumer
• org.eclipse.ohf.ihe.xds.metadata
• org.eclipse.ohf.ihe.xds.metadata.extract
• org.eclipse.ohf.ihe.xds.metadata.extract.cdar2
• org.eclipse.ohf.ihe.xds.metadata.transform
• org.eclipse.ohf.ihe.xds.soap
• org.eclipse.ohf.ihe.xds.source
• org.eclipse.ohf.utilities
• org.xmlpull.v1