Package org.vmdb.hl7

Veterinary Medical Database (VMDB) Veterinary HL7 Messaging Library .

See:
Description

Class Summary

ACKMessage	Acknowlegement (ACK) Message.
CEElement	Coded Element (CE) Element.
CM_ERRElement	Composite Message Type Element.
CTDSegment	Contact Data (CTD) Segment Placeholder.
CTISegment	Clinical Trial Identification (CTI) Segment Placeholder.
CXElement	Extended Composite ID with Check Digit (CX) Element.
DRElement	Date/Time Range (DR) Element.
DSCSegment	Continuation Pointer (DSC) Segment Placeholder.
EIElement	Entity Identifier (EI) Element.
ERRSegment	Error (ERR) Segment.
FCElement	Financial Class (FC) Element.
FNElement	Family Name (FN) Element.
FT1Segment	Financial Transaction (FT1) Segment Placeholder.
HDElement	Hierarchic Designator (HD) Element.
HL7Element	Abstract Base Class for HL7 Data Type Elements.
HL7Loop	Abstract Base Class for HL7 Loop Structures.
HL7Message	Generic HL7 Message Structure.
HL7Object	Generic HL7 Object Abstract Base Class.
HL7Segment	Base Class for All Types of HL7 Segments.
HL7SegmentContainer	Abstract Base Class For HL7 Messages and Loops.
Identifiers	Identifier Type Constants and Lists.
Loinc	Predefined Loinc Codes For Common VMDB Observations.
MSASegment	Message Acknowledgement (MSA) Segment.
MSGElement	Composite Message Type Element.
MSHSegment	Message Header (MSH) Segment.
NK1Segment	Next of Kin (NK1) Segment Placeholder.
NTESegment	Notes and Comments (NTE) Segment Placeholder.
OBRSegment	Observation Request (OBR) Segment.
OBSERVATIONLoop	OBSERVATION Loop.
OBXSegment	Observation/Result (OBX) Segment.
ORCSegment	Order Common (ORC) Segment.
ORDER_OBSERVATIONLoop	ORDER_OBSERVATION Loop.
ORUMessage	Observation Unsolicited (ORU) Message.
PATIENT_RESULTLoop	PATIENT_RESULT Loop.
PATIENT_VISITLoop	PATIENT_VISIT Loop.
PATIENTLoop	PATIENT Loop.
PD1Segment	Patient Additional Demographics (PD1) Segment Placeholder.
PIDSegment	Patient Identification (PID) Segment.
PLElement	Person Location (PL) Element.
PTElement	Processing Type (PT) Element.
PV1Segment	Patient Visit (PV1) Segment.
PV2Segment	Patient Visit Additional Information (PV2) Segment Placeholder.
QAKSegment	Query Parameter Definition (QAK) Segment.
QBPMessage	Query By Parameters (QBP) Message.
QPDSegment	Query Parameter Definition (QPD) Segment.
RCPSegment	Response Control Parameter (RCP) Segment.
RepeatElement	Repeat Element.
RSPMessage	Query By Pattern Response (RSP) Message.
SimpleElement	Single Implementation for All Simple HL7 Data Types.
SNElement	Structured Numeric (SN) Element.
StringList	String List Modified String Tokenizer.
TSElement	Time Stamp (TS) Element.
Units	Constants For ISO and ANSI standard Units.
VIDElement	Version ID Element.
XADElement	Extended Address XAD Element.
XCNElement	Extended Composite ID Number and Name for Persons (XCN) Element.
XPNElement	Extended Person Name XPN Element.

Exception Summary

MalformedFieldException	Malformed Field Exception.
MalformedMessageException	Malformed Message Exception.
MalformedRuleException	Malformed Rule Exception.
MalformedSegmentException	Malformed Segment Exception.

Package org.vmdb.hl7 Description

Veterinary Medical Database (VMDB) Veterinary HL7 Messaging Library .

This package is designed to simplify the process of building, formatting, parsing, and accessing HL7 messages used by VMDB--and eventually other veterinary applications.

The library uses recursive construction to build an in-memory representation of the message structure and content. It follows the structure defined by the rules of specific HL7 v2.x message and the semi-official XML representation. This construct can be accessed at multiple levels. The lowest level will allow construction of any HL7 message (correct or otherwise). At a slightly higher level, the library allows moderately user-friendly access to all fields and components of all segments in a message, following basic rule strings. At the highest level, message-specific classes allow application-specific access via a simple get/set, add/list accessor methods with descriptive names. This high level access should ensure that any message constructed complies with both the HL7 standard and the VMDB-specific implementation guides.

The best way to get started with this library is to read the documentation for the ORUMessage class. This class provides the highest level access for all elements of a Observation Unsolicited as used for submission of chart abstract data to VMDB. To add features not anticipated in the design of the ORUMessage class, you will need to understand the lower level implementation. Because this library is open source, the source code of the library is available. The source code in org/vmdb/hl7/ORUMessage.java is a good example of how to implement a high level attribute using the lower levels of the library.

C++ Version

A nearly one-to-one port to ANSI/ISO standard C++ is also available. In general, this same documentation set can be used with the C++ version simply substituting C++ syntax for Java as needed. Differences forced by the underlying language and library differences are documented in Java to C++ Porting Issues

Library Developers

The library source code for both versions is maintained on SourceForge and developers are needed to help with a number of issues. Library Developer Notes

LICENSE

VMDB Veterinary HL7 Messaging Library
Copyright (C) 2002-2003 Michael K. Martin and Veterinary Medical Database (VMDB)

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

For more information about this library or to make suggestions or contributions, you can contact the developer via email at martinmkm@mminformatics.com