The ZEPHYR data collection

The ZEPHYR data collection

Organisations and/or individuals that provide data

71001030Grand Hopital de Charleroi
71003901CHU UCL Namur - Mont-Godinne
71011720AZ Delta
71032209UZ Leuven
71040622CUB Hopital Erasme
71067049UZ Gent
71070712CHU de Liege

Start date of the data collection

9/09/2022

End date of the data collection

Not defined.

Periodicity of the data collection

Continuously

This documentation is under construction. 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 send us an email 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!

manager Tue, 09/20/2022 - 10:16

The Endobronchial valve Data Collection Definition (HDBP0231)

The Endobronchial valve Data Collection Definition (HDBP0231)

In the file below you can find the Data Collection Definition (DCD) of the project Unidirectional endobronchial valve for the treatment of pulmonary emphysema (Zephyr). It is a detailed description of the content of the 3 sections (Primo-implantation, Follow-up and Replacement) with field names, formats, values, validation rules, help texts, warning texts, translations, ... This DCD was used to build the forms, csv's, and API's for this project, which you also can find in this project manual.

This documentation is under construction. 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 send us an email 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!

manager Thu, 09/22/2022 - 17:02

The Endobronchial valve Dataflow description

The Endobronchial valve Dataflow description

Below we describe (high level) the Endobronchial valve dataflow between the data provider and the healthdata.be platform.

Step 1. Automatic data export from systems of data provider towards HD4DP v2 and prefill of forms if not complete

Step 2. Manual registration (de novo or completion) of data in form component of HD4DP v2

Step 3. Direct real time transfer of registry variables and technical ID of record from HD4DP v2 towards HD

Step 4. Transfer of patient identifiers and technical ID of record from HD4DP v2 towards eHBox messaging client of HCO (HCO UM/EM)

Step 5. Transfer of patient identifiers and technical ID of record from eHBox messaging client of HCO (HCO UM/EM) towards TTP service of eHealth

Step 6. Transfer of pseudonymized patient identifiers and technical ID of record from TTP service of eHealth towards eHBox messaging client of HD (HD UM/EM)

Step 7. Transfer of pseudonymized patient identifiers and technical ID of record from eHBox messaging client of HD (HD UM/EM) to HD Integration engine

Step 8. Join and Transfer of pseudonymized patient IDs, registry variables and technical ID of record from HD Integration engine towards Data Validation environment on DHW

This documentation is under construction. 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 send us an email 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!
manager Mon, 09/19/2022 - 14:45

HD4DP v2

HD4DP v2

For the project "Unidirectional endobronchial valve for the treatment of pulmonary emphysema" only the local version of HD4DP v2 can be used. HD4DP v2 WEB is not available for this project.


General description of the HD4DP v2 application

HD4DP v2 is a local application developed by healthdata.be (Sciensano) and installed on the infrastructure of the data provider. The application allows the data provider to extract data from the primary system and map it to one or more data collection projects.

The local HD4DP v2 application is also accessible via a web browser. Questions that cannot be answered with data from the primary systems can be processed manually in electronic ("pre-filled") forms.

If the records are complete, the data can be transferred to the central data platform healthdata.be. For this transfer, HD4DP v2 connects to the ehealth messaging software of the data provider.

In the following sections, we will provide you with information on how to proceed:

manager Thu, 09/22/2022 - 16:16

Request account for HD4DP v2

Request account for HD4DP v2

The applications of healthdata.be (like HD4DP v2 and healthstat.be) process sensitive personal information. Therefore, strict controlled processes are used to grant access to these applications. The Entity Access Management (EAM) portal of healthdata.be facilitates these processes. In this article we describe how to use it.

This image has an empty alt attribute

To request access to healthdata.be applications (such as HD4DP v2 and healthstat.be), you can click on REQUEST ACCESS in the blue box in the middle of the screen.

Then, you arrive at the next page, click on Connect with eID.

You will be directed to the government's Federal Authentication Service (FAS) where you can log in with multiple digital keys with eID or digital identity.

If you choose to connect with ItsMe, you can enter your cell phone number.

Follow the instructions on your mobile device via the ItsMe application.

You can now fill out the access request form.

VPlease fill in all fields with a red asterisk *

Note: You must indicate your role in the project (Local Study Lead, Local Study Associate or Local Study Support). Your role determines your access options in HD4DP2 for this project. Read more about User roles in HD4DP v2.

Check the boxes of the projects you wish to request access to.

Select HD4DP2.0 if you want to access the application to make recordings for the selected project.

Select Healthstat.be if you want to access the reporting of the selected project.

Click the Submit button when you have completed the form.

Once you have successfully completed the access request form, you will receive a confirmation message.



Your request will be forwarded to an employee of your organization who is authorized to grant you access. After he has approved your request, your account will be immediately created by healthdata.be. The whole procedure can take 2 working days. We will inform you once the account is active.

This documentation is under construction. 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 send us an email 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!
manager Sun, 09/18/2022 - 16:57

User roles in HD4DP v2

User roles in HD4DP v2

Several user roles are possible in the HD4DP v2 application:

Local Study Lead: This role takes responsibility for the study or project within the participating health care organisation. Often this is the head of the clinical department involved in the study or project. The Local Study Lead can:

  1. make registrations in HD4DP v2;
  2. grant access to other colleagues (in the role of Local Study Lead, Local Study Associate or Local Study Support);
  3. view all registrations made by colleagues (regardless of role) for the study or project.

Local Study Associate: The Local Study Associate is a health care professional that participates in the study or project. He/she reports/records medical information towards the researcher using HD4DP v2 and thereby assumes responsibility on the correctness of the reported information. He/she is considered to be the author of the registration. This will be represented in the registration form. The Local Study Associate can:

  1. make registrations in HD4DP v2;
  2. grant access to other colleagues (in the Local Study Support role);
  3. only see his/her own registrations, not those of other colleagues in the same healthcare organisation participating in the same study or project.

Local Study Support: A Local Study Associate can delegate registration to a Local Study Support. Often this is an administrative collaborator or staff of a department medical coding. The Local Study Associate is still considered the author of the registration; the Local Study Support is considered co-author. The Local Study Associate can view and change registrations made by Local Study Support. The Local Study Support can:

  1. make registrations in HD4DP v2;
  2. cannot grant access to other colleagues;
  3. only see his/her own recordings, not those of other colleagues in the same health care organisation participating in the same study or project.

By default, only 1 Local Study Lead is created by healthdata.be (Sciensano) for each project within each organisation. This means that only 1 person can see all registrations made for that project within that organisation. This policy prevents HD4DP v2 users to see personal and sensitive information from persons they do not have a therapeutic relationship with.

In case organisations create more then 1 Local Study Leads for a project within that organisation, so that they all can see each others registrations, and thus personal and sensitive information from persons they do not have a therapeutic relationship with, the organisations are fully responsible and accountable for this policy deviation. Healthdata.be (Sciensano) cannot be held responsible or accountable for this policy deviation. Professionals wanting to participate in projects are kindly suggested to contact the Data Protection Officer (DPO) of their organisation to consult them about this intended policy deviation.

This documentation is under construction. 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 send us an email 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!
johanvanbussel Sun, 09/18/2022 - 11:20

Access the HD4PD v2 application

Access the HD4PD v2 application

To access the application HD4DP v2, you must first request an account. If you do not have an account yet, please read the article "Request an account for HD4DP v2" first.

Once your account has been created, you will receive an email with following information (note that the text between the [ ] will be adapted.):

  • Organisation: [RIZIV number - Name] 
  • Login: [email] 
  • Password: [password] 
  • Application URL: [url] 

