Technical guidelines

UPDATE 19.10.2020: Update of the "TestPrescribedReasonCodelist". Because of the launch of a central national laboratory test reservation tool (NL FR) , an update of the "TestPrescribedReasonCodelist" in the message LaboratoryTestPrescription is needed.

Read more

A. Content of the messages

Valuesets


Points of attention

All results (“Detected”, “Not detected”, “Inconclusive”) of laboratory tests for COVID-19 performed in Belgian intramural and extra mural laboratories should be reported to the central COVID-19 Laboratory Test Result Database.

  • In case the patient has a NISS or a NISS Bis number, the regular address information, date of birth and gender should not be provided. This information is available at the COVID-19 central database, through ConsultRN.
  • In case the patient has no NISS or a NISS Bis number, a NISS should be created using the ConsultRN integration in EMD or HIS:
    • This is also the case for foreign tourists.
      • In that case, the address information of his / her stay in BELGIUM should be recorded in the form.
      • As for the field “Country”, the country of permanent residence should be recorded in the form.
  • In case the patient is a minor (child), one of the parents, guardian or legal representative, should be provided as first contact person to (“FirstNamesContp1”; “LastNameContp1”; “TelephoneNumberMobileContp1”).

B. Format of the requested file

B.1. JAVASCRIPT OBJECT NOTATION (JSON)

Every requested field has to be provided also the optional fields, even when the values are missing or false. The reason is that this way every record will have the same structure. Although this is not necessary, this assures us that the field names are correctly spelled. If we do not find a field, we will know something is wrong and we can act upon this.
The structure of the record is completely flattened and this is done on purpose. This makes it easier and more transparent to load the data in a database and compare the original record with the result programmatically.

You can find the links to examples of the four messages in JSON format in this folder:

Example of message “LaboratoryTestPrescription” in JSON format
Example of message “LaboratoryTestResult” in JSON format
Example of message "RapidTestResult" in JSON format
Example of message “ResultFlagsSuspicionFalseNegativeTest” in JSON format
Example of message “ResultFlagsSuspicionFalsePositiveTest” in JSON format
Example of message “AlertSuspectedCaseNoTestPerformed” in JSON format

Name of the JSON messages

We kindly ask you to use following names for the JSON messages:

  • RIZIVnrSender_LaboratoryTestPrescription_yymmddhhmmss
  • RIZIVnrSender_LaboratoryTestResult_yymmddhhmmss
  • RIZIVnrSender_RapidTestResult_yymmddhhmmss
  • RIZIVnrSender_ResultFlagsSuspicionFalseNegativeTest_yymmddhhmmss
  • RIZIVnrSender_ResultFlagsSuspicionFalsePositiveTest_yymmddhhmmss
  • RIZIVnrSender_AlertSuspectedCaseNoTestPerformed_yymmddhhmmss

Points of attention

  • Multiple records can be included in a .json file.
  • All records should have exactly the same structure (missing values and ‘false’ have to be present also).

B.2. Comma-Separated Values (CSV)

Every requested field has to be provided, including the optional fields, even when the values are missing or false. The reason is that this way every record will have the same structure. In a csv containing more than 1 record this has of course be the case. This way the complete csv can be treated as one table.

You can find links to an example for each of the four messages in CSV format in this folder:

Example of message “LaboratoryTestPrescription” in CSV format
Example of message “LaboratoryTestResult” in CSV format
Example of message "RapidTestResult" in CSV format
Example of message “ResultFlagsSuspicionFalseNegativeTest” in CSV format
Example of message “ResultFlagsSuspicionFalsePositiveTest” in CSV format
Example of message “AlertSuspectedCaseNoTestPerformed” in CSV format

Name of the CSV messages

We kindly ask you to use following names for the csv files:

  • RIZIVnrSender_LaboratoryTestPrescription_yymmddhhmmss
  • RIZIVnrSender_LaboratoryTestResult_yymmddhhmmss
  • RIZIVnrSender_RapidTestResult_yymmddhhmmss
  • RIZIVnrSender_ResultFlagsSuspicionFalseNegativeTest_yymmddhhmmss
  • RIZIVnrSender_ResultFlagsSuspicionFalsePositiveTest_yymmddhhmmss
  • RIZIVnrSender_AlertSuspectedCaseNoTestPerformed_yymmddhhmmss

Points of attention

  • A csv can contain multiple records.
  • All records should have exactly the same structure (missing values and ‘false’ have to be present also).

C. Description of the transportation methods

C.1. EFORM

An eForm has been created for this specific purpose containing all the requested fields. The data on the eForm will be transformed into the required csv and sent via the eHBox to the eHBox of the COVID19 Laboratory Test Result Database.


C.2. EHBOX

If eForm is not an option you can use the eHBox directly for sending the required json or csv files following the specifications mentioned in this document.

Please send the message to the following address:

  • ehealth environment: production
  • type: “EHP”
  • value: “1990003696”
  • application ID: “” (an empty string)
  • quality: “INSTITUTION_EHP”

Points of attention

  • Add a “document title” (also called “description”) for the message.
  • Send the “content” (or “payload”) as an attachment (“annex” in ehbox terminology).
  • The file format has to be non-binary, e.g. JSON or CSV.
  • We only support 1 attachment per message; if you want to send multiple attachments, you’ll have to send them as multiple messages.
  • The encoding of the attachment is expected to be in UTF-8.

C.3. sFTP

We also give you the possibility to send us the requested files directly to our SFTP server. If you opt for this solution, we need you to give us information so we can set it up specifically for your organization. You can do this by sending a mail to covid19lab.healthdata@sciensano.be.

The mail has to contain:

  • Organization name
  • Email address of the person of your organization who will receive
    • the account information
    • the public key to use when authenticating
    • A document describing the connection information
    • a test file that we would like you to send to our SFTP server

Points of attention

In the case of SFTP we have to be sure that the complete file has arrived before reading the file. We propose to do this by means of another file with the same name as the file with the data but with extension ‘ok’. You have to send this ‘.ok’ file after sending the file with the data. This way we know which files are ready for integration.

  • The encoding of the file is expected to be in UTF-8.

C.4. HTTPS

As a final resort we have setup a HTTPS page. This way you avoid having to use a SFTP client. The files however have to be loaded manually. If you opt for this solution we need you to give us information so we can set it up specifically for your organization. You can do this by sending a mail to covid19lab.healthdata@sciensano.be.

The mail has to contain:

  • Organization name
  • Email address of the person of your organization who will receive
    • the account information
    • A document describing the connection information
    • a test file that we would like you to upload via our HTTPS site.