Health questionnaire API

Overview

Most telehealth visits typically collect a series of clinical related questions prior to a provider consult. These questions are bundled into an object known as the patient questionnaire in the Truepill ecosystem. These questionnaires are most commonly based on a specific therapy area or disease state that the patient is inquiring abouthealth questionnaires can range in complexity from a 3-step yes/no screening questionnaire to more complex 30+ questions with various question types, file/data uploads and answer-based branching logic.

Question types

The health Questionnaire supports a range of questions types for your specific needs. The most commonly used question types are listed below:

TypeDefinition
free_textFree text answer to capture answer in string format
multiple_choiceMultiple choice questions with answers stored in array format
dateDate provided as string, formatted `MM-DD-YYYY`
numericFree text that only allows for numeric answers
file_uploadDocumentation or image required
checkboxTrue/False values with answers stored in array format


Question type examples

Below are a series of clinical and survey questions that have been translated into a Question object. A PatientQuestionnaire consists of multiple Questions.


Question: How would you describe your overall health? (multiple choice)

  • Excellent
  • Good
  • Fair
  • Poor

Success response

Copied!

List any trips to emergency room, hospital admissions or surgical procedures In the last 12 months (free text)

Success response

Copied!

Question: How often do you test your blood sugar in a given month? (numeric)

Success response

Copied!

Question: When was the last time you tested your blood sugar? (date)

Success response

Copied!

Question: Please mark all answers that apply to your current overall health condition and symptoms [check all that apply] (checkbox)

  • I am unable to go up and down stairs
  • I lose control of my urine and get wet
  • I have chest pain or shortness of breath when I do work or exercise
  • I have had temporary loss of vision in one eye
  • I have pain in my legs that makes me stop when I walk

Success response

Copied!

Create health questionnaire

A health questionnaire can be created using our /telehealth/health_questionnaire API endpoint. Truepill will provide a receipt confirmation of the request, and you will be required to reference your health_questionnaire_id when creating or updating a patient record.

Create a health questionnaire

Node

cUrl

Copied!

Success response

Copied!

Updating a health questionnaire

There are timing dependencies that distance when you can update your health questionnaire.

You currently cannot update a health questionnaire after it has been created and used for a provider consult. You may however update your health questionnaire at any point before it has been used for a consult. This ensures that any historical provider consults are anchored to a specifichealth questionnaire that cannot be changed after the consult has taken place. This preserves the data in our EHR, maintaining the actualhealth questionnaire used during a consult which is important for both compliance and quality purposes. In other words, you cannot change the questions/details of ahealth questionnaire after it has been used for a real consult.

If you need to make edits or updates to yourhealth questionnaire after it has been used for a consult, you can simply create a new one and reference that patient_questionnaire_id for future consult requests.

Update health questionnaire

Node

cUrl

Copied!

Success response

Copied!

Submit answers to a health questionnaire

You can submit answers to your health questionnaire using the /telehealth/patient_record_questionnaire API endpoint. Truepill will provide a receipt confirmation of the request. You must submit a valid answer for all required questions in your questionnaire. Additionally, when you submit answers to your questionnaire, you must also provide a valid patient_record_token as this is the first point where you are mapping the provided answers (form your patient) to your patient record.

Submit health questionnaire answers

Node

cUrl

Copied!

Success response

Copied!

Branching logic

Overview

Questions presented to a patient may depend on the answer to previous questions. The multiple_choice, checkbox and numeric question types can have properties that specify the branching logic for your next question. This is accomplished using a next_question_id parameter in your answer block.

When next_question_id is not present for a given answer, the questionnaire will default to the default_next_question_id value.

Multiple choice example

Success response

Copied!

Checkbox example

Success response

Copied!

Numeric example

Success response

Copied!