com.mirth.connect.server.userutil
Class ACKGenerator

java.lang.Object
  extended by com.mirth.connect.server.userutil.ACKGenerator

public class ACKGenerator
extends java.lang.Object

Allows users to generate HL7 v2.x acknowledgments based on an inbound message, with a specified ACK code and custom text message. This class will not work as expected if the HL7 v2.x data type plugin is disabled or uninstalled.


Constructor Summary
ACKGenerator()
          Instantiates a new ACKGenerator object.
 
Method Summary
 java.lang.String generateAckResponse(java.lang.String message, boolean isXML, java.lang.String acknowledgementCode, java.lang.String textMessage, java.lang.String dateFormat, java.lang.String errorMessage)
          Generates an HL7 v2.x acknowledgment.
 java.lang.String generateAckResponse(java.lang.String message, java.lang.String acknowledgementCode, java.lang.String textMessage)
          Generates an HL7 v2.x acknowledgment.
 java.lang.String generateAckResponse(java.lang.String message, java.lang.String dataType, java.lang.String acknowledgementCode, java.lang.String textMessage, java.lang.String dateFormat, java.lang.String errorMessage)
          Deprecated. This method is deprecated and will soon be removed. Please use generateAckResponse(message, isXML, acknowledgementCode, textMessage, dateFormat, errorMessage) instead.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ACKGenerator

public ACKGenerator()
Instantiates a new ACKGenerator object.

Method Detail

generateAckResponse

public java.lang.String generateAckResponse(java.lang.String message,
                                            java.lang.String acknowledgementCode,
                                            java.lang.String textMessage)
                                     throws java.lang.Exception
Generates an HL7 v2.x acknowledgment. Assumes that the inbound message is proper ER7, and uses the default format "yyyyMMddHHmmss" for the MSH.7 message date/time.

Parameters:
message - The inbound HL7 v2.x message to generate the ACK for.
acknowledgementCode - The MSA.1 ACK code to use (e.g. AA, AR, AE).
textMessage - The MSA.3 text message to use.
Returns:
The generated HL7 v2.x acknowledgment.
Throws:
java.lang.Exception

generateAckResponse

public java.lang.String generateAckResponse(java.lang.String message,
                                            java.lang.String dataType,
                                            java.lang.String acknowledgementCode,
                                            java.lang.String textMessage,
                                            java.lang.String dateFormat,
                                            java.lang.String errorMessage)
                                     throws java.lang.Exception
Deprecated. This method is deprecated and will soon be removed. Please use generateAckResponse(message, isXML, acknowledgementCode, textMessage, dateFormat, errorMessage) instead.

Generates an HL7 v2.x acknowledgment.

Parameters:
message - The inbound HL7 v2.x message to generate the ACK for.
dataType - If "XML", assumes the inbound message is formatted in XML, and the acknowledgment returned will also be XML.
acknowledgementCode - The MSA.1 ACK code to use (e.g. AA, AR, AE).
textMessage - The MSA.3 text message to use.
dateFormat - The date/time format used to generate a timestamp for the MSH.7 message date/time (e.g. "yyyyMMddHHmmss").
errorMessage - The ERR.1 error message to use. If left blank, an ERR segment will not be generated.
Returns:
The generated HL7 v2.x acknowledgment.
Throws:
java.lang.Exception

generateAckResponse

public java.lang.String generateAckResponse(java.lang.String message,
                                            boolean isXML,
                                            java.lang.String acknowledgementCode,
                                            java.lang.String textMessage,
                                            java.lang.String dateFormat,
                                            java.lang.String errorMessage)
                                     throws java.lang.Exception
Generates an HL7 v2.x acknowledgment.

Parameters:
message - The inbound HL7 v2.x message to generate the ACK for.
isXML - If true, assumes the inbound message is formatted in XML, and the acknowledgment returned will also be XML.
acknowledgementCode - The MSA.1 ACK code to use (e.g. AA, AR, AE).
textMessage - The MSA.3 text message to use.
dateFormat - The date/time format used to generate a timestamp for the MSH.7 message date/time (e.g. "yyyyMMddHHmmss").
errorMessage - The ERR.1 error message to use. If left blank, an ERR segment will not be generated.
Returns:
The generated HL7 v2.x acknowledgment.
Throws:
java.lang.Exception