HL7 Module Step Glossary
- 14 Dec 2021
- 2 Minutes to read
- Print
- DarkLight
This documentation version is deprecated, please click here for the latest version.
HL7 Module Step Glossary
- Updated on 14 Dec 2021
- 2 Minutes to read
- Print
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
The following article details all steps found in the HL7 Module category in the Step Toolbox.
| Step Name | Description | Location | Inputs/Outputs |
|---|---|---|---|
| Create Message | The Create Message step is used to create a message for HL7. A user can configure the desired message type in the OutputMessage field and the version in the OutputVersion field. The options for the message can be configured by selecting UKNOWN on the for the Input category, and then selecting Build Data. | HL7 > Processing Steps | Inputs: Message Outputs: New Message, Error Message |
| Add Segment At Position | Inserts the specified text (assumed to be a segment) at a position in a String [] of segments. | HL7 > Processing Steps | Inputs: All Segments, New Segment, Position Outputs: Output |
| Clean Special Chars Before Segment Start | Removes newline and carriage return characters. | HL7 > Processing Steps | Inputs: Segment Outputs: Output |
| For Each Segment Array In Envelope | Takes the main text from the HL7 Message and gives each individual Message as a String[] of segments at one time. | HL7 > Processing Steps | Inputs: Message Envelope Outputs: Message Data |
| Get Data From Segment By Position | Gets data from a segment by the position of the data in the segment. | HL7 > Processing Steps | Inputs: Segment, Position Outputs: Output |
| Get Data From Segment By Position In Message | Gets data from a segment by the position of the data in the Message. | HL7 > Processing Steps | Inputs: Message, Position, Segment Name Outputs: Output |
| Get First Segment By Type | Returns the first segment from the Array of Segments by Segment Type. | HL7 > Processing Steps | Inputs: All Segments, Segment Type To Find Outputs: Output |
| Get Segment Position | Gets the position or index of a specific segment. | HL7 > Processing Steps | Inputs: All Segments, Segment Type To Find Outputs: Output |
| Get Segments By Type | Gets all segments by a specific Segment Type. | HL7 > Processing Steps | Inputs: All Segments, Segment Type To Find Outputs: Output |
| Join Messages Into Envelope | Takes a list of String values and converts it into a String with Message Separator characters between each Message. | HL7 > Processing Steps | Inputs: Segments Outputs: Output |
| Join Segments Into Message | Takes a list of String values and converts it into an HL7 Message with segment separator characters between each segment. | HL7 > Processing Steps | Inputs: Segments Outputs: Output |
| Remove All Segments By Type | Removes all the segments with the matching String type. | HL7 > Processing Steps | Inputs: All Segments, Type To Remove Outputs: Output |
| Replace Data In Segment By Position | Substitutes new data in a segment by the position value. | HL7 > Processing Steps | Inputs: New Data, Position, Segment Outputs: Output |
| Replace Data In Segment By Position In Message | Substitutes new data in a segment by the position value in a Message. | HL7 > Processing Steps | Inputs: All Matching Segments, Message, New Data, Position, Segment Name Outputs: Output |
| Split Envelope Into Messages | Splits an Envelope into a String[] with the Message Separator character. | HL7 > Processing Steps | Inputs: Message Outputs: Output |
| Split Message Into Segments | Splits a Message into a String[] of segments with the segment separator character. | HL7 > Processing Steps | Inputs: Message Outputs: Output |
| For Each Abstract Message In Envelope | Iterates through all of the HL7 Messages in the Envelope and allows users to work with one Message at a time until the work is complete. (Used with the Cast Message as Another Message Type step which lets users treat a Message as another Type). | HL7 > Processing Steps | Inputs: Message Envelope Outputs: Message Data |
| For Each Message In Envelope | Similar to the For Each Abstract Message in Envelope except that the Message Types that are expected to be processed are specified and each Message Type received separate paths to modify Message in the workflow. | HL7 > Processing Steps | Inputs: Message Envelope Outputs: Message Type |
| Send Message To Interface | Allows the user to send a Message directly to an Interface at a specific Stage (Pre-Processing, Processing, Post-Processing, Emitter) of the processing. | HL7 > Processing Steps | Inputs: Additional Data For Flow, Interface Name, Message, Stage. Outputs: None |
Was this article helpful?
