Braid User’s Guide                                                                            

 

This guide provides a starting place for users who are new to Braid. It’s describes how to use the braid project.

Introducing Braid

 

This section introduces Braid and its types, including an explanation of various IHE profiles and jar files information.

Content

 

·        Introducing Braid

o       What is Braid

o       What is Base Library

o       What is IHE Library

o       What is Bridge Library

o       IHE Profiles

§        IT Infrastructure Domain

§        Patient Care Coordination (PCC) Domain

o       Braid Distribution

o       Testing Distribution

o       References

What is Braid

 

The Braid project is broken up into three pieces.

1.      Base Library

2.      IHE Library

3.      Bridge Library

The base library contains classes that are reusable and fundamental, but not specific to the IHE contents. This package was built into one separate library like “braid-base-1.1.jar” 

The IHE library is the main implementation of the IHE profiles. It depends on the base library. This package was built into one separate library like “braid-ihe-1.1.jar”

The bridge library is a server side web services for non java applications to access the Braid IHE library, so it depends on the base and IHE libraries. This library was implemented by using Apache Axis2. The package was build from the braid-ihe-1.1.jar and named like “braid-bridge-1.1.aar”.

Client1 is the java application, which directly accesses the IHE client components.

Client2 is the non-java application accessing the IHE client components through web services. These web services are implemented in the bridge component.

Note:

·        The dependent libraries of the base, ihe and bridge packages exist in the root folder.  

·        The braid-bridge-1.1.aar is required only for non-java client applications.

Base Library

 

The base library provides reusable and fundamental functions and data contents. It is usable by itself and has a number features that some other application such as Misys Connect relies on, even without the IHE specific portions.

The base library currently is composed of two major components, namely data class and configuration package. The data class is the basic container class for data model. Some of the main use of the data class is to pass required information to the brokers (such as PatientBroker), and the document builders. The data class is broken up into demographic and clinical data. The demographic data makes up the patient descriptor and patient descriptor set classes. The clinical information is used to describe visits, which in turn are associated with documents which may be retrieved or submitted via the brokers.

The configuration package contains XML based configuration infrastructure that can be used to configure document builders for Patient Care Coordination (PCC) content profiles and network connection for IHE IT infrastructure profile actors.

.   

IHE Library

 

The IHE specific entry points are contained in the IHE library. This library contains client side implementation of IHE profiles in the IT Infrastructure (ITI) domain and the implementation of CDA/CCD document content profiles in the Patient Care Coordination (PCC) domain. 

For ITI domain, the data communication is facilitated via brokers. Brokers are singletons configured for a set of connections with each communication event happening with all available connections. This feature is useful for large systems with multiple repositories, however it is especially useful for the Connectathon where there are many different configurations to be tested. All calls by external data sources are made through the following three brokers: AuditBroker, DocumentBroker and PatientBroker.

AuditBroker

Used to send audit messages to one or more audit record repositories.

DocumentBroker

DocumentBroker supports the client actors of IHE XDS profiles, namely XDS source and consumer. It is used to submit documents to a XDS repository, query documents from a XDS registry, or retrieve documents from a XDS repository.  

PatientBroker

PatientBroker supports the client actors of IHE PIX and PDQ profiles, namely PIX source, PIX consumer and PDQ query. It is used to register a patient to a PIX manager, or query patient demographics from a PDQ supplier.

 

For PCC domain, there are some document (CDA/CCD) creation and submission functions.  The entry point is in IheService.

IheService

 IheService is a static façade that provides document creation (or building) and submission capabilities. So far it offers APIs to build XDS-MS (Referral Summary, Discharge Summary), EDR (Emergency Department Referral), Scanned Document and BPPC Consent documents.  There is also an convenient method to submit documents.

 

The other API entry point in the IHE library is the library configuration element. This configuration loads up most of the IHE connection specific data from XML configuration files.

 

Bridge Library

 

The bridge library contains server side web services for non-java client applications. It’s depends on the base and IHE libraries. This library was implemented by using Apache Axis2. This package was built from the braid-ihe-1.1.jar and named like “braid-bridge-1.1.aar”.  

IHE Profiles

The braid project has implemented the following profiles so far.

IT Infrastructure Domain

1.      Cross-Enterprise Document Sharing of Scanned Documents (Content Creation and View)

2.      Cross-Enterprise Clinical Documents Share (XDS.a)  (XDS.a Source & XDS.a Consumer)

3.      Cross-Enterprise Clinical Documents Share (XDS.b) (XDS.b Source & XDS.b Consumer)

4.      Patient Identifier Cross-referencing for MPI (PIX v2 Source & PIX v2 Consumer)

5.      Patient Demographics Query (PDQ v2 Consumer)

6.      Basic Patient Privacy Consents (BPPC) (BPPC Content & Enforcement)

7.      Audit Trail and Node Authentication

8.      Consistent Time

 

Patient Care Coordination (PCC) Domain

9.      Emergency Department Referral (ED Referral) (Content Creation and View)

10.   Cross-Enterprise Sharing of Medical Summaries (Content Creation and View)

- Referral Summary

- Discharge Summary

Braid Distributions

 

Braid project is released in two distributions.

Distributable-1

 

This distributable is useful for client applications implemented in java to access the IHE client libraries.

Download the braid-1.1.zip file and extract it. It contains the following files.

·        “conf” directory contains the files to configure the IHE actors.

·        “lib” folder contains the common library files.

·        braid-base-1.1.jar         

·        braid-ihe-1.1.jar

Distributable-2

 

This distributable is useful for client applications implemented in no-java (.net) to access the IHE client libraries.

Download the braid-ws-1.1.zip file and extract it. It contains the following files.

·        “conf” directory contains the files to configure the IHE actors.

·        “lib” folder contains the common library files.

·        braid-base-1.1.jar         

·        braid-ihe-1.1.jar

·        braid-bridge-1.1.aar

Directory structure look like this,

o       braid

o       axis2-web

o       WEB-INF

§        classes

§        lib

§        services

§        web.xml

 

Note: This distributable is scheduled to release later.

 

Testing Libraries

 

·        Test Base library

o       Downloads the base\test JUnit classes from the braid trunk to test the base library.

·        Test IHE Library

o       Downloads the ihe\test JUnit classes from the braid trunk to test the ihe library.

References

 

·        IHE Website

http://www.ihe.net/Technical_Framework/index.cfm#IT

·        IHE Wiki

http://wiki.ihe.net/index.php?title=Main_Page

·        NIST Tools for XDS Testing

http://hcxw2k1.nist.gov:9080/

·        Connectathon Results

http://ihe.univ-rennes1.fr/con_result/