IQRS Subject Database Import Formats

Importing subjects into your IQRS subject database is an alternative to manually adding and maintaining subject database information. This feature provides users with an electronic interface within the IQRS to import large amounts of subject information from their corporate systems into their IQRS subject database for querying and reporting.

Subject information must be formatted in an American Standard Code for Information Interchange (ASCII) file which can then be imported into the IQRS. Subject information must be formatted in either the Extensible Markup Language (XML) Import Format or the Fixed-Width Import Format. XML is an industry standard for electronic data exchange. XML Import Format specifications and Fixed-Width Import Format specifications are provided below.

The Fixed-Width Import Format is the IQRS legacy import format used to add individual subjects to an IQRS subject database. The XML Import Format provides powerful and flexible features to import and maintain subject information in an IQRS subject database. The XML Import Format will enable users to automatically add, update, and delete both individual and organization subjects. The XML Import Format also provides a Subject ID data element which enables users to more easily track subjects during the import process.

Feature

XML Import
Format

Fixed-Width
Input Format

Add New Subjects

Yes

Yes

Update Existing Subjects

Yes

No

Delete Existing Subjects

Yes

No

Subject ID Support

Yes

No

Individual Subjects

Yes

Yes

Organization Subjects

Yes

No


New users are encouraged to contact the Customer Service Center if they have questions about using these specifications. Test import files may be e-mailed to the Customer Service Center for validation. The Data Banks will process your test file and return a result via e-mail.

XML Import Format Specifications

The XML Import Format is defined by the XML Import Format Interface Control Document (ICD) and XML Import Format Schema. The XML Import Format Schema defines how to structure and format subject information in an XML import file. This schema is intended to be used by the technical staff who will create the functionality to format a user's subject information in XML. The Data Banks strongly recommend the use of an XML validator to ensure that your XML files are correctly formatted prior to importing them into the IQRS. There are many commercial and open-source XML validators available. The IQRS may not be able to process subject information that does not satisfy the XML Import Format Schema.

The XML Import Format ICD provides high level guidance to help users provide complete subject information required for querying and reporting. For more information see the Fact Sheet on Importing XML Format Subject Data into the IQRS PDF Document. This fact sheet also provides instructions for importing your XML Import Format files.

Using the XML Import Format requires:

  1. XML Import Format ICD PDF Document
  2. XML Import Format Schema Zip File
  3. XML Import Format Sample Files Zip File
  4. Data Field Code Lists (in CSV format) Zip File

The XML Import Format is updated periodically by the Data Banks. It is strongly recommended that users join the IQRS Subject Database XML Import Mailing List to receive notice of updates. The Data Banks make an effort to notify users at least one month in advance of an update to code lists. Users should expect code lists to be updated quarterly. Additional updates to the XML Import Format are required periodically. Users will be notified six months in advance of updates to the XML Import Format. If you are already registered for the IQRS Subject Database XML Import Mailing List and would like to be removed, contact the Customer Service Center.

Fixed-Width Format Specifications

The Fixed-Width Import Format is defined by the Fact Sheet on Importing Fixed-Width Format Subject Data into the IQRS PDF Document. This fact sheet also provides instructions for importing your Fixed-Width Import Format files.

Using the Fixed-Width Import Format requires:

  1. Fact Sheet on Importing Fixed-Width Format Subject Data into the IQRS PDF Document
  2. Fixed-Width Import Format Sample File