Understanding the API response

It is essential to understand the response from the Smart Symptom Checker to build a responsive User Interface for your application or service that presents messages to the end users, as well as allowing them to respond to free text or multiple-choice questions.

This guide describes the structure of the response, the data the elements may contain, and when they are included in the response.

A more technical overview of the API Response is described in the API Response Schema.

Question

A question asks for input from the user, as a choice of one or more options from a list.

Messages

A message is information presented to the user as a part of a question.

Choices

The answers to the question that a user can choose.

Conversation

Step back possible

Whether or not to show the back button. Only in some scenario this is possible.

Conversation progress

Information that would allow you to render a project bar, offering a name as a stage property and an integer from 0 to 100 named percentage

Conversation ended

This flags whether the conversation has ended. Most times, this is always true when the report is also possible, but the conversation might end early without a full report.

Report Possible

This flags whether a final consultation report is possible. When true, you should call the report endpoint to fetch the report.

Report

At the end of an assessment, a Consultation Report is generated. See Consultation Report for further information.