eNICQ 6 External Data Interface Developer's Guide

Important Update:

Vermont Oxford Network will be releasing a patch for the External Data Interface, release 6.1.0, that will allow eNICQ 6 to auto-assign ID numbers on import in the same manner that eNICQ 5 has done.  This change was based on vendor and member feedback.  Text that has been struck through below will no longer apply when this release is available.  This guide will be updated at that time.

Original Announcement:

If you are a center or vendor with an existing data interface to eNICQ 5, you will need to consider what changes in eNICQ 6 will require rework of your current system.

Changes to External Data Interface:

  • Text file import now accepts text files in XML, JSON or CSV format.
  • Direct write to database now requires writing an XML or JSON structure to a data field.
  • VON ID number is now required in all data imported to eNICQ.

This final requirement will likely be a source of rework.  The decision to require VON ID's on import was a difficult one. We've taken this course in order to safe guard data integrity and hope that our partners will understand the necessity.

In addition to assigning the VON ID number, your system should provide the end user with a means of storing ID assignment in its own database (so that they can be tied out with your records.)

More information on the ID assignment requirement is found in Part 1 of this document.  Please review the available materials for information and feel free to contact us at support@vtoxford.org with additional questions.


Not enough time before January 1 to make necessary changes?  Theoretically, this should not be a problem.  Your existing systems will function fine with eNICQ 5 into 2018 and we will still accept data submissions for 2017 from the old eNICQ 5.  You will need to make changes available to users in order to allow 2018 data entry, however, so the changes will be needed soon, but not for the 2017 closeout cycle that will occupy your user's attention at the start of 2018.

Does this information apply to me?  If you are uncertain if you are using the External Data Interface in eNICQ 5, please check with all users on their data entry workflow.  The following screenshot shows how EDI is accesed in eNICQ 5.  If your users recognize this menu item as part of their workflow, review of this material should be part of your preparations for migration from eNICQ 5.

Image: Tools...EDI 

Errata:  The following items will be addressed in future revisions to this document.

  • ImportConnectionID.  This field must be filled when writing to tblExternalData.  Its value represents the structure of your data and will correspond to one of the keys in the lookup table, tblImportConnections.
    • 1 = CSV
    • 2 = JSON
    • 3 = XML
  • prcLoadExternalData.  Based on developer request, we put together a stored procedure that can be used to handle your direct write to tblExternalData in eNICQ 6.  There's not much to it, but it clarifies the intent of the design and can be used to wrap your data write activity.  We missed the cut-off to have this included in 6.1.0, but you can download and run the procedure to create it on your database.

 About the Sample Files:  Please note that under the eNICQ 6 model, not all data items need to be included in every record.  This is particularly apparent in the XML and JSON records where data items that are not populated simply don't appear in the data format.  For example, if you look at record ID 4591, you will see that it is a 2018 birth year record with answers that force nearly all possible data items for 2018 to appear.  On the contrary, ID 4579 in the data set is a 2016 birth year record and shows the data items SRGLIG and SRGLIGWD, which are discontinued in 2018 and can only be shown in earlier birth year recorss.

Sample files are set to "Hospno 9999" which is compatible with an Expanded certification test installation in eNICQ 6.


Have more questions? Submit a request