Sonde Health API Platform Documentation
Partner Questionnaire Integration with APIs
Overview
Partner applications integrating Sonde Vocal Biomarker scoring may also require asking questions and capturing responses to these questions. For example, an application using Sonde’s MF scores may also want to ask the two questions from the PHQ-2 questionnaire. This Mental Fitness PHQ-2 Score is generated for a Mental Fitness health check using a validated PHQ-2 questionnaire.
The questionnaire and users' responses are captured in the meta-data linked to the voice sample and can be used for score refinement, improving models, and tracking longitudinal responses.
To share your questionnaire, you can raise a support request by sending an email at support@sondehealth.com and providing the following information:
A questionnaire in JSON format. This questionnaire should be valid as per the Questionnaire JSON Schema
Your email, which you have used to sign-up on the Sonde Portal.
As a resolution to your request, the Sonde success team will reply back with a new variant of the Mental Fitness health check and this new variant will be bound to your questionnaire.
You can use a new variant instead of the variant mentioned in the document Mental Fitness PHQ-2 Score to generate the questionnaire score.
Before sending the questionnaire in a support ticket, please validate questionnaire JSON conforms to the guidelines in the section Validate Questionnaire JSON.
Questionnaire JSON Schema
{
"type": "object",
"$schema": "http://json-schema.org/draft/2019-09/schema#",
"required": [
"title",
"language",
"questions"
],
"properties": {
"title": {
"type": "string"
},
"language": {
"type": "string",
"enum": [
"en",
"hi"
]
},
"questions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"MULTIPLE_CHOICE"
]
},
"text": {
"type": "string"
},
"isSkippable": {
"type": "boolean"
},
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"text": {
"type": "string"
},
"score": {
"type": "integer"
}
}
}
}
}
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"MULTIPLE_SELECT"
]
},
"text": {
"type": "string"
},
"isSkippable": {
"type": "boolean"
},
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"text": {
"type": "string"
},
"score": {
"type": "integer"
}
}
}
}
}
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"TEXT_FIELD"
]
},
"text": {
"type": "string"
},
"isSkippable": {
"type": "boolean"
},
"inputDataType": {
"type": [
"integer",
"string"
]
}
}
}
]
}
}
}
}Sample Questionnaire JSON
{
"title": "sample",
"language": "en",
"questions": [
{
"type": "MULTIPLE_CHOICE",
"text": "Have you been with a lab confirmed case of COVID-19 or with symptoms of COVID-19 for at least 15 minutes, or had direct contact with their mucus or saliva, in the past 14 days?",
"isSkippable": true,
"options": [
{
"text": "No",
"score": 0
},
{
"text": "Yes",
"score": 1
}
]
},
{
"type": "TEXT_FIELD",
"text": "How many covid center do you have in your city?",
"isSkippable": true,
"inputDataType": "INTEGER"
},
{
"type": "MULTIPLE_SELECT",
"text": "In the last 24 hours, have you had any of the following NEW symptoms? Select all that apply",
"isSkippable": false,
"options": [
{
"text": "Fever of 100.4° F or above",
"score": 9
},
{
"text": "Trouble breathing",
"score": 8
}
]
}
]
}
Â
Validate Questionnaire JSON
Go to website https://www.jsonschemavalidator.net/ and paste Questionnaire JSON Schema in the right-hand side panel and questionnaire JSON in the left-hand side panel.
Sonde Health