A C D E F G H I L M N O P R S T U V W X

A

append(StringBuilder, HL7Seps) - Method in class org.dellroad.hl7.HL7Field

Append properly separated and escaped version of this field to the given buffer.

append(StringBuilder, HL7Seps) - Method in class org.dellroad.hl7.HL7Segment

Append string encoding of this segment to the provided buffer.

append(StringBuilder, HL7Seps) - Method in class org.dellroad.hl7.MSHSegment

Append string encoding of this segment to the provided buffer.

appendField(HL7Field) - Method in class org.dellroad.hl7.HL7Segment

Add a field to the end of this segment.

appendMessage(Node, HL7Message, boolean) - Static method in class org.dellroad.hl7.XMLConverter

Convert a message to XML and append it to the given element.

appendMessage(XMLStreamWriter, HL7Message, boolean) - Static method in class org.dellroad.hl7.XMLConverter

Convert a message to XML and append it to the given XMLStreamWriter.

appendSegment(Node, HL7Segment, boolean) - Static method in class org.dellroad.hl7.XMLConverter

Convert a segment to XML and append it to the given element.

appendSegment(XMLStreamWriter, HL7Segment, boolean) - Static method in class org.dellroad.hl7.XMLConverter

Convert a segment to XML and write it to the given XMLStreamWriter.

C

clear() - Method in class org.dellroad.hl7.HL7SegmentList

close() - Method in class org.dellroad.hl7.io.HL7FileReader

Closes the underlying reader.

close() - Method in class org.dellroad.hl7.io.HL7FileWriter

Closes the underlying writer.

close() - Method in class org.dellroad.hl7.llp.LLPInputStream

Close the underlying stream.

close() - Method in class org.dellroad.hl7.llp.LLPOutputStream

Close this output stream.

COMPONENT_SEPARATOR_ESCAPE - Static variable in class org.dellroad.hl7.HL7Seps

createACK(long) - Method in class org.dellroad.hl7.MSHSegment

Create an acknowlegement message for this message.

createDocument() - Static method in class org.dellroad.hl7.XMLConverter

Create an empty XML document for HL7 messages.

D

DEFAULT - Static variable in class org.dellroad.hl7.HL7Seps

Separator using the default HL7 separator and escape characters.

DEFAULT_COMPONENT_SEPARATOR - Static variable in class org.dellroad.hl7.HL7Seps

DEFAULT_ESCAPE_CHARACTER - Static variable in class org.dellroad.hl7.HL7Seps

DEFAULT_FIELD_SEPARATOR - Static variable in class org.dellroad.hl7.HL7Seps

DEFAULT_PROCESSING_ID - Static variable in class org.dellroad.hl7.MSHSegment

DEFAULT_REPEAT_SEPARATOR - Static variable in class org.dellroad.hl7.HL7Seps

DEFAULT_SUBCOMPONENT_SEPARATOR - Static variable in class org.dellroad.hl7.HL7Seps

DEFAULT_VERSION_ID - Static variable in class org.dellroad.hl7.MSHSegment

E

EMPTY - Static variable in class org.dellroad.hl7.HL7Field

The empty field.

equals(Object) - Method in class org.dellroad.hl7.HL7Field

equals(Object) - Method in class org.dellroad.hl7.HL7Message

equals(Object) - Method in class org.dellroad.hl7.HL7Segment

equals(Object) - Method in class org.dellroad.hl7.HL7Seps

escape(String) - Method in class org.dellroad.hl7.HL7Seps

Escape instances of any separator or escape character within the given string.

escape(String, StringBuilder) - Method in class org.dellroad.hl7.HL7Seps

Escape instances of any separator or escape character within the given string, and add the result to the given buffer.

ESCAPE_CHARACTER_ESCAPE - Static variable in class org.dellroad.hl7.HL7Seps

F

FIELD_SEPARATOR_ESCAPE - Static variable in class org.dellroad.hl7.HL7Seps

fields - Variable in class org.dellroad.hl7.HL7Segment

find(String, char) - Static method in class org.dellroad.hl7.HL7Util

Convenience method.

find(String, char, int) - Static method in class org.dellroad.hl7.HL7Util

Convenience method.

find(String, char, int, int) - Static method in class org.dellroad.hl7.HL7Util

Find all occurrences of the separator character in the sub-string.

