Skip to main content


abstract class EnsLib.HL7.Operation.Standard extends Ens.BusinessOperation, EnsLib.HL7.Util.IOFraming

This is an abstract superclass for HL7 Operations that send an HL7 message

Property Inventory

Method Inventory


parameter SETTINGS = Separators,SearchTableClass::selector?context={Ens.ContextSearch/SearchTableClasses?host=EnsLib.HL7.Operation.Standard},DefCharEncoding::selector?context={Ens.ContextSearch/CharacterSets};
Inherited description: List of properties can be set as settings in the configuration file format is a comma separated list of property names


property FailureTimeout as %Numeric (MINVAL = -1) [ InitialExpression = -1 ];
How long to keep retrying before giving up and returning an error code
Property methods: FailureTimeoutDisplayToLogical(), FailureTimeoutGet(), FailureTimeoutIsValid(), FailureTimeoutLogicalToDisplay(), FailureTimeoutNormalize(), FailureTimeoutSet()
property SearchTableClass as %String (MAXLEN = 100);
Store a set of searchable properties in SearchTable records associated with each message processed.

These records will be of the named SearchTable class, if any.

Property methods: SearchTableClassDisplayToLogical(), SearchTableClassGet(), SearchTableClassIsValid(), SearchTableClassLogicalToDisplay(), SearchTableClassLogicalToOdbc(), SearchTableClassNormalize(), SearchTableClassSet()
property Separators as %String (MAXLEN = 14) [ InitialExpression = $$$HL7DefSeparators ];
String of separator characters to use in encoding outbound messages. Order is FS, CS, RS, ESC, SS.

Empty string means use the default values of the outbound message.

Additional characters will be used to override the default output Segment Terminator which is Ascii 13.

After position 5, '\r' means Ascii 13 (Carriage Return) and '\n' means Ascii 10 (Linefeed / Newline).

You can also pad the separators up to position 5 with \x if you need to specify a line terminator but want your output messages to show less than 5 separators. The separators designated by \x will not be written out.

Property methods: SeparatorsDisplayToLogical(), SeparatorsGet(), SeparatorsIsValid(), SeparatorsLogicalToDisplay(), SeparatorsLogicalToOdbc(), SeparatorsNormalize(), SeparatorsSet()
property Validation as %String;
Comma-separated string specifying types of Validation to perform; make it a Setting in your subclass if you override OnValidate() and need to provide options
Property methods: ValidationDisplayToLogical(), ValidationGet(), ValidationIsValid(), ValidationLogicalToDisplay(), ValidationLogicalToOdbc(), ValidationNormalize(), ValidationSet()


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 OnValidate(pDoc As EnsLib.EDI.Document, pValSpec As %String, Output pStatus As %Status) as %Boolean
Override this method to implement your own custom method for validating of an incoming Document
method validateAndIndex(pDoc As EnsLib.EDI.Document) as %Status

Inherited Members

Inherited Properties

Inherited Methods


FeedbackOpens in a new tab