Additional field information for CSV and API

Last updated: 2024-10-07 09:42

Additional field information for S2S API

Additional field information for CSV Upload

Additional field information for S2S API

Author group, Author and Coauthor

When the values for Author Group, Author and Coauthor have been left out in the json file, the default values for Author group, Author and Coauthor will be used automatically.
In order to create a record with the desired Author Group, Author and Coauthor, the following fields TX_AUTHOR_GR, TX_AUTHOR and TX_COAUTHOR must be added to the json file with their respective values.

Example:

Note:

The Author group, Author and Coauthor must exist and are well configured at the back-end of the system. TX_AUTHOR_GR can be a string that identifies the Author group to which this Author belongs. Commonly, the first name and last name are used to identify the TX_AUTHOR_GROUP. Be sure to avoid leading and trailing spaces when entering the Author group value.

Submitting a Record Requiring Manual Intervention in HD4DP

In order to submit a record requiring a manual intervention in HD4DP before submission, you need to add the key STATUS (all upper case) with the value "draft" to the record as follows:

"STATUS": "draft",

If the status is sent as "draft", a record is created allowing further completion and/or validation before submission. In case of a successful submission the user receives a HTTP 202 (Accepted) notification with an empty business key, e.g.:

If the status key is not sent, the default value "submit" is used. The user performs a complete submission, and in case of a successful submission the user receives a HTTP 202 (Accepted) notification with a business key, e.g.:

Note that a record with "draft" status needs to be sent, when it needs completion and approval in HD4DP. The status "submit" is not necessary when performing a complete submission.

In the HD4DP front-end, the difference is that the draft submission has the status open while the complete submission has the status submitted:

Once the draft is submitted in the front-end, the business key is generated and the process completed.

SSIN code formatting

Adding separators to a SSIN code

It is not necessary to add separators in a SSIN code when uploading a file using S2S API. You can fill out the SSIN code both with or without separators. E.g.: 85.04.02-169.32 or 85040216932.

Example:

COUNTRY and POSTAL CODE

Completion of the postal code if the country of residence to be selected is not Belgium

Only for the registries that need completion of the field Country (CD_CNTRY_RES) and the country to be selected is NOT Belgium, then the postal code (CD_POSTCODE) needs to be left empty and thus the code “9999 – Woonplaats niet in België” should not be selected.

This is important to avoid blocking and not uploading of your S2S API uploads.

Example:

Compare to:

Formatting of 'Date' and 'Date:Time'

The correct format for a field reporting the Date is "dd/mm/yyyy".

Example:

The correct format for a field reporting the Date:Time is "dd/mm/yyyy:hh:mm:ss".

Example:

Formatting of repeatable fields

In the DCD specifications, some fields or block of fields may be defined as repeatable. In that case, the values have to be separated by a comma (",").

Example:

    "TX_TTL_IMPLANT_DATA": [
        {
            "CD_IMPLANT": "127909",
            "CD_PAC_SADMI_NOTIFIC": "000017811475",
            "CD_IMPLANT_CAT": "",
            "CD_IMPLANT_PRD_NM": "",
            "TX_IMPLANT_PRODUC": "",
            "TX_IMPLANT_DSTRBTR": "",
            "TX_IMPLANT_DESC": ""
        },
        {
            "CD_IMPLANT": "127910",
            "CD_PAC_SADMI_NOTIFIC": "",
            "CD_IMPLANT_CAT": "127906",
            "CD_IMPLANT_PRD_NM": "productnaam",
            "TX_IMPLANT_PRODUC": "fabrikant",
            "TX_IMPLANT_DSTRBTR": "verdeler",
            "TX_IMPLANT_DESC": "opmerking product"
        }
    ],

Formatting of multiple choice

In some DCD specifications, some fields are defined as multiple choice. In that case, multiple values can be selected and need to be separated by a pipe ("|").

Example:

Additional field information for CSV Upload

Author group, Author and Coauthor

When the values for Author Group, Author and Coauthor have been left out in the csv file, the default values for Author group, Author and Coauthor will be used automatically.
In order to create a record with the desired Author Group, Author and Coauthor, the following fields TX_AUTHOR_GR, TX_AUTHOR and TX_COAUTHOR must be added to the csv file with their respective values.

Example:

TX_AUTHOR_GR;TX_AUTHOR;TX_COAUTHOR
Test group;test@sciensano.be;test@sciensano.be

Submitting a Record Requiring Manual Intervention in HD4DP

In order to submit a record requiring a manual intervention in HD4DP before submission, you need to do add the field name 'STATUS' in capitals in an additional column, and add the value 'draft'. If not, the record will be submitted without manual intervention.

SSIN code

Adding separators to a SSIN code

It is not necessary to add separators to a SSIN code when uploading a file using CSV Upload. You can fill out the SSIN code both with or without separators. E.g.: 85.04.02-169.32 or 85040216932.

Example:

COUNTRY and POSTAL CODE

Completion of the postal code if the country of residence to be selected is not Belgium

This is important to avoid blocking and not uploading of your CSV uploads.

Example:

Compare to:

Formatting of 'Date' and 'Date:Time'

The correct format for a field reporting the Date is dd/mm/yyyy.

Example:

The correct format for a field reporting the Date:Time is "dd/mm/yyyy:hh:mm:ss".

Example:

Formatting of repeatable fields

In the DCD specifications, some fields or block of fields may be defined as repeatable. In that case, manually enter the repeatable fields as shown in the following template: field_category|<index>|field.

The values have to be separated by a semi-colon (";").

Example:

Fields:
Transplants

Repeatable 1:
transplant_status

Repeatable 2:
transplant_status

Formatting:

transplants|0|transplant_status;transplants|1|transplant_status

4;6

as presented in the DCD:

as presented in the form:

Formatting of a multiple choice

In some DCD specifications, some fields are defined as multiple choice. In that case, the selected values can be reported separately by means of the pipe symbol (|), e.g. 68452|68453|68454.

Example:

cftr_modulating_therapy_1
1|2|3|4|5|6

as presented in the DCD:

as presented in the form:

Other formatting

Boolean: true / false
Codes: the value of the code (not the translation)
CSV file name: HD_DCD_submcsv_HDBPnumber_HDBPabbreviation_versionnumber_versionreleasedate

This documentation is being updated regularly. We try to provide as correct, complete and clear as possible information on these pages. Nevertheless, if you see anything in the documentation that is not correct, does not match your experience or requires further clarification, please create support ticket via our portal (https://healthdatabe.atlassian.net/servicedesk/customer/portals) or send us an e-mail via support.healthdata@sciensano.be to report this documentation issue. Please, do not forget to mention the URL or web address of the page with the documentation issue. We will then adjust the documentation as soon as possible. Thank you!

Additional field information for CSV and API