Doctorlink has joined HealthHerohealthheroLearn More
doctorlink
  • Home
  • Authentication
  • Traversal API
  • Example Responses
  • Traversal Client
  • Health Risk Assessment API
  • Advanced Techniques

Answer

Answers arrive in the response on a question. These are the data points that all algorithms require to identify the next question.

1{
2	"answerId": int,
3	"controlChecked": bool,
4	"controlType": "string",
5	"controlValue": "string",
6	"data": {},
7	"displayText": "string",
8	"explanation": "string",
9	"nodeId": int,
10	"questionId": int
11}

AnswerId : Unique Id of this answer.

ControlChecked : A boolean describing the checked state of a Checkbox or Radio answer.

ControlType : An enum value, as a string, representing the type of answer. Checkbox, Radio, Text, Number, Date, Range, and Hidden.

ControlValue : Value of the input to display in a Text, Number, or Date answer. Values in a Date answer will be in ISO 8601 format YYYY-MM-DD.

Data : A JSON object . This can be used to tell the UI any special requirements, or simply as a system notification.

DisplayText : Answer text, for example, for radio button labels.

Explanation : A more in-depth message to the user usually shown as a clickable information icon (:information_source:).

NodeId : Unique Id of the node.

QuestionId : Unique Id of the question.

Min : A nullable double only used on Range answer type to set the min value. Reference

Max : A nullable double only used on Range answer type to set the max value. Reference