findSegment(String, int) - Method in class org.dellroad.hl7.HL7Message

Get the first occurrence of a segname segment in this message.

findSegment(String) - Method in class org.dellroad.hl7.HL7Message

Convenience method.

G

get(int, int, int) - Method in class org.dellroad.hl7.HL7Field

Get a specific field sub-component.

get(String, int, int) - Method in class org.dellroad.hl7.HL7Message

Find a string value by HL7 name.

get(String) - Method in class org.dellroad.hl7.HL7Message

Convenience method.

getCompSep() - Method in class org.dellroad.hl7.HL7Seps

Get the component separator character.

getContent() - Method in exception org.dellroad.hl7.HL7ContentException

Get the offending content.

getControlID() - Method in class org.dellroad.hl7.MSHSegment

Returns control ID from MSH.10.

getEscChar() - Method in class org.dellroad.hl7.HL7Seps

Get the escape character.

getField(String, int) - Method in class org.dellroad.hl7.HL7Message

Find a field by HL7 name.

getField(String) - Method in class org.dellroad.hl7.HL7Message

Convenience method.

getField(int) - Method in class org.dellroad.hl7.HL7Segment

Get a field by "HL7 index".

getFields() - Method in class org.dellroad.hl7.HL7Segment

Get all of the fields, starting with the segment name.

getFieldSep() - Method in class org.dellroad.hl7.HL7Seps

Get the field separator character.

getHL7Seps() - Method in class org.dellroad.hl7.MSHSegment

Get the separator and escape characters defined by MSH.1 and MSH.2.

getMessageType() - Method in class org.dellroad.hl7.MSHSegment

Returns message type from MSH.9.

getMSHSegment() - Method in class org.dellroad.hl7.HL7Message

Get the MSH segment of this message.

getName() - Method in class org.dellroad.hl7.HL7Segment

Get segment name, e.g., MSH, PV1, etc.

getNumFields() - Method in class org.dellroad.hl7.HL7Segment

Get number of fields (including segment name).

getProcessingID() - Method in class org.dellroad.hl7.MSHSegment

Returns control ID from MSH.11.

getReceivingApplication() - Method in class org.dellroad.hl7.MSHSegment

Returns receiving application from MSH.5.

getReceivingFacility() - Method in class org.dellroad.hl7.MSHSegment

Returns receiving facility from MSH.6.

getRepSep() - Method in class org.dellroad.hl7.HL7Seps

Get the repeat separator character.

getSegments() - Method in class org.dellroad.hl7.HL7Message

Get all of the segments in this message.

getSendingApplication() - Method in class org.dellroad.hl7.MSHSegment

Returns sending application from MSH.3.

getSendingFacility() - Method in class org.dellroad.hl7.MSHSegment

Returns sending facility from MSH.4.

getSubSep() - Method in class org.dellroad.hl7.HL7Seps

Get the sub-component separator character.

getTimestamp() - Method in class org.dellroad.hl7.MSHSegment

Returns message timestamp from MSH.7.

getValue() - Method in class org.dellroad.hl7.HL7Field

Get field contents.

getVersionID() - Method in class org.dellroad.hl7.MSHSegment

Returns HL7 version from MSH.12.

H

hasEscapeCharacter() - Method in class org.dellroad.hl7.HL7Seps

Determine if there is an escape character defined.

hashCode() - Method in class org.dellroad.hl7.HL7Field

hashCode() - Method in class org.dellroad.hl7.HL7Message

hashCode() - Method in class org.dellroad.hl7.HL7Segment

hashCode() - Method in class org.dellroad.hl7.HL7Seps

hasSubcomponentSeparator() - Method in class org.dellroad.hl7.HL7Seps

Determine if there is a sub-component character defined.

HEX_DATA_ESCAPE - Static variable in class org.dellroad.hl7.HL7Seps

HL7_NAMESPACE_URI - Static variable in class org.dellroad.hl7.XMLConverter

HL7 message XML namespace.

HL7_TAG - Static variable in class org.dellroad.hl7.XMLConverter

XML tag name used by XMLConverter.toXML(org.dellroad.hl7.HL7Message, boolean).

HL7ContentException - Exception in org.dellroad.hl7

Exception thrown to indicate invalid HL7 content was encountered.

HL7ContentException() - Constructor for exception org.dellroad.hl7.HL7ContentException

