...
This page outlines the process of sending questionnaires requests questionnaire requests and retrieving the corresponding questionnaire responses to patients using PKB FHIR API, and how to retrieve the corresponding Questionnaire Responses.
Workflow
...
Sending questionnaire requests
The $send-questionnaire-request FHIR operation allows you to send a questionnaire requests request either to a few specific patients or to a whole team in one call.
...
Prerequisite: much like the other façade FHIR APIs, you need to be able to generate an access token (you can do so by following the OAuth 2.0 walkthrough).
In order to To send questionnaire requests, you need to chose choose which questionnaire you will send and find its corresponding id. This can be done by sending a request to our Questionnaire Search API, following this example. You will get all your questionnaires back and can find the appropriate questionnaire id.
...
On questionnaire request creation, PKB will notify the patient that they have been asked to fill in a questionnaire both by an email and a message in PKB. For this reason, you need to chose choose a PKB professional appear to have send these requests messages (although that is done automatically as part of the API)account from which these messages should appear to be from in the patient’s record. As of now, you need to get in touch with us to know the id ID of one of your clinicians clinician's professional accounts so that you can use them as a requestor in your API call.
Step 3: Make an API call
According to As per the specification, only two parameters are mandatory in the body of the request to make a call:
...
notificationFlag: this code parameter allows you to enable or disable email notification notifications sent to the requestor when a patient fills in a questionnaire response for this request. Accepted values are: ‘EMAIL_NOTIFICATION_ENABLED’ or ‘EMAIL_NOTIFICATION_DISABLED’. If no notificationFlag is provided, it defaults to enabled.
additionalIdentifier: if you are sending a request only to just one specific patient, you are allowed to add an additional identifier (for instance a business identifier coming from another softwareexample; a surgical order ID from the hospital clinical system), so that matching between the responses with to the data from your other software becomes is easy and can be automated.
Step 5: Read the response bundle
From the API call, you will get a response Bundle that encapsulate encapsulates all the questionnaire requests that were created in the form of a URL (ProcedureRequest/<id>). If something went wrong for any of the requests, you will get an error back explaining why the request could not have been created.
If you want to see in further details detail the Procedure Request that was created, you can do so by using the Procedure Request API, following this example.
...
If you added an additional identifier when sending the questionnaire request initially, you will be able to retrieve the questionnaire responses that specifically match this procedure request. These responses were created when patient patients clicked the link in the email they received for the questionnaire request and submitted a response, so generally, only one questionnaire response will match this identifier. However, if the patient clicks a second time on this link, they will be able to submit a second response matching the same Procedure Request identifier. The following diagram shows this workflow.
...