logo200.png

Welcome to the HL7 Java SIG Project

... where we strive to prove the promise of semantic interoperability through the HL7 Reference Information Model (RIM).

We call our work product an "API" so here is the javadoc API documentation

HL7 Java SIG code is open source, see license.

Nightly Build

UPDATE (2007/9/20 18:11) we are thankful to have picked up several excellent developers. Including Brian DeCamp? and his co-worker Jon Moore, and also Nick Radov and his co-worker Ravi Luthra. I (Gunther) too have added Chase Crafton to my team and my extended team in people in Pune, India will soon be committing also. With that much good stuff going on, it happens that unclean things are checked in. As a general rule and reminder, we should do a 

ant -Dedition.dir=../encumbered clean tests

before checking in. But I am one of the worst in disobeying this rule. It happens that code is checked in that breaks the build. Currently, when the nightly build is broken, we notice that the javadoc API documentation is not working. For a quick fix, I also have the compiler log online that can be looked it so see what the error is. In addition, Ravi Luthra is installing hudson and some hooks into our subversion check-in process so that we will get immediate feedback on build errors, with email sent to the person checking in. This is soon to come online.

The nightly build produces zip files to download.

HPath Coming of Age

UPDATE (2007/7/9 23:51) Our navigation and querying language, HPath, has now matured to the point where it can perform updates in a more reasonable manner. The documentation of HPath is still skimpy and presently one needs to refer to API documentation and example code. In a nutshell, the new update method will allow one to "update" even the immutable types. Updating immutable values will result in a copy of the value to be returned with the update applied. Further one can apply updates to complex (long) HPath expressions so that all values which would be retrieved by the expression are being updated. Other functions supported include insert and removal of items from itemized lists. Give us a few more weeks to fully adopt and test all these functions and we will be able to provide even updates where the new value results from dynamically evaluating an expression.

New Message Processor Web Service

UPDATE (2006/9/22 23:34) Finally, a new MessageServlet? has been added which receives and processes messages. This is a very simple, but effective, approach of processing HL7 v3 data packets in a much more orderly and quicker way than our previous "DemoDriver?". The new ant targets webServer starts this service using the light-weight but fully featured jetty web server. The jsig.war web application can also be deployed into tomcat or any other web server which knows how to handle war files. The server can be configured by editing etc/web.xml. An easy way of HTTP/POSTing HL7 v3 data instances to the web service is also included. More documentation to follow. I am using this to post the 1300 (and counting) SPL drug labels into the database. We will rewrite most of the demos to use this much faster and realistic means of submitting data to the HL7 v3 complient database.

Java SIG now using the Official HL7 CD-ROM Edition

UPDATE (2006/8/10 14:30) All ties to encumbered data gone. Now building from HL7 CD-ROM

The latest revision of our code generates all code etc. from the official HL7 edition CD-ROM. That way all the ties to the old encumbered branch are broken. This may cause a temporary bump in the road for developers who do not have their CD-ROM handy. I have therefore rearranged the encumbered directory to match the relevant parts of the CD-ROM. However, with the build from CD-ROM, a new Vocabulary.xml file is used and that has changed some names of constants. This leads to source-code incompatibility.

Java SIG Release Candidate

UPDATE (2006/6/10 12:30) Nightly snapshot releases available here

We post nightly snapshot releases along with the most up to date javadoc at the above location. What you find in here is all that you need to build our code except for the HL7 protected intellectual property, which is the MIF files, schemas etc. However, you do not need these files to build and run our software depending on what you do. You can drop in your own MIF files from the CD ROM edition (see instructions). The old encumbered content from the old CVS repository is no longer supported.

I call this a "release candidate" not because this code went through excessive testing and is now ready to go for release but because for the first time we have something that even qualifies as a self-consistent manageable release. However, we are using this code in a system close to production and it is very stable for us. Be sure to read the license, which tells you what you can do, and that there is NO WARRANTY.

Getting Started

To compile you can run ant (which is included in the package). It is as simple as 

./ant/bin/ant

After it is compiled again (from all sources including generated sources) you can run the demos. For example you could run the built-in persistence demo can be played with these steps: 

./ant/bin/ant setupDB
./ant/bin/ant loadData2
./ant/bin/ant loadData3
./ant/bin/ant loadData4

Note, since the jsig.jar file is also included, you would not have to recompile this in order to use it. However, at present it is anticipated that you want to dig into the javasig sources since it is still a work in progress. It works for us as far as we tested it, but you are likely to want to do things in other, new ways, which probably will nudge you to dig into our sources and then recompile.

