INTERFACE FAQ

Contents

General Questions ..................................................................................................................................... 5

Q: How do I install an interface? ........................................................................................................... 5
Q: how do I uninstall an interface?........................................................................................................ 5
Q: I am trying to install an interface using command prompt and getting an error as below. How can
I fix this? ................................................................................................................................................. 6
Q: What are the files needed for an Inbound interface? ...................................................................... 7
Q: What are the files needed for an Outbound interface? ................................................................... 7
Q: Not able to install service .................................................................................................................. 7
Q: Service is installed. However, not able to run it ............................................................................... 8
Q: Service is installed. However, it did not connect to DB .................................................................... 9
Q: I don’t have a dedicated test environment and need to run interface for production and test in
same machine. How can I do that? ....................................................................................................... 9
Q: I want the interface to send email whenever there is an issue. How can I achieve this? ................ 9
Q: I have an interface up and running. However, it did not process any message. ............................10
Q: I have an interface up and running. The message was not processed and I see an error says
“midas.dll is not found or missing”. How can I fix this? ......................................................................10
ADT/SIU/ORM ..........................................................................................................................................10
Q: I have an interface up and running. However, not seeing any message as processed. .................10
Q: I see a message in log file “Message type cannot not be processed” ............................................11
Q: During detailed troubleshoot, I see a message in log file “Message facility cannot not be
processed” ...........................................................................................................................................11
Q: During detailed troubleshoot, I see a message in log file “Cannot schedule procedure as the
AIP/AIL/AIS segment(s) missing” .........................................................................................................11
Q: DEBUGMODE is enabled and the message has AIL/AIP/AIS segments in it. However, I am not
seeing the scheduling created from the message. ..............................................................................11
Q: I would like to process an A03 message. How can I do this?..........................................................11
Q: I would like to process an A13 message. How can I do this?..........................................................12
Q: I processed an SIU/ORM message. However, the department and/or specialty was not
populated. How can I fix this? .............................................................................................................12
Q: I processed an SIU/ORM message. However, the facility name was not populated. How can I fix
this?......................................................................................................................................................12
Q. I processed an SIU/ORM message. However, the provider was not populated. How can I fix this?
.............................................................................................................................................................12
 Q: I processed and SIU/ORM message. However, the procedure did not populate correctly. How can
I fix this? ...............................................................................................................................................13
ORU/DFT/MDM .......................................................................................................................................14
Q: I have an interface up and running. However, it do not send any message. .................................14
Q: I need to update the query to be used by the interface. How can I do that? ................................14
Q: Interface is up and running and generates the report. However, client says they did not receive
it. How can I fix this? ............................................................................................................................14
Q: I have an interface setup and running. The message has been sent with pdf location information.
However, the pdf was not created. How can I fix this? .......................................................................15
Q: I have an interface setup and running. However, it is not sending addendum messages. ............15
Q: I have an interface setup and running. It is currently using PROCEDUREREPORTS and I want to
switch the interface to use templates on the fly. How can I achieve that? ........................................15
Q: I have an interface setup and running. It is currently using Templates and generating the reports
on the fly. I would like to switch the interface to use generated reports from PROCEDUREREPORTS
table. How can I achieve this? .............................................................................................................16
Q: I have an interface setup and running. I did receive a change request from client and updated
interface to work accordingly. How can I make sure the changes are in place or not? .....................16
Q: I have the interface set up and running. The message has been sent to client. How do I check
whether we received an ACK for the message or not? .......................................................................17
Q: I have an interface set up and running. Client acknowledged that I am sending a wrong Message
Processing ID in MSH header. How can I fix this? ...............................................................................18
Q: I have an interface set up and running. I would like to send ICD10 codes instead of ICD9. How
can achieve this?..................................................................................................................................19
Q: I have an interface set up and running. I would like to send the discrete data in single OBX lines.
How can I achieve this? .......................................................................................................................19
Q: I have an interface set up and running. I would like to send PDF report information along with
the discrete data. How can I achieve this? ..........................................................................................19
Q: I have an interface set up and running. I would like to send PDF report information as Base64
data along with the discrete data. How can I achieve this? ................................................................19
Q: I have an interface set up and running. How can I specify the time delay setup? .........................20
Q: I have an interface set up and running. At client side, the MLLP character they are expecting is
different with what interface is sending. How can I change according to the client requirement? ..20
Q: I have an ORU interface running for VA. I am able to send the results messages out. However,
the ACK says “Device error” and the procedure gets updated with status “E”. How can I fix this? ...20
Q: I have an ORU interface set up and running. However it is not generating the PDF and the log file
says “Invalid Argument”. How can I fix this? .......................................................................................20
PathIN ......................................................................................................................................................22
Q: I have an interface set up and running. I would like to configure the interface to pick the
pathology messages from a folder. How can I achieve that?..............................................................22
Q: I have an interface set up and running. Just curious to know what will happen to the pathology
messages once they are processed from a folder. ..............................................................................22
Q: I have an interface set up and running. Pathology messages got processed. However, I am not
seeing the pdf file in patient documents .............................................................................................22
General Questions

