Segment Iterator Object

The segment iterator object allows you to programmatically iterate through and access the segments and fields of a message. This is the main object used in scripted transformation. The following shows the methods on the object.

Method	Description
move_next("SegmentName")	Move to the next segment named by the provided parameter. Returns false if no such segment exists.
move_one()	Move forward by one segment. Returns false if no segment exists.
reset()	Resets iterator to the top of the message.
segment_id()	Returns the label of the current segment.
apply_transform()	Applies outbound Python scripts to the current segment.
count_of_field()	Returns the number of fields in a segment.
field(FieldIndex)	Returns a field object at the specified index. For more information, see Field Object Methods/Properties.
output()	Returns a string with the current segment.

For more information on how the segment iterator object is used in scripted transformation, see Viewing the Transformation Script.


	The segment iterator object can only be used in transformation scripts. It cannot be used when parsing or generating HL7 messages.

iNTERFACEWARE™ Inc.

Segment Iterator Object