With these credentials you can access the application HD4DP v2 of your organisation:

  1. Go to the url mentioned in the mail 
  2. Select "your organisation" from the list 
  3. Your Organisation: [RIZIV number– Name] 
  4. Click "Next
  5. Fill in your "username" and "password"
  6. Click "Log in"
This documentation is under construction. 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 send us an email 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!
manager Mon, 09/19/2022 - 14:49

Navigate to the "Endobronchial valve" project

Navigate to the "Endobronchial valve" project

When logged in, you will see the Welcome page. In the left dark blue menu you can see all the study programs and projects you have access to.

When you select the study program QERMID Pneumology, you can see the study project Endobronchial valve.

Select the study project Endobronchial valve.

You will see that the study project Endobronchial valve consists of three parts: Primo-implantation, Follow-up and Replacement.

This documentation is under construction. 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 send us an email 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!
manager Sun, 09/18/2022 - 11:21

Create a "Endobronchial valve" registration

Create a "Endobronchial valve" registration

The study project Endobronchial valve consists of three parts: Primo-implantationFollow-up and Replacement.

This image has an empty alt attribute

On the following pages we explain how you can register for each part.

This documentation is under construction. 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 send us an email 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!
manager Sun, 09/18/2022 - 11:21

Create a "Endobronchial valve" registration "Primo-implantation"

Create a "Endobronchial valve" registration "Primo-implantation"

To create a "Primo-implantation" registration for the study project Endobronchial valve, select "Primo-implantation" in the dark blue left menu.

You will see the number of versions of this study section. In this case, there is only one version.

When you select the highest version of this study section for the first time, you will see an empty overview table in the main part of your screen. The table contains, among others, the following items: Registration IDProgressAuthorCo-authorUnique ID, Business keyRegistration codeNational registry ID of the patient...

In the top right corner of the screen you can find a green button "+ New registration". Press this button.

After pressing the button "+ New registration", the main screen will now be replaced with 2 sections: a study form (in the middle of the screen) and a Table of contents (on the right side of the screen).

By completing the study form, you will create a "Primo-implantation" registration for the study project Endobronchial valve.

The Table of contents indicates which sections you must complete. You can also use the table of contents to navigate through the study form: pressing a section in the table of contents will take you to this section in the study form.

By pressing the tab "Progress" on the right side of the screen , the Table of contents will be replaced by a progress bar and a list of open validation errors.

You can use the list of open validation errors to navigate through the study form: pressing a validation error in the list will take you to this section in the study form.

When the study form is completed and there are no validation errors, you can Save or Submit this registration. Notice that the Submit button is in clear green.

When the study form is completed but there are validation errors, you can Save but not Submit this registration. Notice that the Submit button is in dim green.

When the study form is saved or submitted, the screen switches to the overview table. Now, this table is not empty anymore but shows the saved or submitted registration.

manager Sun, 09/18/2022 - 11:22

Create a "Endobronchial valve" registration "Follow-up"

Create a "Endobronchial valve" registration "Follow-up"

To create a "Follow-up" registration for the study project Endobronchial valve, select "Follow-up" in the dark blue left menu.

You will see the number of versions of this study section. In this case, there is only one version.

When you select the highest version of this study section for the first time, you will see an empty overview table in the main part of your screen. The table contains, among others, the following items: Registration IDProgressAuthorCo-authorUnique ID, Business keyRegistration codeNational registry ID of the patient...

In the top right corner of the screen you can find a green button "+ New registration". Press this button.

After pressing the button "+ New registration", the main screen will now be replaced with 2 sections: a study form (in the middle of the screen) and a Table of contents (on the right side of the screen).

By completing the study form, you will create a "Follow-up" registration for the study project Endobronchial valve.

The Table of contents indicates which sections you must complete. You can also use the table of contents to navigate through the study form: pressing a section in the table of contents will take you to this section in the study form.

By pressing the tab "Progress" on the right side of the screen , the Table of contents will be replaced by a progress bar and a list of open validation errors.

You can use the list of open validation errors to navigate through the study form: pressing a validation error in the list will take you to this section in the study form.

When the study form is completed and there are no validation errors, you can Save or Submit this registration. Notice that the Submit button is in clear green.

When the study form is completed but there are validation errors, you can Save but not Submit this registration. Notice that the Submit button is in dim green.

When the study form is saved or submitted, the screen switches to the overview table. Now, this table is not empty anymore but shows the saved or submitted registration.

This documentation is under construction. 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 send us an email 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!
manager Sun, 09/18/2022 - 11:24

Create a "Endobronchial valve" registration "Replacement"

Create a "Endobronchial valve" registration "Replacement"

To create a "Replacement" registration for the study project Endobronchial valve, select "Replacement" in the dark blue left menu.

You will see the number of versions of this study section. In this case, there is only one version.

When you select the highest version of this study section for the first time, you will see an empty overview table in the main part of your screen. The table contains, among others, the following items: Registration IDProgressAuthorCo-authorUnique ID, Business keyRegistration codeNational registry ID of the patient...

In the top right corner of the screen you can find a green button "+ New registration". Press this button.

After pressing the button "+ New registration", the main screen will now be replaced with 2 sections: a study form (in the middle of the screen) and a Table of contents (on the right side of the screen).

By completing the study form, you will create a "Replacement" registration for the study project Endobronchial valve.

The Table of contents indicates which sections you must complete. You can also use the table of contents to navigate through the study form: pressing a section in the table of contents will take you to this section in the study form.

By pressing the tab "Progress" on the right side of the screen , the Table of contents will be replaced by a progress bar and a list of open validation errors.

You can use the list of open validation errors to navigate through the study form: pressing a validation error in the list will take you to this section in the study form.

When the study form is completed and there are no validation errors, you can Save or Submit this registration. Notice that the Submit button is in clear green.

When the study form is completed but there are validation errors, you can Save but not Submit this registration. Notice that the Submit button is in dim green.

When the study form is saved or submitted, the screen switches to the overview table. Now, this table is not empty anymore but shows the saved or submitted registration.

This documentation is under construction. 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 send us an email 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!
manager Sun, 09/18/2022 - 11:25

Find a "Endobronchial valve" registration

Find a "Endobronchial valve" registration

The study project Endobronchial valve consists of three sections: Primo-implantationFollow-up and Replacement.

This image has an empty alt attribute

On the following pages we explain how you can find a registration for each section.

This documentation is under construction. 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 send us an email 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!
manager Sun, 09/18/2022 - 11:26

Find a "Endobronchial valve" registration "Primo-implantation"

Find a "Endobronchial valve" registration "Primo-implantation"

To find a "Primo-implantation" registration for the study project Endobronchial valve, select "Primo-implantation" in the dark blue left menu.

This image has an empty alt attribute

When you select a version of this study section, you will see the summary table in the main part of your screen. This table contains, among other things: Registration ID, Progress, Author, Co-author, Unique ID, Business Key, Registration Code, National Patient Registry Number…

In the header of the summary table, you can use the filter below each column label. In the example below, the last name "Khan" has been entered in the filter (text field), so only the record with "Khan" is displayed.

This image has an empty alt attribute
This documentation is under construction. 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 send us an email 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!
manager Sun, 09/18/2022 - 11:26

Find a "Endobronchial valve" registration "Follow-up"

Find a "Endobronchial valve" registration "Follow-up"

To find a "Follow-up" registration for the study project Endobronchial valve, select "Follow-up" in the dark blue left menu.