Q: How do I install an interface?

Ans: In case you are going to install the interface for a specific facility, get the installation files from
development team. For VA, get the installation files from support folder in FTP.

Support\ENDOVAULT RELEASES\STAGE 2\VA INTERFACES

• Verify you have “Install.bat” available in installation files. If yes, run Inastall.bat in administrator
mode. In case you don’t have “Install.bat” file available in installation files, then, run command prompt
in administrator mode and move to the specified interface folder and then use “<interface executable
name> -install”

Highlighted area shows test interface

Note: interface service name is dependent of ProcessingID value available in interface INI file. Hence,
make sure you have proper ProcessingID value depending upon the environment. Default value is ‘D’.

P – Production

T – Test and

D – Development

Q: how do I uninstall an interface?

• Verify you have “UnInstall.bat.bat” available in installation files. If yes, run Inastall.bat in
administrator mode. In case you don’t have “UnInstall.bat.bat” file available in installation files, then,
run command prompt in administrator mode and move to the specified interface folder and then use
“<interface executable name> -uninstall”
Highlighted area shows test interface

Note: interface service name is dependent of ProcessingID value available in interface INI file. Hence,
make sure you have proper ProcessingID value depending upon the environment. Default value is ‘D’.

P – Production

T – Test and

D – Development

Q: I am trying to install an interface using command prompt and getting an error as below. How
can I fix this?

Ans: The error happened because you did not run the command prompt in administrator mode. Run
command prompt in administrator mode will fix this issue.
Q: What are the files needed for an Inbound interface?
Ans: Below are the list of required files to setup an inbound interface

• interface exe

• interface INI

• ChilkatDelphiXE.dll

• CRDE2001.dll

• HL7Merge.dat

• libeay32.dll (optional and used for email)

• ssleay32.dll (optional and used for email)

• midas.dll (optional if it’s already registered it in the server)

Q: What are the files needed for an Outbound interface?

Ans: Below are the list of required files to setup an outbound interface

• interface exe

• interface INI

• ChilkatDelphiXE.dll

• CRDE2001.dll

• Report.fr3 (optional used only when you are using templets for generating reports)

• BaseReport.fr3 (optional used only when you are using templets for generating reports)

• EndoLogo.bmp (optional used only if you are using rave report)

• Logo.bmp (optional used only if you are using rave report)

• PhotoPrinted.bmp (optional used only if you are using rave report)

• libeay32.dll (optional and used for email)

• ssleay32.dll (optional and used for email)

Q: Not able to install service

I have an interface and it throws below error when I try to install it. How do I fix this?
Ans: ChilkatDelphiXE.dll is missing in your interface folder. This is used for AES encryption. Get the DLL
either from development team or from EndosoftFTP (\Support\ENDOVAULT RELEASES\STAGE 2\VA
INTERFACES\Orders\)

Q: Service is installed. However, not able to run it

Highlighted area shows the demo interface name.

Ans: Verify Event-Viewer. If you see an error like below, ensure you have properly specified the inter
server and port. Also, there should not be multiple services running on the same port.
Q: Service is installed. However, it did not connect to DB

Ans: The screenshot is from log file. It says login failed for user “XXXX”. Ensure that, you have the correct
database user name and encrypted DB password available in interface INI file. Also, using SQL Server
Management Studio, try to connect database using the same credentials.

Highlighted area shows the demo name.

If you can connect to database using SQL Server Management Studio using same credentials, then,
ensure that you have specified the Database name and Server name correctly in interface INI file.

Highlighted area shows the demo name.

Q: I don’t have a dedicated test environment and need to run interface for production and test
in same machine. How can I do that?
Ans: Interface has a setting in INI file which helps to define the service instance name. By default, the
service name would be “<interface name>+Development”.

D – Development

T - Test Environment

P – Production Environment

