message.getSegmentDelimiter

Use when: You want to read values from the modified message during mapping. If you need the original incoming message, use source.getSegmentDelimiter.

Signature: message.getSegmentDelimiter()

Returns: String separator - the segment delimiter associated with the message

Get the segment delimiter used for this message.

Note

This method only applies to the following formatted messages: HL7, EDIFACT, X12.

Parameters

None

Example

// Example: Get the segment delimiter used by a delimited message.

// assumes `message` is an HL7 message model object, like:
//    MSH|^~\&|SendingApp|SendingFacility|ReceivingApp|ReceivingFacility|202311071230||ADT^A01|123456|P|2.3
//    PID|1||123456^^^&1.2.3.4&ISO||Doe^Jane||19850515|F|||123 Elm St^^Somecity^ST^12345||(555)123-4567^PRN^PH^^^555^1234567

// Retrieve the segment delimiter
var segmentDelimiter = message.getSegmentDelimiter(); // "\r" for HL7