Overview
The following use cases (with curl language examples) are a guide for your app development. To return a questionnaire score for a user.
Notes:
To access Mental Fitness M3 Questionnaire Score, please contact Sonde at support@sondehealth.com. Please provide your company name and address.
API Credentials
For all use-cases, you should have the following information (the following values are examples only):
Refer to Account for detail on how to create an account with Sonde and obtain below client-id & client-secret.
...
For a list of supported scopes, please check the schema in the Authentication section of the API Documentation REST API Reference.
For a list of scopes required for Scoring refer to Authentication Scopes
Using the generated access-token, you can access Sonde Platform’s Services.
...
Get the access-token with scopes sonde-platform/scores.write
, sonde-platform/users.write
and sonde-platform/storage.write
.
...
Use "access_token"
to register a user. Put the value of access_token
into the Authorization
header (refer to the below curl command).
...
Anchor | ||||
---|---|---|---|---|
|
Response4:
Note: Your app should not have string matching logic on questions[].text. Sonde can edit this text.
Code Block |
---|
{ "id": "qnr-8a110a405", "title": "M3", "language": "en", "questions": [ { "type": "MULTIPLE_CHOICE", "text": "Over the last two weeks or more, have you noticed the following (for each question select the answer that best applies to you). I feel sad, down in the dumps or unhappy", "isSkippable": false, "options": [ { "text": "Not at all", "score": 0 }, { "text": "Rarely", "score": 1 }, { "text": "Some time", "score": 2 }, { "text": "Often", "score": 3 }, { "text": "Most of the time", "score": 4 } ] }, { "type": "MULTIPLE_CHOICE", "text": "I can't concentrate or focus", "isSkippable": false, "options": [ { "text": "Not at all", "score": 0 }, { "text": "Rarely", "score": 1 }, { "text": "Some time", "score": 2 }, { "text": "Often", "score": 3 }, { "text": "Most of the time", "score": 4 } ] }, { "type": "MULTIPLE_CHOICE", "text": "Nothing seems to give me much pleasure", "isSkippable": false, "options": [ { "text": "Not at all", "score": 0 }, { "text": "Rarely", "score": 1 }, { "text": "Some time", "score": 2 }, { "text": "Often", "score": 3 }, { "text": "Most of the time", "score": 4 } ] }, { "type": "MULTIPLE_CHOICE", "text": "I feel tired; have no energy", "isSkippable": false, "options": [ { "text": "Not at all", "score": 0 }, { "text": "Rarely", "score": 1 }, { "text": "Some time", "score": 2 }, { "text": "Often", "score": 3 }, { "text": "Most of the time", "score": 4 } ] }, { "type": "MULTIPLE_CHOICE", "text": "I have had thoughts of suicide", "isSkippable": false, "options": [ { "text": "Not at all", "score": 0 }, { "text": "Rarely", "score": 1 }, { "text": "Some time", "score": 2 }, { "text": "Often", "score": 3 }, { "text": "Most of the time", "score": 4 } ] }, { "type": "MULTIPLE_CHOICE", "text": "I have difficulty sleeping or I sleep too much", "isSkippable": false, "options": [ { "text": "Not at all", "score": 0 }, { "text": "Rarely", "score": 1 }, { "text": "Some time", "score": 2 }, { "text": "Often", "score": 3 }, { "text": "Most of the time", "score": 4 } ] }, { "type": "MULTIPLE_CHOICE", "text": "I have lost some appetite or I am eating more", "isSkippable": false, "options": [ { "text": "Not at all", "score": 0 }, { "text": "Rarely", "score": 1 }, { "text": "Some time", "score": 2 }, { "text": "Often", "score": 3 }, { "text": "Most of the time", "score": 4 } ] }, { "type": "MULTIPLE_CHOICE", "text": "I feel tense, anxious or can't sit still", "isSkippable": false, "options": [ { "text": "Not at all", "score": 0 }, { "text": "Rarely", "score": 1 }, { "text": "Some time", "score": 2 }, { "text": "Often", "score": 3 }, { "text": "Most of the time", "score": 4 } ] }, { "type": "MULTIPLE_CHOICE", "text": "I feel worried or fearful", "isSkippable": false, "options": [ { "text": "Not at all", "score": 0 }, { "text": "Rarely", "score": 1 }, { "text": "Some time", "score": 2 }, { "text": "Often", "score": 3 }, { "text": "Most of the time", "score": 4 } ] }, { "type": "MULTIPLE_CHOICE", "text": "I have attacks of anxiety or panic", "isSkippable": false, "options": [ { "text": "Not at all", "score": 0 }, { "text": "Rarely", "score": 1 }, { "text": "Some time", "score": 2 }, { "text": "Often", "score": 3 }, { "text": "Most of the time", "score": 4 } ] }, { "type": "MULTIPLE_CHOICE", "text": "I worry about dying or losing control", "isSkippable": false, "options": [ { "text": "Not at all", "score": 0 }, { "text": "Rarely", "score": 1 }, { "text": "Some time", "score": 2 }, { "text": "Often", "score": 3 }, { "text": "Most of the time", "score": 4 } ] }, { "type": "MULTIPLE_CHOICE", "text": "I am nervous or shaky in social situations", "isSkippable": false, "options": [ { "text": "Not at all", "score": 0 }, { "text": "Rarely", "score": 1 }, { "text": "Some time", "score": 2 }, { "text": "Often", "score": 3 }, { "text": "Most of the time", "score": 4 } ] }, { "type": "MULTIPLE_CHOICE", "text": "I have nightmares or flashbacks", "isSkippable": false, "options": [ { "text": "Not at all", "score": 0 }, { "text": "Rarely", "score": 1 }, { "text": "Some time", "score": 2 }, { "text": "Often", "score": 3 }, { "text": "Most of the time", "score": 4 } ] }, { "type": "MULTIPLE_CHOICE", "text": "I am jumpy or feel startled easily", "isSkippable": false, "options": [ { "text": "Not at all", "score": 0 }, { "text": "Rarely", "score": 1 }, { "text": "Some time", "score": 2 }, { "text": "Often", "score": 3 }, { "text": "Most of the time", "score": 4 } ] }, { "type": "MULTIPLE_CHOICE", "text": "I avoid places that remind of a bad experience", "isSkippable": false, "options": [ { "text": "Not at all", "score": 0 }, { "text": "Rarely", "score": 1 }, { "text": "Some time", "score": 2 }, { "text": "Often", "score": 3 }, { "text": "Most of the time", "score": 4 } ] }, { "type": "MULTIPLE_CHOICE", "text": "I feel dull,numb, or detached", "isSkippable": false, "options": [ { "text": "Not at all", "score": 0 }, { "text": "Rarely", "score": 1 }, { "text": "Some time", "score": 2 }, { "text": "Often", "score": 3 }, { "text": "Most of the time", "score": 4 } ] }, { "type": "MULTIPLE_CHOICE", "text": "I can't get certain thoughts out of my mind", "isSkippable": false, "options": [ { "text": "Not at all", "score": 0 }, { "text": "Rarely", "score": 1 }, { "text": "Some time", "score": 2 }, { "text": "Often", "score": 3 }, { "text": "Most of the time", "score": 4 } ] }, { "type": "MULTIPLE_CHOICE", "text": "I feel I must repeat certain acts or rituals", "isSkippable": false, "options": [ { "text": "Not at all", "score": 0 }, { "text": "Rarely", "score": 1 }, { "text": "Some time", "score": 2 }, { "text": "Often", "score": 3 }, { "text": "Most of the time", "score": 4 } ] }, { "type": "MULTIPLE_CHOICE", "text": " I feel the need to check and recheck things", "isSkippable": false, "options": [ { "text": "Not at all", "score": 0 }, { "text": "Rarely", "score": 1 }, { "text": "Some time", "score": 2 }, { "text": "Often", "score": 3 }, { "text": "Most of the time", "score": 4 } ] }, { "type": "MULTIPLE_CHOICE", "text": "Have you ever noticed the following? I have more energy than usual", "isSkippable": false, "options": [ { "text": "Not at all", "score": 0 }, { "text": "Rarely", "score": 1 }, { "text": "Some time", "score": 2 }, { "text": "Often", "score": 3 }, { "text": "Most of the time", "score": 4 } ] }, { "type": "MULTIPLE_CHOICE", "text": "I have felt unusually irritable or angry", "isSkippable": false, "options": [ { "text": "Not at all", "score": 0 }, { "text": "Rarely", "score": 1 }, { "text": "Some time", "score": 2 }, { "text": "Often", "score": 3 }, { "text": "Most of the time", "score": 4 } ] }, { "type": "MULTIPLE_CHOICE", "text": "I have felt unusually excited,rewed up or high", "isSkippable": false, "options": [ { "text": "Not at all", "score": 0 }, { "text": "Rarely", "score": 1 }, { "text": "Some time", "score": 2 }, { "text": "Often", "score": 3 }, { "text": "Most of the time", "score": 4 } ] }, { "type": "MULTIPLE_CHOICE", "text": "I have needed less sleep than usual", "isSkippable": false, "options": [ { "text": "Not at all", "score": 0 }, { "text": "Rarely", "score": 1 }, { "text": "Some time", "score": 2 }, { "text": "Often", "score": 3 }, { "text": "Most of the time", "score": 4 } ] }, { "type": "MULTIPLE_CHOICE", "text": "Select from the option whether any or the above symptoms interferes with work or school", "isSkippable": false, "options": [ { "text": "Not at all", "score": 0 }, { "text": "Rarely", "score": 1 }, { "text": "Some time", "score": 2 }, { "text": "Often", "score": 3 }, { "text": "Most of the time", "score": 4 } ] }, { "type": "MULTIPLE_CHOICE", "text": "affects my relationships with friends or family", "isSkippable": false, "options": [ { "text": "Not at all", "score": 0 }, { "text": "Rarely", "score": 1 }, { "text": "Some time", "score": 2 }, { "text": "Often", "score": 3 }, { "text": "Most of the time", "score": 4 } ] }, { "type": "MULTIPLE_CHOICE", "text": "has led to my using other substances", "isSkippable": false, "options": [ { "text": "Not at all", "score": 0 }, { "text": "Rarely", "score": 1 }, { "text": "Some time", "score": 2 }, { "text": "Often", "score": 3 }, { "text": "Most of the time", "score": 4 } ] }, { "type": "MULTIPLE_CHOICE", "text": "has led to my using alcohol to get by", "isSkippable": false, "options": [ { "text": "Not at all", "score": 0 }, { "text": "Rarely", "score": 1 }, { "text": "Some time", "score": 2 }, { "text": "Often", "score": 3 }, { "text": "Most of the time", "score": 4 } ] } ], "requestId": "3c11160b-6e50-4e75-9498-f44e5f554ad3" } |
...
It should be available on Server
It should be questionnaire responses for the M3 questionnaire
Note: Your app should gracefully handle any extra validation which may be added in future releases of the Sonde API Platform.
Replace <questionnaireResponseId>
with the value of id
attribute of Response5.
...