Q: I want the interface to send email whenever there is an issue. How can I achieve this?
Ans: Interface INI has a switch to handle this and you need to configure it as per the requirement. Also,
make sure that, the interface folder has below files in it.
Q: I have an interface up and running. However, it did not process any message.
Ans: Run the parser client and search for the message. Verify if there is any error captured or not. If yes,
take the necessary steps to fix the error. If, you are not seeing any error, verify event viewer to ensure
whether any unhandled exception occurred or not. If yes, take the necessary steps to fix the issue. In
case you are not seeing error either in parser tool or in event viewer, contact development team.

Q: I have an interface up and running. The message was not processed and I see an error says
“midas.dll is not found or missing”. How can I fix this?
Ans: The log says midas dll is missing in your interface folder. Get the midas.dll from any working site
and copied to the interface folder.

ADT/SIU/ORM
Q: I have an interface up and running. However, not seeing any message as processed.
Ans: Using parser tool, search for messages received. The tool should bring all the messages received.
Enable debug mode in interface INI and resend one message to troubleshoot.

Note: DebugMode should be used only for detailed troubleshoot purpose. Otherwise, ensure that the
property is set to be FALSE.
Q: I see a message in log file “Message type cannot not be processed”
Ans: The log says, message received are not supported by the interface. In case, you need this type of
message to be processed, contact development team and get the updated build.

Q: During detailed troubleshoot, I see a message in log file “Message facility cannot not be
processed”
Ans: The log says, the message facility received is not supported by interface. In case, you need this type
of facility to be processed, then update the interface INI as well as FacilityCode column of Facility table.
Interface read message facility from MSH [3] and validates it. In case, you are not seeing FacilityCode
column in Facility table, then add column with datatype varchar (32) and then update the data.

Highlighted are sample facilities.

Q: During detailed troubleshoot, I see a message in log file “Cannot schedule procedure as the
AIP/AIL/AIS segment(s) missing”
Ans: The log says, you are trying to process a schedule message. However, the message doesn’t have an
AIP and/or AIL and/or AIS segment is missing. These three are mandatory segments for an SIU message.
In case, you don’t want the scheduling interface look into these segments and use SCH segment for
scheduling, contact the development team and get the updated build.

Q: DEBUGMODE is enabled and the message has AIL/AIP/AIS segments in it. However, I am not
seeing the scheduling created from the message.
Ans: An ADT/SIU/ORM interface can be used only for updating patient demographics. Hence, the base
interface comes with a switch to enable the scheduling feature. Ensure that, the scheduling switch is
enabled in interface INI file.

Q: I would like to process an A03 message. How can I do this?

Ans: Interface INI has a switch to handle this and you need to set the value as 1
Q: I would like to process an A13 message. How can I do this?
Ans: Interface INI has a switch to handle this and you need to set the value as 1

Q: I processed an SIU/ORM message. However, the department and/or specialty was not
populated. How can I fix this?
Ans: Interface uses procedure codes to pull the department and specialty from PROCNAMESMAPPING
table. Ensure, the procedure code you received in the message is available in the table and has
department and specialty updated.

Note: For VA, you need to refer PROCCODES table, instead of PROCNAMESMAPPING.

Q: I processed an SIU/ORM message. However, the facility name was not populated. How can I
fix this?
Ans: Interface populates the facility name from Facility table. Ensure that, the facility code you received
in message (MSH [3]) is available as Facility table. Column you should be looking is “FacilityCode”.

Note: For VA interface, facility is not populated from Facility table. Instead, there are multiple options to
get facility.

• If you have “FacilityLookUp” switch enabled in INI file, then facility code from ORB[4] will be
considered and this value will be used to do lookup in INI file section [FACILITYNAMES].
• When “FacilityLookUp” is not set, then “FacilityName” from USERS table will be considered. By
default, “FacilityLookUp” will be false.

Q. I processed an SIU/ORM message. However, the provider was not populated. How can I fix
this?
Ans: The provider code should be available in USERNUM field of Users table. Also, IS_ACTIVE column
should be “Yes” for the given provider.

For SIU messages, generally, the provider code can be found in AIP segment. However, there are
scenarios wherein SCH segment is used instead of AIP. So, you need to make sure which segment needs
to be taken care and ensure the code is available in USERS table.

For ORM messages, the provider code can be found in OBR segment. However, there are scenarios,
wherein PV1 segment is used instead of OBR. So, you need to make sure which segment needs to be
taken care and ensure the code is available in USERS table.

Note: For VA, CUSTOM2 field of USERS table will be considered.

Q: I processed and SIU/ORM message. However, the procedure did not populate correctly. How
can I fix this?
Ans: Procedure code should be available in PROCCODE column of PROCNAMESMAPPING table.

