Introduction

The PKBs advanced questionnaire APIs require a separate set of credentials, different to those used in previous steps. You will therefore need to be provided with FHIR AQS credentials, once again consisting of a Client ID and a Client Secret.

Authenticate

Get A Questionnaire IDs

Before you can start sending Waiting List Validation questionnaires to patients, it is necessary to know the Questionnaire ID(s) which relate to the WLV questionnaire template(s) that you will be using.

It is also necessary to specify the PKB team which you want to search. Teams are specified using the x-team-id which will be provided by PKB.

Example

Once you have received the response, it will include all the questionnaire templates available to the team. Included in the details for each template will be the name and the ID. You can therefore extract the ID for the questionnaire(s) which are in scope for the Waiting List Validation workflow.

Sending Questionnaire Requests

For example, using the above options, you could send a request specifying:

• The WLV questionnaire template you want to send, using the Questionnaire ID obtained above (included in the URL endpoint)

• The patient that you want to send the request to, using their NHS number (target parameter)

• That neither the patient or clinicians should be able to amend a completed response (by not including the amendableBy parameter)

• The team from which the request is coming, using the x-team-id (included as a header)

Example Request URL

Example Request Header

Example Request Body

Once a request has been successfully sent, it will appear in the patients PKB record, ready for them to fill in. If the patient has a date of birth and email address against their PKB record, they will also receive an email notification from PKB, advising them of the request and directing them a link via which they can fill it out.