Class: Net_HL7_Message

Net_HL7_Message Net_HL7_Message( [ $msgStr = ""], [ $hl7Globals = array()])

Constructor for Net_HL7_Message. Consider using the HL7 factory to obtain a message instead.

The constructor takes an optional string argument that is a string representation of a HL7 message. If the string representation is not a valid HL7 message. according to the specifications, undef is returned instead of a new instance. This means that segments should be separated within the message with the segment separator (defaults to \015) or a newline, and segments should be syntactically correct. When using the string argument constructor, make sure that you have escaped any characters that would have special meaning in PHP.

The control characters and field separator will take the values from the MSH segment, if set. Otherwise defaults will be used. Changing the MSH fields specifying the field separator and control characters after the MSH has been added to the message will result in setting these values for the message.

If the message couldn't be created, for example due to a erroneous HL7 message string, an error is raised.

Parameters:

boolean addSegment( object An &$segment)

Add a segment.

The segment will be added to the end of the message. The segment should be an instance of Net_HL7_Segment.

Parameters:

mixed getSegmentAsString( int $index)

Get the segment identified by index as string, using the messsages separators.

Parameters:

object An &getSegmentByIndex( int $index)

Return the segment specified by $index.

Segment count within the message starts at 0.

Parameters:

mixed getSegmentFieldAsString( int $segIndex, int $fldIndex)

Get the field identified by $fldIndex from segment $segIndex.

Returns empty string if field is not set.

Parameters:

array getSegments( )

Return an array containing all segments in the right order.

array getSegmentsByName( mixed $name)

Return an array of all segments with the given name

Parameters:

boolean insertSegment( object An &$segment, [int $idx = ""])

Insert a segment.

The segment should be an instance of Net_HL7_Segment. If the index is not given, nothing happens.

Parameters:

boolean removeSegmentByIndex( int $index)

Remove the segment indexed by $index.

If it doesn't exist, nothing happens, if it does, all segments after this one will be moved one index up.

Parameters:

boolean setSegment( object An &$segment, int $idx)

Set the segment on index.

If index is out of range, or not provided, do nothing. Setting MSH on index 0 will revalidate field separator, control characters and hl7 version, based on MSH(1), MSH(2) and MSH(12).

Parameters:

mixed toString( [boolean $pretty = False])

Return a string representation of this message.

This can be used to send the message over a socket to an HL7 server. To print to other output, use the $pretty argument as some true value. This will not use the default segment separator, but '\n' instead.

Parameters: