class EnsLib.HL7.Service.AckInStandard extends EnsLib.HL7.Service.Standard

A specialized HL7 TCP Service that receives ACKs on behalf of a paired HL7 TCP Operation It also depends on this partner Operation to send ACKs on its behalf, for example to respond to messages from a dual-channel iSoft iCM application.

Property Inventory

Method Inventory


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


property AckMode as %String (DISPLAYLIST = ",Never,Immediate,Application,MSH-determined", VALUELIST = ",Never,Immed,App,Msh") [ InitialExpression = "App" , Required ];
Control of ACK handling; ACKs are returned on a separate TCP socket via the Partner Operation. On this service's channel each received message may also be acknowledged with an immediate byte response, according to the value of the ImmediateByteAck setting. Options: - Never : Do not send any ACK - Immediate : Send (commit) ACK reply message immediately upon receipt of the inbound message - Application : If message passes validation, wait for ACK from target config item and forward it when it arrives - MSH-determined : Send ACK messages as requested in the MSH header of the incoming message
Property methods: AckModeDisplayToLogical(), AckModeGet(), AckModeIsValid(), AckModeLogicalToDisplay(), AckModeLogicalToOdbc(), AckModeNormalize(), AckModeSet()
property IgnoreInboundAck as %Boolean [ InitialExpression = 0 ];
Ignore inbound ACK messages to avoid ACK feedback loop
Property methods: IgnoreInboundAckDisplayToLogical(), IgnoreInboundAckGet(), IgnoreInboundAckIsValid(), IgnoreInboundAckLogicalToDisplay(), IgnoreInboundAckNormalize(), IgnoreInboundAckSet()
property ImmediateByteAck as %Boolean [ InitialExpression = 1 ];
In addition to forwarding a full ACK message according to the AckMode setting, return immediate 1-byte ACKs on this Service's TCP connection
Property methods: ImmediateByteAckDisplayToLogical(), ImmediateByteAckGet(), ImmediateByteAckIsValid(), ImmediateByteAckLogicalToDisplay(), ImmediateByteAckNormalize(), ImmediateByteAckSet()
property PartnerOperation as %String (MAXLEN = 128);
ConfigName of the partner operation used to send application ACK responses for this Service
Property methods: PartnerOperationDisplayToLogical(), PartnerOperationGet(), PartnerOperationIsValid(), PartnerOperationLogicalToDisplay(), PartnerOperationLogicalToOdbc(), PartnerOperationNormalize(), PartnerOperationSet()


classmethod OnGetConnections(Output pArray As %String, pItem As Ens.Config.Item) [ Language = objectscript ]
Inherited description: Return an array of connections for drawing lines on the config diagram.
method OnInboundAck(pDoc As EnsLib.EDI.Document, pMSH As EnsLib.HL7.Segment, ByRef pSC As %Status) as %Boolean [ Language = objectscript ]
Returning nonzero means we are handling it and the normal framework should ignore it
method OnInit() as %Status [ Language = objectscript ]
Inherited description: This user callback method is called via initConfig() from %OnNew() or in the case of SOAP Services from OnPreSOAP()
method SendEarlyReply(pReplyDocument As EnsLib.EDI.Document, pOriginalDoc As EnsLib.EDI.Document) as %Status [ Language = objectscript ]
method SendReply(pReplyDocument As EnsLib.EDI.Document, pOriginalDoc As EnsLib.EDI.Document = $$$NULLOREF) as %Status [ Language = objectscript ]

Inherited Members

Inherited Properties

Inherited Methods