Skip to main content


abstract class EnsLib.HL7.Operation.BatchStandard extends EnsLib.HL7.Operation.Standard

Property Inventory

Method Inventory


parameter SETTINGS = Filename:Basic,AutoBatchParentSegs;
Inherited description: List of properties can be set as settings in the configuration file format is a comma separated list of property names


property AutoBatchParentSegs as %Boolean [ InitialExpression = 0 ];
When writing a message that has a batch parent, output the batch headers first, and follow up with the batch trailers when triggered by the final batch parent header message or by a file name change.
All child messages of a batch parent message will be written out unless already written previously while AutoBatchParentSegs=true.
Property methods: AutoBatchParentSegsDisplayToLogical(), AutoBatchParentSegsGet(), AutoBatchParentSegsIsValid(), AutoBatchParentSegsLogicalToDisplay(), AutoBatchParentSegsNormalize(), AutoBatchParentSegsSet()
property Filename as %String (MAXLEN = 1000, MINLEN = 1) [ InitialExpression = "%f_%Q" , Required ];
Name of file to output the document(s) to. May include timestamp specifiers. The %f specifier, if present, will be replaced with the name of the document's original source stream (stripped of characters that are illegal in filenames).

See method Ens.Util.File.CreateTimestamp() for documentation of timestamp options.

Property methods: FilenameDisplayToLogical(), FilenameGet(), FilenameIsValid(), FilenameLogicalToDisplay(), FilenameLogicalToOdbc(), FilenameNormalize(), FilenameSet()
property Framing as %String (DISPLAYLIST = ",None,MLLP,MLLP11/28,AsciiLF,AsciiCR,AsciiCRLF,Ascii11,Ascii11/28,LLP,MsgEnvelope,MLLPMsgEnvelope") [ InitialExpression = "AsciiLF" ];
HL7 message outbound framing protocol. The options are:
  • None: No framing - Each line that begins with 'MSH' is the start of a new message.
  • MLLP: Minimal Lower Level Protocol - Frame each HL7 message with ASCII code 11 prefix and ASCII code 28,13 suffix.
  • MLLPN/M: Minimal Lower Level Protocol - Frame each HL7 message with ASCII code N prefix, and ASCII code M suffix followed by an additional ASCII code 13.
  • AsciiLF: Frame messages with ASCII code 10 (Line Feed) separating each message from the subsequent one.
  • AsciiCRLF: Same as AsciiLF.
  • AsciiCR: Frame messages with an extra ASCII code 13 (Carriage Return) separating each message from the subsequent one.
  • AsciiM: Frame messages with ASCII code M suffix character(s) separating each message from the subsequent one.
  • AsciiN/M: Frame messages with ASCII code N prefix character(s) before each message and ASCII code M suffix character(s), but no trailing ASCII code 13 as in MLLPN/M.
  • LLP: Lower Level Protocol - (Obsolete) Frame each HL7 message in a redundant checksum block.
  • MsgEnvelope: Use the message's Envelope property verbatim if it is present. The string <!--HL72MSG--> if present in the Envelope will be replaced with the message content. Otherwise the message will simply follow the Envelope text.
  • MLLPMsgEnvelope: Same as MsgEnvelope, but with MLLP prefix and suffix also around the message inside the Envelope.

- ASCII code N is a sequence of one or more characters represented by their ASCII code, separated by comma in case of more than one character.
- All ASCII codes should be given in decimal.
- ASCII code 120 (character 'x') is not allowed as a framing character.
- If an asterisk (*) is appended to the framing specification, 'Flexible' framing will be used in parsing received acknowledgement response messages. Otherwise the response messages will be expected with the same kind of framing as that specified here for outbound messages.

Property methods: FramingDisplayToLogical(), FramingGet(), FramingIsValid(), FramingLogicalToDisplay(), FramingLogicalToOdbc(), FramingNormalize(), FramingSet()


method OnInit() as %Status
Inherited description: This user callback method is called via initConfig() from %OnNew() or in the case of SOAP Services from OnPreSOAP()
method OnMessage(pRequest As EnsLib.HL7.Message, Output pResponse As EnsLib.HL7.Message) as %Status
This method is for File and FTP Operations: per-message batch output with no reply. TCP and HTTP Operations receive reply messages and only support entire batch output.
method outputHeaders(pKey As %String, pOldParents As %String, pParents As %String) as %Status

Inherited Members

Inherited Properties

Inherited Methods


FeedbackOpens in a new tab