Repository navigation
Questionnaire Creation Checklist
The following checklist should be followed when creating a new questionnaire (PROM). See how to access the page to create these questionnaires here.
✔️ Check if the questionnaire administration rights has been obtained from the organization / person responsible for the same. Some questionnaires need special permission for electronic administration.
✔️ Confirm the language translations that are available.See this page for details.
✔️ Check if any branching logic is to be applied. If so document that carefully
✔️ Check if the questionnaire has been created already with the administrators. If not create a template questionnaire first. Copy the template to the main questionnaire once done. See this page to understand the process.
✔️ If created earlier then copy the template questionnaire. This is usually the easiest to get started as it will have all the elements viz. questions, scoring rules, translations and the entity handler configuration
✔️ If not start by creating the questionnaire. Note that in electronic displays it is a good practice to present the questions one after another in separate pages. This ensures that attention is not diverted away from question text by the next question. Use webform cards to ensure a smooth user experience. See this page to understand the process.
✔️ When adding the question choose a consistent naming scheme. Note that the webform module will give an automatic "KEY" name from the title you typed. Ensure that the Key is not inconsistent. We generally following the following convention : questionnaire name acronym_question number. As seen in the screenshot below, the question is in full text but the key is hn35_q31 where hn35 is the acronym for the eortc HN35 module and q31 is question number 31. Follow the question numbering scheme in the questionnaire as it helps later when doing calculations.
✔️ Add visibility rules if questions need to be visible based on answers to previous answers (a.k.a braching logic / skip logic).
✔️ Add scoring rules using the computed twig field. This will enable the scoring of the form. See this page to understand the process. Code examples for Computed Twig calculations are provided here.
✔️ Add translations to the webform.
✔️ Add entity handler to ensure data of the webform gets saved to the correct content. See rationale for this here and how to do this here. Usually if a webform is duplicated, then the entity handler configuration, translations and scoring will come with the duplicated webform. See the dedicated page for this.
✔️ Add a webform node reference so that the webform can be accessed by the patients after configuring the settings correctly. To understand the logic of why this is needed see the Patient Access Congfiguration Logic page