Advanced Questionnaires development plan
Â
- 1 What are advanced questionnaires?
- 2 When can I use advanced questionnaires?
- 3 Development and rollout plan
- 3.1 Released functionality
- 3.1.1 FHIR APIs (Released December 2023)
- 3.1.2 Patients can see questionnaires on the Events & messages page (Released January 2024)
- 3.1.3 Professionals can send questionnaires to individual patients (Released July 2024)
- 3.1.4 Professionals and coordinators can export questionnaire answers as a CSV (Released October 2024)
- 3.1.5 Clinical teams can suppress email notifications when sending advanced questionnaires via the API (Released October 2024)
- 3.1.6 Professionals can configure whether patients are allowed to edit the answers to a completed questionnaire (Released November 2024)
- 3.2 Unreleased functionality
- 3.2.1 Professionals can edit the answers to a completed questionnaire (Q1 2025)
- 3.2.2 Email notifications for professionals when questionnaires are submitted or amended (Q4 2024)
- 3.2.3 Patients can initiate questionnaires via the UI (Q1 2025)
- 3.2.4 Professionals and coordinators can send mass questionnaires (2025)
- 3.2.5 Questionnaires can be completed by professionals and carers (2025)
- 3.3 Future work (Unscheduled)
- 3.1 Released functionality
What are advanced questionnaires?
PKB’s questionnaires feature is being updated to make it easier for clinical teams to gather information from their patients, including patients who have a PKB record but are not yet registered. The new questionnaires feature is now released and available for customers to use via our FHIR APIs and via the user interface (UI).
The currently released functionality allows:
Clinical teams to send questionnaire requests via the API
Clinical teams to retrieve questionnaire responses via the API
Professionals to send questionnaire requests to individual patients via the UI
Professionals to view completed questionnaires inside a patient’s record
Professionals and coordinators to export questionnaire responses as a CSV
Advanced questionnaires have an improved UI for patients completing the questionnaires and improved functionality inside the questionnaires; including calculated fields, questionnaire scoring, branching, and coded data.
See our Advanced questionnaires features page for an overview of all the new features.
When can I use advanced questionnaires?
We are rolling out advanced questionnaires functionality iteratively. See the Development Plan below for details about what is going to change and when.
Â
As of November 2024, your team can use advanced questionnaires as long as your use case does not rely on any of the following functionality:
Professionals or coordinators sending a ‘mass questionnaire’ to an entire team
Professionals editing the answers to a submitted questionnaire
Patients initiating a questionnaire via the UI
Â
To begin using advanced questionnaires, PKB will need to rebuild your existing questionnaires as advanced questionnaires and then move your team over. To arrange this, please discuss with your Customer Success PM.
Development and rollout plan
Released functionality
FHIR APIs (Released December 2023)
This phase of the project made new FHIR API endpoints available for clinical teams to send questionnaires to patients and retrieve their responses.
The patient’s answers will be stored in our database as FHIR QuestionnaireResponse resources and can be retrieved using the QuestionnaireResponse endpoint.
When questionnaires are triggered via the API, patients receive an email notification containing a link to complete the questionnaire. Once the patient has completed the questionnaire, they are directed to a landing page which confirms they have completed the questionnaire. For unregistered patients, this page has an option for them to register via NHS login.
Â
Patients can see questionnaires on the Events & messages page (Released January 2024)
Patients can see questionnaire requests on the Events & messages page, where they can answer the questions in the questionnaire, continue answering questions on a questionnaire they’ve saved or view their answers to completed questionnaires.
Other users with the required access, such as professionals and carers, cannot answer questions on behalf of a patient but can see the questionnaire request and view their answers.
Professionals can send questionnaires to individual patients (Released July 2024)
This stage of the project introduced the advanced questionnaire functionality to the UI for professionals, who can now send advanced questionnaires to individual patients if their team has advanced questionnaires enabled. This stage does not include mass questionnaires, which have not yet been released for advanced questionnaires. This stage of the project had both UI and functional changes:
The ‘Consultations’ tab on in the professional and coordinator UI changed to ‘Questionnaires’ and the ‘Start consultation’ button changed to ‘Send questionnaire’. This changed for all teams, even those who have not moved to advanced questionnaires.
Professionals can send advanced questionnaires to patients via the PKB UI by clicking ‘Send questionnaire’. Patients will get an email notification asking them to complete the questionnaire and will see the questionnaire request in the Events & messages section.
Currently, professionals can send advanced questionnaires to individual patients. In early 2025, we will be releasing the ‘mass questionnaire’ feature for advanced questionnaires, which will allow coordinators and professionals to send the questionnaire to every patient in a team.
At this stage of the project, teams began moving to advanced questionnaires. Once a team has moved to advanced questionnaires:
Professionals can only send advanced questionnaires via the UI. They cannot send the consultations that they were sending before the move, but they can still export historic answers.
Patients can not initiate questionnaires via the UI. These patients will not see the ‘Start consultation’ button until we allow the patient to initiate the questionnaire via the UI, unless they are also in teams that have not moved to advanced questionnaires.
At this stage, teams can move to advanced questionnaires as long as they do not require the following features:
Mass questionnaire
Patient trigger
Â
Professionals and coordinators can export questionnaire answers as a CSV (Released October 2024)
Professionals and coordinators can now export their patients' answers to advanced questionnaires as a CSV file, via the ‘Questionnaires’ page. Professionals and coordinators will see a list of advanced questionnaires that are linked to their team on the ‘Questionnaires’ page.
The CSV file is formatted differently to the CSV export for simple questionnaires, with one row per question, rather than per patient. This allows the export file to contain other information about a question, such as any clinical codes associated with it or any formula that were used to calculate a score.
Â
Â
See our manual page for an example CSV file containing one patient’s answers to a GAD7 questionnaire.
Clinical teams can suppress email notifications when sending advanced questionnaires via the API (Released October 2024)
The notificationFlag parameter can be used in API calls to the $send-questionnaire-request endpoint to suppress the email notifications that a patient receives when sent a questionnaire. Clinical teams may choose to use this if they are sending the patient their own notifications; e.g. via SMS or email.
Professionals can configure whether patients are allowed to edit the answers to a completed questionnaire (Released November 2024)
When a professional sends a questionnaire request to a patient, they will now see a checkbox called ‘Allow patient to edit answers after submission'. If the professional ticks this box, the patient will be able to edit the answers to their questionnaire after they have submitted it. If the professional does not tick the box, the patient will not be able to edit their answers after submission.
Currently, the professional who sent the questionnaire does not get an email notification when the patient submits or amends a questionnaire. However, these email notifications will be added in Q4 2024/Q1 2025.
When a completed questionnaire is edited, the status of the questionnaire is changed to amended and the message thread shows this status as ‘Amended’, with the date and time of the most recent edit.
Clinical teams can also configure whether a patient is allowed to edit a completed questionnaire when sending questionnaires using the FHIR API, using the amendableBy parameter.
Unreleased functionality
Professionals can edit the answers to a completed questionnaire (Q1 2025)
Professionals will be able to configure whether they, or other professionals, can edit the responses of a questionnaire completed by a patient.
A second checkbox will be added to the ‘Send questionnaire’ modal where a professional chooses the questionnaire they would like to send. If the professional ticks the ‘Allow professionals to edit patient’s answers after submission' box, professionals will be able to edit a patient’s answers after the patient has submitted them. If the professional leaves the box unticked, professionals will not be able to edit completed questionnaires.
When a professional edits a completed questionnaire, the QuestionnaireResponse is updated and the professional is added to the author field. The name of the professional is also displayed in the UI, next to the ‘Amended’ status and date and time of the last edit. This provides an audit trail of who has updated the questionnaire and when.
Clinical teams will also be able to configure whether a professional is allowed to edit a completed questionnaire when sending questionnaires using the FHIR API, using the amendableBy parameter.
Email notifications for professionals when questionnaires are submitted or amended (Q4 2024)
Professionals will receive an email notification when a patient submits or edits a questionnaire that the professional sent. The email notification will take the professional to the questionnaire in their inbox, where they can view the answers by clicking the ‘View’ button.
Â
Patients can initiate questionnaires via the UI (Q1 2025)
Teams will be able to configure whether patients can initiate questionnaires via the UI. Patients will initiate these questionnaires by clicking ‘Start consultation’.
Only questionnaires that have been marked by the team as patient-facing will appear to the patient; meaning the patient will not see a ‘Start consultation’ button if the team has no questionnaires or if the team only has questionnaires that the patient is not allowed to initiate.
The button will remain ‘Start consultation’, as the patient is consulting their team online when they choose to initiate a questionnaire.
Patients will then only be able to initiate advanced questionnaires via the user interface. All teams that have patient-initiated questionnaire workflows will be moved to advanced questionnaires at this point.
At this stage, teams that have workflows that require the patient to initiate a questionnaire begin using advanced questionnaires.
Professionals and coordinators can send mass questionnaires (2025)
Professionals and coordinators will be able to send an advanced questionnaire to their whole team, using the ‘mass questionnaire’ feature.
Professionals and coordinators will be able to send a questionnaire to their whole team by clicking ‘Send questionnaire' on the ‘Questionnaires' page. The professional or coordinator is asked to confirm that they are sure they want to send the questionnaire to the entire team. This warning message is being improved as part of the advanced questionnaire project (please see the section titled ‘Questionnaires UI upgrade’).
When a professional or coordinator sends a mass questionnaire, it is sent to every patient in their team. Professionals and coordinators will not receive email notifications or inbox items for mass questionnaires.
Questionnaires can be completed by professionals and carers (2025)
Professionals and carers will have the option of completing questionnaires on behalf of patients. When a user who isn’t the patient completes a questionnaire, the user is added to the author field of the QuestionnaireResponse (whereas the patient is still recorded in the subject field). This user will also be displayed in the UI next to the status of the questionnaire and the date and time it was last updated.
Future work (Unscheduled)
We will then move onto development of other features related to Advanced Questionnaires, including:
Making the QuestionnaireResponse available via our APIs as a PDF
Allowing patients and professionals to send secure messages about an Advanced Questionnaire
Â