HL7ContentException(String) - Constructor for exception org.dellroad.hl7.HL7ContentException

HL7ContentException(String, Throwable) - Constructor for exception org.dellroad.hl7.HL7ContentException

HL7ContentException(Throwable) - Constructor for exception org.dellroad.hl7.HL7ContentException

HL7Field - Class in org.dellroad.hl7

Represents one field in an HL7 message, possibly with repeats.

HL7Field(String) - Constructor for class org.dellroad.hl7.HL7Field

Constructor.

HL7Field(String[]) - Constructor for class org.dellroad.hl7.HL7Field

Constructor used to create a field containing zero or more repeated values, each a simple string value.

HL7Field(String[][][]) - Constructor for class org.dellroad.hl7.HL7Field

Constructor used to create a field containing zero or more repeated values, each containing zero or more components, each component containing zero or more sub-components.

HL7Field(String, HL7Seps) - Constructor for class org.dellroad.hl7.HL7Field

Parsing constructor.

HL7Field(HL7Field) - Constructor for class org.dellroad.hl7.HL7Field

Copy constructor.

HL7FileReader - Class in org.dellroad.hl7.io

Reads in HL7 messages in "file format".

HL7FileReader(Reader) - Constructor for class org.dellroad.hl7.io.HL7FileReader

Constructor.

HL7FileReader(InputStream) - Constructor for class org.dellroad.hl7.io.HL7FileReader

Convenience constructor.

HL7FileWriter - Class in org.dellroad.hl7.io

Writes out HL7 messages in "file format".

HL7FileWriter(Writer) - Constructor for class org.dellroad.hl7.io.HL7FileWriter

Constructor.

HL7FileWriter(OutputStream) - Constructor for class org.dellroad.hl7.io.HL7FileWriter

Convenience constructor.

HL7Message - Class in org.dellroad.hl7

Represents an HL7 message.

HL7Message(MSHSegment) - Constructor for class org.dellroad.hl7.HL7Message

Construct a new HL7 message containing only the given MSH segment.

HL7Message(HL7Seps) - Constructor for class org.dellroad.hl7.HL7Message

Construct an empty HL7 message.

HL7Message() - Constructor for class org.dellroad.hl7.HL7Message

Convenience constructor.

HL7Message(String) - Constructor for class org.dellroad.hl7.HL7Message

Parsing constructor.

HL7Reader - Interface in org.dellroad.hl7

Input source for HL7 messages.

HL7Segment - Class in org.dellroad.hl7

Represents one segment in an HL7 message.

HL7Segment(String) - Constructor for class org.dellroad.hl7.HL7Segment

Constructor that initializes the name of the segment only.

HL7Segment(String, HL7Field[]) - Constructor for class org.dellroad.hl7.HL7Segment

Constructor taking segment name and explicit fields.

HL7Segment(String, HL7Seps) - Constructor for class org.dellroad.hl7.HL7Segment

Constructor that parses a segment line.

HL7Segment(HL7Segment) - Constructor for class org.dellroad.hl7.HL7Segment

Copy constructor.

HL7SegmentList - Class in org.dellroad.hl7

List of HL7Segment objects that requires there to always be an initial MSH segment.

HL7SegmentList(MSHSegment) - Constructor for class org.dellroad.hl7.HL7SegmentList

Constructor.

HL7Seps - Class in org.dellroad.hl7

Container for the HL7 separator and escape characters for an HL7 message.

HL7Seps(char, char, char, char, char) - Constructor for class org.dellroad.hl7.HL7Seps

Constructor.

HL7Seps(char, char, char, char) - Constructor for class org.dellroad.hl7.HL7Seps

Convenience constructor for when there is no sub-component separator.

HL7Seps(char, char, char) - Constructor for class org.dellroad.hl7.HL7Seps

Convenience constructor for when there is no sub-component separator and no escape character.

HL7Util - Class in org.dellroad.hl7

Utility methods.

HL7Writer - Interface in org.dellroad.hl7

Implemented by classes whose instances are capable of sending out HL7 messages.

I

isACK(HL7Message) - Method in class org.dellroad.hl7.MSHSegment

Check whether the given message is an acknowlegement of this MSH.

isEmpty() - Method in class org.dellroad.hl7.HL7Field

L

LEADING_BYTE - Static variable in class org.dellroad.hl7.llp.LLPConstants