We also have tentative instructions for using the official HL7 distributed MIFs with our software.

Java SIG Code Base is now truly Open Source

UPDATE (2006/10/2 9:30) The trunk of our development is now the liberated code.

I moved the old encumbered (humongous) trunk on a branch named 'as-is-from-cvs'. So, you can now check out (or switch to) the main trunk which is now FREEly accessible by anyone (without password). Everything below has been updated to reflect this. The encumbered remainder is still on ...branches/encumbered.

Release Candidate Build is Ready

UPDATE (2006/10/1 23:30) GOOD NEWS! We have a release candidate'''

Here is how you build it: 

svn co http://aurora.regenstrief.org/svn/javasig/trunk javasig
svn co http://aurora.regenstrief.org/svn/javasig/branches/encumbered encumbered
cd javasig
ant -Dedition.dir=../encumbered dist

et voilà, a file named hl7-javasig-<timestamp>.zip appears as a sibling to the javasig directory. This file then includes everything for people to build and run. It includes the jsig.jar file, prebuilt generated code, javadoc all set and ready to go. As long as you don't run the "clean" target, there will be no need to regenerate the code, hence no access to the encumbered files will be necessary and you still can do everything with the Java code.

This zip file is still 20 MB in size for all these many lib files we have in there. So I'm not uploading it through my DSL tonight, but tomorrow a release candidate will be available here.

Subversion is our Source Code Repository

NOTE: THE OLD CVS REPOSITORY SHOULD NO LONGER BE USED

UPDATE (2006/10/2 9:30) The trunk of our development is now the liberated code. I moved the old encumbered (humongous) trunk on a branch named 'as-is-from-cvs'. So, you can now check out (or switch to) the main trunk which is now FREEly accessible by anyone (without password). Everything below has been updated to reflect this. The encumbered remainder is still on ...branches/encumbered.

UPDATE (2006/10/1 22:00): The encumbered remainder has been cleaned up so that only the data encumbered by HL7 intellectual property is contained. Old material (pre-MIF and pre-RIM207) has also been removed because it is no longer supported. It is anticipated that the rest of this material will become obsolete too as a release of these files will be used which is maintained by HL7 rather than by Java SIG. You may not need to check out anything but the hl7mif207.jar file, that is recommended if you prefer downloading only 6 MB instead of 253 MB. Just check out hl7mif207.jar

Please Register

If you register, please use the firstinitial+lastname style, which you used to have on the CVS server at NSCEE.

I have a tag on the CVS version after I copied it. So I can track any further changes that are by accident made to the CVS repository. But I may not know unless someone says I should check.

Quick Instuctions for Subversion

Subversion is used essentially like CVS. You say 

svn co http://aurora.regenstrief.org/svn/javasig/trunk javasig

(the trunk is now FREEly available) and once that is done you can do 

cd javasig

and 

svn update

or 

svn commit

just like one did with CVS.

Subversion for Eclipse

Download Subclipse to access the repository with Eclipse.

New Wiki Items Added

For lack of a better front-page and organization of the little wiki content we have at this point, here is a list of new items of interest.

Miscellaneous Tidbits

The old javasig directory contained a 'doc' directory which contains tons of little tidbits of questionable veracity and actuality. As I'm deleting this, I copy most of its content (which I don't know is outdated) to the wiki. May someone else take care of cleaning this up.

This is a Trac Site

Trac is a minimalistic approach to web-based management of software projects. Its goal is to simplify effective tracking and handling of software issues, enhancements and overall progress.

All aspects of Trac have been designed with the single goal to help developers write great software while staying out of the way and imposing as little as possible on a team's established process and culture.

As all Wiki pages, this page is editable, this means that you can modify the contents of this page simply by using your web-browser. Simply click on the "Edit this page" link at the bottom of the page. WikiFormatting will give you a detailed description of available Wiki formatting commands.

"trac-admin yourenvdir initenv" created a new Trac environment, containing a default set of wiki pages and some sample data. This newly created environment also contains documentation to help you get started with your project.

You can use trac-admin to configure Trac to better fit your project, especially in regard to components, versions and milestones.

TracGuide is a good place to start.

Enjoy!
The Trac Team

Starting Points

For a complete list of local wiki pages, see TitleIndex.

Trac is brought to you by Edgewall Software, providing professional Linux and software development services to clients worldwide. Visit http://www.edgewall.com/ for more information.

Attachments