com.illcode.hl7

Class Message

java.lang.Object

com.illcode.hl7.Message

public final class Message
extends java.lang.Object

An HL7v2 message. A message is represent as a map from a segment ID to a list of SegmentS (with entries in the list being the repetitions of segments in the message).

Constructor Summary

Constructors

Constructor and Description
Message() Construct an empty message.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	containsSegment(java.lang.String id) Return true if a segment with the given ID is in the message.
static Message	copyOf(Message m) Create and return a new Message that is a deep copy of the given message.
java.lang.String	getField(java.lang.String spec) Returns the string value of a segment field given a path-like spec string as input.
java.lang.String	getMessageType() Returns the message type found in MSH.9, if present, or null otherwise.
Segment	getSegment(java.lang.String id) Return the first segment (among any repetitions) with the given ID, or null if no such segment is in the Message.
Segment	getSegment(java.lang.String id, int repetition) Return a given reptition of segments with the given ID, or null if no such segment is in the Message.
java.util.Set<java.lang.String>	getSegmentIds() Return a set of all the segment IDs in the message.
java.util.List<Segment>	getSegments(java.lang.String id) Return a list of repetitions for a given segment ID, or null if no segment with that ID is in the message.
void	putSegment(Segment s) Put a segment into the message.
void	removeSegment(Segment s) Remove a segment from the message.
java.util.Collection<java.util.List<Segment>>	segments() Return a collection of all the repetitions of segments in the message.
void	setField(java.lang.String spec, java.lang.String value) Sets a field of a segment in the message.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Message

public Message()

Construct an empty message.

Method Detail

getSegmentIds

public java.util.Set<java.lang.String> getSegmentIds()

Return a set of all the segment IDs in the message.

containsSegment

public boolean containsSegment(java.lang.String id)

Return true if a segment with the given ID is in the message.

segments

public java.util.Collection<java.util.List<Segment>> segments()

Return a collection of all the repetitions of segments in the message.

Note that the iteration order of the returned collection is the order in which the segment lists were added to the message, so to get a well-formed HL7 message, you'll either need to:

1. Insert segments in the correct order (i.e. MSH first, etc.), or
2. Pick out the segments you need in the appropriate order using getSegment(String) or getSegment(String, int) and encode them individually

getSegments

public java.util.List<Segment> getSegments(java.lang.String id)

Return a list of repetitions for a given segment ID, or null if no segment with that ID is in the message.

getSegment

public Segment getSegment(java.lang.String id,
                 int repetition)

Return a given reptition of segments with the given ID, or null if no such segment is in the Message.

getSegment

public Segment getSegment(java.lang.String id)

Return the first segment (among any repetitions) with the given ID, or null if no such segment is in the Message.

putSegment

public void putSegment(Segment s)

Put a segment into the message. If a segment with the same ID already exists, the new segment is added as a repetition.

removeSegment

public void removeSegment(Segment s)

Remove a segment from the message.

getMessageType

public java.lang.String getMessageType()

Returns the message type found in MSH.9, if present, or null otherwise.

Example: "QRY^A19"

getField

public java.lang.String getField(java.lang.String spec)

Returns the string value of a segment field given a path-like spec string as input. The forms that this spec string may take are described below. SID is the three-character segment ID, and F, R, C, and S are positive integers.

1. SID.F — field F of segment SID
2. SID.F.C — component C of field F of segment SID
3. SID.F.C.S — subcomponent S of component C of field F of segment SID

Each of these forms has a variant where the field number F is given in the format "F(R)", where R is the repetition number (starting at 1) for a given field.

Examples:

"MSH.9.1" - Message Type
"PID.3(2).1 - The ID portion (i.e. PID.3.1) of the 2nd repetition in the PID.3 field.

Likewise, for segments that can repeat in a message, the SID can be written SID(R) to get the Rth repetition. Ex: "NK1(2).2.1" for the Family Name of the second instance of the NK1 segment.

If the repetition number is not specified for segment IDs or fields, it defaults to 1.

HAPI Terser Compatibility Syntax

To be partially compatible with the syntax for HAPI's Terser class, you can use a dash "-" in place of the periods "." in the above format. Also, if the spec string starts with a slash "/", it will be silently discarded.

Parameters:

spec - spec string, as above

Returns:

the field value or the empty string "" if such a field is not present in the message

setField

public void setField(java.lang.String spec,
            java.lang.String value)

Sets a field of a segment in the message.

Parameters:

spec - spec string as described in the docs for getField(java.lang.String)

value - scalar value to assign to the field

copyOf

public static Message copyOf(Message m)

Create and return a new Message that is a deep copy of the given message.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object