This image has an empty alt attribute

When you select a version of this study section, you will see the summary table in the main part of your screen. This table contains, among other things: Registration ID, Progress, Author, Co-author, Unique ID, Business Key, Registration Code, National Patient Registry Number…

In the header of the summary table, you can use the filter below each column label. In the example below, the last name "Khan" has been entered in the filter (text field), so only the record with "Khan" is displayed.

This image has an empty alt attribute
This documentation is under construction. 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 send us an email 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!
manager Sun, 09/18/2022 - 11:27

Find a "Endobronchial valve" registration "Replacement"

Find a "Endobronchial valve" registration "Replacement"

To find a "Replacement" registration for the study project Endobronchial valve, select "Replacement in the dark blue left menu.

This image has an empty alt attribute

When you select a version of this study section, you will see the summary table in the main part of your screen. This table contains, among other things: Registration ID, Progress, Author, Co-author, Unique ID, Business Key, Registration Code, National Patient Registry Number…

In the header of the summary table, you can use the filter below each column label. In the example below, the last name "Khan" has been entered in the filter (text field), so only the record with "Khan" is displayed.

This image has an empty alt attribute
This documentation is under construction. 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 send us an email 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!
manager Sun, 09/18/2022 - 11:27

Update a "Endobronchial valve" registration

Update a "Endobronchial valve" registration

The study project Endobronchial valve consists of three sections: Primo-implantationFollow-up and Replacement.

This image has an empty alt attribute

On the following pages we explain how you can update a registration for each section.

This documentation is under construction. 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 send us an email 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!
manager Sun, 09/18/2022 - 11:27

Update a "Endobronchial valve" registration "Primo-implantation"

Update a "Endobronchial valve" registration "Primo-implantation"

A "Primo-implantation" registration can be updated as long as the registration has not yet been submitted. If the status of a registration is "Saved" , the registration can still be updated.

To update a "Primo-implantation" registration for the study project Endobronchial valve, select "Primo-implantation" in the dark blue left menu.

This image has an empty alt attribute

When you select a version of this study section , you will see the overview table in the main part of your screen. The table contains, among others, the following items: Registration IDProgressAuthorCo-authorUnique ID, Business keyRegistration codeNational registry ID of the patient...

This image has an empty alt attribute

Use the filters in the header of the table to find the registration that you want to update.

If you have found the registration, you can open the study form of the registration by pressing the corresponding row in the overview table.

You can complete the missing fields and / or change previously completed fields in the study form.

At the end of the study form you can Save or Submit the registration.

If you save the registration, you can still edit it. A submitted registration can no longer be modified or deleted.

This documentation is under construction. 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 send us an email 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!
manager Sun, 09/18/2022 - 11:28

Update a "Endobronchial valve" registration "Follow-up"

Update a "Endobronchial valve" registration "Follow-up"

A "Follow-up" registration can be updated as long as the registration has not yet been submitted. If the status of a registration is "Saved" , the registration can still be updated.

To update a "Follow-up" registration for the study project Endobronchial valve, select "Follow-up" in the dark blue left menu.

This image has an empty alt attribute

When you select a version of this course of study, you will see the summary table in the main body of your screen. The table includes the following items: Registration ID, Progress, Author, Co-author, Unique ID, Business Key, Registration Code, National registry number of the patient.…

Use the filters in the header of the table to find the registration you want to update.

Once you have found the registration, you can open the registration's study form by clicking on the corresponding row in the summary table.

You can complete missing fields and/or change previously completed fields in the survey form.

At the end of the survey form, you can Save or Submit the registration.

If you save the registration, you can still change it. A sent registration cannot be changed or deleted again.

This documentation is under construction. 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 send us an email 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!
manager Sun, 09/18/2022 - 11:28

Update a "Endobronchial valve" registration "Replacement"

Update a "Endobronchial valve" registration "Replacement"

A "Replacement" registration can be updated as long as the registration has not yet been submitted. If the status of a registration is "Saved" , the registration can still be updated.

To update a "Replacement" registration for the study project Endobronchial valve, select "Replacement" in the dark blue left menu.

This image has an empty alt attribute

When you select a version of this course of study, you will see the summary table in the main body of your screen. The table includes the following items: Registration ID, Progress, Author, Co-author, Unique ID, Business Key, Registration Code, National registry number of the patient.…

Use the filters in the header of the table to find the registration you want to update.

Once you have found the registration, you can open the registration's study form by clicking on the corresponding row in the summary table.

You can complete missing fields and/or change previously completed fields in the survey form.

At the end of the survey form, you can Save or Submit the registration.

If you save the registration, you can still change it. A sent registration cannot be changed or deleted again.

This documentation is under construction. 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 send us an email 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!
manager Sun, 09/18/2022 - 11:28

Delete a "Endobronchial valve" registration

Delete a "Endobronchial valve" registration

The study project Endobronchial valve consists of three sections: Primo-implantationFollow-up and Replacement.

This image has an empty alt attribute

On the following pages we explain how you can delete a registration for each section.

This documentation is under construction. 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 send us an email 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!
manager Sun, 09/18/2022 - 11:29

Delete a "Endobronchial valve" registration "Primo-implantation"

Delete a "Endobronchial valve" registration "Primo-implantation"

A "Primo-implantation" registration can be deleted as long as the registration has not yet been submitted. If the status of a registration is "Open" , the registration can still be deleted.

To delete a "Primo-implantation" registration for the study project Endobronchial valve, select "Primo-implantation" in the dark blue left menu.

This image has an empty alt attribute

When you select a version of this course of study, you will see the summary table in the main body of your screen. The table includes the following items: Registration ID, Progress, Author, Co-author, Unique ID, Business Key, Registration Code, National registry number of the patient...

Use the filters in the header of the table to find the registration you want to delete.

Once you have found the registration you want to delete, you must select the registration by checking the checkbox at the beginning of the row in the summary table.

Then you need to press the "Actions" button at the top right of the summary table.

There are now two options, "Submit" and "Delete". Now press "Delete".

After you press "Delete," a pop-up message will appear asking you to confirm the deletion of the selected registration(s). If you are sure about this action, press "Confirm." If not, press "Cancel."

If you delete the registration, you cannot change its status or content.

The deleted registration will not be removed from the summary table. It remains present, but the status has changed from "Open" to "Deleted".

If you want to see only Open and Sent registrations, you can adjust the filter on the "Status" item in the summary table.

This documentation is under construction. 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 send us an email 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!
manager Sun, 09/18/2022 - 11:29

Delete a "Endobronchial valve" registration "Follow-up"

Delete a "Endobronchial valve" registration "Follow-up"

A "Follow-up" registration can be deleted as long as the registration has not yet been submitted. If the status of a registration is "Open" , the registration can still be deleted.

To delete a "Follow-up" registration for the study project Endobronchial valve, select "Follow-up" in the dark blue left menu.

This image has an empty alt attribute

When you select a version of this course of study, you will see the summary table in the main body of your screen. The table includes the following items: Registration ID, Progress, Author, Co-author, Unique ID, Business Key, Registration Code, National registry number of the patient...

Use the filters in the header of the table to find the registration you want to delete.

Once you have found the registration you want to delete, you must select the registration by checking the checkbox at the beginning of the row in the summary table.

Then you need to press the "Actions" button at the top right of the summary table.

There are now two options, "Submit" and "Delete". Now press "Delete".

After you press "Delete," a pop-up message will appear asking you to confirm the deletion of the selected registration(s). If you are sure about this action, press "Confirm." If not, press "Cancel."

