HLO APPLICATION ACKNOWLEDGEMENT APIS (CONTINUED) ICR (4723)

Name

Value

NUMBER

4723

IA #

4723

DATE CREATED

2005/08/19

CUSTODIAL PACKAGE

HEALTH LEVEL SEVEN

USAGE

Supported

TYPE

Routine

DBIC APPROVAL STATUS

APPROVED

ROUTINE

HLOAPI3

NAME

HLO APPLICATION ACKNOWLEDGEMENT APIS (CONTINUED)

GENERAL DESCRIPTION

These APIs are part of the set of tools that an
application uses to return an application acknowledgement to a message that
was received via HLO. See integration agreement # 4722 for the related APIs.

STATUS

Active

DURATION

Till Otherwise Agreed

HLOAPI3

COMPONENT/ENTRY POINT

COMPONENT DESCRIPTION

VARIABLES

$$BATCHACK(.HLMSTATE,PARMS,.ACK,.ERROR)

This routine is used to  initiate a batch message
containing inidividual application acknowledgments to a batch of messages that
was received via HLO.  Individual acks are placed in this batch by calling
$$ADDACK^HLOAPI3, then the batch of acks is actually sent by calling
$$SENDACK^HLOAPI2.

VARIABLES	TYPE	VARIABLES DESCRIPTION
$$BATCHACK	Output	The function returns 1 on success, 0 on failure.
HLMSTATE	Both	The HLMSTATE array is used internally by HLO to track the processing of the message. It is created by the application's earlier call to $$STARTMSG^HLOPRS when parsing the original message.
PARMS	Input	These subscripts may be defined: ("ACCEPT ACK RESPONSE") - <tag^routine> to call in response to a commit ack (optional). ("ACCEPT ACK TYPE") - <AL,NE> (Optional, defaults to AL). ("COUNTRY") - A three-character country code from the HL7 standard table (optional). ("ENCODING CHARACTERS") - The four HL7 encoding characters; optional, defaults to "^~\&". ("FAILURE RESPONSE") - Optional. The <tag>^<routine> that the sending application routine should execute if the transmission of the message fails, i.e., the message can not be sent or a requested commit ack is not received. ("FIELD SEPARATOR") - Field separator; optional, defaults to "\|". ("QUEUE") - Optional. An application can name a private queue (a string under 20 characters, it should be namespaced). The default is the name of the queue of the original message. ("SECURITY") - Security information to include in the header segment, SEQ 8 (optional). ("VERSION") - The HL7 Version ID (optional, defaults to 2.4)
ACK	Output	The acknowledgement being built.
ERROR	Output	On failure, the function returns an error message.

$$ADDACK(.ACK,.PARMS,.ERROR)

This API adds an application acknowledgement to a
batch acknowledgement message that was started by calling $$BATCHACK^HLOAPI3.

VARIABLES	TYPE	VARIABLES DESCRIPTION
$$ADDACK	Output	The function returns 1 on success, 0 on failure.
ACK	Both	The batch of acknowledgements that is being built.
PARMS	Input	These subscripts may be defined: ("ACK CODE" ) - Required. MSA1 contains AA, AE, or AR. ("ERROR MESSAGE" ) - Optional. MSA3 should be used only if AE or AR. ("EVENT") - A three-character event type (optional, defaults to the event code of the original message). ("MESSAGE CONTROL ID") - Required. The message control ID of the original individual message within the batch that is being acknowledged. ("MESSAGE STRUCTURE CODE") - Optional. ("MESSAGE TYPE") - Optional, defaults to ACK. ("SECURITY") - Optional. Security information to include in the header segment SEQ.

ERROR	Output	On failure, the function also returns an error message.