HL7 Vendors and Versions

<< Click to Display Table of Contents >>

Navigation:  Database Schemas >

HL7 Vendors and Versions

*Screenshots are from the UltraPort SQL Schema Engine version 5.2.3

 

By default the UltraPort Schema engine comes with ANSI definitions for HL7 versions 2.2, 2.3, 2.4, 2.5, 2.5.1 and 2.6. When you create an UltraPort database schema you select a vendor definition to use as the basis for your schema. The HL7 vendor definition contains information about the specific structure and all of the HL7 segments, fields and data types related to that particular version of HL7. While there is nothing wrong with using these "default" vendor definitions when creating your schemas we do recommend that you actually create your OWN vendor definitions for use with your interfaces. You should (if at all possible) avoid modifying the "default" vendor definitions which come with the Schema Engine since they have been constructed according to the ANSI standard. These definitions should be kept "in reserve" to be used as the basis for creating your own custom HL7 vendor definitions (see below).

 

To access the HL7 manager select HL7 Vendor Definitions from the 'File' menu of the main window.

 

Managing your HL7 vendor definitions

HL7 Vendor Definitions

 

Creating HL7 vendorsCreating Your Own HL7 Vendor Definitions

To create a new HL7 Vendor definition is quite easy and can be done in a matter of seconds from the Vendor Management window (see above). In this system you NEVER have to create an HL7 vendor from scratch. You always clone an existing HL7 vendor. To create a new vendor:

Step 1: In the list of installed vendor definitions select the one which you wish to clone.

Step 2: In the 'File' menu select 'New Vendor Definition'. This will open the 'New Vendor' window. In the New Vendor window simply enter a name and description and click 'Ok'.

 

Creating a new HL7 Vendor

Creating a new HL7 Vendor

 

It really is that easy! Now you can either use this new vendor to create your database schemas or continue and add any customizations necessary.

 

 

Modifying HL7 vendorsAdding and Editing HL7 Segments

Many times you may need to change the HL7 vendor definition and add or modify the HL7 segment definitions, most commonly because your trading partner either sends you (or requires that you send them) custom Z segments. To add/edit/view the HL7 segments contained in a vendor definition just click the 'HL7 Segments' button in the Vendor Management window. You will need to check the 'Allow Updates' check box in the Segments window if you wish to make any changes.

 

Editing the HL7 Segment definitions

Editing the HL7 Segment definitions

From the segments window you can change the Segment description by clicking in the Segment Description field and changing the value. After you make a change click OFF of the field and the Save Changes button will appear.

 

To create a NEW segment click the Add Segment button to open the New Segment window. In the New Segment window type in the 3 character segment name (UPPER CASE) and segment description and click 'Ok'.

 

New HL7 Segment window

New HL7 Segment window

 

To access the data fields (Segment Elements) click on the 'Properties' button on the particular segment you wish to edit in the segments window. This will open up the Segment Fields window.

 

Segment fields

Segment fields

 

In the segment fields window you can add a new field to the segment by clicking the 'Add Field' button OR click the 'Properties' button in the list of fields to open the Field Properties Window

 

HL7 Field Properties

HL7 Field Properties

 

 

 

 

 

 

Modifying HL7 vendorsMiscellaneous HL7 Vendor Properties

Many times you may need to change the HL7 vendor definition and add or modify the HL7 segment definitions, most commonly because your trading partner either sends you (or requires that you send them) custom Z segments.