For SIU message, generally, procedure code information can be found in AIS segment. However, there
are scenarios, wherein SCH segment is used instead of AIS. So, you need to make sure which segment
needs to be taken care and ensure the code is available in PROCNAMESMAPPING table.

For ORM messages, procedure code information can be found in OBR segment. Ensure the code is
available in PROCNAMESMAPPING table.

Note: For VA, you need to refer PROCCODES table, instead of PROCNAMESMAPPING.
ORU/DFT/MDM

Q: I have an interface up and running. However, it do not send any message.

Ans: Ensure the log file and/or event viewer for any SQL related errors. If there is an error, fix the SQL
and restart the service. You can always verify the SQL by executing the query using SQL Server
Management Studio.

Q: I need to update the query to be used by the interface. How can I do that?
Ans: Interface always looks for an external query. If external query is not available, interface uses the
default built-in query. You can create and/or modify the .SQL file in interface folder to have the latest or
updated SQL. The .SQL file must have the same name as interface executable.

Q: Interface is up and running and generates the report. However, client says they did not
receive it. How can I fix this?
Ans: Ensure that “ResultSaveToFile” is set as False in interface INI file.

In case, “ResultSaveToFile” is already set to False, ensure the interface INI file has correct PORT and IP.

Highlighted are sample IP and PORT.

IP and PORT looks good and you still have issues, ensure you are able to connect to the IP and PORT
using Parser tool. In case of any error, communicate with client IT team.

You have all the configuration setup correctly, ensure that, the message sent by the interface has
correct sending facility and sending application values. In case of wrong values, you need to update the
interface INI file.

You still have issues, check the log file for acknowledgement errors. If you are not seeing an
acknowledgement, ensure you enabled logging acknowledgement in interface INI file. Verify the
acknowledgement and see if there is any error sent by the client and fix them if any.
You still have an issue, contact development team.

Q: I have an interface setup and running. The message has been sent with pdf location
information. However, the pdf was not created. How can I fix this?
Ans: This can be because of multiple reasons.

• Enable the detailed log and reprocess the same message. Verify whether there is any template
error captured while creating .pdf file. If yes, fix the template issue.
• If you are using a share path to save the .pdf files, make sure the settings in interface INI file is
configured correctly. Also, you need to make sure interface is setup to run with the same
credentials.

Highlighted area shows the demo values. Password is always AES encrypted.

• If you are using PROCEDUREREPORTS table and the PDF for given encounter is not available in
that table, then you may have to switch back to use templates rather than using already
generated reports.

Q: I have an interface setup and running. However, it is not sending addendum messages.
Ans: Verify the master query used by interface and make sure it pulls addendum data.

Q: I have an interface setup and running. It is currently using PROCEDUREREPORTS and I want to
switch the interface to use templates on the fly. How can I achieve that?
Ans: You need to set the interface INI to use templates and remove all the link and/or reference to
PROCEDUREREPORTS table from the master query. The default value is false. So, if you are not seeing
this section, you will need to add it.
Q: I have an interface setup and running. It is currently using Templates and generating the
reports on the fly. I would like to switch the interface to use generated reports from
PROCEDUREREPORTS table. How can I achieve this?
Ans: Verify that you have “UseTemplates” entry in interface INI file. If available, set the value to “False”.
Since the default value is false, you don’t have to add it if the entry is not available in INI. Once the INI
file is updated, then, you need to update the master query and add reference to PROCEDUREREPORTS
table. The main query must contain following columns from PROCEDUREREPORTS.

• REPORT with alias PROCREPORT

• COMPRESSED
• REPORTPATH and
• ID with alias PROCID

Q: I have an interface setup and running. I did receive a change request from client and updated
interface to work accordingly. How can I make sure the changes are in place or not?
Ans: There are two ways to achieve this.

• Update the interface INI file and set “ResultSaveToFile” property to True and set
“ResultOutputPath” with location information to where the message needs to be saved. Restart
the interface and verify the message.

Note: Make sure the save location exists. Once you done with testing, make sure to set the property to
False and restart the interface.

Highlighted area shows test path.

• Using latest version of parser tool, you can choose a local port and then update the interface INI
with local IP and chosen PORT and process the message. Make sure to restart the interface to
get the updated IP and PORT.
Highlighted area shows

• Menu option from where the listener can be called/invoked

• Port# to which the message will be sending from interface
• Open/Close button to keep the port active/inactive.
• Acknowledgement to be send or not send.

Highlighted area shows the test IP and PORT.