LLPConstants - Class in org.dellroad.hl7.llp

HL7 LLP framing constants.

LLPException - Exception in org.dellroad.hl7.llp

Exception generated due to improper LLC framing.

LLPException() - Constructor for exception org.dellroad.hl7.llp.LLPException

LLPException(String) - Constructor for exception org.dellroad.hl7.llp.LLPException

LLPInputStream - Class in org.dellroad.hl7.llp

Reads HL7 messages framed in the "lower layer protocol" (LLP).

LLPInputStream(InputStream, int) - Constructor for class org.dellroad.hl7.llp.LLPInputStream

Constructor.

LLPInputStream(InputStream, Charset, int) - Constructor for class org.dellroad.hl7.llp.LLPInputStream

Constructor.

LLPOutputStream - Class in org.dellroad.hl7.llp

Writes out HL7 messages using the "lower layer protocol".

LLPOutputStream(OutputStream) - Constructor for class org.dellroad.hl7.llp.LLPOutputStream

Constructor.

LLPOutputStream(OutputStream, Charset) - Constructor for class org.dellroad.hl7.llp.LLPOutputStream

Constructor.

M

main(String[]) - Static method in class org.dellroad.hl7.XMLConverter

Test routine.

MESSAGE_TAG - Static variable in class org.dellroad.hl7.XMLConverter

XML tag name used for one XML-encoded message.

MSA_SEGMENT_NAME - Static variable in class org.dellroad.hl7.MSHSegment

MSH_SEGMENT_NAME - Static variable in class org.dellroad.hl7.MSHSegment

MSHSegment - Class in org.dellroad.hl7

Represents an MSH segment.

MSHSegment(String) - Constructor for class org.dellroad.hl7.MSHSegment

Parsing constructor.

MSHSegment(HL7Seps) - Constructor for class org.dellroad.hl7.MSHSegment

Constructor.

MSHSegment() - Constructor for class org.dellroad.hl7.MSHSegment

Convenience constructor.

MSHSegment(MSHSegment) - Constructor for class org.dellroad.hl7.MSHSegment

Copy constructor.

N

nextLine() - Method in class org.dellroad.hl7.io.HL7FileReader

Read next non-ignorable line.

O

org.dellroad.hl7 - package org.dellroad.hl7

This is the API documentation for the hl7lib Java library.

org.dellroad.hl7.io - package org.dellroad.hl7.io

Classes relating to sending and receiving HL7 messages.

org.dellroad.hl7.llp - package org.dellroad.hl7.llp

Classes relating to HL7 "lower layer protocol" (LLP) framing.

P

parseAndAddFields(String, HL7Seps) - Method in class org.dellroad.hl7.HL7Segment

Parse fields from given line and add them.

pushback(String) - Method in class org.dellroad.hl7.io.HL7FileReader

Save the line for next time.

R

reader - Variable in class org.dellroad.hl7.io.HL7FileReader

readMessage() - Method in interface org.dellroad.hl7.HL7Reader

Read the next HL7 message.

readMessage() - Method in class org.dellroad.hl7.io.HL7FileReader

Read next message from the underlying stream.

readMessage() - Method in class org.dellroad.hl7.llp.LLPInputStream

Read next message from the underlying stream.

remove(int) - Method in class org.dellroad.hl7.HL7SegmentList

remove(Object) - Method in class org.dellroad.hl7.HL7SegmentList

removeRange(int, int) - Method in class org.dellroad.hl7.HL7SegmentList

REPEAT_SEPARATOR_ESCAPE - Static variable in class org.dellroad.hl7.HL7Seps

S

SEGMENT_TERMINATOR - Static variable in class org.dellroad.hl7.HL7Message

The character that separates segments in an HL7 message.

segments - Variable in class org.dellroad.hl7.HL7Message

The segments in this message.

set(int, HL7Segment) - Method in class org.dellroad.hl7.HL7SegmentList

setContent(String) - Method in exception org.dellroad.hl7.HL7ContentException

Record the offending text.

setControlID(HL7Field) - Method in class org.dellroad.hl7.MSHSegment

setField(int, HL7Field) - Method in class org.dellroad.hl7.HL7Segment

Set a field in this segment.

setField(int, String) - Method in class org.dellroad.hl7.HL7Segment

Convenience method.

setField(int, HL7Field) - Method in class org.dellroad.hl7.MSHSegment

