Overview
The following is a use case example for administrating an M3 in your application and returning a user score. The M3 score indicates the overall level of mental health symptom burden. A score greater than 32 is
flagged as High.
Notes:
To access Mental Fitness M3 score functionality, please contact Sonde at support@sondehealth.com. Please provide your company name and contact information.
API Credentials
For all use cases, you should have the following information (the following values are examples only):
...
Call the /measures/name/{measureName}?variant=v2v1 API to check the questionnaire required for measure and list of languages in which the questionnaire is available on the API Platform.
...
| Anchor | ||||
|---|---|---|---|---|
|
Response3:
| Code Block |
|---|
{
"id": "msr_67rerf432a1484a355",
"name": "mental-fitnessm3",
"questionnaire": {
"id": "qnr_e23er432w-6b8428b25",
"title": "M3_V1",
"languages": [
"en"
]
},
} "requestId": "1607c153-6689-41c6-b90b-e5d9c44bfe00"
} |
questionnaire.id and questionnaire.languages are required in STEP 4.
...
| Anchor | ||||
|---|---|---|---|---|
|
Response4:
Note: Your app should not have string matching logic on questions[].text. Sonde can edit this text.
| Code Block |
|---|
{
"id": "qnr-8a110a405_e23er432w",
"title": "M3_V1",
"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": "Not at allRarely",
"score": 0
},
{
1
},
{
"text": "RarelySometimes",
"score": 1
},
{
2
},
{
"text": "Some timeOften",
"score": 2
},
{
3
},
{
"text": "Often",Most of the time",
"score": 4
}
]
},
"score {
"type": 3
},
{
"MULTIPLE_CHOICE",
"text": "I can't concentrate or focus",
"isSkippable": false,
"options": [
{
"text": "MostNot ofat the timeall",
"score": 4
}
]
},
{
"type": "MULTIPLE_CHOICE",
0
},
{
"text": "Rarely",
"score": 1
},
{
"text": "Sometimes",
"score": 2
},
{
"text": "I can't concentrate or focusOften",
"isSkippable": false,
"options": [
{
"text": "Not at all",
"score": 0
},
{
"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 timeSometimes",
"score": 2
},
{
{
"text": "Often",
"score": 3
},
{
"text": "Most of the },
{
"text": "Most of the time",
"time",
"score": 4
}
]
},
{
}
]
},
{
"type": "MULTIPLE_CHOICE",
"text": "NothingI seemsfeel totired; givehave meno much pleasureenergy",
"isSkippable": false,
"options": [
{
{
"text": "Not at all",
"score": 0
},
{
{
"text": "Rarely",
"score": 1
},
{
{
"text": "Some timeSometimes",
"score": 2
},
{
{
"text": "Often",
"score": 3
},
{
},
{
"text": "Most of the time",
"score": 4
}
]
},
{
}
]
},
{
"type": "MULTIPLE_CHOICE",
"text": "I feelhave tired;had havethoughts noof energysuicide",
"isSkippable": false,
"options": [
{
{
"text": "Not at all",
"score": 0
},
{
{
"text": "Rarely",
"score": 1
},
{
},
{
"text": "Some timeSometimes",
"score": 2
},
{
{
"text": "Often",
"score": 3
},
{
},
{
"text": "Most of the time",
"score": 4
}
]
},
{
}
]
},
{
"type": "MULTIPLE_CHOICE",
"text": "I have had thoughts of suicidedifficulty sleeping",
"isSkippable": false,
"options": [
{
{
"text": "Not at all",
"score": 0
},
{
{
"text": "Rarely",
"score": 1
},
{
},
{
"text": "Some timeSometimes",
"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 timeSometimes",
"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 timeSometimes",
"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,
am eating more",
"isSkippable": false,
"options": [
{
{
"text": "Not at all",
"score": 0
},
{
{
"text": "Rarely",
"score": 1
},
{
{
"text": "Some timeSometimes",
"score": 2
},
{
{
"text": "Often",
"score": 3
},
{
{
"text": "Most of the time",
"score": 4
}
]
},
{
}
]
},
{
"type": "MULTIPLE_CHOICE",
"text": "I feel worried or fearful"tense, anxious or can't sit still",
"isSkippable": false,
"options": [
{
{
"text": "Not at all",
"score": 0
},
{
{
"text": "Rarely",
"score": 1
},
{
{
"text": "Some timeSometimes",
"score": 2
},
{
{
"text": "Often",
"score": "score": 3
},
{
3
},
{
"text": "Most of the time",
"score": 4
}
]
},
{
}
]
},
{
"type": "MULTIPLE_CHOICE",
"text": "I have attacks of anxiety or panic",
"text": "I feel worried or fearful",
"isSkippable": false,
"options": [
{
{
"text": "Not at all",
"score": 0
},
{
"text": {
"Rarely",
"score": 1
},
{
"text": "RarelySometimes",
"score": 1
},
{
2
},
{
"text": "Some timeOften",
"score": 2
},
{
"text": "Often",
"score": 3
},
{
3
},
{
"text": "Most of the time",
"score": 4
}
]
},
{
"type": "MULTIPLE_CHOICE",
"text": "I have attacks of anxiety or panic",
"isSkippable": false,
"options": [
{
"text": "MostNot ofat the timeall",
"score": 4
}
]
},
{
"type": "MULTIPLE_CHOICE",
0
},
{
"text": "Rarely",
"score": 1
},
{
"text": "I worry about dying or losing controlSometimes",
"score": 2
},
"isSkippable {
"text": false,
"options"Often",
"score": [
{
3
},
{
"text": "NotMost atof allthe time",
"score": 04
}
]
},
{
"text {
"type": "RarelyMULTIPLE_CHOICE",
"text": "I worry about dying or losing control",
"isSkippable": false,
"scoreoptions": 1[
{
"text": "Not at all",
"score": 0
},
{
{
"text": "Some timeRarely",
"score": 2
},
{
1
},
{
"text": "OftenSometimes",
"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": "RarelySometimes",
"score": 1
},
{
2
},
{
"text": "Some timeOften",
"score": 2
},
{
3
},
{
"text": "Often",Most of the time",
"score": 34
}
]
},
{
{
"type": "MULTIPLE_CHOICE",
"text": "MostI ofhave thenightmares or timeflashbacks",
"isSkippable": false,
"options": [
{
"text": "Not at all",
"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
},
{
0
},
{
"text": "Rarely",
"score": 1
},
{
"text": "Sometimes",
"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": "Sometimes",
"score": 2
},
{
"text": "Often",
"score": 3
},
{
"text": "Most of the time",
"score": 4
}
]
},
{
}
]
},
{
"type": "MULTIPLE_CHOICE",
"text": "I avoid places amthat jumpyremind orof feela startledbad easilyexperience",
"isSkippable": false,
"options": [
{
{
"text": "Not at all",
"score": 0
},
{
{
"text": "Rarely",
"score": 1
},
{
{
"text": "Some timeSometimes",
"score": 2
},
{
{
"text": "Often",
"score": 3
},
{
{
"text": "Most of the time",
"score": 4
}
}
]
},
{
" ]
},
{
"type": "MULTIPLE_CHOICE",
"text": "I avoidfeel placesdull, thatnumb, remind of a bad experienceor detached",
"isSkippable": false,
"options": [
{
{
"text": "Not at all",
"score": 0
},
{
{
"text": "Rarely",
"score": 1
},
{
{
"text": "Some timeSometimes",
"score": 2
},
{
},
{
"text": "Often",
"score": 3
},
{
{
"text": "Most of the time",
"score": 4
}
}
]
},
{
]
},
{
"type": "MULTIPLE_CHOICE",
"text": "I feel dull,numb, or detached",
can't get certain thoughts out of my mind",
"isSkippable": false,
"options": [
{
{
"text": "Not at all",
"score": "score": 0
},
{
0
},
{
"text": "Rarely",
"score": 1
},
{
{
"text": "Some timeSometimes",
"score": 2
},
{
{
"text": "Often",
"score": 3
},
{
{
"text": "Most of the time",
"score": "score": 4
}
]
},
{
4
}
]
},
{
"type": "MULTIPLE_CHOICE",
"text": "I can'tfeel getI certainmust thoughtsrepeat outcertain ofacts myor mindrituals",
"isSkippable": false,
"options": [
{
"text": {
"text": "Not "Not at all",
"score": 0
},
{
{
"text": "Rarely",
"score": 1
},
{
{
"text": "Some timeSometimes",
"score": 2
},
{
{
"text": "Often",
"score": 3
},
{
"text": "Most of },
{
"text": "Most of the the time",
"score": 4
}
]
},
{
}
]
},
{
"type": "MULTIPLE_CHOICE",
"text": "I feel Ithe mustneed repeatto certaincheck actsand orrecheck ritualsthings",
"isSkippable": false,
"options": [
{
{
"text": "Not at all",
"score": 0
},
{
{
"text": "Rarely",
"score": 1
},
{
{
"text": "Some timeSometimes",
"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": "Most of the time",
"score": 4
}
]
},
{
"type": "MULTIPLE_CHOICE",
"text": "I have more energy than usual",
"isSkippable": false,
"options": [
{
"text": "Not at all",
"score": 0
},
{
"text": "Rarely",
"score": 1
},
{
{
"text": "Some timeSometimes",
"score": 2
},
{
: 2
},
{
"text": "Often",
"score": 3
},
{
"text": "Most of the time",
"score": 34
}
]
},
{
"type": {
"MULTIPLE_CHOICE",
"text": "I have felt unusually irritable or angry",
"isSkippable": false,
"options": [
{
"text": "MostNot ofat the timeall",
"score": 4
}
]
},
{
"type": "MULTIPLE_CHOICE",
0
},
{
"text": "Rarely",
"score": 1
},
{
"text": "I have needed less sleep than usualSometimes",
"score": 2
},
"isSkippable {
"text": false,
"options"Often",
"score": [
{
3
},
{
"text": "NotMost of atthe alltime",
"score": 4
}
]
},
{
"type": "score"MULTIPLE_CHOICE",
"text": 0"I have felt unusually excited, revved up or }high",
"isSkippable": false,
"options": {
[
{
"text": "Not at all",
"score": 0
},
{
"text": "Rarely",
"score": 1
},
{
{
"text": "Some timeSometimes",
"score": 2
},
{
: 2
},
{
"text": "Often",
"score": 3
},
{
{
"text": "Most of the time",
"score": 4
}
]
},
{
"score": 4
}
]
},
{
"type": "MULTIPLE_CHOICE",
"text": "SelectI fromhave theneeded optionless whethersleep any or the above symptoms interferes with work or school",
than usual",
"isSkippable": false,
"options": [
{
"options": [
{
"text": "Not at all",
"score": 0
},
{
{
"text": "Rarely",
"score": 1
},
{
},
{
"text": "Some timeSometimes",
"score": 2
},
{
{
"text": "Often",
"score": 3
},
{
"score": 3
},
{
"text": "Most of the time",
"score": 4
}
]
},
{
"type": "score"MULTIPLE_CHOICE",
"text": 4"interferes with work or school",
"isSkippable": false,
"options": [
}
]
},
{
"type": "MULTIPLE_CHOICE",
{
"text": "Not at all",
"score": 0
},
{
"text": "Rarely",
"score": 1
},
{
"text": "affects my relationships with friends or familySometimes",
"score": 2
},
"isSkippable {
"text": false,
"options"Often",
"score": [
{
3
},
{
"text": "NotMost of atthe alltime",
"score": 04
}
},
{
"text ]
},
{
"type": "RarelyMULTIPLE_CHOICE",
"text": "affects my relationships with friends or "scorefamily",
"isSkippable": 1
},
{
false,
"options": [
{
"text": "SomeNot at timeall",
"score": 0
},
{
"text": "Rarely",
"score": 2
},
{
1
},
{
"text": "OftenSometimes",
"score": 3
},
{
2
},
{
"text": "Often",
"score": 3
},
{
"text": "Most of the time",
"score": 4
}
]
},
{
}
]
},
{
"type": "MULTIPLE_CHOICE",
"text": "has led to my using alcohol to otherget substancesby",
"isSkippable": false,
"isSkippable": false,
"options": [
{
{
"text": "Not at all",
"score": 0
},
{
{
"text": "Rarely",
"score": 1
},
{
"score": 1
},
{
"text": "Some timeSometimes",
"score": 2
},
{
{
"text": "Often",
"score": 3
},
{
3
},
{
"text": "Most of the time",
"score": 4
}
]
},
{
}
]
},
{
"type": "MULTIPLE_CHOICE",
"text": "has led to my using alcohol to get by",
led to my using other substances",
"isSkippable": false,
"options": [
{
{
"text": "Not at all",
"score": 0
},
{
{
"text": "Rarely",
"Rarely",
"score": 1
},
{
{
"text": "Some timeSometimes",
"score": 2
},
{
{
"text": "Often",
,
"score": 3
},
{
{
"text": "Most of the time",
"score": 4
}
]
}
],
}
]
}
],
"requestId": "3c11160bc8c176f9-6e501225-4e754929-9498a03a-f44e5f554ad3c4c561babdaf"
} |
STEP 5: SUBMIT QUESTIONNAIRE RESPONSE TO SERVER
...
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.
...
| Code Block |
|---|
{
"requestId": "3c45dc08405e",
"state": "CONSTRUCTED",
"id": "scr_34redf451",
"score": 18,
"type": "MultiScore",
"functionalImpairment" : 0,
"suicidalIdeation": 0,
"subScore": [
{
"id": "scr_34redf2232",
"disorderName": "Depression",
"score": {
"value": 5
}
},
{
"id": "scr_34redf2233",
"disorderName": "Bipolar",
"score": {
"value": 4
}
},
{
"id": "scr_34redf2234",
"disorderName": "Anxiety",
"score": {
"value": 3
}
},
{
"id": "scr_34redf2235",
"disorderName": "PTSD",
"score": {
"value": 6
}
}
],
"measure": {
"id": "msr_67rerf231",
"name": "m3",
"variant": "v1"
}
} |
...