|
|
|
Querying and Reporting XML Service (QRXS)
QRXS Quick Links:
The QRXS is an alternative to the Integrated Querying and Reporting
Service (IQRS) for those users who wish to receive machine-readable
responses. The QRXS is an electronic service similar to the Interface
Control Document (ICD) Transfer Program (ITP) for reporters who
wish to interface their data processing system directly with the
Data Banks to submit reports and receive responses. This service
is currently available for reporting only. QRXS querying specifications will be
available beginning June 16, 2008.
The QRXS interface is ideal for large volume reporters who particularly
benefit from using their own transaction processing systems for
interfacing with the NPDB-HIPDB and desire a more flexible and more
easily tested interface. The eXtensible Markup Language (XML) provides
the advantage to the reporters of verifying the reporting format
without have to submit transactions and wait for validation responses
from the NPDB-HIPDB system. The XML technology also enables a more
flexible interface that is more easily changed than the ITP if report
or querying formats change. View the Fact Sheet on the QRXS.
| Feature
|
QRXS |
ITP |
| Stand-Alone Client
Program |
Yes |
Yes |
| Client Program API |
Yes |
No |
| Transmits Data Over
a Secure Socket Layer (SSL) |
Yes |
Yes |
| Supports Proxy Servers |
Yes |
Yes |
| File Format Validation
Prior to Submission |
Yes |
No |
| Real-Time Data Validation |
Yes |
No |
| Type of Submission and
Response File Format |
XML |
ITP |
| Transaction Support: |
|
|
| AAR |
Yes |
Yes |
| MMPR |
Yes |
Yes |
| JOCR |
Yes |
Yes |
| Report Change Notifications |
Yes |
No |
| Password Changes |
Yes |
Yes |
| Query (*coming June 16, 2008) |
No* |
Yes |
QRXS transactions must be submitted through the QRXS Java client
software in an XML document that conforms to the schemas written
in the W3C XML Schema Language (version 1.0) provided in the QRXS
File Format Specifications. Submission files should be checked for
schema compliance prior to submission using a third-party XML Schema
validator.
Response files are downloaded using the QRXS Java client software.
Successful response files will be available for download within
an average of two to four hours of receipt by the Data Bank(s). Under
certain circumstances, additional processing time may be required.
Please do not re-submit your report on the subject in question,
since this will result in duplicate transactions. If your submission
file is not formatted properly following the specifications, it
will be rejected. If you do not receive your response within two business days of submission, please contact the Customer
Service Center.
Using the QRXS interface requires:
| 1. |
Java 2 Runtime Environment (JRE), available as a free download
from Sun
Microsystems' Java web site.
|
| 2. |
Installation of a Java client provided by the Data Banks:
Links to an installation instructions file and the zip file
containing the QRXS Java client and associated files necessary
for execution of the QRXS are available below.
|
| 3. |
QRXS File Format Specifications:
The QRXS file format specifications will be updated on June 16, 2008. The future versions of the specifications are provided below.
The QRXS file format is defined by an XML Interface Control
Document (ICD) and an XML schema. The XML schema defines the
structure and format of QRXS submission and response files.
This schema is intended to be used by the technical staff who
will create the functionality to format and process QRXS submission
and response files. The XML ICD provides high level guidance
to help users provide complete information for file submissions
and for processing response files. The Data Banks
strongly recommend the use of an XML validator to ensure that
your XML files are correctly formatted prior to submission.
There are many commercial and open-source XML validators available.
The Data Banks may not be able to process submission
files that do not satisfy the XML schema. Sample XML submission
and response files are provided as part of the specifications.
|
| 4. |
Registration for the QRXS
Mailing List. The QRXS file format is updated periodically
by the Data Banks. It is strongly recommended that users join
the QRXS 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 QRXS file formats are required periodically.
Users will be notified six months in advance of updates to the
QRXS file formats. If you are already registered for the QRXS
Mailing List and would like to be removed, contact the Customer
Service Center.
|
| 5. |
QRXS users are encouraged to use the sample response files to format their response data.
|
New users are strongly encouraged to contact the Customer
Service Center regarding their use of the QRXS interface. Test
submission files may be sent to the Customer Service Center for
validation. The Data Banks will process your test file and return
a response via e-mail.
|
|