If you delete the registration, you cannot change its status or content.

The deleted registration will not be removed from the summary table. It remains present, but the status has changed from "Open" to "Deleted".

If you want to see only Open and Sent registrations, you can adjust the filter on the "Status" item in the summary table.

This documentation is under construction. 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 send us an email 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!
manager Sun, 09/18/2022 - 11:30

Delete a "Endobronchial valve" registration "Replacement"

Delete a "Endobronchial valve" registration "Replacement"

A "Replacement" registration can be deleted as long as the registration has not yet been submitted. If the status of a registration is "Open" , the registration can still be deleted.

To delete a "Replacement" registration for the study project Endobronchial valve, select "Replacement" in the dark blue left menu.

This image has an empty alt attribute

When you select a version of this course of study, you will see the summary table in the main body of your screen. The table includes the following items: Registration ID, Progress, Author, Co-author, Unique ID, Business Key, Registration Code, National registry number of the patient...

Use the filters in the header of the table to find the registration you want to delete.

Once you have found the registration you want to delete, you must select the registration by checking the checkbox at the beginning of the row in the summary table.

Then you need to press the "Actions" button at the top right of the summary table.

There are now two options, "Submit" and "Delete". Now press "Delete".

After you press "Delete," a pop-up message will appear asking you to confirm the deletion of the selected registration(s). If you are sure about this action, press "Confirm." If not, press "Cancel."

If you delete the registration, you cannot change its status or content.

The deleted registration will not be removed from the summary table. It remains present, but the status has changed from "Open" to "Deleted".

If you want to see only Open and Sent registrations, you can adjust the filter on the "Status" item in the summary table.

This documentation is under construction. 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 send us an email 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!
manager Sun, 09/18/2022 - 11:30

Submit a "Endobronchial valve" registration

Submit a "Endobronchial valve" registration

The study project Endobronchial valve consists of three sections: Primo-implantationFollow-up and Replacement.

This image has an empty alt attribute

On the following pages we explain how you can submit a registration for each section.

This documentation is under construction. 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 send us an email 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!
manager Sun, 09/18/2022 - 11:30

Submit a "Endobronchial valve" registration "Primo-implantation"

Submit a "Endobronchial valve" registration "Primo-implantation"

A "Primo-implantation" registration can be submitted at the end of the creation process using the study form (see: Create a "Endobronchial valve" registration "Primo-implantation").

When the registration was completed using the study form, saved and there are no more validation errors, the registration can also be submitted via the overview table. This method can be useful to submit multiple registrations in the same action.

To submit a "Primo-implantation" registration for the study project Endobronchial valve using the overview table, select "Primo-implantation" in the dark blue left menu.

This image has an empty alt attribute

When you select a version of this course of study, you will see the summary table in the main body of your screen. The table includes the following items: Registration ID, Progress, Author, Co-author, Unique ID, Business Key, Registration Code, National registry number of the patient…

Use the filters in the header of the table to find the registration(s) you want to submit. For example, you can use the filters "Status" (set to "Open") and "Validation Errors" (set to "0") to find the registrations that are eligible for submission.

Once you have found the registration(s) you want to submit, you must select the registration(s) by checking the checkbox at the beginning of the row in the summary table.

Then you need to press the "Actions" button at the top right of the summary table.

There are now two options, "Submit" and "Delete". Now press "Submit".

Once you confirm the submission, you cannot change the content of the registration(s). Sent registrations can also no longer be deleted.

The sent registration remains present in the summary table, but the status has changed from "Open" to "Sent".

If you want to see only "Open" registrations, you can adjust the filter on the "Status" item in the summary table.

This documentation is under construction. 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 send us an email 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!
manager Sun, 09/18/2022 - 11:32

Submit a "Endobronchial valve" registration "Follow-up"

Submit a "Endobronchial valve" registration "Follow-up"

A "Follow-up" registration can be submitted at the end of the creation process using the study form (see: Create a "Endobronchial valve" registration "Follow-up").

When the registration was completed using the study form, saved and there are no more validation errors, the registration can also be submitted via the overview table. This method can be useful to submit multiple registrations in the same action.

To submit a "Follow-up" registration for the study project Endobronchial valve using the overview table, select "Follow-up" in the dark blue left menu.

This image has an empty alt attribute
This image has an empty alt attribute

When you select a version of this course of study, you will see the summary table in the main body of your screen. The table includes the following items: Registration ID, Progress, Author, Co-author, Unique ID, Business Key, Registration Code, National registry number of the patient…

Use the filters in the header of the table to find the registration(s) you want to submit. For example, you can use the filters "Status" (set to "Open") and "Validation Errors" (set to "0") to find the registrations that are eligible for submission.

Once you have found the registration(s) you want to submit, you must select the registration(s) by checking the checkbox at the beginning of the row in the summary table.

Then you need to press the "Actions" button at the top right of the summary table.

There are now two options, "Submit" and "Delete". Now press "Submit".

Once you confirm the submission, you cannot change the content of the registration(s). Sent registrations can also no longer be deleted.

The sent registration remains present in the summary table, but the status has changed from "Open" to "Sent".

If you want to see only "Open" registrations, you can adjust the filter on the "Status" item in the summary table.

This documentation is under construction. 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 send us an email 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!

manager Sun, 09/18/2022 - 11:34

Submit a "Endobronchial valve" registration "Replacement"

Submit a "Endobronchial valve" registration "Replacement"

A "Replacement" registration can be submitted at the end of the creation process using the study form (see: Create a "Endobronchial valve" registration "Replacement" ).

When the registration was completed using the study form, saved and there are no more validation errors, the registration can also be submitted via the overview table. This method can be useful to submit multiple registrations in the same action.

To submit a "Replacement" registration for the study project Endobronchial valve using the overview table, select "Replacement" in the dark blue left menu.

This image has an empty alt attribute

When you select a version of this course of study, you will see the summary table in the main body of your screen. The table includes the following items: Registration ID, Progress, Author, Co-author, Unique ID, Business Key, Registration Code, National registry number of the patient…

Use the filters in the header of the table to find the registration(s) you want to submit. For example, you can use the filters "Status" (set to "Open") and "Validation Errors" (set to "0") to find the registrations that are eligible for submission.

Once you have found the registration(s) you want to submit, you must select the registration(s) by checking the checkbox at the beginning of the row in the summary table.

Then you need to press the "Actions" button at the top right of the summary table.

There are now two options, "Submit" and "Delete". Now press "Submit".

Once you confirm the submission, you cannot change the content of the registration(s). Sent registrations can also no longer be deleted.

The sent registration remains present in the summary table, but the status has changed from "Open" to "Sent".

If you want to see only "Open" registrations, you can adjust the filter on the "Status" item in the summary table.

This documentation is under construction. 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 send us an email 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!
manager Sun, 09/18/2022 - 11:35

Send a correction registration

Send a correction registration

Suppose we want to send a correction registration of "Primo-implantation" registration. In that case, we need to navigate to the study program QERMID Pneumology and then to the study project Endobronchial valve. There we need to select "Primo-implantation" in the dark blue left menu.

Important: a correction registration can be added only if the status of the registration is submitted.

A correction registration can be added in two ways. The first way is via the overview table and second way in the preview page of a registration.

Send a correction via Overview table

When the registration was submitted, the correction registration can be added via the overview table:

When you select a version of this study section, you will see the summary table in the main part of your screen. This table contains, among other things: Registration ID, Progress, Author, Co-author, Unique ID, Business Key, Registration Code, National Registry ID of the patient…

