The Orthopride Hip data collection

The Orthopride Hip data collection

Organizations and/or individuals that provide data

71000436Clinique Reine Astrid
71000634CHR de Namur
71000733CHR de la Haute Senne
71000931Ziekenhuisnetwerk Antwerpen
71001030Grand Hopital de Charleroi
71001228AZ St-Blasius
71001525St-Nikolaus Hospital
71001723AZ Maria Middelares
71002020CHR Verviers
71002317Clinique Andre Renard
71002614AZ St-Maarten
71003208AZ Alma
71003703ISOSL- Cliniques de Soins Specialises Valdor - Peri
71003901CHU UCL Namur - Mont-Godinne
71004295CH du Bois de l'Abbaye et de Hesbaye
71004394Clinique St-Pierre
71004988AZ St-Jan Brugge-Oostende
71005780Jan Yperman Ziekenhuis
71006374AZ Turnhout
71006869CHR de Huy
71007661CHU St-Pierre
71007760CHU Brugmann
71007958Institut Jules Bordet
71008750Hopitaux Iris Sud - Iris Ziekenhuizen Zuid
71009641CHU Tivoli
71009740H. Hartziekenhuis Lier
71009938GZA-Ziekenhuizen
71010235H. Hartziekenhuis Mol
71010334CHR du Val de Sambre Auvelais
71010433St-Jozefkliniek
71010631RZ St-Maria
71010829RZ Heilig Hart Leuven
71010928RZ Heilig Hart Tienen
71011027Kliniek St-Jan - Clinique St-Jean
71011126Europaziekenhuizen - Cliniques de l'Europe
71011720AZ Delta
71012413St-Jozefskliniek Izegem
71012611OLV Aalst
71013403St-Vincentiusziekenhuis
71014094AZ St-Lucas Brugge
71014391UZ Brussel
71014688CH de Jolimont - Lobbes
71015084HUDERF
71015282CH Chretien
71015282CH Chretien Campus St-Vincent
71016470VIVALIA - IFAC
71016668CHU UCL Namur - Ste Elisabeth
71016866VIVALIA - CHA
71017064AZ Oudenaarde
71017658ASZ Aalst
71020430AZ Jan Portaels
71021717AZ St-Elisabeth Zottegem
71024289Centre Neurologique et de Readaptation Fonctionnelle
71024388Jessaziekenhuis
71024685VIVALIA - CSL
71024784CH de Mouscron
71024982Centre de Sante Des Fagnes
71025477CHU Ambroise Pare
71025774Klinik St-Josef
71026467CHU UCL Namur - Dinant
71026566AZ Lokeren
71026665CHR Mons-Hainaut
71029041AZ St-Lucas Gent
71030031UZ Antwerpen
71030823AZ St-Elisabeth Herentals
71031021AZ West
71031417AZ Heilige Familie
71032209UZ Leuven
71032506Hopital Andre Vesale
71033296CHIREC Delta
71034682CH Jolimont - Tubize-Nivelles
71037157Ziekenhuis Oost-Limburg
71037850AZ Delta - Campus Sint-Rembert
71039236AZ Zeno
71039533St-Andriesziekenhuis
71039632AZ Groeninge
71039731OLV Van Lourdes Ziekenhuis Waregem
71040325UCL St-Luc
71040622CUB Hopital Erasme
71040919Clinique Notre-Dame de Grace
71041018CH Epicura - Baudour - Hornu
71041216CHR de la Citadelle
71049926Ziekenhuis Inkendaal
71052597AZ Damiaan
71053488CHWAPI
71053686AZ St-Jozef
71055072AZ Glorieux Ronse
71059527AZ Nikolaas
71067049UZ Gent
71067643Koningin Elisabeth Instituut
71068237AZ Monica
71068930Imelda Ziekenhuis
71069326Nationaal Multiple Sclerose Centrum
71070019Silva Medical
71070613Clinique St-Luc
71070712CHU de Liege
71070910AZ St-Dimpna
71071009AZ Klina
71071207AZ Diest
71071306AZ Jan Palfijn
71071405St-Franciscusziekenhuis
71071504St-Trudo Ziekenhuis
71071603AZ Vesalius
71071702Ziekenhuis Maas en Kempen
71071801Hopital Civil Marie-Curie
71071801CHU de Charleroi
71071997Mariaziekenhuis Noord-Limburg
71072393CHIREC - Ste-Anne St-Remi
71072492CH Epicura - Ath

Start date of the data collection

01/03/2023

End date of the data collection

To be determined.

Periodicity of the data collection

