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

Question summary

The question summary endpoint (ReDoc) allows you to get a full list of questions the user has seen on their journey through the product. This will exclude questions that were Preanswered by injecting history.

1curl ".../{tenantId}/Traversals/{traversalId}/questions" \
2  -X "GET" \
3  -H "Authorization: Bearer ACCESS_TOKEN" \

Using this data packet you can allow users to revisit questions they've seen, and re-answer them, with the exception of nodes that specifically request you not to allow it in the response's previousDisabled property. Once you've received a node with previousDisabled: true you should not allow the user to go back to any previous questions.

The summary could look something like this:

question-summary.png

This actionable summary was made using the below sample code. This sample contains all the seen questions and all the answers, including non-selected answers. This is because you may want to show the negatives (the answers not selected) as well the positives (the answers selected).

1[
2  {
3    algoId: 2,
4    nodeId: 163,
5    assetId: 70,
6    groupId: 200157,
7    displayText: "Gender:",
8    summaryText: "Gender",
9    clinicalText: "Gender",
10    nodeTypeId: 34,
11    nodeType: "GenderCheck",
12    state: "Permanent",
13    answers: [
14      {
15        id: "8cd74ac9-77b8-4d5c-ab3b-a017a71b5cc6",
16        traversalId: "34dd96f3-9fd7-4514-8587-1039de86039a",
17        algoId: 2,
18        groupId: 200157,
19        nodeId: 163,
20        assetId: 70,
21        nodeTypeId: 34,
22        nodeType: "GenderCheck",
23        answerId: 88,
24        nextNodeId: 160,
25        value: null,
26        counter: 0.0,
27        previousCounter: 0.0,
28        createdDateTime: "2020-07-16T14:24:57.0767514Z",
29        displayText: "Male",
30        summaryText: "Male",
31        clinicalText: "Male",
32        isAnswered: true,
33      },
34      {
35        id: "1fdc4119-c007-4c16-98cc-e7076cb9e80d",
36        traversalId: "34dd96f3-9fd7-4514-8587-1039de86039a",
37        algoId: 2,
38        groupId: 200157,
39        nodeId: 163,
40        assetId: 70,
41        nodeTypeId: 34,
42        nodeType: "GenderCheck",
43        answerId: 89,
44        nextNodeId: 160,
45        value: null,
46        counter: 0.0,
47        previousCounter: 0.0,
48        createdDateTime: "2020-07-16T14:24:57.0767514Z",
49        displayText: "Female",
50        summaryText: "Female",
51        clinicalText: "Female",
52        isAnswered: false,
53      },
54    ],
55  },
56  {
57    algoId: 2,
58    nodeId: 160,
59    assetId: 19063,
60    groupId: 200157,
61    displayText: "Enter the patient's date of birth",
62    summaryText: "Enter your date of birth",
63    clinicalText: "Enter your date of birth",
64    nodeTypeId: 35,
65    nodeType: "AgeCheck",
66    state: "Permanent",
67    answers: [
68      {
69        id: "6efb2494-a1b5-46f1-9fe8-4781710be170",
70        traversalId: "34dd96f3-9fd7-4514-8587-1039de86039a",
71        algoId: 2,
72        groupId: 200157,
73        nodeId: 160,
74        assetId: 19063,
75        nodeTypeId: 35,
76        nodeType: "AgeCheck",
77        answerId: 19225,
78        nextNodeId: 1000160,
79        value: "1980-01-01",
80        counter: 0.0,
81        previousCounter: 0.0,
82        createdDateTime: "2020-07-16T14:24:57.0767514Z",
83        displayText: "DOB (dd/mm/yyyy).",
84        summaryText: "*",
85        clinicalText: "Age enter",
86        isAnswered: true,
87      },
88    ],
89  },
90  {
91    algoId: 2,
92    nodeId: 2,
93    assetId: 3200,
94    groupId: 0,
95    displayText: "What kind of health assessment would you like to complete?",
96    summaryText: "",
97    clinicalText: "Health assessment choice",
98    nodeTypeId: 32,
99    nodeType: "Exclusive",
100    state: "Transient",
101    answers: [
102      {
103        id: "4c12e16e-9058-46fc-90ed-55e6621c910e",
104        traversalId: "34dd96f3-9fd7-4514-8587-1039de86039a",
105        algoId: 2,
106        groupId: 0,
107        nodeId: 2,
108        assetId: 3200,
109        nodeTypeId: 32,
110        nodeType: "Exclusive",
111        answerId: 3810,
112        nextNodeId: 42,
113        value: null,
114        counter: 0.0,
115        previousCounter: 0.0,
116        createdDateTime: "2020-07-16T14:25:06.6942046Z",
117        displayText: "Full health risk and well-being assessment",
118        summaryText: "Full health risk and well-being assessment",
119        clinicalText: "Full health risk and well-being assessment",
120        isAnswered: true,
121      },
122      {
123        id: "fb37ff59-bda0-48b4-b053-473f5f65e498",
124        traversalId: "34dd96f3-9fd7-4514-8587-1039de86039a",
125        algoId: 2,
126        groupId: 0,
127        nodeId: 2,
128        assetId: 3200,
129        nodeTypeId: 32,
130        nodeType: "Exclusive",
131        answerId: 3813,
132        nextNodeId: 8,
133        value: null,
134        counter: 0.0,
135        previousCounter: 0.0,
136        createdDateTime: "2020-07-16T14:25:06.6942046Z",
137        displayText: "A specific well-being assessment",
138        summaryText: "A specific well-being assessment",
139        clinicalText: "A specific well-being assessment",
140        isAnswered: false,
141      },
142      {
143        id: "c0c12f4c-b5dc-46b6-b296-71a0e6dabab3",
144        traversalId: "34dd96f3-9fd7-4514-8587-1039de86039a",
145        algoId: 2,
146        groupId: 0,
147        nodeId: 2,
148        assetId: 3200,
149        nodeTypeId: 32,
150        nodeType: "Exclusive",
151        answerId: 3814,
152        nextNodeId: 23,
153        value: null,
154        counter: 0.0,
155        previousCounter: 0.0,
156        createdDateTime: "2020-07-16T14:25:06.6942046Z",
157        displayText: "A specific health risk assessment",
158        summaryText: "A specific health risk assessment",
159        clinicalText: "A specific health risk assessment",
160        isAnswered: false,
161      },
162    ],
163  },
164  {
165    algoId: 3865,
166    nodeId: 343,
167    assetId: 1508,
168    groupId: 0,
169    displayText:
170      "In general, compared to other people your age, would you say your health is:",
171    summaryText:
172      "Compared to others of the same age, self-perceived health status is rated as",
173    clinicalText:
174      "Self-perceived health status compared to others the same age",
175    nodeTypeId: 32,
176    nodeType: "Exclusive",
177    state: "Transient",
178    answers: [
179      {
180        id: "62941f49-838d-4b20-9144-a15b20d2b631",
181        traversalId: "34dd96f3-9fd7-4514-8587-1039de86039a",
182        algoId: 3865,
183        groupId: 0,
184        nodeId: 343,
185        assetId: 1508,
186        nodeTypeId: 32,
187        nodeType: "Exclusive",
188        answerId: 4934,
189        nextNodeId: 1598,
190        value: null,
191        counter: 0.0,
192        previousCounter: 0.0,
193        createdDateTime: "2020-07-16T14:25:10.2772843Z",
194        displayText: "Excellent",
195        summaryText: "Excellent",
196        clinicalText: "Excellent",
197        isAnswered: false,
198      },
199      {
200        id: "2c2f712c-7587-4618-8fc3-22e85ef706de",
201        traversalId: "34dd96f3-9fd7-4514-8587-1039de86039a",
202        algoId: 3865,
203        groupId: 0,
204        nodeId: 343,
205        assetId: 1508,
206        nodeTypeId: 32,
207        nodeType: "Exclusive",
208        answerId: 10553,
209        nextNodeId: 1598,
210        value: null,
211        counter: 0.0,
212        previousCounter: 0.0,
213        createdDateTime: "2020-07-16T14:25:10.2772843Z",
214        displayText: "Very good",
215        summaryText: "Very good",
216        clinicalText: "Very Good",
217        isAnswered: false,
218      },
219      {
220        id: "9f24f86f-d168-42f9-96b2-92994aebc170",
221        traversalId: "34dd96f3-9fd7-4514-8587-1039de86039a",
222        algoId: 3865,
223        groupId: 0,
224        nodeId: 343,
225        assetId: 1508,
226        nodeTypeId: 32,
227        nodeType: "Exclusive",
228        answerId: 10554,
229        nextNodeId: 1598,
230        value: null,
231        counter: 0.0,
232        previousCounter: 0.0,
233        createdDateTime: "2020-07-16T14:25:10.2772843Z",
234        displayText: "Good",
235        summaryText: "Good",
236        clinicalText: "Good",
237        isAnswered: true,
238      },
239      {
240        id: "76253b66-35fe-44c2-8937-f66f7a70e474",
241        traversalId: "34dd96f3-9fd7-4514-8587-1039de86039a",
242        algoId: 3865,
243        groupId: 0,
244        nodeId: 343,
245        assetId: 1508,
246        nodeTypeId: 32,
247        nodeType: "Exclusive",
248        answerId: 10555,
249        nextNodeId: 1598,
250        value: null,
251        counter: 0.0,
252        previousCounter: 0.0,
253        createdDateTime: "2020-07-16T14:25:10.2772843Z",
254        displayText: "Fair",
255        summaryText: "Fair",
256        clinicalText: "Fair",
257        isAnswered: false,
258      },
259      {
260        id: "9d512f6d-7f5e-4c62-a3e4-75e895b9ca17",
261        traversalId: "34dd96f3-9fd7-4514-8587-1039de86039a",
262        algoId: 3865,
263        groupId: 0,
264        nodeId: 343,
265        assetId: 1508,
266        nodeTypeId: 32,
267        nodeType: "Exclusive",
268        answerId: 10556,
269        nextNodeId: 1598,
270        value: null,
271        counter: 0.0,
272        previousCounter: 0.0,
273        createdDateTime: "2020-07-16T14:25:10.2772843Z",
274        displayText: "Poor",
275        summaryText: "Poor",
276        clinicalText: "Poor",
277        isAnswered: false,
278      },
279    ],
280  },
281];