Use the filters in the table header to find the registration that need a correction. For example, you can use the "Status" (set to "Submitted") filter to get only submitted registrations.

Then, you must press the "Actionsbutton at the top right of the summary table.

Three options are displayed : "Submit" and "Delete" and "Add correction" but only option "Add correction" is available for submitted registrations. Now press "Add correction".

After you press "Add correction", a pop-up window will appear asking you to confirm the action of adding a correction registration for selected registration. If you are sure of this action, press "Confirm". If not, press "Cancel".

If you confirm, you will be redirected to correction registration form.

The correction DCD has no more than:

  • Business key of original registration,
  • The name of Data Collection,
  • The field or variable which is wrong,
  • The correction value,
  • Comment field.

Some fields are automatically filled with values of original registration, like :"Data collection " and "Business_KEY" .

The number of fields to correct in the same correction registration is limited to three. You can add another field to correct by clicking on "Add another " button.

When you finish filling the correction registration, you can add a comment and send the correction by clicking on "submit" button.

Send a correction via Preview page

We can also add a correction form in the preview page of a registration.

Click on the registration to correct in overview table, you will be redirected to the preview page.

Click on "Add correction" button to add a correction for current registration.

Follow same steps described in previous section( See "1.Send a correction via Overview table")

Preview a correction registration

Correction form is a generic form available for all projects and DCDs.

If you want to preview "correction registrations" already submitted, you have to navigate to the study program Correction form and then to the study project Correction form. There you need to select the last version of "correction form" in the dark blue left menu.

All corrections registrations will be displayed(of different projects). You can use the filters in the table header to find a specific registration.

If you want to preview a correction registration, you need to click on, then you will be redirected to preview page.

This documentation is under construction. 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 send us an email 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!
hamza.kursun@s… Sun, 09/18/2022 - 17:01

HD4DP v2 Support Services

HD4DP v2 Support Services

The Service Desk of healthdata.be (Sciensano) helps users of our applications and services and deals with requests and problems when they arise.

The Service Desk focuses on those services run by our IT Services (HD4DP, HD4RES, healthstat.be, ...) and helps you with accounts and passwords. For questions about the content and objective(s) of the projects, we kindly refer to the managing research organisations.

For most efficient processing of your request, we advise you to use our service portal: https://sciensano.service-now.com/sp.

Please find below our support window hours:

manager Sun, 09/18/2022 - 07:44

How to report an incident

How to report an incident

The healthdata.be service (Sciensano) processes each incident report according to a standard operating procedure (SOP). A public version of this SOP "HD Incident Management Process" is also available on this portal docs.healthdata.be.

To submit an incident related to projects and applications in production and facilitated or managed by Sciensano's healthdata.be service, you must first log into the HD Service and Support portal: https://sciensano.service-now.com/sp

After the login step, you will arrive at the main page of the portal.

On the main page, you must select "Get Help".

A new page with the title "Create an incident" will appear.

You can now document your incident or problem by providing the following information:
Please indicate the urgency of resolving your issue based on its criticality to the business.

Please indicate the type of problem you are experiencing.

When the problem type "Application" is selected, two additional fields appear: "Project Name" and "Application".

Please select the appropriate information.

Please describe clearly and briefly (1 sentence) the subject of your problem.

Please describe the problem in detail. The following aspects are important for us to understand and solve the problem:

  • a description of the actions you want to perform but fail to perform (e.g. provide us with a field name, a validation rule, a button, etc.)
  • a description (if possible) of the sequential steps you follow to use the service or the application of healthdata.be for which you need support;
  • a brief description of the technical problem you are experiencing (e.g. error messages)

We strongly recommend that you add a screenshot describing the problem (IMPORTANT: do not provide us with patient data!).

You can add the screenshot by clicking on " Add attachments".

On the right side of the form, the mandatory information items of the incident form are listed. When these fields are completed, their names disappear from the "required information" box.

The form can only be submitted if all required fields are filled in, by pressing the green "Submit" button.

If all required fields have not been completed, a warning message will appear at the top of the form.

In addition, missing mandatory fields will be highlighted in green.

When the incident form has been successfully submitted, a preview of your submission appears in a new screen.

On the right side of the screen you will find the details, including the incident number.

On the left side of the screen, you will find a chronology of your incident processing, starting with your creation.

manager Sun, 09/18/2022 - 07:48

HD4DP v2 API

HD4DP v2 API

The HD4DP v2 S2S API is a unified Application Programming Interface (API) that will allow participating Health Care Organisations (HCO) to submit DCDs data to HD4DP2.0 fully automated. In the manual of the application HD4DP v2 we provide detailed information about the S2S API:

Please read this documentation before it's project specific use.

The study project Endobronchial valve consists of three sections or DCD's: 

  • Primo-implantation
  • Follow-up and 
  • Replacement.

On the following pages we explain how to submit an Endobronchial valve DCD using the HD4DP v2 S2S API for each section.

This documentation is under construction. 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 send us an email 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!
manager Thu, 09/29/2022 - 09:14

API for "Endobronchial valve: Primo-implantation"

API for "Endobronchial valve: Primo-implantation"

In this article we describe how to submit a DCD for Zephyr "Primo-implantation".

Example JSON

An example of an Zephyr "Primo-implantation" submission json is available here:

Rest endpoint calls

Getting organizations to get organization id

Description
We need to know for further endpoint calls, the id of the organization where we are going to submit our DCD to
Example
EndPoint Type
/api/organizations GET
Result
[
   { "id": 9,
     "identificationValue": "71063584",
     "name": "Multicenter Child 2",
     "loginMethods": [ "USERNAME_PASSWORD", "EID" ]
   },
 
 { "id": 11,
     "identificationValue": "71089914",
     "name": "Multicenter Child 1",
     "loginMethods": [ "USERNAME_PASSWORD", "EID" ]
   },
   { "id": 5572,
     "identificationValue": "71001129",
     "name": "Multicenter Main",
     "loginMethods": [ "USERNAME_PASSWORD", "EID" ]
   },
   { "id": 8429,
     "identificationValue": "71001129",
     "name": "Ziekenhuis Oost Limburg (ACC)",
     "loginMethods": [ "USERNAME_PASSWORD", "EID" ]
   } ]  

Getting menu structure info to get dcd and version id

Description
We need to know for further endpoint calls, the id of the DCD we are going to submit and its version
Example
EndPoint Type
/api/dcd/menu/structure?organization-id=8429 GET
Result
[
  {
    "id": 4,
    "key": "zephyr_pneumo_program",
    "projects": [
      {
        "id": 4,
        "key": "zephyr_pneumo_project",
        "dcds": [
          {
            "id": 9,
            "key": "zephyr_pneumo_t1_dcd",
            "dcdVersions": [
              {
                "id": 9,
                "version": 1,
                "supportsEN": true,
                "supportsFR": true,
                "supportsNL": true
              }
            ],
            "menuIndex": 1
          },
          {
            "id": 10,
            "key": "zephyr_pneumo_tr_dcd",
            "dcdVersions": [
              {
                "id": 10,
                "version": 1,
                "supportsEN": true,
                "supportsFR": true,
                "supportsNL": true
              }
            ],
            "menuIndex": 2
          },
          {
            "id": 11,
            "key": "zephyr_pneumo_t2_dcd",
            "dcdVersions": [
              {
                "id": 11,
 
              "version": 1,
                "supportsEN": true,
                "supportsFR": true,
                "supportsNL": true
              }
            ],
            "menuIndex": 3
          }
        ],
        "menuIndex": 1
      }
    ],
    "menuIndex": 1
  },
  . . . . . . . . .
  . . . . . . . . .
  . . . . . . . . .
  . . . . . . . . .
  . . . . . . . . .
  ]  

