Page Comparison

Question

Response

Can requests be sent to patients outside of the questionnaire’s team?

Yes

Can requests be sent to unregistered patients?

Yes. If the patient has an email address and date of birth in their record, they will receive an email informing them of the questionnaire request, even if they are not registered.

If a patient does not have an email address or date of birth in their record, no questionnaire request will be sent. 

Can unregistered patients complete questionnaires without having to register first?

Yes. Patients can complete the questionnaires without having to register, by clicking the link in the questionnaire email and providing their date of birth. After completing the questionnaire, the patient will be able to register via NHS login.

I want to send/retrieve questionnaires outside of a team, so why do I still need to specify a team ID?

All questionnaire requests must be sent on behalf of a team which has access to the template and therefore a Team ID is always required. This does not affect your ability to send requests to patients outside of that team.

The Team ID is also required when pulling back responses. Calls to the QuestionnaireResponse endpoint will return all QuestionnaireResponses that were generated from questionnaire requests sent by that team. 

Is there an API for obtaining Team IDs?

Currently there is no API which will provide this information. Team IDs will therefore be provided by PKB during the development of the integration feed.

How exactly can the date parameter be used when pulling responses?

The date is flexible and can be used to specify: Equal to, Greater than, Less than, Greater or equal to & Less or equal to.

NB. Search parameters are currently in development so not available yet.

We don’t hold patient NHS numbers. How else can we identify patients?

The APIs allow ‘NHS numbers’ or ‘PKB Public IDs’ to be used as patient identifiers. If you want to use the Public IDs, this will require some extra development to obtain these IDs from PKB.

I previously used the Simple FHIR APIs and had to include a Practitioner ID. Why is this no longer needed?

Questionnaire requests are now sent on behalf of a Team rather than a Practitioner. For this reason, a Practitioner ID is no longer required.

Can I choose what format the responses are provided in, in the FHIR response?

No, responses are always provided as a standard FHIR R4 resource in JSON format.

Can requests be sent to deceased patients?

No. If the Deceased flag has been added to a patient record in PKB, the system will prevent any requests from being sent for that patient.

How do I find out the ID of the Questionnaire templates we want to use?

Customers can obtain Questionnaire IDs themselves by using the FHIR GET Questionnaire API.

A search on the Questionnaire endpoint will return a bundle of all Questionnaires that the team has access to. 

Will a Questionnaire ID ever change?

Potentially. Questionnaire templates can be amended if needed. Depending on whether you, or any other customers, still need access to the old version. In this case, a new Questionnaire ID will also be applied to the new version in order to differentiate it from the old one.

Can the patient’s demographic details be included in the questionnaire response request?

PKB will be adding an optional parameter:: _include=QuestionnaireResponse:subject:Patient

If used, the patient demographic details will appear at the bottom of the response.

NB. Search parameters are currently in development so not available yet.

Can we make changes to the questionnaire templates in PKB ourselves?

No. The Questionnaire templates are configured and maintained by PKB. 

Requests must be made with at least a week's notice to allow the changes to be reviewed, configured and deployed. Once the change has been made by PKB, the questionnaire will be updated after the next release.