This subclass version disallows setting MSH.1 or MSH.2 directly.

setHL7Seps(HL7Seps) - Method in class org.dellroad.hl7.MSHSegment

Set MSH.1 and MSH.2 based on the provided separator and escape characters.

setMessageType(HL7Field) - Method in class org.dellroad.hl7.MSHSegment

setName(String) - Method in class org.dellroad.hl7.HL7Segment

Set segment name.

setProcessingID(HL7Field) - Method in class org.dellroad.hl7.MSHSegment

setReceivingApplication(HL7Field) - Method in class org.dellroad.hl7.MSHSegment

setReceivingFacility(HL7Field) - Method in class org.dellroad.hl7.MSHSegment

setSendingApplication(HL7Field) - Method in class org.dellroad.hl7.MSHSegment

setSendingFacility(HL7Field) - Method in class org.dellroad.hl7.MSHSegment

setTimestamp(HL7Field) - Method in class org.dellroad.hl7.MSHSegment

setVersionID(HL7Field) - Method in class org.dellroad.hl7.MSHSegment

skip() - Method in class org.dellroad.hl7.llp.LLPInputStream

Advance past the end of the current message.

stream(Document, OutputStream) - Static method in class org.dellroad.hl7.XMLConverter

Serialize the XML document and write it to the given output.

stream(TransformerFactory, Document, OutputStream) - Static method in class org.dellroad.hl7.XMLConverter

Serialize the XML document and write it to the given output.

SUBCOMPONENT_SEPARATOR_ESCAPE - Static variable in class org.dellroad.hl7.HL7Seps

T

TIMESTAMP_FORMAT - Static variable in class org.dellroad.hl7.MSHSegment

toString(HL7Seps) - Method in class org.dellroad.hl7.HL7Field

Convert to a string using the provided separators.

toString() - Method in class org.dellroad.hl7.HL7Field

Convert to a string using HL7Seps.DEFAULT.

toString() - Method in class org.dellroad.hl7.HL7Message

Convert this message into a string by concatenating the segments in string form, each terminated with a carriage return.

toString(HL7Seps) - Method in class org.dellroad.hl7.HL7Message

Format this message using the supplied separators instead of the ones defined by the MSH segment.

toString(HL7Seps) - Method in class org.dellroad.hl7.HL7Segment

Convert to a string using the provided separators.

toString() - Method in class org.dellroad.hl7.HL7Segment

Convert to a string using HL7Seps.DEFAULT.

toString() - Method in class org.dellroad.hl7.HL7Seps

Returns string representation as well-formed MSH.1 and MSH.2 fields.

toString(HL7Seps) - Method in class org.dellroad.hl7.MSHSegment

Convert to a string using the provided separators.

toString() - Method in class org.dellroad.hl7.MSHSegment

toXML(HL7Message, boolean) - Static method in class org.dellroad.hl7.XMLConverter

Convert an HL7 message message to an XML document.

TRAILING_BYTE_0 - Static variable in class org.dellroad.hl7.llp.LLPConstants

TRAILING_BYTE_1 - Static variable in class org.dellroad.hl7.llp.LLPConstants

trimTo(int) - Method in class org.dellroad.hl7.HL7Segment

Trim off all but the first size fields.

trimTo(int) - Method in class org.dellroad.hl7.MSHSegment

This subclass version disallows trimming away MSH.1 or MSH.2.

U

unescape(String) - Method in class org.dellroad.hl7.HL7Seps

Parse the escaped string back into its unescaped form.

V

validate(char, char, char, char, char) - Static method in class org.dellroad.hl7.HL7Seps

Verify that the given combination of separator and escape characters is valid.

value - Variable in class org.dellroad.hl7.HL7Field

W

writeMessage(HL7Message) - Method in interface org.dellroad.hl7.HL7Writer

Write a message.

writeMessage(HL7Message) - Method in class org.dellroad.hl7.io.HL7FileWriter

Write the given message to the underlying output (and then flush it).

writeMessage(HL7Message) - Method in class org.dellroad.hl7.llp.LLPOutputStream

Write a message using HL7 LLP framing and flush the underlying output.

writer - Variable in class org.dellroad.hl7.io.HL7FileWriter

X

XMLConverter - Class in org.dellroad.hl7

Converts HL7Messages to and from XML.

A C D E F G H I L M N O P R S T U V W X