The UltraPort SQL Schema Engine creates Database "Schemas" based on a EasyHL7 Vendor Definition which tells the software which tables to create and which columns are in those tables etc. The LIS2-A2 TCP/IP Listener receives LIS2 messages from a compatible device then converts those messages into a modified version of HL7 version 2.2 which it then imports into the database tables.

In the folder where the LIS2-A2 listener software is installed there is a file named TBLIS V1 - (Version 2.2.1).vDef. This file is a EasyHL7 Vendor Definition file created especially for this product.

HINT: You can access the installation folder quickly by clicking "Open the Installation Folder" from the "Tools" menu of the Main Window.

Before you can create a compatible database schema in the Schema Engine software you MUST first IMPORT this vendor definition file into your Schema Engine software.

See the online help for the SQL Schema Engine for how to do this by clicking HERE.

After you have completed Step 1 you are ready to continue on and create your new HL7 Database Schema Profile which MUST use the EasyHL7 Definition you imported in Step 1. When creating your schema profile you MUST also make sure that you check the Automatically Train My Schema Tables check box. See below for an example.

Example Completed Schema Profile

See the online help for the SQL Schema Engine for information on how to create SQL Schema Profile by clicking HERE.

In this Listener product you will create "Listener Profiles", in the UltraPort SQL Schema Engine you create "Schema Profiles" which are essentially a set of database connection information for accessing a set of HL7 Schema Tables created by that product. An "API Key" is an encrypted text file containing a representation of a particular "Schema Profile" which activates the Schema Engine API to allow database access and functions like importing HL7 messages. These API Keys are produced by the UltraPort SQL Schema Engine's Database Maintenance windows service which handles all file maintenance operations.

While you should always refer to the online help for the SQL Schema Engine (See Online Manuals) we can give you a brief overview of what needs to be done.

Click to Expand

When creating or editing your SQL Schema Profile you click on the DB Maintenance button on the toolbar to access the Maintenance Settings. At the bottom of this screen is the Schema Engine Visual Studio API area which is where you set up your API Key for each profile. You need to check the boxes as shown above with only 2 differences.

1.Choose your own API Key ID, a 4-10 character Alpha-Numeric value which MUST be different for each schema profile.

2.Check the box to Export the API Key and then choose a windows folder where the API Key files should be placed. When creating or choosing the folder don't use any "special" windows folders like the Desktop, Documents, Program Files, etc.

You will note that it will show you at the bottom of the screen what your key file will be named which will be APIKey.<api key id>.txt, where <api key id> is the value you entered in the API Key ID field. Once this has been set and saved, you just restart the SQL Schema Engine's Database Maintenance service and you should notice your key file appears in the folder you've selected using the naming convention shown above.

The Database Maintenance Service will create/update key files whenever the service starts and every 24 hours thereafter.

Bonus Hint: In the Schema Info section (not shown above) be sure and check the AutoTrain Your Schema box for maximum effectiveness.

NO! You do not. You CAN if you ALSO need for your Schema Engine to import HL7 messages from files in a folder, but this product does not need a schema engine "inbound" processor.