Note: Make sure to revert the interface INI with actual IP and PORT and restart the service.

Q: I have the interface set up and running. The message has been sent to client. How do I check
whether we received an ACK for the message or not?
Ans: You can achieve this in two ways.

• Using latest version of Parser tool, you can perform “Search Message” for outgoing messages
and verify the ACK.
Highlighted area shows procedure number, message type and acknowledgement. When you double
click on the message, you will get a popup screen with full message.

• Update the interface INI file and set “LogMessages” to True. Verify the log messages and you
will see the acknowledgements information there.

Note: Make sure to revert back the interface INI file and set the value to False and restart the service.

Q: I have an interface set up and running. Client acknowledged that I am sending a wrong
Message Processing ID in MSH header. How can I fix this?
Ans: Message Processing ID can be configured through interface INI file.

Acceptable values for processing id are D, T and P

D – Development
T – Test

P – Production

The default value is “D”

Q: I have an interface set up and running. I would like to send ICD10 codes instead of ICD9. How
can achieve this?
Ans: ICD10 codes can be send through the interface by updating interface INI. The property you should
be looking at is “ICD10Enabled”. By default, the value will be False. You must restart the service to get
the change impacted.

Q: I have an interface set up and running. I would like to send the discrete data in single OBX
lines. How can I achieve this?
Ans: Sending discrete data in single OBX can be taken care by updating interface INI file. The property
you should be looking at is “SingleOBXSegment”. By default, the value will be False. You must restart the
service to get the change impacted.

Q: I have an interface set up and running. I would like to send PDF report information along with
the discrete data. How can I achieve this?
Ans: Sending PDF report file information through OBX can be taken care by updating interface INI file.
The property you should be looking at is “IncludePDF”. By default, the value will be False. You must
restart the service to get the change impacted.

Q: I have an interface set up and running. I would like to send PDF report information as Base64
data along with the discrete data. How can I achieve this?
Ans: Sending PDF report as Base64 data through OBX can be taken care by updating interface INI file.
The property you should be looking at is “IncludePDF”. By default, the value will be False. You must
restart the service to get the change impacted.
Q: I have an interface set up and running. How can I specify the time delay setup?
Ans: Time delay setup defines the idle time interval of the interface. You can update the idle time
through interface INI. By default, the idle time is 1 minute. You must restart the service to get the
change impacted.

Highlighted area shows the default time in seconds. In this case, the interface will process signed
procedures in every minute.

Note: The time interval is in seconds.

Q: I have an interface set up and running. At client side, the MLLP character they are expecting is
different with what interface is sending. How can I change according to the client requirement?
Ans: Change in MLLP characters can be taken care by updating interface INI file. The property you should
be looking at is “EndOfMsgChars”. By default, the value will be “#$1c#$0d”. You must restart the service
to get the change impacted.

Q: I have an ORU interface running for VA. I am able to send the results messages out. However,
the ACK says “Device error” and the procedure gets updated with status “E”. How can I fix this?
Ans: Device Error for VA happens when there is any mismatch happens with the procedure code we
receive and send back to them. Verify OBR segment [4] and make sure you are sending back the correct
procedure code.

Q: I have an ORU interface set up and running. However it is not generating the PDF and the log
file says “Invalid Argument”. How can I fix this?
Ans: This is an issue related to FR3. The FR3 designed is expecting some variable while generating the
report and interface is not passing them. Please find the list of interface supported variables.

<EncounterNum_p>

<Provider_p>

<P_PID_p>

<Procedure_p>

<TemplateType_p>

<Facility_p>

<Department_p>
<PrintImage>
PathIN

Q: I have an interface set up and running. I would like to configure the interface to pick the
pathology messages from a folder. How can I achieve that?
Ans: Processing pathology messages from a folder can be taken care by updating interface INI file. The
property you should be looking at is “ReadFromFolder”. By default, the value will be False. You must
restart the service to get the change impacted.

Q: I have an interface set up and running. Just curious to know what will happen to the
pathology messages once they are processed from a folder.
Ans: After processing the messages, interface will move the message from incoming folder to a
designated folder. This will be based on the message process status. After a successful completion,
messages will be archived in the archive path. In case of an error, messages will be moved to the errored
messages folder. You can configure these paths through interface INI.

Q: I have an interface set up and running. Pathology messages got processed. However, I am not
seeing the pdf file in patient documents
Ans: Ensure “PDFPath” property in interface INI file is configured correctly. This should match with the
path in Endovault application.

Highlighted area shows the configuration in Endovault application. This can be found in Administration-
> Tools -> Local Settings