Continuously

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 a request (type : request for information) via our portal (https://sciensano.service-now.com/sp) 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!
manager Tue, 04/04/2023 - 13:13

The Orthopride Hip Data Collection Definition (HDBP0386)

The Orthopride Hip Data Collection Definition (HDBP0386)

In the file below you can find the Data Collection Definition (DCD) specifications of the project Orthopride Hip. It is a detailed description of the content of the 3 DCD's:

  • Primo-implantation
  • Revision
  • Resection

with field names, formats, values, validation rules, help texts, error messages, translations... These specifications were used to build the forms, csv's, and API's for this project, which you also can find in this project manual.

Please note that the below version of the Data collection Definition includes the latest changes. An overview of these changes can be found in the Release notes section.

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 a request (type : request for information) via our portal (https://sciensano.service-now.com/sp) 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!
johanvanbussel Tue, 01/16/2024 - 12:11

XLSForm Orthopride Hip (HDBP0386)

XLSForm Orthopride Hip (HDBP0386)

Explanation of DCD specifications

The above Data Collection Definition (DCD) specifications are published in an MS Excel file using a slightly modified XLSForm format. XLSForm is a form standard created to simplify the creation of forms. The creation is done in a human readable format. XLSForms are a convenient standard for sharing and collaborating on form creation. For a detailed guide to the XLSForm standard, we refer you to https://xlsform.org/en/.

Each DCD Excel workbook has three worksheets: "settings", "survey" and "choices". Sometimes a project is composed of several DCDs. In this case, a "survey" worksheet is created for each DCD. The lists of values for all DCDs are listed in a single "choice" worksheet.

While not all survey and choice characteristics are used by healthdata.be to describe the data collection definitions, all standard XLSForm columns are present in the MS Excel file.

Note: healthdata.be itself does not use the XLSForm standard to create its DCD in its own applications (HD4DP, HD4Patient). The XLSForm standard (used by popular electronic data capture systems such as OpenClinica, LibreClinica, ODK,…) is chosen to describe the DCD only because it is a human readable format.

The "Survey" worksheet

This worksheet gives the general structure of the DCD and contains most of the content. It contains the complete list of variables and information on how they should appear in the form. Each row usually represents one variable.

The following columns are primarily used in the survey worksheet to describe DCD:

  • type: Defines the type of question/variable
  • name: Unique ID (name) of the question / variable
  • label::[English]: Question / variable in English, appears on the screen
  • label::[French]: Question / variable in French, appears on the screen
  • label::[Dutch]: Question / variable in Dutch, appears on the screen
  • label::[German]: Question / variable in German, appears on the screen
  • hint::[English]: Hint or explanatory text for a question, in English
  • hint::[French]: Hint or explanatory text for a question, in French
  • hint::[Dutch]: Hint or explanatory text for a question, in Dutch
  • hint::[German]: Hint or explanatory text for a question, in German
  • constraint_javascript: Constraint on the allowed values for a response defined in javascript
  • constraint_message::[English]: The message displayed to the user if the answer is not valid, in English
  • constraint_message::[French]: The message displayed to the user if the answer is not valid, in French
  • constraint_message::[Dutch]: The message displayed to the user if the answer is not valid, in Dutch
  • constraint_message::[German]: The message displayed to the user if the answer is not valid, in German
  • required: If a question or variable must be completed for the form to continue or be submitted
  • relevant_javascript: Skip logic condition (the relevant condition that must be met for this question to be displayed)
  • read_only: If a variable question/answer can be changed
  • calculation
  • repeat_count: Number of repetitions for a group of repetitions
  • hidden: Hidden fields in the HD4DP application

The "Choices" worksheet

This worksheet is used to specify answer choices for multiple choice questions. Each row represents an answer choice. Answer choices with the same list name are considered part of a set of related choices and appear together for a question/variable. This also allows a choice set to be reused for multiple questions/variables (for example, yes/no questions).

The following columns are primarily used in the choices worksheet to describe the DCD:

  • list_name: A unique name for each choice set
  • name: ID (name or code) of the specific choice
  • label::[English]: The choice label, in English, appears on the screen
  • label::[French]: The choice label, in French, appears on the screen
  • label::[Dutch]: The choice label, in Dutch, appears on the screen
  • label::[German]: The choice label, in German, appears on the screen

 

The "Settings" worksheet

  • form_title: Title displayed at beginning of form, in form list
  • public_key: Key required for encrypted forms
  • submission_url: Specific URL for uploading data
  • default_language: If form uses multiple languages, this one sets which to use by default
  • style: Separate questions groups into pages. Switch to a different theme.
  • instance_name: Allows user to create a dynamic naming convention for each submitted instance
  • status: status of the form: options are "final" and "draft"
  • start_date: date start form in production
  • end_date: date end form in production
Adelaide.DAmore Tue, 10/03/2023 - 12:59

The Orthopride Hip Dataflow description

The Orthopride Hip Dataflow description

Below we describe (high level) the Orthopride Hip 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. Joining of pseudonymized patient IDs and the registry variables based on the technical ID and Transfer of the records from HD Integration engine towards Data Validation environment on DHW.

Step 9 - Option 1. Indirect transfer of patient identifiers and NIC-CIN variables from HD4DP v2 Local via the MyCareNet component of the HCO towards NIC-CIN (default).

Step 9 - Option 2. Direct real time transfer of patient identifiers and NIC-CIN variables from HD4DP v2 Local towards NIC-CIN (optional).

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 a request (type : request for information) via our portal (https://sciensano.service-now.com/sp) 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!
manager Tue, 04/04/2023 - 13:13

HD4DP v2

HD4DP v2

For the project "Orthopride Hip" only the local version of HD4DP v2 can be used. HD4DP v2 WEB is not available for this project.


In the following sections, we will provide you with information on how to proceed with the application HD4DP v2.

manager Tue, 04/04/2023 - 13:14

General description of the application HD4DP v2

General description of the application HD4DP v2

The HD4DP version 2.x Local is an electronic data capture (EDC) system: a computerized system designed for the collection of clinical data in electronic format for use in research supporting human public health policy. HD4DP (Health Data for Data providers) replaces the traditional paper-based data collection methodology and the proliferation of websites to streamline data collection and expedite the time to analysis and reporting.

Components and features

The HD4DP version 2.x Local application contains the following major components: NextGen Connect, Form.io, HD Connect (LOCAL Proxy), Local datawarehouse.

NextGen Connect

NextGen Connect is a health care integration engine that translates message standards into the standard required by the receiving system, including data formats and standards like HL7, DICOM, ANSI X12, ASCII, and XML. Main functionalities are filtering, transformation, extraction and routing.

The NextGen Connect component is used to handle all integrations within HD4DP 2.0 itself but also all integrations with the external world.

Data collections API: The form.io server offers a REST API which can be used to submit data for each known data collection. Data provider Master Systems cannot access this API directly but need to use the API exposed by the NextGen Connect component. This API is simply a proxy for the form.io API, but allows extra features on top of the form.io API such as security, monitoring, throttling, …

CSV API: For each data collection data can be submitted file-based using a CSV. A CSV can contain multiple data entries for a single data collection definition. These data entries are transformed and pushed by the NextGen Connect component towards the form.io server for potential manual post-processing and validation.

HL7 FHIR API: For some data collections an HL7 FHIR API will be available. The NextGen Connect component performs the transformation towards the Data Collections API and push the data into the form.io server.

Data delivery: the NextGen Connect component handles all routing of data towards the external world. This means it verifies the form.io server for completed data entries which have not yet been delivered. For each data entry that needs to be delivered, it determines where to send the data to, how it needs to be transformed and how it needs to be split. It performs all these actions in a guaranteed delivery fashion: it makes sure the data reaches its destination, possibly retrying when something went wrong.

Feedback: the NextGen Connect component coordinates the receival of feedback, potentially transforming it and pushing it towards the respective data collection entry using the data collections API.

Form.io

Form.io is a data management platform that includes a form builder with a drag and drop interface, management of data with complete API platform, management of users, offline forms, dynamic forms, automatic creation of API, and application embedding. In HD4DP v2, an Angular frontend application is available on top of the form.io server. This application provides a user interface to data providers in which they can see the different data collections for which they are allowed to record and submit data manually. A form.io backend server is responsible for providing the form definitions and registrations of new/updated entries.

HD Connect (LOCAL Proxy)

The HD Connect component is used to retrieve metadata from Master Data Management Database (MDM DB) residing on healthdata.be side.

Local datawarehouse

Each and every change in data entries on the form.io server is pushed towards the local datawarehouse (Local DWH) for easy reporting and data extraction. This local DWH consists of a PostgreSQL database.

Installation and maintenance

The application HD4DP v2 Local is provided without cost and installed remotely on the infrastructure of the healthcare organization by healthdata.be. Healthcare organizations are provided the system requirements for installation of HD4DP v2 application. Healthcare organizations that cannot provide the system requirements can opt to request access and use of a HD4DP v2 Local application of another healthcare organization. Healthcare organizations that cannot provide the system requirements and cannot access and use a HD4DP v2 Local application of another healthcare organization, can request access and use of HD4DP v2 WEB hosted by healthdata.be.

The application HD4DP v2 Local is maintained without cost remotely on the infrastructure of the healthcare organization by healthdata.be. The infrastructure on which the application HD4DP v2 Local is installed, should be maintained by the healthcare organization.

Jonas.VanBussel Tue, 08/08/2023 - 14:21

Position of HD4DP v2 in HD Architecture 2.0

Position of HD4DP v2 in HD Architecture 2.0
Jonas.VanBussel Tue, 08/08/2023 - 14:21

User manual of the application HD4DP v2

User manual of the application HD4DP v2

In this manual we describe the following functions of the application HD4DP v2:

Jonas.VanBussel Sun, 01/07/2024 - 12:09

Request access to an HD application for a specific project

Request access to an HD application for a specific project

Healthdata.be applications such as HD4DP v2 and healthstat.be process sensitive personal information. Therefore, strictly controlled processes are used to grant access to these applications. The Entity Access Management (EAM) portal of healthdata.be facilitates these processes.

Due to the migration from EAM version 2.7 to EAM version 3.0 both systems will exist parallel during the transition period. Make sure that you always use the version currently available for your organization.

Below you will find the links to the user manuals to the different EAM systems. When selecting the desired version, the manual will appear in a separate tab.

When requesting access via the EAM portal version 2.7, go here.

When requesting access via the EAM portal version 3.0, go here.

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 a request (type : request for information) via our portal (https://sciensano.service-now.com/sp) 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!
Bart.Servaes Sun, 01/07/2024 - 12:09

User roles in HD4DP v2

User roles in HD4DP v2

Each healthcare organisation has an Access Manager who watches over the access rights to the applications of the own organisation and manages them in the HD Entity Access Management (EAM) system. In this process access requests by healthcare organisation employees are analysed and validated if legitimised. The scope of the accesses granted may differ, which is reflected in various user roles. Based on access rights, following three user roles can be distinguished:

Local Study Lead (author):

The Local Study Lead can:  

  • edit and review all peer registrations (regardless of role) for the study or project;
  • make registrations in HD4DP v2

This role might be but should not be limited to the responsible for the study or project within the participating healthcare institution.

Local Study Associate (author):

The Local Study Associate can: 

  • edit and review the own registrations, not those of other colleagues from the same healthcare organisation participating in the same study or project. The indicated registrations are limited to the patients treated by the Local Study Associate;
  • make registrations in HD4DP v2.

The Local Study Associate is a healthcare provider participating in the study or project. This is reflected in the registration form.

Local Study Support (co-author):

The Local Study Support can: 

  • edit and review registrations belonging to the author group they are linked to;
  • make registrations in HD4DP v2.

A Local Study Associate and Local Study Lead can delegate registration tasks to a Local Study Support. This might be but should not be limited to an administrative assistant or staff from a medical coding department. The Local Study Associate and Local Study Lead are still considered the author of the registration; the Local Study Support is considered the co-author. The Local Study Associate and Local Study Lead can view and modify Local Study Support entries.

By default, only 1 Local Study Lead is intended by healthdata.be (Sciensano) for each project within each organisation. The idea is that only one person is meant to see all submissions for that project within that organisation. This policy prevents users of HD4DP v2 from seeing personal and sensitive information from individuals with whom they do not have a therapeutic relationship. For policy deviations on this, healthcare organisation staff should contact their Data Protection Officer (DPO). 

Remarks:

  • The scope of the access rights does not necessarily reflect the hierarchy within your healthcare organisation.
  • It is up to the Access manager to change roles from/to Local Study Lead, Local Study Associate and Local Study Support. These requests are carried out in the EAM system.
johanvanbussel Sun, 01/07/2024 - 12:10

Access the HD4DP v2 application

Access the HD4DP v2 application

To access the application HD4DP v2, you must first request an account. If you do not have an account yet, please consult "Request access to an HD application for a specific project" first.

Once your account has been created and the registry is put in production, you will receive an e-mail with the following information (Note that the text between the [ ] will be adapted):

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

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

  1. Go to the url mentioned in the email 
  2. Select "your organization" from the list 
  3. Your organization: [RIZIV number – Name] 
  4. Click on "Next
  5. Fill in your "username" and "password"
  6. Click on "Log in"

Please be sure to log off after making use of the application HD4DP 2.0, or any other Healthdata.be application. Just closing your internet browser does not guarantee that your application with registrations has been closed.

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 a request (type : request for information) via our portal (https://sciensano.service-now.com/sp) 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!
manager Tue, 08/08/2023 - 12:39

Navigate to the Orthopride Hip project

Navigate to the Orthopride Hip 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 Orthopedics, you can see the study projects Orthopride HipOrthopride Knee and Orthopride total femur.

Select the study project Orthopride Hip.

You will see that the study project Orthopride Hip consists of three parts: Primo-implantationRevision and Resection.

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 a request (type : request for information) via our portal (https://sciensano.service-now.com/sp) 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!
manager Tue, 08/08/2023 - 12:39

Create a Hip registration

Create a Hip registration

The study project Orthopride Hip consists of three sections: Primo-implantationRevision and Resection.

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

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 a request (type : request for information) via our portal (https://sciensano.service-now.com/sp) 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!
manager Tue, 08/08/2023 - 12:40

Create a Hip registration "Primo-implantation"

Create a Hip registration "Primo-implantation"

To create a "Primo-implantation" registration for the study project Orthopride Hip, 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 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...

NOTE:

The study section is not always available in the selected language. In that case the text frame pictured below covers the language selection buttons. It automatically disappears after a few seconds.

You will have to select the desired language through the respective language buttons:
NL for Dutch, FR for French or EN for English.

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

After selection of the "+ New registration" button the main screen will be replaced by 2 sections: a study form in the middle of the screen and a table of contents on the right-hand side of the screen.

By completing the study form you will create a registration for the respective study project.

Table of contents

The Table of contents offers an overview of the sections that are to be completed. It can also be used to navigate through the study form instead of scrolling up and down in the study form: clicking on a section in the table of contents will take you directly to this section in the study form.

Take into account that the study form may contain conditional fields. This means that some fields with selection options ONLY will be displayd IF related fields in previous sections have been completed.

E.g. the field ‘Type implantaat / Type d’implant’ under section ‘Implantaatgegevens / Données d’implant’ ONLY opens up, IF the field ‘Type resectie / Type de résection’ in the section ‘Interventiegegevens / Données de l’intervention’ has been completed.

Detailed information on conditional fields is to be found in the respective DCD specifications.

ATTENTION!

If you want to search and add the data of the implant used, you first have to select the Implant data item in the Table of contents from the right-hand side section of the screen. The relevant item will now appear in the middle section of the screen.

In case an implant with notification code has been used, it is possible to retrieve the corresponding data from the SADMI database. In order to do so, you select yes under Implant(s) used? and implant with notification code under Type of implant.

In some interfaces this option is also referred to as genotificeerd serieproduct implantaat. Select this option.

Now, click on the Search button. The SADMI Notification code search window will pop up. Enter the notification code you have available in the relevant field and click on the Search button.

The screen refreshes and shows all implant data underneath the search button.

It is now NECESSARY to select the Choose button to the right in order to effectively ADD the data to the registration form.

Hereafter, you will automatically return to the registration form, where the SADMI notification code of the implant has been registered. You can now repeat the procedure above to add further implants via the "Add another" button.

In case an implant without notification code has been used, you have to select the Category and enter the necessary data you have at hand.

Note: SADMI stands for Source Authentique des dispositifs médicaux implantables. General and technical information can be found in the SADMI cookbook which is provided through the eHealth platform.

Progress

By selecting the tab "Progress" on the right-hand 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: selection of 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: Save or Submit. 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: Save but not submit. 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 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 a request (type : request for information) via our portal (https://sciensano.service-now.com/sp) 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!
manager Wed, 05/17/2023 - 17:18

Create a Hip registration "Revision"

Create a Hip registration "Revision"

To create a "Revision" registration for the study project Orthopride Hip, select "Revision" 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 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...

NOTE:

The study section is not always available in the selected language. In that case the text frame pictured below covers the language selection buttons. It automatically disappears after a few seconds.

You will have to select the desired language through the respective language buttons:
NL for Dutch, FR for French or EN for English.

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

After selection of the "+ New registration" button the main screen will be replaced by 2 sections: a study form in the middle of the screen and a table of contents on the right-hand side of the screen.

By completing the study form you will create a registration for the respective study project.

Table of contents

The Table of contents offers an overview of the sections that are to be completed. It can also be used to navigate through the study form instead of scrolling up and down in the study form: clicking on a section in the table of contents will take you directly to this section in the study form.

Take into account that the study form may contain conditional fields. This means that some fields with selection options ONLY will be displayd IF related fields in previous sections have been completed.

E.g. the field ‘Type implantaat / Type d’implant’ under section ‘Implantaatgegevens / Données d’implant’ ONLY opens up, IF the field ‘Type resectie / Type de résection’ in the section ‘Interventiegegevens / Données de l’intervention’ has been completed.

Detailed information on conditional fields is to be found in the respective DCD specifications.

ATTENTION!

If you want to search and add the data of the implant used, you first have to select the Implant data item in the Table of contents from the right-hand side section of the screen. The relevant item will now appear in the middle section of the screen.

In case an implant with notification code has been used, it is possible to retrieve the corresponding data from the SADMI database. In order to do so, you select yes under Implant(s) used? and implant with notification code under Type of implant.

In some interfaces this option is also referred to as genotificeerd serieproduct implantaat. Select this option.

Now, click on the Search button. The SADMI Notification code search window will pop up. Enter the notification code you have available in the relevant field and click on the Search button.

The screen refreshes and shows all implant data underneath the search button.

It is now NECESSARY to select the Choose button to the right in order to effectively ADD the data to the registration form.

Hereafter, you will automatically return to the registration form, where the SADMI notification code of the implant has been registered. You can now repeat the procedure above to add further implants via the "Add another" button.

In case an implant without notification code has been used, you have to select the Category and enter the necessary data you have at hand.

Note: SADMI stands for Source Authentique des dispositifs médicaux implantables. General and technical information can be found in the SADMI cookbook which is provided through the eHealth platform.

Progress

By selecting the tab "Progress" on the right-hand 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: selection of 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: Save or Submit. 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: Save but not submit. 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 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 a request (type : request for information) via our portal (https://sciensano.service-now.com/sp) 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!

manager Wed, 05/17/2023 - 17:19

Create a Hip registration "Resection"

Create a Hip registration "Resection"

To create a "Resection" registration for the study project Orthopride Hip, select "Resection" 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 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...

NOTE:

The study section is not always available in the selected language. In that case the text frame pictured below covers the language selection buttons. It automatically disappears after a few seconds.

You will have to select the desired language through the respective language buttons:
NL for Dutch, FR for French or EN for English.

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

After selection of the "+ New registration" button the main screen will be replaced by 2 sections: a study form in the middle of the screen and a table of contents on the right-hand side of the screen.

By completing the study form you will create a registration for the respective study project.

Table of contents

The Table of contents offers an overview of the sections that are to be completed. It can also be used to navigate through the study form instead of scrolling up and down in the study form: clicking on a section in the table of contents will take you directly to this section in the study form.

Take into account that the study form may contain conditional fields. This means that some fields with selection options ONLY will be displayd IF related fields in previous sections have been completed.

E.g. the field ‘Type implantaat / Type d’implant’ under section ‘Implantaatgegevens / Données d’implant’ ONLY opens up, IF the field ‘Type resectie / Type de résection’ in the section ‘Interventiegegevens / Données de l’intervention’ has been completed.

Detailed information on conditional fields is to be found in the respective DCD specifications.

ATTENTION!

If you want to search and add the data of the implant used, you first have to select the Implant data item in the Table of contents from the right-hand side section of the screen. The relevant item will now appear in the middle section of the screen.

In case an implant with notification code has been used, it is possible to retrieve the corresponding data from the SADMI database. In order to do so, you select yes under Implant(s) used? and implant with notification code under Type of implant.

In some interfaces this option is also referred to as genotificeerd serieproduct implantaat. Select this option.

Now, click on the Search button. The SADMI Notification code search window will pop up. Enter the notification code you have available in the relevant field and click on the Search button.

The screen refreshes and shows all implant data underneath the search button.

It is now NECESSARY to select the Choose button to the right in order to effectively ADD the data to the registration form.

Hereafter, you will automatically return to the registration form, where the SADMI notification code of the implant has been registered. You can now repeat the procedure above to add further implants via the "Add another" button.

In case an implant without notification code has been used, you have to select the Category and enter the necessary data you have at hand.

Note: SADMI stands for Source Authentique des dispositifs médicaux implantables. General and technical information can be found in the SADMI cookbook which is provided through the eHealth platform.

Progress

By selecting the tab "Progress" on the right-hand 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: selection of 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: Save or Submit. 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: Save but not submit. 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 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 a request (type : request for information) via our portal (https://sciensano.service-now.com/sp) 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!
manager Wed, 05/17/2023 - 17:20

Find a Hip registration

Find a Hip registration

The study project Orthopride Hip consists of three sections: Primo-implantationRevision and Resection.

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

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 a request (type : request for information) via our portal (https://sciensano.service-now.com/sp) 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!
manager Tue, 08/08/2023 - 12:40

Find a Hip registration "Primo-implantation"

Find a Hip registration "Primo-implantation"

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

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 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 a request (type : request for information) via our portal (https://sciensano.service-now.com/sp) 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!
manager Tue, 04/04/2023 - 13:16

Find a Hip registration "Revision"

Find a Hip registration "Revision"

To find a "Revision" registration for the study project Orthopride Hip, select "Revision" in the dark blue left menu.

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 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 a request (type : request for information) via our portal (https://sciensano.service-now.com/sp) 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!
manager Tue, 04/04/2023 - 13:16

Find a Hip registration "Resection"

Find a Hip registration "Resection"

To find a "Resection" registration for the study project Orthopride Hip, select "Resection" in the dark blue left menu.

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 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 a request (type : request for information) via our portal (https://sciensano.service-now.com/sp) 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!
manager Tue, 04/04/2023 - 13:17

Update a Hip registration

Update a Hip registration

The study project Orthopride Hip consists of three sections: Primo-implantationRevision and Resection.

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

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 a request (type : request for information) via our portal (https://sciensano.service-now.com/sp) 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!
manager Tue, 08/08/2023 - 12:41

Update a Hip registration "Primo-implantation"

Update a Hip registration "Primo-implantation"

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

When you select a version of this 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.

A registration can be updated as long as it has the status "Saved" and as long as the registration not has been submitted. A submitted registration cannot be updated or deleted again.

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 a request (type : request for information) via our portal (https://sciensano.service-now.com/sp) 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!
manager Tue, 04/04/2023 - 13:17

Update a Hip registration "Revision"

Update a Hip registration "Revision"

To update a "Revision" registration for the study project Orthopride Hip, select "Revision" in the dark blue left menu.

When you select a version of this 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.

A registration can be updated as long as it has the status "Saved" and as long as the registration not has been submitted. A submitted registration cannot be updated or deleted again.

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 a request (type : request for information) via our portal (https://sciensano.service-now.com/sp) 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!
manager Tue, 04/04/2023 - 13:17

Update a Hip registration "Resection"

Update a Hip registration "Resection"

To update a "Resection" registration for the study project Orthopride Hip, select "Resection" in the dark blue left menu.

When you select a version of this 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.

A registration can be updated as long as it has the status "Saved" and as long as the registration not has been submitted. A submitted registration cannot be updated or deleted again.

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 a request (type : request for information) via our portal (https://sciensano.service-now.com/sp) 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!
manager Tue, 04/04/2023 - 13:17

Delete a Hip registration

Delete a Hip registration

The study project Orthopride Hip consists of three sections: Primo-implantationRevision and Resection.

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

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 a request (type : request for information) via our portal (https://sciensano.service-now.com/sp) 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!
manager Tue, 08/08/2023 - 12:42

Delete a Hip registration "Primo-implantation"

Delete a Hip registration "Primo-implantation"

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

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.

A 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.

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 a request (type : request for information) via our portal (https://sciensano.service-now.com/sp) 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!
manager Tue, 04/04/2023 - 13:18

Delete a Hip registration "Revision"

Delete a Hip registration "Revision"

To delete a "Revision" registration for the study project Orthopride Hip, select "Revision" in the dark blue left menu.

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.

A 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.

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 a request (type : request for information) via our portal (https://sciensano.service-now.com/sp) 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!
manager Tue, 04/04/2023 - 13:18

Delete a Hip registration "Resection"

Delete a Hip registration "Resection"

To delete a "Resection" registration for the study project Orthopride Hip, select "Resection" in the dark blue left menu.

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.

A 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.

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 a request (type : request for information) via our portal (https://sciensano.service-now.com/sp) 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!
manager Tue, 04/04/2023 - 13:18

Submit a Hip registration

Submit a Hip registration

The study project Orthopride Hip consists of three sections: Primo-implantationRevision and Resection.

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

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 a request (type : request for information) via our portal (https://sciensano.service-now.com/sp) 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!
manager Tue, 08/08/2023 - 12:42

Submit a Hip registration "Primo-implantation"

Submit a Hip registration "Primo-implantation"

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

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".

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

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 "Submitted".

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

A registration can be submitted at the end of the creation process using the study form (see: Create a [project] registration).

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.

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 a request (type : request for information) via our portal (https://sciensano.service-now.com/sp) 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!
manager Tue, 04/04/2023 - 13:19

Submit a Hip registration "Revision"

Submit a Hip registration "Revision"

To submit a "Revision" registration for the study project Orthopride Hip using the overview table, select "Revision" in the dark blue left menu.

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".

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

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 "Submitted".

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

A registration can be submitted at the end of the creation process using the study form (see: Create a [project] registration).

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.

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 a request (type : request for information) via our portal (https://sciensano.service-now.com/sp) 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!
manager Tue, 04/04/2023 - 13:19

Submit a Hip registration "Resection"

Submit a Hip registration "Resection"

To submit a "Resection" registration for the study project Orthopride Hip using the overview table, select "Resection" in the dark blue left menu.

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".

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

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 "Submitted".

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

A registration can be submitted at the end of the creation process using the study form (see: Create a [project] registration).

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.

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 a request (type : request for information) via our portal (https://sciensano.service-now.com/sp) 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!
manager Tue, 04/04/2023 - 13:19

Send a correction of a registration

Send a correction of a registration

To send a correction of a submitted registration you need to submit the complete record again. An overview of the submitted corrections is available via the HD4DP v2 generic correction form.

The Add corrections function (and button) to a registration form has been discontinued. It is not available anymore, neither via the overview table, nor via the preview page of a registration.

Submitting the complete record again

The preferred way to send a correction is to fill out the complete registration form with the correct values and resubmit it. When you do so, the most recent version of the record that is received by healthdata.be will be considered to be the correct one.

Whether a record qualifies or not is determined by a so-called business key. This is a unique set of values of specific fields per record, such as a combination of the patient ID and the hospitalization date, or the niss code and the sample ID. The business key is created when submitting the original record, and so helps to identify the most recent record received in the healthdata.be database in case of resubmission.

Attention: In case one of the fields that build the business key needs to be corrected, the record that will be resubmitted will have a different business key. Consequently, both records will be considered as correct ones, since there is no identical business key.
You may consider to log a RITM ticket via our Service portal (https://sciensano.service-now.com/sp) to follow-up on this particular case.

There are two options to resubmit a record:

Option 1: Submission via S2S API / CSV Upload

The correction of the values is performed directly in the json or csv file. To resubmit the complete record via the back-end, please refer to the applicable technical documentation pages. The examples shown in the links below are for Pacemaker Primo-Implantation:

  • For submitting the complete record as a .json file via S2S API, go here.
  • For submitting the complete record as a .csv file via CSV Upload, go here.

Option 2: Submission via the HD4DP 2.0 web application

First, you need to access the HD4DP v2 web application, navigate to the study program and select the desired study project in the left dark blue menu. Then, fill out the complete registration form again manually with the correct values. Resubmit the completed registration form.

The previously submitted record will become irrelevant based on the business key.

The generic correction form

The Correction Form you can find in the list of study programmes and study projects in the HD4DP v2 web application contains an overview of all submitted corrections of registrations.

If you want to preview these corrections of registrations, navigate to the study program Correction form and then to the study project Correction form. Finally, select the most recent version.

The corrections of registrations of the different projects will be displayed READ-ONLY in the overview table.

johanvanbussel Tue, 01/02/2024 - 13:45

Registration statuses in HD4DP v2

Registration statuses in HD4DP v2

This article explains the different registration statuses in HD4DP v2.

Statuses are shown in Status column

You can select the columns you want to display via the menu Select visible columns located in the top-right corner:

Select the columns you want to display and click on Apply.

Description of the statuses:

Open: Registration is created and stored. It has not been submitted

Deleted: Registration has been deleted.

Submitted: Registration has been submitted and sent.

Jonas.VanBussel Tue, 08/08/2023 - 12:44

Reset password for HD4DP v2

Reset password for HD4DP v2

After having received your credentials to login to the HD4DP 2.0 application, you can consider to reset the password to one that is easier for you to remember.

Go to URL https://acc.kubes.healthdata.be/, select your organization and click on the Next button.

Fill in your e-mail address and the password you received. Click on the Log in button.

The main HD4DP 2.0 application screen appears. On the left you can see the menu of study programmes and study projects, on the right you have the section in which the relevant registrations will become available.

At the top right of the screen you notice the Reset password link. Click on it.

Reset the password you have received by filling in the password of your preference. Repeat the new password in the verification field and click on the Submit button.

You will be redirected to the main screen, and the password will be automatically reset in the background. You don't need to log in again now.

When logging back in for a next registration session you will have to use your new password.

Jonas.VanBussel Sun, 01/07/2024 - 15:17

Technical manual of the application HD4DP v2

Technical manual of the application HD4DP v2 Jonas.VanBussel Tue, 08/08/2023 - 12:46

Technical user roles

Technical user roles

IT administrator: An IT administrator has the highest level of all roles and permissions and can:

  1. log in using Active Director;
  2. grant access to Local Study Lead, Local Study Associate and Local Study Support;
  3. select and access all projects;
  4. create, find, update, delete, send (to healthdata.be, MyCareNet and other destinations) and correct a record using the form.io component;
  5. create, update, send and correct a record using the API data collection;
  6. create, update, send and correct a record using CSV upload;
  7. create and send a MyCareNet record using MyCareNet XML;
  8. view all records for all projects;
  9. harvest all records for all projects from the local DWH using the PostgreSQL database.
Jonas.VanBussel Tue, 08/08/2023 - 13:21

HD4DP v2 Installation

HD4DP v2 Installation

HD4DP v2 Local is an application installed on the infrastructure of the Health Care Organisation participating in research projects facilitated by healthdata.be.

The installation of HD4DP v2 Local is executed by the DevOps team of healthdata.be.

Server Installation and Configuration

Installing and configuring the server requires the following actions:

The HD4DP v2 application is more modular and will support scaling up to meet the requirements of the various data collection projects we facilitate. It will offer several micro-services that will run concurrently on the same machine.

The server should therefore require more resources than the one currently hosting the HD4DP 1.0 application. Furthermore, the resources allocated should be increased.  It is therefore on the one hand imperative to use virtualization for the creation of the machine. On the other hand. It is also imperative to store files and make regular backups to a file server.

Below we take up our three categories of organizations sending data to healthdata.be and the resources we recommend allocating to their virtual machine:

  • “Small”: Small data provider.
  • “Medium”: Medium data provider;
  • “Large”: Big data provider.

Finally, we also offer the possibility for each hospital to have an integration server and a production server. Healthdata.be will deploy the new release of the application on the integration server. This will allow you to accept or decline the promotion of a new release of the HD4DP 2.0 application to the production server. This option is highly recommended, but not mandatory.

Therefore, could you answer the question: Do you want to first deploy HD4DP on an integration server? Yes/No. If Yes, Could you provide a server whose label used for specifications is ‘Small’ (following the instructions in section 1 of this mail), that is:

  • Processors number: 1
  • Physical cores/Processor : 8
  • RAM memory : 16 Go
  • Disk space: 100 Go
  • Network Station Mount with Space for Backups
  • Operating System: Linux Ubuntu v18.04
  • Virtualization

Server installation timing

In order to establish the deployment schedule for the HD4DP 2.0 application within your organization, we would like to know when the server could be installed and configured. To this end, could you give us the 2 dates relating to the installation of the server:

  • Starting date ;
  • Finalization date.

Based on these dates, an employee of healthdata.be will regularly monitor the operations linked to the installation of the server.

For any request for information on installing the HD4DP 2.0 server, please send an email to hd-architecture-20@sciensano.be.

Jonas.VanBussel Tue, 08/08/2023 - 13:00

HD4DP v2 Infrastructure instructions

HD4DP v2 Infrastructure instructions

Introduction

This document is written for IT staff / system engineers of data providers and therefore assumes technical knowledge. It acts as a guide through the on-boarding process of HD4DP v2 and covers installation of the server, user configuration, network configuration and remote access.

The order of steps in this document should be respected during execution.

Overview

HD4DP v2 consists of a modular application stack, which allows healthdata.be to seamlessly upgrade individual elements.

An HD4DP v2 deployment comprises of following components:

  • Form.io component
  • MongoDB
  • PostgreSQL
  • Nextgen Connect

As it is the case in HD4DP 1.0, an Encryption Module with a connection to the eHealthBox is still required for HD4DP v2 and must be provided by the data provider.

Network configuration

IP

The HD4DP server needs to be accessible via domain names in DNS, and must have a static IP in your private network.

DNS

The application stack of HD4DP v2 requires four domain names pointing to the IP of the locally installed HD4DP v2 server. Use the following names in your DNS:

  • nextgenconnect.hd4dp.<yourdomain.be>
  • hd4dp.<yourdomain.be>
  • metabase.hd4dp.<yourdomain.be>
  • admin.hd4dp.<yourdomain.be>

Firewall

The following connections should be possible in the firewall flow:

  • To and from (a) machine(s) in your IT department on port 22 for initial configuration and local support.
  • To and from the Encryption Module server. The protocol and ports depend on your local EM implementation. Contact your EM vendor if more information is necessary.
  • Reachable by your staff who uses HD4DP, on ports 80 and 443 for HTTP(s) traffic.
  • To and from the LDAP server (this is not mandatory if you are not using LDAP to authenticate) (port 389 by default)

The healthdata.be proxy server is used as a gateway to the internet for the security of HD4DP servers. The configuration of this proxy server will be provided to you by healthdata.be at a later date.

Server installation

To install the application stack of HD4DP v2, healthdata.be requires a fresh installed operating system, specifically Ubuntu Server 18.04 LTS.

Please use these instructions even if you have previous experience with installing this operating system, as its configuration is specific for healthdata.be.

These instructions assume that the network configuration described in the previous section is completed.

Instructions

HD4DP v2 requires a (virtual) machine running Ubuntu Server 18.04 LTS.

We assume knowledge of loading a .iso file onto a (virtual) machine. Healthdata.be can’t provide instructions for this, as the environment of your center is unknown. Should you have any trouble, however, please contact Healthdata.be support so that we can help out.

Please find the installation steps below.

Installation steps

  1. Download the .iso file from the link below.
    Download Ubuntu Server 18.04 LTS
  2. Create a new (virtual) machine with Linux Ubuntu 64 bit as the OS family
  3. When prompted, select the .iso file downloaded in step 1.
  4. After some time, you will be prompted to select a system language. Select English.
  5. “Keyboard configuration”
    Select your preferred keyboard layout and press enter
  6. “Network Connections”
    Highlight the network interface and press enter. Navigate as follows:
    Edit IPv4 -> Manual -> enter the network details -> save -> Done
  7. Proxy IP -> Leave default/empty.
  8. “Configure Ubuntu Archive Mirror” -> leave default
  9. “File system Setup” -> Use An Entire Disk
  10. Proceed until “Confirm destructive action” -> press continue. The installation process starts, this can take several minutes.
  11. In the meantime, create the user for Healthdata.
    username = healthdata,
    Password = choose a secure password and communicate it to healthdata.be.
  12. Mark “Install OpenSSH server”. This will be used for remote access. “Import SSH Identity” -> no -> done
  13. “Featured Server Snaps” -> Select nothing and press Done.
  14. Wait until installation is finished.

Configuration steps

Connecting to the server

Log into the machine with the healthdata.be user created in the previous section.

Instructions (from a Windows machine):

  1. Install the tool Putty and open the application.
  2. On the configuration screen, enter the following (replace cursive text with the appropriate values)
    • Host Name: healthdata@server_private_ip
    • Port: 22
    • Connection type: SSH
  3. Click Open. Enter the password (you will not see text as you type, you can paste into putty by right-clicking in the terminal).
  4. You should now be logged in and see a prompt  “healthdata@server_name:~$”

Administrator account for internal use

An administrator account for internal use can be created on the HD4DP v2 server.

The configuration of remote access (described below) should not happen on this account, but on the Healthdata.be account.

The internal account can later be used to install and configure OS monitoring software and antivirus software by the internal IT team. For more information, see the section on Antivirus and Monitoring.

(Text with a gray background should be entered as a command in the terminal of the server)

Create the user:

            sudo adduser <username>

Add the user to the sudo group

            sudo usermod -aG sudo <username>

Installation and configuration of the software stack

Healthdata.be support will instruct you when to execute the next step, which is to enable remote access so that Healthdata.be can execute the software installation and configuration.

Backups

The configuration of the HD4DP v2 server is administered by healthdata.be and does not require backups.

HD4DP v2 regularly dumps its databases automatically to the /backup directory on the server. A network storage should be mounted at this location.

Please fill out the infrastructure sheet with the required credentials, domain name/url, protocol… to connect to the network drive. The connection will then be configured by healthdata.be.

Patching and Updates

Healthdata.be configures HD4DP v2 servers to automatically receive recommended security updates. The choice for Ubuntu 18.04 is motivated by the long-term support for this version. Security flaws are rare in this distribution, and security updates are quick and often don’t require a system reboot.

If the IT department of your organization prefers to manage patches, this is possible but not encouraged. Please use the account for internal use created in Section 3 for this purpose.

Antivirus and Monitoring

Most data providers will want to manage their own antivirus and OS monitoring on all machines in their network. Installation of such software on the HD4DP v2 server is allowed, but healthdata.be should be informed about all extra software installed on the server. Additionally, healthdata.be will not provide support for the installation of this software.

Contact information

Jonas.VanBussel Tue, 08/08/2023 - 13:00

HD4DP v2 Infrastructure sheet

HD4DP v2 Infrastructure sheet

The HD4DP v2 Infrastructure Sheet contains information that healthdata.be needs in order to start the insallation of the HD4DP 2.0 Software at your organization.

Below you can find the description of the necessary information:

SERVER CONNECTION

Healthdata.be performs its installation and support tasks remotely (using VPN or remote port forwarding via SSH). Please provide the required credentials.

  • Type of connection (VPN / Remote port forwarding via SSH)
  • Link (IF VPN)
  • Username, token, other (if VPN)
  • Password (if VPN)³
  • Public SSH Key (if remote port forwarding)

³ For security reasons, we advise to communicate passwords to us either by phone, or via a link using a secret-sharing service such as onetimesecret.com.

SERVER MACHINE

  • Server Name
  • Internal IP-Address
  • Ram (in GB)
  • CPU (number of CPU's and number of cores)
  • Disk space (in GB)
  • Username: Healthdata
  • Password ³

³ For security reasons, we advise to communicate passwords to us either by phone, or via a link using a secret-sharing service such as onetimesecret.com.

ATTACHED DRIVE FOR BACKUPS

HD4DP 2.0 regularly performs data dumps for backup purposes. Please provide connection information to a network share volume.

  • Link / IP address
  • Path
  • Username
  • Password ³

³ For security reasons, we advise to communicate passwords to us either by phone, or via a link using a secret-sharing service such as onetimesecret.com.

USER MANAGEMENT

HD4DP can either connect to a LDAP server or use its own application database for performing user authentication and management. Please check the user management mechanism you want to use.

  • LDAP user management : Yes / No
  • Application user management : Yes / No

LDAP configuration (Optional)

If you chose ‘LDAP user management’ as user management mechanism, please provide the following information that allows us to connect to your LDAP system.

  • Connection URL
  • Username
  • Password³

³ For security reasons, we advise to communicate passwords to us either by phone, or via a link using a secret-sharing service such as onetimesecret.com.

SOFTWARE CONFIGURATION

Encryption Module interface

HD4DP communicates with the Encryption Module (EM) either using the file system interface or by calling a REST web service. Please choose which interface HD4DP should use for its communication with the Encryption Module.

Note: if the encryption module is not yet purchased (or developed), HD4DP can already be installed; the EM can then be configured in HD4DP once it is available. Please note that HD4DP 1.x and HD4DP 2.0 cannot use the same EM.

  • REST web service
  • File system

REST web service interface

If you chose to communicate with the Encryption Module using a REST interface, please provide the web service URLs that should be used by HD4DP for its communication with EM.

  • "Outgoing flow URL: Example: http://host:8080/encryptionmodule/send"
  • "Incoming flow URL : Example: http://host:8080/encryptionmodule/receive"

File system interface

  • "Incoming directory: Directory where HD4DP checks for incoming files"
  • "Incoming directory: Directory where HD4DP writes outgoing files"
  • "Incoming directory: Directory to which HD4DP moves successfully processed files"
  • "Incoming directory: Directory to which HD4DP moves unsuccessfully processed files"
Jonas.VanBussel Tue, 08/08/2023 - 13:01

Requirements for the HD4DP installation

Requirements for the HD4DP installation

This documentation details the necessary adaptations to be performed in order to allow the necessary technical accesses and smooth operation of the different healthdata.be platforms and interfaces.

The file is available for download below.

Jonas.VanBussel Tue, 08/08/2023 - 13:01

HD4DP v2 S2S API

HD4DP v2 S2S API

The HD4DP v2 S2S API is a unified Application Programming Interface (API) that will allow participating Healthcare Organizations (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:

Important note: For code fields (fieldType = 'CODE') the id of the codeListValue item must be sent, not the code value or the label. In future releases it will be made possible to also send the code value.

Please read this documentation before its project specific use.

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

  • Primo-implantation
  • Revision and 
  • Resection.

On the following pages we explain how to submit data for Orthopride Hip using the HD4DP v2 S2S API for each section.

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 a request (type : request for information) via our portal (https://sciensano.service-now.com/sp) 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!

manager Tue, 08/08/2023 - 12:50

S2S API for Orthopride Hip "Primo-implantation"

S2S API for Orthopride Hip "Primo-implantation"

Documentation for System 2 System API on Architecture 2.0

Description of the service

API is the acronym for Application Programming Interface, which is a software intermediary that allows two applications to talk to each other.

In this case, the API is used to have the system of the Data Providers communicate with the system of HealthData.

The S2S API is a unified API that will allow clients (Data Providers) to submit DCDs data to HD4DP2.0 in fully automated way.

End point information (per DCD) + examples

APIResponseNotes
/api/organizationsList of organizations. Client
must select the right
organizationId
Current existing end-point is:
/api/installation/organizations

We’ll create this new end-point with a
different signature re-routing the call to
this existing one or we will refactor the
existing one to this new signature.
/api/dcd/menu/structure?
organization-id={organizationId}
List of projects of the given
organization, dcds of each project, dcdVersions of each dcd in a JSON format
Client can get dcdId and dcdVersionId
(optional) which are needed on following API calls.
/api/dcd/payload/definition? 
dcd-id={dcdId}; 
<optional>version={version}; 
<optional>language-id={languageId} 
List of all the fields of the form as well as their corresponding data-types that are allowed in the json data structure for the  Payload   This field names values are the key properties in the formIO json config form. When we implement this new api end-point, we need to parse the json content in order to get the key properties. Given these field keys, we’ll get each field definition from new API end-points helpers: 
 
/api/dcd/field?field-id={fieldId} 
/api/dcd/codelist?codelist-id={codelistId} 
 
These ones are described in the next table. 
 
<optional parameter> version={version} : If this parameter is not provided, latest one is assumed 
 
<optional parameter> language-id = {languageId} : language id for the code_list example results. If this parameter is not provided, default language will be English. Current permitted values: 
en: English 
nl: Dutch 
fr: French 
 
Client must build this json object as the payload data to be sent based on this list of fields, on the last api call 
/api/dcd/payload/example?dcd-id={dcdId}; 
<optional>version={version} 
Example of payload in JSON format Providing this API end-point in order to help the Client on the Payload build with an example 
 
<optional parameter> version={version} : If this parameter is not provided, latest one is assumed 
/api/dcd/payload/submit? 
organization-id={organizationId}; 
dcd-id={dcdId}; 
<optional>version={version}; 
<optional>data-src-type={dataSrcType}; 
 
POST Payload 
 
/api/dcd/payload/submit? 
organization-id={organizationId}; 
dcd-id={dcdId}; 
<optional>version={version}; 
<optional>data-src-type={dataSrcType}; 
 
POST Payload 
 
Some implementation tasks is needed in here in order to return the result info (either succeed or failed).  
Similar like the one in HDConnectProxyRestTemplate.postCsv method, and the CsvExecutionResult object build. 
 
<optional parameter> version={version} : If this parameter is not provided, latest one is assumed. 
 
<optional parameter> data-src-type={dataSrcType} :  
permitted values:  
API 
CSV 
If this parameter is not provided, default values is <HD4DP>. 
api/dcd/submit?organization-id={organizationtId};dcd-id={dcd-id};<optional>dcd-version-id={dcdVersionId};<optional>incl-submit-data={inclSubmitData}; <optional>incl-submit-results={inclSubmitResults}; 
GET method 
 
List of submitted dcds data and/or their corresponding business keys or validation errors.  
 
<optional parameter> dcd-version-id={dcdVersionId} : If this parameter is not provided, lastest one is assumed 
 
<optional parameter> incl-submit-data={inclSubmitData} : If this parameter is not provided, default values is <false> 
 
<optional parameter> incl-submit-results={inclSubmitResults} : If this parameter is not provided, default values is <true> 
 

HOW TO: Upload data using System 2 System

Steps To Upload data

1. IT services of data providers must setup their systems to be able to communicate with HD4DP v2 System 2 System API

A prerequisite to be able to use the Health Data's System 2 System API, is that the IT services of the hospitals must have the following in place before the systems can communicate:

  • The endpoint/URL is protected by credentials for which the support services need to be contacted.
  • End-to-end API process to submit DCD registrations in a fully automated manner.
  • Support for searching submitted DCD registrations.

2. Prepare the JSON file (example file in this section)

To send DCD registrations to Health Data, the file must be in a .json file format.

  • At the Data Provider's side, we must foresee a way to extract the JSON file from the electronic patient files and/or other local databases.
  • Author group, Author and Coauthor:
    • When the Author group, Author and Coauthor has been left out in the json file, the default Author group, Author and Coauthor will be used automatically.
    • When the desired Author group, Author and Coauthor are specified in the json file, the following fields TX_AUTHOR_GR, TX_AUTHOR and TX_COAUTHOR must be added to the json file with their values respectively.

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

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.

  • Similarly, to submit a draft, the only thing to add is the key STATUS (all upper case) with the value "draft" to the request, as described in Submission of drafts.
  • Adding separators to a NISS number:
    It is not necessary to necessary to add separators in a NISS number when uploading a file using S2S API. You can fill the NISS number out both with or without seperators. E.g.: 85.04.02-169.32 or 85040216932.

    Example:
This image has an empty alt attribute


  • Make sure the name of the JSON file has the correct format:
    HD_DCD_submjson_HDBPnumber_HDBPabbreviation_versionnumber_versionreleasedate

So for Orthopride Hip - Primo-implantation the format would be:
HD_DCD_submxml_HDBP0386_Orthopride_Hip_Primo_Implantation_01_20230504.json
Please note that this version includes editorial changes.

EXAMPLES:

Disclaimer: The example files above are only provided as a guideline and do not contain real life data.

3. Uploading the JSON File

  • The IT department of the Data Provider must provide a manner in their system to send the API requests containing DCD registrations in a JSON file format, the correct end-points must be addressed.
  • In this case the end-point to upload the json file will be:

4. Validate the JSON Upload

4.1 Validation of the S2S API Upload via the response:

Verify in the same way the request was sent, that the returned response is containing a valid Business key.

If a valid Business key has been provided, the registration upload via System 2 System API was succesful.

4.2 Validation of the System 2 System API via HD4DP 2.0:

Step 1: Open the web application HD4DP 2.0.

Step 2: Select the concerned organization in the dropdown list and click on Volgende (Next)

Step 3: Fill in the username and password, that has been provided by your IT Department or Healthdata team, and click on Log in to access the HD4DP 2.0 application.

Step 4: Navigate in the menu on the left-hand side panel to the desired study program:

Step 5: Check that the uploaded registration(s) is/are displayed in the overview table.

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 a request (type : request for information) via our portal (https://sciensano.service-now.com/sp) 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!
manager Thu, 02/22/2024 - 23:56

S2S API for Orthopride Hip "Revision"

S2S API for Orthopride Hip "Revision"

Documentation for System 2 System API on Architecture 2.0

Description of the service

API is the acronym for Application Programming Interface, which is a software intermediary that allows two applications to talk to each other.

In this case, the API is used to have the system of the Data Providers communicate with the system of HealthData.

The S2S API is a unified API that will allow clients (Data Providers) to submit DCDs data to HD4DP2.0 in fully automated way.

End point information (per DCD) + examples

APIResponseNotes
/api/organizationsList of organizations. Client
must select the right
organizationId
Current existing end-point is:
/api/installation/organizations

We’ll create this new end-point with a
different signature re-routing the call to
this existing one or we will refactor the
existing one to this new signature.
/api/dcd/menu/structure?
organization-id={organizationId}
List of projects of the given
organization, dcds of each project, dcdVersions of each dcd in a JSON format
Client can get dcdId and dcdVersionId
(optional) which are needed on following API calls.
/api/dcd/payload/definition? 
dcd-id={dcdId}; 
<optional>version={version}; 
<optional>language-id={languageId} 
List of all the fields of the form as well as their corresponding data-types that are allowed in the json data structure for the  Payload   This field names values are the key properties in the formIO json config form. When we implement this new api end-point, we need to parse the json content in order to get the key properties. Given these field keys, we’ll get each field definition from new API end-points helpers: 
 
/api/dcd/field?field-id={fieldId} 
/api/dcd/codelist?codelist-id={codelistId} 
 
These ones are described in the next table. 
 
<optional parameter> version={version} : If this parameter is not provided, latest one is assumed 
 
<optional parameter> language-id = {languageId} : language id for the code_list example results. If this parameter is not provided, default language will be English. Current permitted values: 
en: English 
nl: Dutch 
fr: French 
 
Client must build this json object as the payload data to be sent based on this list of fields, on the last api call 
/api/dcd/payload/example?dcd-id={dcdId}; 
<optional>version={version} 
Example of payload in JSON format Providing this API end-point in order to help the Client on the Payload build with an example 
 
<optional parameter> version={version} : If this parameter is not provided, latest one is assumed 
/api/dcd/payload/submit? 
organization-id={organizationId}; 
dcd-id={dcdId}; 
<optional>version={version}; 
<optional>data-src-type={dataSrcType}; 
 
POST Payload 
 
/api/dcd/payload/submit? 
organization-id={organizationId}; 
dcd-id={dcdId}; 
<optional>version={version}; 
<optional>data-src-type={dataSrcType}; 
 
POST Payload 
 
Some implementation tasks is needed in here in order to return the result info (either succeed or failed).  
Similar like the one in HDConnectProxyRestTemplate.postCsv method, and the CsvExecutionResult object build. 
 
<optional parameter> version={version} : If this parameter is not provided, latest one is assumed. 
 
<optional parameter> data-src-type={dataSrcType} :  
permitted values:  
API 
CSV 
If this parameter is not provided, default values is <HD4DP>. 
api/dcd/submit?organization-id={organizationtId};dcd-id={dcd-id};<optional>dcd-version-id={dcdVersionId};<optional>incl-submit-data={inclSubmitData}; <optional>incl-submit-results={inclSubmitResults}; 
GET method 
 
List of submitted dcds data and/or their corresponding business keys or validation errors.  
 
<optional parameter> dcd-version-id={dcdVersionId} : If this parameter is not provided, lastest one is assumed 
 
<optional parameter> incl-submit-data={inclSubmitData} : If this parameter is not provided, default values is <false> 
 
<optional parameter> incl-submit-results={inclSubmitResults} : If this parameter is not provided, default values is <true> 
 

HOW TO: Upload data using System 2 System

Steps To Upload data

1. IT services of data providers must setup their systems to be able to communicate with HD4DP v2 System 2 System API

A prerequisite to be able to use the Health Data's System 2 System API, is that the IT services of the hospitals must have the following in place before the systems can communicate:

  • The endpoint/URL is protected by credentials for which the support services need to be contacted.
  • End-to-end API process to submit DCD registrations in a fully automated manner.
  • Support for searching submitted DCD registrations.

2. Prepare the JSON file (example file in this section)

To send DCD registrations to Health Data, the file must be in a .json file format.

  • At the Data Provider's side, we must foresee a way to extract the JSON file from the electronic patient files and/or other local databases.
  • Author group, Author and Coauthor:
    • When the Author group, Author and Coauthor has been left out in the json file, the default Author group, Author and Coauthor will be used automatically.
    • When the desired Author group, Author and Coauthor are specified in the json file, the following fields TX_AUTHOR_GR, TX_AUTHOR and TX_COAUTHOR must be added to the json file with their values respectively.

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

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.

  • Similarly, to submit a draft, the only thing to add is the key STATUS (all upper case) with the value "draft" to the request, as described in Submission of drafts.
  • Adding separators to a NISS number:
    It is not necessary to necessary to add separators in a NISS number when uploading a file using S2S API. You can fill the NISS number out both with or without seperators. E.g.: 85.04.02-169.32 or 85040216932.

    Example:
This image has an empty alt attribute


  • Make sure the name of the JSON file has the correct format:
    HD_DCD_submjson_HDBPnumber_HDBPabbreviation_versionnumber_versionreleasedate

So for Orthopride Hip - Revision the format would be:
HD_DCD_submxml_HDBP0386_Orthopride_Hip_Revision_01_20230504.json
Please note that this JSON example includes the latest changes. An overview of these changes can be found in the Release notes section.

EXAMPLES:

Disclaimer: The example files above are only provided as a guideline and do not contain real life data.

3. Uploading the JSON File

  • The IT department of the Data Provider must provide a manner in their system to send the API requests containing DCD registrations in a JSON file format, the correct end-points must be addressed.
  • In this case the end-point to upload the json file will be:

4. Validate the JSON Upload

4.1 Validation of the S2S API Upload via the response:

Verify in the same way the request was sent, that the returned response is containing a valid Business key.

If a valid Business key has been provided, the registration upload via System 2 System API was succesful.

4.2 Validation of the System 2 System API via HD4DP 2.0:

Step 1: Open the web application HD4DP 2.0.

Step 2: Select the concerned organization in the dropdown list and click on Volgende (Next)

Step 3: Fill in the username and password, that has been provided by your IT Department or Healthdata team, and click on Log in to access the HD4DP 2.0 application.

Step 4: Navigate in the menu on the left-hand side panel to the desired study program:

Step 5: Check that the uploaded registration(s) is/are displayed in the overview table:

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 a request (type : request for information) via our portal (https://sciensano.service-now.com/sp) 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!

manager Thu, 02/22/2024 - 23:57

S2S API for Orthopride Hip "Resection"

S2S API for Orthopride Hip "Resection"

Documentation for System 2 System API on Architecture 2.0

Description of the service

API is the acronym for Application Programming Interface, which is a software intermediary that allows two applications to talk to each other.

In this case, the API is used to have the system of the Data Providers communicate with the system of HealthData.

The S2S API is a unified API that will allow clients (Data Providers) to submit DCDs data to HD4DP2.0 in fully automated way.

End point information (per DCD) + examples

APIResponseNotes
/api/organizationsList of organizations. Client
must select the right
organizationId
Current existing end-point is:
/api/installation/organizations

We’ll create this new end-point with a
different signature re-routing the call to
this existing one or we will refactor the
existing one to this new signature.
/api/dcd/menu/structure?
organization-id={organizationId}
List of projects of the given
organization, dcds of each project, dcdVersions of each dcd in a JSON format
Client can get dcdId and dcdVersionId
(optional) which are needed on following API calls.
/api/dcd/payload/definition? 
dcd-id={dcdId}; 
<optional>version={version}; 
<optional>language-id={languageId} 
List of all the fields of the form as well as their corresponding data-types that are allowed in the json data structure for the  Payload   This field names values are the key properties in the formIO json config form. When we implement this new api end-point, we need to parse the json content in order to get the key properties. Given these field keys, we’ll get each field definition from new API end-points helpers: 
 
/api/dcd/field?field-id={fieldId} 
/api/dcd/codelist?codelist-id={codelistId} 
 
These ones are described in the next table. 
 
<optional parameter> version={version} : If this parameter is not provided, latest one is assumed 
 
<optional parameter> language-id = {languageId} : language id for the code_list example results. If this parameter is not provided, default language will be English. Current permitted values: 
en: English 
nl: Dutch 
fr: French 
 
Client must build this json object as the payload data to be sent based on this list of fields, on the last api call 
/api/dcd/payload/example?dcd-id={dcdId}; 
<optional>version={version} 
Example of payload in JSON format Providing this API end-point in order to help the Client on the Payload build with an example 
 
<optional parameter> version={version} : If this parameter is not provided, latest one is assumed 
/api/dcd/payload/submit? 
organization-id={organizationId}; 
dcd-id={dcdId}; 
<optional>version={version}; 
<optional>data-src-type={dataSrcType}; 
 
POST Payload 
 
/api/dcd/payload/submit? 
organization-id={organizationId}; 
dcd-id={dcdId}; 
<optional>version={version}; 
<optional>data-src-type={dataSrcType}; 
 
POST Payload 
 
Some implementation tasks is needed in here in order to return the result info (either succeed or failed).  
Similar like the one in HDConnectProxyRestTemplate.postCsv method, and the CsvExecutionResult object build. 
 
<optional parameter> version={version} : If this parameter is not provided, latest one is assumed. 
 
<optional parameter> data-src-type={dataSrcType} :  
permitted values:  
API 
CSV 
If this parameter is not provided, default values is <HD4DP>. 
api/dcd/submit?organization-id={organizationtId};dcd-id={dcd-id};<optional>dcd-version-id={dcdVersionId};<optional>incl-submit-data={inclSubmitData}; <optional>incl-submit-results={inclSubmitResults}; 
GET method 
 
List of submitted dcds data and/or their corresponding business keys or validation errors.  
 
<optional parameter> dcd-version-id={dcdVersionId} : If this parameter is not provided, lastest one is assumed 
 
<optional parameter> incl-submit-data={inclSubmitData} : If this parameter is not provided, default values is <false> 
 
<optional parameter> incl-submit-results={inclSubmitResults} : If this parameter is not provided, default values is <true> 
 

HOW TO: Upload data using System 2 System

Steps To Upload data

1. IT services of data providers must setup their systems to be able to communicate with HD4DP v2 System 2 System API

A prerequisite to be able to use the Health Data's System 2 System API, is that the IT services of the hospitals must have the following in place before the systems can communicate:

  • The endpoint/URL is protected by credentials for which the support services need to be contacted.
  • End-to-end API process to submit DCD registrations in a fully automated manner.
  • Support for searching submitted DCD registrations.

2. Prepare the JSON file (example file in this section)

To send DCD registrations to Health Data, the file must be in a .json file format.

  • At the Data Provider's side, we must foresee a way to extract the JSON file from the electronic patient files and/or other local databases.
  • Author group, Author and Coauthor:
    • When the Author group, Author and Coauthor has been left out in the json file, the default Author group, Author and Coauthor will be used automatically.
    • When the desired Author group, Author and Coauthor are specified in the json file, the following fields TX_AUTHOR_GR, TX_AUTHOR and TX_COAUTHOR must be added to the json file with their values respectively.

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

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.

  • Similarly, to submit a draft, the only thing to add is the key STATUS (all upper case) with the value "draft" to the request, as described in Submission of drafts.
  • Adding separators to a NISS number:
    It is not necessary to necessary to add separators in a NISS number when uploading a file using S2S API. You can fill the NISS number out both with or without seperators. E.g.: 85.04.02-169.32 or 85040216932.

    Example:
This image has an empty alt attribute


  • Make sure the name of the JSON file has the correct format:
    HD_DCD_submjson_HDBPnumber_HDBPabbreviation_versionnumber_versionreleasedate

So for Orthopride Hip - Resection the format would be:
HD_DCD_submxml_HDBP0386_Orthopride_Hip_Resection_01_20230504.json
Please note that this version includes editorial changes.

EXAMPLES:

Disclaimer: The example files above are only provided as a guideline and do not contain real life data.

3. Uploading the JSON File

  • The IT department of the Data Provider must provide a manner in their system to send the API requests containing DCD registrations in a JSON file format, the correct end-points must be addressed.
  • In this case the end-point to upload the json file will be:

4. Validate the JSON Upload

4.1 Validation of the S2S API Upload via the response:

Verify in the same way the request was sent, that the returned response is containing a valid Business key.

If a valid Business key has been provided, the registration upload via System 2 System API was succesful.

4.2 Validation of the System 2 System API via HD4DP 2.0:

Step 1: Open the web application HD4DP 2.0.

Step 2: Select the concerned organization in the dropdown list and click on Volgende (Next)

Step 3: Fill in the username and password, that has been provided by your IT Department or Healthdata team, and click on Log in to access the HD4DP 2.0 application.

Step 4: Navigate in the menu on the left-hand side panel to the desired study program:

Step 5: Check that the uploaded registration(s) is/are displayed in the overview table.

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 a request (type : request for information) via our portal (https://sciensano.service-now.com/sp) 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!
manager Thu, 02/22/2024 - 23:58

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 its project specific use.

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

  • Primo-implantation
  • Revision and 
  • Resection.

On the following pages we explain how to submit data for Orthopride Hip using the HD4DP v2 CSVUploader for each section.

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 a request (type : request for information) via our portal (https://sciensano.service-now.com/sp) 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!
manager Tue, 08/08/2023 - 12:51

CSV Upload for Orthopride Hip "Primo-implantation"

CSV Upload for Orthopride Hip "Primo-implantation"

Documentation for CSV Upload on Architecture 2.0

Description of the service

The CSV Upload functionality gives the possibility to import multiple parameters from a set of patients in one time into HD4DP 2.0. The csv file is based on an extract of the electronic patient files and/or other local databases.

Currently there is no user interface in HD4DP 2.0 for uploading csv files. If a data provider wants to upload a csv file, the file has to be dropped at a specific location. These files will be picked up and processed periodically. The files should be “final”, meaning that no application is writing to them. The pick-up location will be identical for all registries.
Pre-registry handling will be based on a naming-convention of the csv file.

HOW TO: Upload data using CSV Upload

Steps To Upload data

1. Prepare the csv file (example file in this section)

  • Extract the csv file from the electronic patient files and/or other local databases.
  • Author group, Author and Coauthor:
    • When the Author Group, Author and Coauthor have been left out in the csv file, the default Author group, Author and Coauthor will be used automatically.
    • When the desired Author Group, Author and Coauthor are specified in the csv file, the following headers TX_AUTHOR_GR, TX_AUTHOR and TX_COAUTHOR must be added to the csv file with their values respectively.

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

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.

  • Similarly, add the field name 'STATUS' in capitals in an additional column. Add the value 'draft' in case a manual submission of the record is requested.
    If not, the record will be submitted without manual intervention.
  • Adding separators to a NISS number:
    It is not necessary to add separators in a NISS number when uploading a file using CSV Upload. You can fill out the NISS number both with or without separators. E.g.: 85.04.02-169.32 or 85040216932.

    Example:
  • Make sure the name of the csv file has the correct format:
    HD_DCD_submcsv_HDBPnumber_HDBPabbreviation_versionnumber_versionreleasedate

So for Orthopride hip - Primo-implantation the format would be:
HD_DCD_submcsv_HDBP0386_Orthopride-Hip-Primo-implantation_01_20230504.csv
Please note that this version includes editorial changes.

EXAMPLES:

Disclaimer: The example files above are only provided as a guideline and do not contain real life data.

2. Uploading the csv file

Step 1: Open the sftp tool like WinSCP

Step 2: Get the credentials (Host name, Port number, User name and Password) from the IT department of the Data Provider, to log on to the sftp server located on the Data Provider side. See section Data transfer via an SFTP client in the documentation of the Online Acceptance Environment.

Step 3: Fill in the credentials into the Login screen and click on Login to be able to access the different upload folders:

Note: a warning might be given, just click on Update

Now the CSV Upload folder structure is displayed on the right-hand side panel. You will notice draftcsv folders and submcsv folders for the diverse HD business projects. Historically, a directly submitted csv file would end up in the submitted folder, whereas a csv file featuring ‘draft’ in the status field would have ended up in the draft folder. At this stage there is no real distinction between both folders, so you can save the csv file in either of them.
Attention: If you wish to create a draft to work on at a later stage, don’t forget to add ‘draft’ in the status column of the csv file.

Step 4: Select the project folder  Orthopridehip-7 and open it by double-clicking on it:

Step 5: Double-click on the DCD folder to open it:

Step 6: Now go to the folder on the left-hand side panel where the CSV file to be uploaded is located:

Step 7: Drag the CSV file to be uploaded from the left-hand side panel into the folder on the right-hand side panel:

Step 8: Wait until the polling system of the CSV Uploader has picked up the CSV file and processed it.
Once the CSV file has been processed, it will disappear from the folder when we refresh the page manually!

3. Validate csv upload

Once the csv file has been processed 3 folders will be created (if they haven't been created already) in the DCD folder:

  • ARCHIVE (after a csv file has been processed, the original csv file will be saved in this folder)
  • RESULT (when the csv file is placed in this folder, it means that the csv file has been processed, a file will be created or (or appended, if the file already existed) with the result of the upload of the csv file).
    All the errors that are described in this file are business related, which means that they are technically correct, but in violation with the business rules or contain wrong values for that field.
  • ERROR (when the csv file is placed in this folder, it means that a technical error has occurred like the csv file contained erroneous formatting. The csv file won't get processed and an error file will be created with the errors and reason why the csv file couldn't be processed)

3.1 Validation of the csv upload via sftp tool:

Step 1: Double-click on the ERROR folder to open it, click on the refresh button and verify that there is no error file present.

Step 2: Return to the DCD folder. Now double-click on the RESULT folder to open it, click on the refresh button and verify that the result file is present.

Step 4: If there are multiple records in the result file, scroll to the entry of the current csv upload by looking at the upload date (Started at dd/mm/yyyy hh:mm). 
Verify the result file that the upload was successful by searching for the word SUCCESS and having a look at the Status. This Status must contain: Success;Success Count:1;Error Count:0

3.2 Validation of the CSV Upload via HD4DP 2.0:

Step 1: Open the web application HD4DP 2.0.

Step 2: Select the concerned organization in the dropdown list and click on Volgende (Next)

Step 3: Fill in the username and password, that has been provided by your IT Department or Healthdata team, and click on Log in to access the HD4DP 2.0 application.

Step 4: Navigate in the menu on the left-hand side panel to the desired study program:

Step 5: Check that the uploaded registration(s) is/are displayed in the overview table.

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 a request (type : request for information) via our portal (https://sciensano.service-now.com/sp) 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!
manager Thu, 02/22/2024 - 23:45

CSV Upload for Orthopride Hip "Revision"

CSV Upload for Orthopride Hip "Revision"

Documentation for CSV Upload on Architecture 2.0

Description of the service

The CSV Upload functionality gives the possibility to import multiple parameters from a set of patients in one time into HD4DP 2.0. The csv file is based on an extract of the electronic patient files and/or other local databases.

Currently there is no user interface in HD4DP 2.0 for uploading csv files. If a data provider wants to upload a csv file, the file has to be dropped at a specific location. These files will be picked up and processed periodically. The files should be “final”, meaning that no application is writing to them. The pick-up location will be identical for all registries.
Pre-registry handling will be based on a naming-convention of the csv file.

HOW TO: Upload data using CSV Upload

Steps To Upload data

1. Prepare the csv file (example file in this section)

  • Extract the csv file from the electronic patient files and/or other local databases.
  • Author group, Author and Coauthor:
    • When the Author Group, Author and Coauthor have been left out in the csv file, the default Author group, Author and Coauthor will be used automatically.
    • When the desired Author Group, Author and Coauthor are specified in the csv file, the following headers TX_AUTHOR_GR, TX_AUTHOR and TX_COAUTHOR must be added to the csv file with their values respectively.

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

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.

  • Similarly, add the field name 'STATUS' in capitals in an additional column. Add the value 'draft' in case a manual submission of the record is requested.
    If not, the record will be submitted without manual intervention.
  • Adding separators to a NISS number:
    It is not necessary to add separators in a NISS number when uploading a file using CSV Upload. You can fill out the NISS number both with or without separators. E.g.: 85.04.02-169.32 or 85040216932.

    Example:
  • Make sure the name of the csv file has the correct format:
    HD_DCD_submcsv_HDBPnumber_HDBPabbreviation_versionnumber_versionreleasedate

So for Orthopride hip - Revision the format would be:
HD_DCD_submcsv_HDBP0386_Orthopride-Hip-Revision_01_20230504.csv

Please note that this CSV example includes the latest changes. An overview of these changes can be found in the Release notes section.

EXAMPLES:

  • Please find below an example file for Orthopride Hip Revision:
    • HD_DCD_submcsv_HDBP0386_Orthopride_Hip_Revision_v1.csv

Disclaimer: The example files above are only provided as a guideline and do not contain real life data.

2. Uploading the csv file

Step 1: Open the sftp tool like WinSCP

Step 2: Get the credentials (Host name, Port number, User name and Password) from the IT department of the Data Provider, to log on to the sftp server located on the Data Provider side. See section Data transfer via an SFTP client in the documentation of the Online Acceptance Environment.

Step 3: Fill in the credentials into the Login screen and click on Login to be able to access the different upload folders:

Note: a warning might be given, just click on Update

Now the CSV Upload folder structure is displayed on the right-hand side panel. You will notice draftcsv folders and submcsv folders for the diverse HD business projects. Historically, a directly submitted csv file would end up in the submitted folder, whereas a csv file featuring ‘draft’ in the status field would have ended up in the draft folder. At this stage there is no real distinction between both folders, so you can save the csv file in either of them.
Attention: If you wish to create a draft to work on at a later stage, don’t forget to add ‘draft’ in the status column of the csv file.

Step 4: Select the project folder  Orthopridehip-7 and open it by double-clicking on it:

Step 5: Double-click on the DCD folder to open it:

Step 6: Now go to the folder on the left-hand side panel where the CSV file to be uploaded is located:

Step 7: Drag the CSV file to be uploaded from the left-hand side panel into the folder on the right-hand side panel:

Step 8: Wait until the polling system of the CSV Uploader has picked up the CSV file and processed it.
Once the CSV file has been processed, it will disappear from the folder when we refresh the page manually!

3. Validate csv upload

Once the csv file has been processed 3 folders will be created (if they haven't been created already) in the DCD folder:

  • ARCHIVE (after a csv file has been processed, the original csv file will be saved in this folder)
  • RESULT (when the csv file is placed in this folder, it means that the csv file has been processed, a file will be created or (or appended, if the file already existed) with the result of the upload of the csv file).
    All the errors that are described in this file are business related, which means that they are technically correct, but in violation with the business rules or contain wrong values for that field.
  • ERROR (when the csv file is placed in this folder, it means that a technical error has occurred like the csv file contained erroneous formatting. The csv file won't get processed and an error file will be created with the errors and reason why the csv file couldn't be processed)

3.1 Validation of the csv upload via sftp tool:

Step 1: Double-click on the ERROR folder to open it, click on the refresh button and verify that there is no error file present.

Step 2: Return to the DCD folder. Now double-click on the RESULT folder to open it, click on the refresh button and verify that the result file is present.

Step 3: Double-click on the result file to open it.

Step 4: If there are multiple records in the result file, scroll to the entry of the current csv upload by looking at the upload date (Started at dd/mm/yyyy hh:mm). 
Verify the result file that the upload was successful by searching for the word SUCCESS and having a look at the Status. This Status must contain: Success;Success Count:1;Error Count:0

3.2 Validation of the CSV Upload via HD4DP 2.0:

Step 1: Open the web application HD4DP 2.0.

Step 2: Select the concerned organization in the dropdown list and click on Volgende (Next)

Step 3: Fill in the username and password, that has been provided by your IT Department or Healthdata team, and click on Log in to access the HD4DP 2.0 application.

Step 4: Navigate in the menu on the left-hand side panel to the desired study program:

Step 5: Check that the uploaded registration(s) is/are displayed in the overview table.

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 a request (type : request for information) via our portal (https://sciensano.service-now.com/sp) 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!
manager Thu, 02/22/2024 - 23:48

CSV Upload for Orthopride Hip "Resection"

CSV Upload for Orthopride Hip "Resection"

Documentation for CSV Upload on Architecture 2.0

Description of the service

The CSV Upload functionality gives the possibility to import multiple parameters from a set of patients in one time into HD4DP 2.0. The csv file is based on an extract of the electronic patient files and/or other local databases.

Currently there is no user interface in HD4DP 2.0 for uploading csv files. If a data provider wants to upload a csv file, the file has to be dropped at a specific location. These files will be picked up and processed periodically. The files should be “final”, meaning that no application is writing to them. The pick-up location will be identical for all registries.
Pre-registry handling will be based on a naming-convention of the csv file.

HOW TO: Upload data using CSV Upload

Steps To Upload data

1. Prepare the csv file (example file in this section)

  • Extract the csv file from the electronic patient files and/or other local databases.
  • Author group, Author and Coauthor:
    • When the Author Group, Author and Coauthor have been left out in the csv file, the default Author group, Author and Coauthor will be used automatically.
    • When the desired Author Group, Author and Coauthor are specified in the csv file, the following headers TX_AUTHOR_GR, TX_AUTHOR and TX_COAUTHOR must be added to the csv file with their values respectively.

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

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.

  • Similarly, add the field name 'STATUS' in capitals in an additional column. Add the value 'draft' in case a manual submission of the record is requested.
    If not, the record will be submitted without manual intervention.
  • Adding separators to a NISS number:
    It is not necessary to add separators in a NISS number when uploading a file using CSV Upload. You can fill out the NISS number both with or without separators. E.g.: 85.04.02-169.32 or 85040216932.

    Example:
  • Make sure the name of the csv file has the correct format:
    HD_DCD_submcsv_HDBPnumber_HDBPabbreviation_versionnumber_versionreleasedate

So for Orthopride hip - Resection the format would be:
HD_DCD_submcsv_HDBP0386_Orthopride-Hip-Resection_01_20230504.csv
Please note that this version includes editorial changes.

EXAMPLES:

Disclaimer: The example files above are only provided as a guideline and do not contain real life data.

2. Uploading the csv file

Step 1: Open the sftp tool like WinSCP

Step 2: Get the credentials (Host name, Port number, User name and Password) from the IT department of the Data Provider, to log on to the sftp server located on the Data Provider side. See section Data transfer via an SFTP client in the documentation of the Online Acceptance Environment.

Step 3: Fill in the credentials into the Login screen and click on Login to be able to access the different upload folders:

Note: a warning might be given, just click on Update

Now the CSV Upload folder structure is displayed on the right-hand side panel. You will notice draftcsv folders and submcsv folders for the diverse HD business projects. Historically, a directly submitted csv file would end up in the submitted folder, whereas a csv file featuring ‘draft’ in the status field would have ended up in the draft folder. At this stage there is no real distinction between both folders, so you can save the csv file in either of them.
Attention: If you wish to create a draft to work on at a later stage, don’t forget to add ‘draft’ in the status column of the csv file.

Step 4: Select the project folder Orthopridehip-7 and open it by double-clicking on it:

Step 5: Double-click on the DCD folder to open it:

Step 6: Now go to the folder on the left-hand side panel where the CSV file to be uploaded is located:

Step 7: Drag the CSV file to be uploaded from the left-hand side panel into the folder on the right-hand side panel:

Step 8: Wait until the polling system of the CSV Uploader has picked up the CSV file and processed it.
Once the CSV file has been processed, it will disappear from the folder when we refresh the page manually!

3. Validate csv upload

Once the csv file has been processed 3 folders will be created (if they haven't been created already) in the DCD folder:

  • ARCHIVE (after a csv file has been processed, the original csv file will be saved in this folder)
  • RESULT (when the csv file is placed in this folder, it means that the csv file has been processed, a file will be created or (or appended, if the file already existed) with the result of the upload of the csv file).
    All the errors that are described in this file are business related, which means that they are technically correct, but in violation with the business rules or contain wrong values for that field.
  • ERROR (when the csv file is placed in this folder, it means that a technical error has occurred like the csv file contained erroneous formatting. The csv file won't get processed and an error file will be created with the errors and reason why the csv file couldn't be processed)

3.1 Validation of the csv upload via sftp tool:

Step 1: Double-click on the ERROR folder to open it, click on the refresh button and verify that there is no error file present.

Step 2: Return to the DCD folder. Now double-click on the RESULT folder to open it, click on the refresh button and verify that the result file is present.

Step 3: Double-click on the result file to open it.

Step 4: If there are multiple records in the result file, scroll to the entry of the current csv upload by looking at the upload date (Started at dd/mm/yyyy hh:mm). 
Verify the result file that the upload was successful by searching for the word SUCCESS and having a look at the Status. This Status must contain: Success;Success Count:1;Error Count:0

3.2 Validation of the CSV Upload via HD4DP 2.0:

Step 1: Open the web application HD4DP 2.0.

Step 2: Select the concerned organization in the dropdown list and click on Volgende (Next)

Step 3: Fill in the username and password, that has been provided by your IT Department or Healthdata team, and click on Log in to access the HD4DP 2.0 application.

Step 4: Navigate in the menu on the left-hand side panel to the desired study program:

Step 5: Check that the uploaded registration(s) is/are displayed in the overview table.

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 a request (type : request for information) via our portal (https://sciensano.service-now.com/sp) 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!
manager Thu, 02/22/2024 - 23:54

HD4DP v2 MyCareNet

HD4DP v2 MyCareNet

HD4DP v.2 permits the administrative obligation of reporting to the insurance institutions. The limited necessary data are sent via HD4DP v.2 to the MyCareNet interface of the National Intermutual College (NIC). This transmission of nominative data occurs in parallel with the transmission of pseudonymized data to the healthdata.be platform. 

Two options are available to enable data transmission from HD4DP v.2 to the National Intermutualist College:

Please read this documentation before its project specific use.

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

  • Primo-implantation,
  • Revision and 
  • Resection.

On the following pages we explain how to submit an Orthopride Hip MyCareNet XML for each section.

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 a request (type : request for information) via our portal (https://sciensano.service-now.com/sp) 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!
manager Thu, 08/10/2023 - 12:24

MyCareNet XML Export for Orthopride Hip

MyCareNet XML Export for Orthopride Hip Bart.Servaes Tue, 04/04/2023 - 13:22

MyCareNet XML Export for Orthopride Hip "Primo-implantation"

MyCareNet XML Export for Orthopride Hip "Primo-implantation"

In this article we describe how to submit a MyCareNet XML for Orthopride Hip Primo implantation.

Flow

This configuration is by default active in HD4DP v2.

The files can be found on the SFTP share inside the directory /nippin/valid. The XML files can be downloaded with an SFTP client of your choice. The XML files you download can be sent with the MyCareNet component available in your organization.

Structure of the XML filename

The XML filename is a combination of different values: RIZIVnumber-random_uuid-inputReference.xml. The files are ready for use, thus contain the required fields. No additional editing is required.

How to link an XML file within the Nippin database

You can attach the XML files to the Web Service call to MyCareNet and sign the message with your eHealth P12 certificate. If you would like to search inside the Nippin database for the correct entry you can filter with the following query for the correct entries:

 select count(*) from nippin_message where input_reference = '<inputReference>' and identification_value = '<RIZIVnumber>';

  • Example: 11111130-6d59369f-11c8-4636-929a-86449f4dde3b-1701979200058.xml
    • RIZIVnumber: 11111130
    • random_uuid: 6d59369f-11c8-4636-929a-86449f4dde3b
    • inputReference: 1701979200058

SFTP Connection

The server name and the SFTP credentials can be requested via our Service Portal 

  • Server: IP of HD4DP v.2 server  
  • Port: 22  
  • Username: (your SFTP credentials)  
  • Password: (your SFTP credentials) 
  • Path: /data/localsftp/upload/nippin (Upload is the home directory of the sftp user)  

Example XML

An example file of a Orthopride Hip - Primo-implantation submission XML:

<RegistryRecordList>
	<RegistryRecord>
		<NIHDI>10220853000</NIHDI>
		<SSIN>84031535312</SSIN>
		<DateForRouting>2023-04-02</DateForRouting>
		<RegistrationCode>209.23.000017.10</RegistrationCode>
		<Registry>OP_HIP_PRIM_IMPLT</Registry>
		<Type>NI0001</Type>
		<SubmissionDate>2023-09-06</SubmissionDate>
		<CareDeliveries>
			<CareDelivery>
				<Occurence>
					<DateOfOccurence>2023-04-02</DateOfOccurence>
					<ImplantCodes>
						<NotificationCode>000017811475</NotificationCode>
					</ImplantCodes>
				</Occurence>
			</CareDelivery>
		</CareDeliveries>
	</RegistryRecord>
</RegistryRecordList>
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 a request (type : request for information) via our portal (https://sciensano.service-now.com/sp) 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!
johanvanbussel Tue, 09/12/2023 - 11:28

MyCareNet XML Export for Orthopride Hip "Revision"

MyCareNet XML Export for Orthopride Hip "Revision"

In this article we describe how to submit a MyCareNet XML for Orthopride Hip Revision.

Flow

This configuration is by default active in HD4DP v2.

The files can be found on the SFTP share inside the directory /nippin/valid. The XML files can be downloaded with an SFTP client of your choice. The XML files you download can be sent with the MyCareNet component available in your organization.

Structure of the XML filename

The XML filename is a combination of different values: RIZIVnumber-random_uuid-inputReference.xml. The files are ready for use, thus contain the required fields. No additional editing is required.

How to link an XML file within the Nippin database

You can attach the XML files to the Web Service call to MyCareNet and sign the message with your eHealth P12 certificate. If you would like to search inside the Nippin database for the correct entry you can filter with the following query for the correct entries:

 select count(*) from nippin_message where input_reference = '<inputReference>' and identification_value = '<RIZIVnumber>';

  • Example: 11111130-6d59369f-11c8-4636-929a-86449f4dde3b-1701979200058.xml
    • RIZIVnumber: 11111130
    • random_uuid: 6d59369f-11c8-4636-929a-86449f4dde3b
    • inputReference: 1701979200058

SFTP Connection

The server name and the SFTP credentials can be requested via our Service Portal 

  • Server: IP of HD4DP v.2 server  
  • Port: 22  
  • Username: (your SFTP credentials)  
  • Password: (your SFTP credentials) 
  • Path: /data/localsftp/upload/nippin (Upload is the home directory of the sftp user)  

Example XML

An example file of a Orthopride Hip - Revision submission XML:

<RegistryRecordList>
	<RegistryRecord>
		<NIHDI>10220853000</NIHDI>
		<SSIN>84031535312</SSIN>
		<DateForRouting>2023-09-05</DateForRouting>
		<RegistrationCode>210.23.000004.78</RegistrationCode>
		<Registry>OP_HIP_REVIS</Registry>
		<Type>NI0001</Type>
		<SubmissionDate>2023-09-06</SubmissionDate>
		<CareDeliveries>
			<CareDelivery>
				<Occurence>
					<DateOfOccurence>2023-09-05</DateOfOccurence>
					<ImplantCodes>
						<NotificationCode>000017803953</NotificationCode>
					</ImplantCodes>
				</Occurence>
			</CareDelivery>
		</CareDeliveries>
	</RegistryRecord>
</RegistryRecordList>
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 a request (type : request for information) via our portal (https://sciensano.service-now.com/sp) 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!
johanvanbussel Wed, 09/13/2023 - 16:17

MyCareNet XML Export for Orthopride Hip "Resection"

MyCareNet XML Export for Orthopride Hip "Resection"

In this article we describe how to submit a MyCareNet XML for Orthopride Hip Resection.

Flow

This configuration is by default active in HD4DP v2.

The files can be found on the SFTP share inside the directory /nippin/valid. The XML files can be downloaded with an SFTP client of your choice. The XML files you download can be sent with the MyCareNet component available in your organization.

Structure of the XML filename

The XML filename is a combination of different values: RIZIVnumber-random_uuid-inputReference.xml. The files are ready for use, thus contain the required fields. No additional editing is required.

How to link an XML file within the Nippin database

You can attach the XML files to the Web Service call to MyCareNet and sign the message with your eHealth P12 certificate. If you would like to search inside the Nippin database for the correct entry you can filter with the following query for the correct entries:

 select count(*) from nippin_message where input_reference = '<inputReference>' and identification_value = '<RIZIVnumber>';

  • Example: 11111130-6d59369f-11c8-4636-929a-86449f4dde3b-1701979200058.xml
    • RIZIVnumber: 11111130
    • random_uuid: 6d59369f-11c8-4636-929a-86449f4dde3b
    • inputReference: 1701979200058

SFTP Connection

The server name and the SFTP credentials can be requested via our Service Portal 

  • Server: IP of HD4DP v.2 server  
  • Port: 22  
  • Username: (your SFTP credentials)  
  • Password: (your SFTP credentials) 
  • Path: /data/localsftp/upload/nippin (Upload is the home directory of the sftp user)  

Example XML

An example file of a Orthopride Hip - Resection submission XML:

<RegistryRecordList>
	<RegistryRecord>
		<NIHDI>10220853000</NIHDI>
		<SSIN>84031535312</SSIN>
		<DateForRouting>2023-09-06</DateForRouting>
		<RegistrationCode>211.23.000002.60</RegistrationCode>
		<Registry>OP_HIP_RESEC</Registry>
		<Type>NI0001</Type>
		<SubmissionDate>2023-09-06</SubmissionDate>
		<CareDeliveries>
			<CareDelivery>
				<Occurence>
					<DateOfOccurence>2023-09-06</DateOfOccurence>
				</Occurence>
			</CareDelivery>
		</CareDeliveries>
	</RegistryRecord>
</RegistryRecordList>
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 a request (type : request for information) via our portal (https://sciensano.service-now.com/sp) 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!
johanvanbussel Wed, 09/13/2023 - 16:19

MyCareNet integration in HD4DP v2

MyCareNet integration in HD4DP v2
Flow

Four major actions are required in order to setup MyCareNet in HD4DP v.2:

  1. Whitelisting URLs
  2. Create certificate (ehealth_certificate.p12) with labels
  3. Upload eHealth certificate in HD4DP v.2
  4. Request credentials needed to upload the eHealth certificate

Whitelisting URL's

The following URLs must be whitelisted to communicate with MyCareNet and E-health. Without a direct connection from HD4DP v.2 server to these URLs, a registration to MyCareNet will not work.

https://prod.mycarenet.be:9443/*

https://services.ehealth.fgov.be/*

Create certificate (ehealth_certificate.p12) with labels

This part requires your organization's eHealth certificate. Create a certificate that has the name ehealth_certificate.p12 using the open source GUI KeyStore Explorer. Download and install the tool from https://keystore-explorer.org/

  1. Open your organization's eHealth certificate

2. Export both certificates as a Key Pair

3. Open KeyStore Explorer, and create a new KeyStore

4. Select the type of the new KeyStore: PKCS#12

5. In the menu bar go to Tools -> Import Key Pair

6. Select the type of key pair import required:

7. Browse the authentication certificate and fill in the Decryption Password

8. Import the authentication PKCS #12 Key Pair and give it the NIHII number as alias, ex 71001129

9. Click OK and give it a password that needs to be same for all imported certs in the P12 KeyStore

10. The Key Pair is imported Successfully

11. Repeat steps 5 to 10 for importing the serial number PKCS #12 Key Pair and give it the same serial number as alias

12. Repeat step 1 to 11 to add more NIHII-HOSPITAL P12 certificates to this KeyStore (Do not execute step 3 and 4 if you already created a new Keystore)

Example of 1 Ehealth certificate import

13. In the menu bar goto File-> Save All

14. Set the KeyStore Password and give it a password that needs to be same for all certificates

15. Click OK and save the KeyStore asehealth_certificate.p12

16. Click save and the P12 for HD4DP is created

Upload eHealth certificate in HD4DP v.2

The filename of your P12 certificate must be ehealth_certificate.p12

Server: IP of HD4DP v. 2 server

Username: (your SFTP credentials)

Password: (your SFTP credentials)

Path: /data/localsftp/upload (home directory of thesftpuser)

File: ehealth_certificate.p12

Request credentials needed to upload the eHealth certificate

The server name and the sftp credentials can be requested via our Service Portal. The password of your P12 certificate can be delivered to healthdata.be either via a secure password sharing tool of your choice or via Belnet Filesender to hd-architecture-2@sciensano.be. You can request a Belnet Filesender voucher via our Service Portal as well.

Bart.Servaes Tue, 04/04/2023 - 13:22

Databases

Databases Bart.Servaes Fri, 02/16/2024 - 11:23

Retrieve Orthopride Hip data from the local database of HD4DP v2

Retrieve Orthopride Hip data from the local database of HD4DP v2

Warning

The person with the login for the local database of "HD4DP v2 local" has access to all the data stored in the database. This means that the personal data of the patients will be VISIBLE to that user.

Requirements

URL Local DWH Database: postgresql://<server_ip>:5432/localdwh. If this is not the case, the IT department hosting HD4DP v2 needs to open the port and allow traffic to this port.

URL NIPPIN Database: postgresql://<server_ip>:5432/nippin

Username/Password: The service desk of healthdata.be will forward, via a secure link, the username and password.

Client: Download one of the clients that support PostgreSQL . A list is available here.

Subnet: Provide us with the subnet from where you will contact the database. The database only accepts incoming traffic of known subnets.

Granted privileges

databaseuserprivileges
localdwhdpuserCONNECT/local_dwhmessage:SELECT/local_dwhmessage_key_value:SELECT/local_dwhmessage_key_value_plus:SELECT
nippindpuserCONNECT/nippin_message:SELECT
Privileges table

"data_collection_name" in local database

  • Orthopride Hip registration "Primo-implantation" = OP_HIP_PRIM_IMPLT
  • Orthopride Hip registration "Revision" = OP_HIP_REVIS
  • Orthopride Hip registration "Resection" = OP_HIP_RESEC

Query examples

With the "data_collection_name" and the following information, you will be able to link multiple tables with each other.

  • local_dwhmessage_key_value: Key value table with more information about the registration
  • msg_document_id: document id of your message located in local_dwhmessage table
  • document_id: document id of your registration
  • local_dwhmessage: table where you can find all the registrations
  • local_dwhmessage_key_value_plus: Extra table to define attribute type and value of a key value
  • key_value_id: Key value id linked to the id of the local_dwh_message_key_value
  • local_dwhmessage_key_value:

"local_dwhmessage_key_value" column "msg_document_id" refer to the "document_id" of "local_dwhmessage".

"local_dwhmessage_key_value_plus" column "key_value_id" refer to the id of "local_dwhmessage_key_value".

Query 1: Get all registrations from the last 15 days.

SELECT * from local_dwhmessage WHERE data_collection_name = 'add data_collection_name' and created_on > current_date - interval '15' day;

Query 2: Get all registrations and key value.

SELECT * from local_dwhmessage as ldm left join local_dwhmessage_key_value as ldmkv on ldmkv.msg_document_id = ldm.document_id WHERE ldm.data_collection_name = 'add data_collection_name';

Query 3: Get all registrations, key value and key value plus from.

SELECT * from local_dwhmessage as ldm left join local_dwhmessage_key_value as ldmkv on ldmkv.msg_document_id = ldm.document_id left join local_dwhmessage_key_value_plus as ldmkvp on ldmkvp.key_value_id = ldmkv.id WHERE ldm.data_collection_name = 'add data_collection_name';

Query 4: Get all MyCareNet registrations, key value and key value plus.

SELECT value from local_dwhmessage as ldm left join local_dwhmessage_key_value as ldmkv on ldmkv.msg_document_id = ldm.document_id WHERE ldm.data_collection_name = 'add data_collection_name'and key = 'TX_REGN_CD';

select * from local_dwhmessage_key_value where msg_document_id in ( select msg_document_id from local_dwhmessage_key_value where key = 'TX_REGN_CD' and value = 'use value from first query');

select * from local_dwhmessage where document_id in ( select msg_document_id from local_dwhmessage_key_value where key = 'TX_REGN_CD' and value = 'use value from first query');
Column Type Description
id bigserial PK
message_id varchar(255) Identifier for the message
identification_value text Identification value of the organization that is sending the message
name text Name of the organization that is sending the message
payload text Payload of the message
payload_after_validation text Payload after (xsd-)validation
response text Response to the message (received from myCarenet)
valid boolean Whether the message is valid or not
interface_type varchar(25) Type of interface used for the message (e.g. FILE_SYSTEM or REST)
status varchar(25) Current status of the message (possible states: INVALID (validation against xsd-scheme failed), TO_SEND (ready for sending to myCarenet), SENT (sent to myCarenet), ERROR (something went wrong during sending, e.g. unable to reach myCarenet))
created_on timestamp Timestamp of when the message was created
input_reference varchar(255) Reference for the input message (this is a unique identifier that can be used for debugging/tracing with myCarenet)
issuer text Issuer of the message
postresponse_tack_applies_to text Applies-to value for the TACK post-response (received from myCarenet)
postresponse_tack_id text ID of the TACK post-response (received from myCarenet)
postresponse_tack_reference text Reference for the TACK post-response (received from myCarenet)
postresponse_tack_resultMajor text Result major for the TACK post-response (received from myCarenet)
postresponse_tack_resultMinor text Result minor for the TACK post-response (received from myCarenet)
postresponse_tack_resultMessage text Result message for the TACK post-response (received from myCarenet)
previous_registrationcode varchar(255) Previous registration code for the message (obsolete)
current_registrationcode varchar(255) Current registration code for the message (value will be identical to previous_registrationcode)

Query 5: Connect to the Nippin database postgresql://<server_ip>:5432/nippin (same user/password) to validate the current state and payload for the nippin message based on the registration code.

select * from nippin_message where current_registrationcode = 'use the value of Query 4 (first query)';
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 a request (type : request for information) via our portal (https://sciensano.service-now.com/sp) 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!

johanvanbussel Thu, 02/15/2024 - 15:14

Nippin database

Nippin database

The different statuses of a Nippin message in the database

StatusDescription
TO_SEND HD4DP v2 ready to be sent to MyCareNet or SFTP folder
ARCHIVEDMessages are set to ARCHIVED, only if the NippinCleanup table has 0 records. These messages will not be processed and won't receive any attention afterwards.
INVALIDXML payload is invalid, a ticket can be created at our service portal.
BUFFEREDnot used
ERRORHD4DP v2 was not able to send the message to MyCareNet or SFTP folder
SENTHD4DP v2 was able to send the message to MyCareNet or SFTP folder

Queries

  • Count records grouped by the type and status:
nippin=# select interface_type, status, count(id) from nippin_message group by interface_type,status;
 interface_type | status  | count
----------------+---------+-------
 FILE_SYSTEM    | SENT    |   117
 FILE_SYSTEM    | INVALID |   352
 FILE_SYSTEM    | TO_SEND |  9238
(3 rows)
  • Get all error and invalid information:
select id, message_id, project_id, dcd_id, payload_after_validation from nippin_message where status in ('INVALID', 'ERROR');
  • Get previous and current registration code:
select id, message_id, project_id, dcd_id, previous_registrationcode, current_registrationcode from nippin_message;

MyCareNet integration-specific queries

Only for hospitals that are using the Nippin integration in HD4DP v2.

  • Count records with status SENT and group them based on the reference ID received from MyCareNet:
 select postresponse_tack_result_major, postresponse_tack_reference, count(*)  from nippin_message where status = 'SENT' group by status, postresponse_tack_result_major, postresponse_tack_reference;
  postresponse_tack_result_major   |     postresponse_tack_reference      | count
-----------------------------------+--------------------------------------+-------
 urn:nip:tack:result:major:success | ***** |   2
 urn:nip:tack:result:major:success | ***** |   88

Bart.Servaes Thu, 02/15/2024 - 15:50

Architecture 2.5

Architecture 2.5 Bart.Servaes Sat, 01/27/2024 - 01:37

Uniformed naming convention

Uniformed naming convention

Change name: 

Create DCD formio naming structure using a general overall naming convention of healthdata projects.

Change Description:

The change is to refactor the formio DCD naming to have a structure as:

HDBPnumberHDBPabbreviationdcdname/abbreviationversionnumber

Where the abbreviation will be used as seen in the column “TX_PROJ_BUS_ABBREV” of the document below, that will be a reference to fill the MDM:

Example 1: 

So for the formio DCDs of the project “Mandatory registration of spine surgery” (full name) it would be something like:

HDBP0240_SPINE_1 and because there is only 1 dcd for the project we do not use a dcd name.

Example 2:
So for the formio DCDs of the project “Pneumology Endobronchial valve” (full name) it would be something like:

HDBP0231_ZEPHYR_ZEPHYR_REPLAC_1
HDBP0231_ZEPHYR_ZEPHYR_PRIM_IMPLT_1

Full example:

dcdname/abbreviation: will be the TX_REG_NAME of the DCD.

form titleform nameform pathcollection name
HDBP0240_SPINEhdbp0240Spine1hdbp0240spine1HDBP0240SPINE1
HDBP0231_ZEPHYR_ZEPHYR_PRIM_IMPLThdbp0231ZephyrZephyrPrimImplt1hdbp0231zephyrzephyrprimimplt1HDBP0231ZEPHYRZEPHYRPRIMIMPLT1

Bart.Servaes Fri, 01/26/2024 - 22:05

MDM Mapping of billing codes for MyCareNet

MDM Mapping of billing codes for MyCareNet

Note: The below described mapping solution only applies to the study project of PACEMAKER.

In Architecture 2.0 the DCD fields related to billing codes for MyCareNet do not contain the billing code as their code value, instead this is just a numerical value, and the code value is only displayed in the label, e.g.:

When then sending key values to localdwh and dwh, the submission will contain a key value as follows:

When generating a message for MyCareNet, however, this same numerical value is used in the message payload. Keeping these numerical values, will generate MyCareNet messages with a incorrect billingcode, in this case <BillingCode>2</BillingCode>.

In Architecture 2.5 an MDM Mapping of billing codes for MyCarenet has been implemented. The value for the key will no longer be a numerical value such as 1,2,3… but an actual billing code. To facilitate this requirement, a new column has been introduced in the MDM to associate the billing code with the correct 13 character value, such as "182932-182943". This billing code will be accepted by MyCareNet.

Bart.Servaes Sat, 01/06/2024 - 16:40

HD4DP v2 Online Acceptance Environment

HD4DP v2 Online Acceptance Environment

Introduction

To support development and validation of data transfers using S2S API or CSV upload, a central Online Acceptance Environment is available for the IT services or IT partners of data providers. It is meant to replace the locally installed acceptance environments at the side of the data providers. With the Online Acceptance Environment the three types of data transfer can be tested and validated: data transfer via an API platform, via an SFTP client and via manual input in the study form.

In order to keep the acceptance environment light, it is rebuilt once a week (every Saturday), automatically removing all data that have been entered for testing. The data are stored locally and will not be sent to Healthdata.be infrastructure. The testing is limited to the upload to the HD4DP v2 application.

Application URLs and port

The Online Acceptance Environment can be found on https://hd4dp.acceptance.healthdata.be, which is a publically accessible URL.

On the homepage you are requested to select your organization from the drop-down list in order to proceed.

Log in with the credentials you have received upon request. The username is test@sciensano.be for all users.

Since the list of organizations to choose from is limited, you might not find your organization in it. In that case we advise you to request your credentials through our service portal at https://sciensano.service-now.com/sp via the Request something tab and subsequently the Request for Information box.

When requesting an account for this acceptance environment you will receive 3 different types of credentials:
⦁ credentials to log in to the front end of the online acceptance environment
⦁ credentials to use the API (-> authorization tab in Postman)
⦁ credentials for the SFTP server you use to test the CSV Upload

Once logged in, the layout looks very familiar: to the left you will find the navigation panel with all running projects and projects that have passed the user acceptance testing (UAT) phase. Note that the list of projects featuring in our Online Acceptance Environment is not filtered out for the organization you have selected.

The data transfer methods

As mentioned above, the Online Acceptance Environment enables the testing of the uploads for the following three types of data transfer. They are described in order of preference underneath:

Data transfer via an API platform

The data are extracted directly from the EPD systems and sent to HD4DP v2 local using S2S API before they are sent to healthdata.be. This transfer method requires the use of an API development platform, such as Postman (freely available).

The endpoint (URL) to send your payload to for testing is

https://hd4dp.acceptance.healthdata.be/proxy/api/dcd/payload/submit

This endpoint is to be completed with some parameters, such as the ID of an organization, the ID of a dcd, the version number:

https://hd4dp.acceptance.healthdata.be/proxy/api/dcd/payload/submit?organization-id=6&dcd-id=18&Version=1

Click on the Send button to post the payload. A succesful submission is indicated with the status message “202 Accepted”. This can also be checked visually in the front end of the Online Acceptance Environment.

The field Data source in the top selection bar indicates whether the data were transferred via S2S API, CSV Upload or manually with HD4DP.

In the production environment records sent through API are sent directly to the healthdata.be infrastructure (status “Submitted” in the Progress field).

Next to posting payloads (POST) you can also retrieve information (GET). Examples of such "calls":

  • The call https://hd4dp.acceptance.healthdata.be/proxy/api/organization (see below) will return an organization id:
  • The call https://hd4dp.acceptance.healthdata.be/proxy/api/dcd/menu/structure?organization-id=6 (see below) will return the menu structure with all projects your organization is registered for.

More information about the API data transfer can be found at https://docs.healthdata.be/documentation/hd4dp-v2-health-data-data-providers/hd4dp-v2-s2s-api

Data transfer via an SFTP client

The csv upload is the second type of data transfer. The data are transferred to an SFTP server and subsequently picked up by the healthdata.be system. This transfer method requires the use of an SFTP client, such as WinSCP (freely available).

The Login window will look somehow as follows:

Herein, you enter Host name (sftp.acceptance.healthdata.be) and Port number (2220).

Credentials for the SFTP folder are shared together with the Front-end and API credentials as described in the section “Navigate to and access the Online Acceptance Environment”.

When logging in to WinSCP, you will need to navigate to the correct csv folder : csv/<project>/<dcd>. Here you need to drag and drop the csv you want to upload from the left panel to the right panel. The CSV file will now be picked up by the polling system of the CSV Uploader, which checks for new CSV files every minute.

The folders Archive and Result will only be created after the first CSV file has been uploaded for testing.

The Result folder shows a log file containing CSV Upload reports. The status Error Count shows technical errors such as incorrect name, code …

CSV files that were uploaded in Architecure 1 can be reused in Architecture 2. Prerequisite for this is the addition of necessary fields that are typical for Architecture 2, e.g.:

  • Author Group (TX_AUTHOR_GR) with the value "Test group"
  • Author (TX_AUTHOR) with the value "test@sciensano.be"
  • Coauthor (TX_COAUTHOR) with the value "test@sciensano.be"

To further facilitate the process of reusing CSV files a mapping table with old and new CSV names is provided.

Next to adding fields, you can also leave out fields, which is indicated in the log file reports as a warning.

Once again the back-end process can be checked in the study forms on the front-end interface. You want to refresh the window to update to the newest status.

More information about the CSV data transfer can be found at https://docs.healthdata.be/documentation/hd4dp-v2-health-data-data-providers/hd4dp-v2-csv-upload.

Manual input in the study form

The third data transfer method is the form entry, carried out manually. For this you can use a common browser such as Google Chrome. This method can also be used to validate data sent via S2S API or CSV Upload.

Bart.Servaes Tue, 10/24/2023 - 16:13

Requesting access

Requesting access

A request for access to the online acceptance environment will be made available in the Entity Access Management tool available via eam.healthdata.be. See also https://docs.healthdata.be/EAM

This feature is foreseen to be added to the EAM portal during the summer of 2023. In the meantime or when the EAM portal should be unavailable, you can use the service portal to request access to the online acceptance environment by creating an incident and clearly mentioning you are an IT Department or IT partner of a data provider requesting access to the online acceptance environment.

More information on how to create an incident in the service portal is available on https://docs.healthdata.be/documentation/hd4dp-v2-health-data-data-providers/how-report-incident

You will receive 3 types of credentials:

  • Credentials for the HD4DP2 web form application.
  • Credentials for the API data transfer.
  • Credentials for the SFTP server to upload CSV files.
Bart.Servaes Tue, 10/24/2023 - 16:37

Support service for HD4DP v2

Support service for HD4DP v2

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 organizations.

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 Tue, 10/24/2023 - 13:04

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 Tue, 04/04/2023 - 13:23