Get DCD definition to know what fields, data types and values are allowed

Description
As a helper for our purpose, we could get the definition of the DCD, this is, fields, data type of those fields, code list values permitted on those code list fields type, etc.
Example
EndPoint Type
/api/dcd/payload/definition?dcd-id=9&version=1 GET
Result
[
   {
    "dcdFields": [
      . . .
      {
        "name": "CD_COMPLIC_ACUT_EXCB",
        "fieldType": "CODE",
        "codeListId": 33,
        "fieldId": null,
        "dataType": "number",
        "codeListValues": [
          {
            "id": 67768,
            "index": 1,
            "code": "195951007",
            "label": "Yes"
          },
          {
            "id": 67769,
            "index": 2,
            "code": "0",
            "label": "No"
          }
        ],
        "nameTranslation": "Acute exacerbatie COPD",
        "dataFormat": null
      },
      . . .
      {
        "name": "CD_SAMA",
        "fieldType": "CODE",
        "codeListId": 9,
        "fieldId": null,
        "dataType": "number",
        "codeListValues": [
          {
            "id": 4516,
            "index": 1,
            "code": "1",
            "label": "Yes"
          },
          {
            "id": 4515,
            "index": 2,
            "code": "0",
            "label": "No"
          }
        ],
        "nameTranslation": "Kortwerkend anticholinergicum (SAMA)",
        "dataFormat": null
      },
      . . .
      {
        "name": "D_ACUT_EXCB_START",
        "fieldType": "DATE",
        "codeListId": 0,
        "fieldId": null,
        "dataType": "timestamp",
        "codeListValues": [],
        "nameTranslation": "Problem start date",
        "dataFormat": null
      },
      . . .
      {
        "name": "TX_PAT_FIRST_NAM",
        "fieldType": "FREE_TEXT",
        "codeListId": 0,
        "fieldId": null,
        "dataType": "string",
        "codeListValues": [],
        "nameTranslation": "ss sdfg sdfg sdfg sdfg sdfg sdfg sdfg sdfg sdfg.",
        "dataFormat": null
      },
      . . .
    ]
  }  

Get a DCD payload example with dummy data

Description
As a helper for our purpose, we could get an example with dummy data values of the DCD payload to be submitted
Example
EndPoint Type
/api/dcd/payload/example?dcd-id=9 GET
Result
[
   . . .
   "CD_COMPLIC_ACUT_EXCB": 67768,
   . . .
   "CD_SAMA": 4516,
   . . .
   "D_ACUT_EXCB_START": "12/09/2022",
   . . .
   "TX_PAT_FIRST_NAM": "MBvMuGzipFYQZzYAOOUr",
   . . .
]  

Submit a DCD payload

Description
We submit the DCD payload for its registratrion
Example
EndPoint Type
/api/dcd/payload/submit?organization-id=8429&dcd-id=9&version=1 GET
Result
[
   {
      "TX_AUTHOR_GR": "Test group",
      "TX_AUTHOR": "test@sciensano.be",
      "TX_COAUTHOR": "test@sciensano.be",
 
      "TX_REGN_CD": "601.22.000001.00",
      "CD_NIC_TPE": "67809",
      "CD_BILL": "67826",
      . . .
      "CD_COMPLIC_ACUT_EXCB": "67769",
      . . .
      "CD_SAMA": "4515",
      . . .
      "D_ACUT_EXCB_START": null,
      . . .
      "TX_PAT_FIRST_NAM": "BERNARD",
      . . .
   }
]  
This documentation is under construction. 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 send us an email 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!
manager Thu, 09/22/2022 - 16:07

API for "Endobronchial valve: Follow-up"

API for "Endobronchial valve: Follow-up"

In this article we describe how to submit a DCD for Zephyr "Follow-up".

Example JSON

An example of an Zephyr "Follow-up" submission json is available here:

Rest endpoints call

Getting organizations to get organization id

Description
We need to know for further endpoint calls, the id of the organization where we are going to submit our DCD to
Example
EndPoint Type
/api/organizations GET
Result
[
   { "id": 9,
     "identificationValue": "71063584",
     "name": "Multicenter Child 2",
     "loginMethods": [ "USERNAME_PASSWORD", "EID" ]
   },
 
 { "id": 11,
     "identificationValue": "71089914",
     "name": "Multicenter Child 1",
     "loginMethods": [ "USERNAME_PASSWORD", "EID" ]
   },
   { "id": 5572,
     "identificationValue": "71001129",
     "name": "Multicenter Main",
     "loginMethods": [ "USERNAME_PASSWORD", "EID" ]
   },
   { "id": 8429,
     "identificationValue": "71001129",
     "name": "Ziekenhuis Oost Limburg (ACC)",
     "loginMethods": [ "USERNAME_PASSWORD", "EID" ]
   } ]  

Getting menu structure info to get DCD and version id

Description
We need to know for further endpoint calls, the id of the DCD we are going to submit and its version
Example
EndPoint Type
/api/dcd/menu/structure?organization-id=8429 GET
Result
[
  {
    "id": 4,
    "key": "zephyr_pneumo_program",
    "projects": [
      {
        "id": 4,
        "key": "zephyr_pneumo_project",
        "dcds": [
          {
            "id": 9,
            "key": "zephyr_pneumo_t1_dcd",
            "dcdVersions": [
              {
                "id": 9,
                "version": 1,
                "supportsEN": true,
                "supportsFR": true,
                "supportsNL": true
              }
            ],
            "menuIndex": 1
          },
      
   {
            "id": 10,
            "key": "zephyr_pneumo_tr_dcd",
            "dcdVersions": [
              {
                "id": 10,
                "version": 1,
                "supportsEN": true,
                "supportsFR": true,
                "supportsNL": true
              }
            ],
            "menuIndex": 2
          },
          {
            "id": 11,
            "key": "zephyr_pneumo_t2_dcd",
            "dcdVersions": [
              {
                "id": 11,
 
              "version": 1,
                "supportsEN": true,
                "supportsFR": true,
                "supportsNL": true
              }
            ],
            "menuIndex": 3
          }
        ],
        "menuIndex": 1
      }
    ],
    "menuIndex": 1
  },
  . . .
  . . .
  . . .
  . . .
  . . .
  ]  

Get DCD definition to know what fields, data types and values are allowed

Description
As a helper for our purpose, we could get the definition of the DCD, this is, fields, data type of those fields, code list values permitted on those code list fields type, etc.
Example
EndPoint Type
/api/dcd/payload/definition?dcd-id=11&version=1 GET
Result
[ {
    "dcdFields": [
      . . .
      {
        "name": "CD_COMPLIC_ACUT_EXCB",
        "fieldType": "CODE",
        "codeListId": 33,
        "fieldId": null,
        "dataType": "number",
        "codeListValues": [
          {
            "id": 67768,
            "index": 1,
            "code": "195951007",
            "label": "Yes"
          },
          {
            "id": 67769,
            "index": 2,
            "code": "0",
            "label": "No"
          }
        ],
        "nameTranslation": "Acute exacerbatie COPD",
        "dataFormat": null
      },
      . . .
      {
        "name": "CD_SAMA",
        "fieldType": "CODE",
        "codeListId": 9,
        "fieldId": null,
        "dataType": "number",
        "codeListValues": [
          {
            "id": 4516,
            "index": 1,
            "code": "1",
            "label": "Yes"
          },
          {
            "id": 4515,
            "index": 2,
            "code": "0",
            "label": "No"
          }
        ],
        "nameTranslation": "Kortwerkend anticholinergicum (SAMA)",
        "dataFormat": null
      },
      . . .
      {
        "name": "D_ACUT_EXCB_START",
        "fieldType": "DATE",
        "codeListId": 0,
        "fieldId": null,
        "dataType": "timestamp",
        "codeListValues": [],
        "nameTranslation": "Problem start date",
        "dataFormat": null
      },
      . . .
      {
        "name": "TX_PAT_FIRST_NAM",
        "fieldType": "FREE_TEXT",
        "codeListId": 0,
        "fieldId": null,
        "dataType": "string",
        "codeListValues": [],
        "nameTranslation": "ss sdfg sdfg sdfg sdfg sdfg sdfg sdfg sdfg sdfg.",
        "dataFormat": null
      },
      . . .
    ]
  }  

Get a DCD payload example with dummy data

Description
As a helper for our purpose, we could get an example with dummy data values of the DCD payload to be submitted
Example
EndPoint Type
/api/dcd/payload/example?dcd-id=11 GET
Result
[ {
  . . .
  "CD_COMPLIC_ACUT_EXCB": 67768,
  . . .
  "CD_SAMA": 4516,
  . . .
  "D_ACUT_EXCB_START": "12/09/2022",
  . . .
  "MBvMuGzipFYQZzYAOOUr",
  . . .
 } ]  

Submit a DCD payload

Description
We submit the DCD payload for its registratrion
Example
EndPoint Type
/api/dcd/payload/submit?organization-id=8429&dcd-id=11&version=1 GET
Result
[ {
      "TX_AUTHOR_GR": "Test group",
      "TX_AUTHOR": "test@sciensano.be",
      "TX_COAUTHOR": "test@sciensano.be",
 
      "TX_REGN_CD": "601.22.000001.00",
      "CD_NIC_TPE": "67809",
      "CD_BILL": "67826",
      . . .
      "CD_COMPLIC_ACUT_EXCB": "67769",
      . . .
      "CD_SAMA": "4515",
      . . .
      "D_ACUT_EXCB_START": null,
      . . .
      "TX_PAT_FIRST_NAM": "BERNARD",
      . . .
} ]  
This documentation is under construction. 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 send us an email 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!
manager Sun, 09/18/2022 - 18:34

API for "Endobronchial valve: Replacement"

API for "Endobronchial valve: Replacement"

In this article we describe how to submit a DCD for Zephyr "Replacement".

Example JSON

An example of an Zephyr "Replacement" submission json is available here:

Rest endpoints call

Getting organizations to get organization id

Description
We need to know for further endpoint calls, the id of the organization where we are going to submit our DCD to
Example
EndPoint Type
/api/organizations GET
Result
[
   { "id": 9,
     "identificationValue": "71063584",
     "name": "Multicenter Child 2",
     "loginMethods": [ "USERNAME_PASSWORD", "EID" ]
   },
 
 { "id": 11,
     "identificationValue": "71089914",
     "name": "Multicenter Child 1",
     "loginMethods": [ "USERNAME_PASSWORD", "EID" ]
   },
   { "id": 5572,
     "identificationValue": "71001129",
     "name": "Multicenter Main",
     "loginMethods": [ "USERNAME_PASSWORD", "EID" ]
   },
   { "id": 8429,
     "identificationValue": "71001129",
     "name": "Ziekenhuis Oost Limburg (ACC)",
     "loginMethods": [ "USERNAME_PASSWORD", "EID" ]
   } ]  

Getting menu structure info to get dcd and version id

Description
We need to know for further endpoint calls, the id of the DCD we are going to submit and its version
Example
EndPoint Type
/api/dcd/menu/structure?organization-id=8429 GET
Result
[
  {
    "id": 4,
    "key": "zephyr_pneumo_program",
    "projects": [
      {
        "id": 4,
        "key": "zephyr_pneumo_project",
        "dcds": [
          {
            "id": 9,
            "key": "zephyr_pneumo_t1_dcd",
            "dcdVersions": [
              {
                "id": 9,
                "version": 1,
                "supportsEN": true,
                "supportsFR": true,
                "supportsNL": true
              }
            ],
            "menuIndex": 1
          },
      
   {
            "id": 10,
            "key": "zephyr_pneumo_tr_dcd",
            "dcdVersions": [
              {
                "id": 10,
                "version": 1,
                "supportsEN": true,
                "supportsFR": true,
                "supportsNL": true
              }
            ],
            "menuIndex": 2
          },
          {
            "id": 11,
            "key": "zephyr_pneumo_t2_dcd",
            "dcdVersions": [
              {
                "id": 11,
 
              "version": 1,
                "supportsEN": true,
                "supportsFR": true,
                "supportsNL": true
              }
            ],
            "menuIndex": 3
          }
        ],
        "menuIndex": 1
      }
    ],
    "menuIndex": 1
  },
  . . . . . . . . .
  . . . . . . . . .
  . . . . . . . . .
  . . . . . . . . .
  . . . . . . . . .
  ]  

Get DCD definition to know what fields, data types and values are allowed

Description
As a helper for our purpose, we could get the definition of the DCD, this is, fields, data type of those fields, code list values permitted on those code list fields type, etc.
Example
EndPoint Type
/api/dcd/payload/definition?dcd-id=10&version=1 GET
Result
[
  {
    "dcdFields": [
      . . .
      {
        "name": "CD_COMPLIC_ACUT_EXCB",
        "fieldType": "CODE",
        "codeListId": 33,
        "fieldId": null,
        "dataType": "number",
        "codeListValues": [
          {
            "id": 67768,
            "index": 1,
            "code": "195951007",
            "label": "Yes"
          },
          {
            "id": 67769,
            "index": 2,
            "code": "0",
            "label": "No"
          }
        ],
        "nameTranslation": "Acute exacerbatie COPD",
        "dataFormat": null
      },
      . . .
      {
        "name": "CD_SAMA",
        "fieldType": "CODE",
        "codeListId": 9,
        "fieldId": null,
        "dataType": "number",
        "codeListValues": [
          {
            "id": 4516,
            "index": 1,
            "code": "1",
            "label": "Yes"
          },
          {
            "id": 4515,
            "index": 2,
            "code": "0",
            "label": "No"
          }
        ],
        "nameTranslation": "Kortwerkend anticholinergicum (SAMA)",
        "dataFormat": null
      },
      . . .
      {
        "name": "D_ACUT_EXCB_START",
        "fieldType": "DATE",
        "codeListId": 0,
        "fieldId": null,
        "dataType": "timestamp",
        "codeListValues": [],
        "nameTranslation": "Problem start date",
        "dataFormat": null
      },
      . . .
      {
        "name": "TX_PAT_FIRST_NAM",
        "fieldType": "FREE_TEXT",
        "codeListId": 0,
        "fieldId": null,
        "dataType": "string",
        "codeListValues": [],
        "nameTranslation": "ss sdfg sdfg sdfg sdfg sdfg sdfg sdfg sdfg sdfg.",
        "dataFormat": null
      },
      . . .
    ]
  }  

Get a DCD payload example with dummy data

Description
As a helper for our purpose, we could get an example with dummy data values of the DCD payload to be submitted
Example
EndPoint Type
/api/dcd/payload/example?dcd-id=10 GET
Result
[
   . . .
   . . .
   "CD_COMPLIC_ACUT_EXCB": 67768,
   . . .
   "CD_SAMA": 4516,
   . . .
   "D_ACUT_EXCB_START": "12/09/2022",
   . . .
   "TX_PAT_FIRST_NAM": "MBvMuGzipFYQZzYAOOUr",
   . . .
   ]  

Submit a DCD payload

Description
We submit the DCD payload for its registratrion
Example
EndPoint Type
/api/dcd/payload/submit?organization-id=8429&dcd-id=10&version=1 GET
Result
[ {
      "TX_AUTHOR_GR": "Test group",
      "TX_AUTHOR": "test@sciensano.be",
      "TX_COAUTHOR": "test@sciensano.be",
 
      "TX_REGN_CD": "601.22.000001.00",
      "CD_NIC_TPE": "67809",
      "CD_BILL": "67826",
      . . .
      "CD_COMPLIC_ACUT_EXCB": "67769",
      . . .
      "CD_SAMA": "4515",
      . . .
      "D_ACUT_EXCB_START": null,
      . . .
      "TX_PAT_FIRST_NAM": "BERNARD",
      . . .} ]  
This documentation is under construction. 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 send us an email 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!
manager Sun, 09/18/2022 - 18:34

HD4DP v2 csv upload

HD4DP v2 csv upload

This page explains the functioning of the CSVUploader feature of HD4DP v2. The CSVUploader feature is aimed to do a bulk upload of records : by filling a csv file, one record per row represents one submission so a user can fill as much records as needed. In the manual of the application HD4DP v2 we provide detailed information about the use of the CSVUploader:

Please read this documentation before it's project specific use.

The study project Zephyr consists of three sections or DCD's: 

  • Primo-implantation
  • Follow-up and 
  • Replacement.

On the following pages we explain how to submit a Zephyr DCD using the HD4DP v2 CSVUploader for each section.

This documentation is under construction. 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 send us an email 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!
manager Thu, 09/29/2022 - 09:16

csv upload for "Endobronchial valve: Primo-implantation"

csv upload for "Endobronchial valve: Primo-implantation"

In this article we describe how to submit a CSV for Zephyr "Primo-implantation".

Example CSV

An example of an Zephyr "Primo-implantation" submission csv is available here:

CSV submission process

The main folder structure of the csv upload folder will look as such:

Each folder consists of sub folders which contains the DCD.

Find below an overview of the DCD's that can be uploaded.

  • Endobronchialvalve-4 (Zephyr):
    • Primo-implantation
    • Replacement
    • Follow-up
This example shows the different DCDs of an Orthopride Knee project

The csv files will be placed in the folders of the DCD which we want to upload. We double click on the folder of the dcd and the structure will be either empty, whether filled with folders containing the following names:

  • ARCHIVE (after a csv file has been processed, the original csv file will be saved in this folder)
  • RESULT (when the csv file has been processed, a file will be created or append with the result of the upload of the csv file)
  • ERROR (when the csv file contains erroneous formatting, the csv file won't get processed and an error file will be created or append with the errors and reason why the csv file couldn't be processed)

I want to upload an Orthopride Knee Primo-Implantation dcd, so I will place the csv file into the dcd-21-v-1-kneePrimoImplantation folder.

  • Open the dcd-21-v-1-kneePrimoImplantation folder
  • Put the orthopride knee primo implantation csv file into the folder
  • Wait until the file has been processed (the file will disappear from this folder if it has been processed - don't forget to click on the refresh button)
  • Go into the RESULT folder and refresh the folder to update the file with the latest changes
  • Double click the file to open it and to read the result of the upload process

The status is the most important line that indicates whether the upload was a success or not.

Verification of the upload process is also possible in the application HD4DP2.

After login to HD4DP2 go to relevant DCD and check the processed data.

This documentation is under construction. 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 send us an email 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!
manager Thu, 09/22/2022 - 16:07

csv upload for "Endobronchial valve: Follow-up"

csv upload for "Endobronchial valve: Follow-up"

In this article we describe how to submit a CSV for Zephyr "Follwo-up".

Example CSV

An example of an Zephyr "Follow-up" submission csv is available here:

CSV submission process

The main folder structure of the csv upload folder will look as such:

Each folder consists of sub folders which contains the DCD.

Find below an overview of the DCD's that can be uploaded.

  • Endobronchialvalve-4 (Zephyr):
    • Primo-implantation
    • Replacement
    • Follow-up
This example shows the different DCDs of an Orthopride Knee project

The csv files will be placed in the folders of the DCD which we want to upload. We double click on the folder of the dcd and the structure will be either empty, whether filled with folders containing the following names:

  • ARCHIVE (after a csv file has been processed, the original csv file will be saved in this folder)
  • RESULT (when the csv file has been processed, a file will be created or append with the result of the upload of the csv file)
  • ERROR (when the csv file contains erroneous formatting, the csv file won't get processed and an error file will be created or append with the errors and reason why the csv file couldn't be processed)

I want to upload an Orthopride Knee Primo-Implantation dcd, so I will place the csv file into the dcd-21-v-1-kneePrimoImplantation folder.

  • Open the dcd-21-v-1-kneePrimoImplantation folder
  • Put the orthopride knee primo implantation csv file into the folder
  • Wait until the file has been processed (the file will disappear from this folder if it has been processed - don't forget to click on the refresh button)
  • Go into the RESULT folder and refresh the folder to update the file with the latest changes
  • Double click the file to open it and to read the result of the upload process

The status is the most important line that indicates whether the upload was a success or not.

Verification of the upload process is also possible in the application HD4DP2.

After login to HD4DP2 go to relevant DCD and check the processed data.

This documentation is under construction. 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 send us an email 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!
manager Sun, 09/18/2022 - 18:37

csv upload for "Endobronchial valve: Replacement"

csv upload for "Endobronchial valve: Replacement"

In this article we describe how to submit a CSV for Zephyr "Replacement".

Example CSV

An example of an Zephyr "Replacement" submission csv is available here:

CSV submission process

The main folder structure of the csv upload folder will look as such:

Each folder consists of sub folders which contains the DCD.

Find below an overview of the DCD's that can be uploaded.

  • Endobronchialvalve-4 (Zephyr):
    • Primo-implantation
    • Replacement
    • Follow-up
This example shows the different DCDs of an Orthopride Knee project

The csv files will be placed in the folders of the DCD which we want to upload. We double click on the folder of the dcd and the structure will be either empty, whether filled with folders containing the following names:

  • ARCHIVE (after a csv file has been processed, the original csv file will be saved in this folder)
  • RESULT (when the csv file has been processed, a file will be created or append with the result of the upload of the csv file)
  • ERROR (when the csv file contains erroneous formatting, the csv file won't get processed and an error file will be created or append with the errors and reason why the csv file couldn't be processed)

I want to upload an Orthopride Knee Primo-Implantation dcd, so I will place the csv file into the dcd-21-v-1-kneePrimoImplantation folder.

  • Open the dcd-21-v-1-kneePrimoImplantation folder
  • Put the orthopride knee primo implantation csv file into the folder
  • Wait until the file has been processed (the file will disappear from this folder if it has been processed - don't forget to click on the refresh button)
  • Go into the RESULT folder and refresh the folder to update the file with the latest changes
  • Double click the file to open it and to read the result of the upload process

The status is the most important line that indicates whether the upload was a success or not.

Verification of the upload process is also possible in the application HD4DP2.

After login to HD4DP2 go to relevant DCD and check the processed data.

This documentation is under construction. 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 send us an email 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!
manager Sun, 09/18/2022 - 18:38