- Title
- FoRSE Outcomes Survey
- instrumentId
- FVBJ
- Description
- Instructions
Questions
Q1: Over the last 30 days, have you used any of the following services?
| Question Number |
Q1 |
| Allow 'Not Answered'? |
Yes |
| Question Type |
pick_multiple |
Answer Options pick_multiple
| Value |
Text |
| 1 |
None |
| 2 |
Detox |
| 3 |
Residential |
| 4 |
Partial Hospitalization (≥ 20 hrs of services weekly) |
| 5 |
Intensive Outpatient (9-20 hrs of services weekly) |
| 6 |
Outpatient (< 9 hrs of services weekly) |
| 7 |
Sober Living/Recovery Residence |
| 8 |
Recovery Support (e.g., recovery coaching) |
| Not Answered |
Not Answered |
Q2: Over the last 30 days, how many recovery support meetings (e.g., AA, NA, or other peer support groups) have you attended?
| Question Number |
Q2 |
| Allow 'Not Answered'? |
Yes |
| Question Type |
input_box |
| Answer Type |
number |
| Maximum Characters |
3 |
| Min |
0.00 |
| Max |
100.00 |
Q3: Over the last 30 days, how many total days have you used alcohol and/or drugs?
| Question Number |
Q3 |
| Allow 'Not Answered'? |
Yes |
| Question Type |
input_box |
| Answer Type |
number |
| Maximum Characters |
3 |
| Min |
0.00 |
| Max |
30.00 |
Q4: Which of the following medications are you currently taking in support of your recovery? (select all that apply)
| Question Number |
Q4 |
| Allow 'Not Answered'? |
Yes |
| Question Type |
pick_multiple |
Answer Options pick_multiple
| Value |
Text |
| 1 |
None |
| 2 |
Acamprosate/Campral |
| 3 |
Buprenorphine (Subutex/Suboxone Film) |
| 4 |
Buprenorphine (Sublocade injection) |
| 5 |
Disulfiram/Antabuse |
| 6 |
Naltrexone (ReVia Pill) |
| 7 |
Naltrexone (Vivitrol Injection) |
| 8 |
Methadone |
| 9 |
Medications for co-occurring disorder (e.g., anxiety or depression) |
| 10 |
Medication not listed |
| 11 |
Other |
| Not Answered |
Not Answered |
Q5: Over the last 30 days, how many days did you visit the hospital or ER, related to your substance use or recovery?
| Question Number |
Q5 |
| Allow 'Not Answered'? |
Yes |
| Question Type |
input_box |
| Answer Type |
number |
| Maximum Characters |
3 |
| Min |
0.00 |
| Max |
30.00 |
Q6: Over the last 30 days, how many incidents have you had with law enforcement?
| Question Number |
Q6 |
| Allow 'Not Answered'? |
Yes |
| Question Type |
input_box |
| Answer Type |
number |
| Maximum Characters |
3 |
| Min |
0.00 |
| Max |
30.00 |
Q7: What is your current employment status?
| Question Number |
Q7 |
| Allow 'Not Answered'? |
Yes |
| Question Type |
pick_one |
Answer Options pick_one
| Value |
Text |
| 1 |
Full-time |
| 2 |
Part-time |
| 3 |
Unemployed - seeking employment |
| 4 |
Unemployed - not seeking employment (retired, on disability, other source of income, etc...) |
| Not Answered |
Not Answered |
Q8: Have you experienced a relapse since discharging from treatment?
| Question Number |
Q8 |
| Allow 'Not Answered'? |
Yes |
| Question Type |
pick_one |
Answer Options pick_one
| Value |
Text |
| 1 |
No |
| 2 |
Yes |
| Not Answered |
Not Answered |
Q9: How would you rate your quality of life?
| Question Number |
Q9 |
| Allow 'Not Answered'? |
Yes |
| Question Type |
pick_one |
Answer Options pick_one
| Value |
Text |
| 1 |
Very poor |
| 2 |
Poor |
| 3 |
Neither poor nor good |
| 4 |
Good |
| 5 |
Very good |
| Not Answered |
Not Answered |
Q10: How frequently are you using nicotine (smoking, vaping, or dipping)?
| Question Number |
Q10 |
| Allow 'Not Answered'? |
Yes |
| Question Type |
pick_one |
Answer Options pick_one
| Value |
Text |
| 1 |
Daily |
| 2 |
Weekly |
| 3 |
Less than weekly |
| 4 |
Not at all |
| Not Answered |
Not Answered |
Scoring
The scoring details below are for information only. The scoring for this survey happens on our side. Please do not provide survey scores.
JSON Instrument Definition for developers
{
"instrumentId": "FVBJ",
"title": "FoRSE Outcomes Survey",
"description": "",
"instructions": "",
"questions": [
{
"assign_qnum": "y",
"instrumentId": "FVBJ",
"include_in_export": "y",
"allow_NotAnswered": "y",
"question_status": "ACTIVE",
"question_text": "Over the last 30 days, have you used any of the following services?",
"question_order": 1,
"question_type": "pick_multiple",
"textbox_max_chars": null,
"textbox_input_type": null,
"textbox_min_value": null,
"textbox_max_value": null,
"date_created": "2023-12-30 12:55:58",
"qNum": "Q1",
"answer_options": [
{
"answer_text": "None",
"answer_order": 1,
"answer_severity": null,
"answer_value": "1.00",
"answer_status": "ACTIVE",
"clients_colName": "",
"date_created": "2023-12-30 12:55:29"
},
{
"answer_text": "Detox",
"answer_order": 2,
"answer_severity": null,
"answer_value": "2.00",
"answer_status": "ACTIVE",
"clients_colName": "",
"date_created": "2023-12-30 12:55:29"
},
{
"answer_text": "Residential",
"answer_order": 3,
"answer_severity": null,
"answer_value": "3.00",
"answer_status": "ACTIVE",
"clients_colName": "",
"date_created": "2023-12-30 12:55:29"
},
{
"answer_text": "Partial Hospitalization (\u2265 20 hrs of services weekly)",
"answer_order": 4,
"answer_severity": null,
"answer_value": "4.00",
"answer_status": "ACTIVE",
"clients_colName": "",
"date_created": "2023-12-30 12:55:29"
},
{
"answer_text": "Intensive Outpatient (9-20 hrs of services weekly)",
"answer_order": 5,
"answer_severity": null,
"answer_value": "5.00",
"answer_status": "ACTIVE",
"clients_colName": "",
"date_created": "2023-12-30 12:55:29"
},
{
"answer_text": "Outpatient (< 9 hrs of services weekly)",
"answer_order": 6,
"answer_severity": null,
"answer_value": "6.00",
"answer_status": "ACTIVE",
"clients_colName": "",
"date_created": "2023-12-30 12:55:29"
},
{
"answer_text": "Sober Living\/Recovery Residence",
"answer_order": 7,
"answer_severity": null,
"answer_value": "7.00",
"answer_status": "ACTIVE",
"clients_colName": "",
"date_created": "2023-12-30 12:55:29"
},
{
"answer_text": "Recovery Support (e.g., recovery coaching)",
"answer_order": 8,
"answer_severity": null,
"answer_value": "8.00",
"answer_status": "ACTIVE",
"clients_colName": "",
"date_created": "2023-12-30 12:55:29"
},
{
"answer_severity": null,
"answer_value": null,
"answer_text": "Not Answered",
"answer_status": "ACTIVE"
}
]
},
{
"assign_qnum": "y",
"instrumentId": "FVBJ",
"include_in_export": "y",
"allow_NotAnswered": "y",
"question_status": "ACTIVE",
"question_text": "Over the last 30 days, how many recovery support meetings (e.g., AA, NA, or other peer support groups) have you attended?",
"question_order": 2,
"question_type": "input_box",
"textbox_max_chars": 3,
"textbox_input_type": "number",
"textbox_min_value": "0.00",
"textbox_max_value": "100.00",
"date_created": "2023-12-30 12:55:58",
"qNum": "Q2",
"answer_options": []
},
{
"assign_qnum": "y",
"instrumentId": "FVBJ",
"include_in_export": "y",
"allow_NotAnswered": "y",
"question_status": "ACTIVE",
"question_text": "Over the last 30 days, how many total days have you used alcohol and\/or drugs?",
"question_order": 3,
"question_type": "input_box",
"textbox_max_chars": 3,
"textbox_input_type": "number",
"textbox_min_value": "0.00",
"textbox_max_value": "30.00",
"date_created": "2023-12-30 12:55:58",
"qNum": "Q3",
"answer_options": []
},
{
"assign_qnum": "y",
"instrumentId": "FVBJ",
"include_in_export": "y",
"allow_NotAnswered": "y",
"question_status": "ACTIVE",
"question_text": "Which of the following medications are you currently taking in support of your recovery? (select all that apply)",
"question_order": 4,
"question_type": "pick_multiple",
"textbox_max_chars": 2,
"textbox_input_type": "number",
"textbox_min_value": "0.00",
"textbox_max_value": "31.00",
"date_created": "2023-12-30 12:55:58",
"qNum": "Q4",
"answer_options": [
{
"answer_text": "None",
"answer_order": 1,
"answer_severity": null,
"answer_value": "1.00",
"answer_status": "ACTIVE",
"clients_colName": "",
"date_created": "2023-12-30 12:55:29"
},
{
"answer_text": "Acamprosate\/Campral",
"answer_order": 2,
"answer_severity": null,
"answer_value": "2.00",
"answer_status": "ACTIVE",
"clients_colName": "",
"date_created": "2023-12-30 12:55:29"
},
{
"answer_text": "Buprenorphine (Subutex\/Suboxone Film)",
"answer_order": 3,
"answer_severity": null,
"answer_value": "3.00",
"answer_status": "ACTIVE",
"clients_colName": "",
"date_created": "2023-12-30 12:55:29"
},
{
"answer_text": "Buprenorphine (Sublocade injection)",
"answer_order": 4,
"answer_severity": null,
"answer_value": "4.00",
"answer_status": "ACTIVE",
"clients_colName": "",
"date_created": "2023-12-30 12:55:29"
},
{
"answer_text": "Disulfiram\/Antabuse",
"answer_order": 5,
"answer_severity": null,
"answer_value": "5.00",
"answer_status": "ACTIVE",
"clients_colName": "",
"date_created": "2023-12-30 12:55:29"
},
{
"answer_text": "Naltrexone (ReVia Pill)",
"answer_order": 6,
"answer_severity": null,
"answer_value": "6.00",
"answer_status": "ACTIVE",
"clients_colName": "",
"date_created": "2023-12-30 12:55:29"
},
{
"answer_text": "Naltrexone (Vivitrol Injection)",
"answer_order": 7,
"answer_severity": null,
"answer_value": "7.00",
"answer_status": "ACTIVE",
"clients_colName": "",
"date_created": "2023-12-30 12:55:29"
},
{
"answer_text": "Methadone",
"answer_order": 8,
"answer_severity": null,
"answer_value": "8.00",
"answer_status": "ACTIVE",
"clients_colName": "",
"date_created": "2023-12-30 12:55:29"
},
{
"answer_text": "Medications for co-occurring disorder (e.g., anxiety or depression)",
"answer_order": 9,
"answer_severity": null,
"answer_value": "9.00",
"answer_status": "ACTIVE",
"clients_colName": "",
"date_created": "2023-12-30 12:55:29"
},
{
"answer_text": "Medication not listed",
"answer_order": 10,
"answer_severity": null,
"answer_value": "10.00",
"answer_status": "ACTIVE",
"clients_colName": "",
"date_created": "2023-12-30 12:55:29"
},
{
"answer_text": "Other",
"answer_order": 11,
"answer_severity": null,
"answer_value": "11.00",
"answer_status": "ACTIVE",
"clients_colName": "",
"date_created": "2023-12-30 12:55:29"
},
{
"answer_severity": null,
"answer_value": null,
"answer_text": "Not Answered",
"answer_status": "ACTIVE"
}
]
},
{
"assign_qnum": "y",
"instrumentId": "FVBJ",
"include_in_export": "y",
"allow_NotAnswered": "y",
"question_status": "ACTIVE",
"question_text": "Over the last 30 days, how many days did you visit the hospital or ER, related to your substance use or recovery?",
"question_order": 5,
"question_type": "input_box",
"textbox_max_chars": 3,
"textbox_input_type": "number",
"textbox_min_value": "0.00",
"textbox_max_value": "30.00",
"date_created": "2023-12-30 12:55:58",
"qNum": "Q5",
"answer_options": []
},
{
"assign_qnum": "y",
"instrumentId": "FVBJ",
"include_in_export": "y",
"allow_NotAnswered": "y",
"question_status": "ACTIVE",
"question_text": "Over the last 30 days, how many incidents have you had with law enforcement?",
"question_order": 6,
"question_type": "input_box",
"textbox_max_chars": 3,
"textbox_input_type": "number",
"textbox_min_value": "0.00",
"textbox_max_value": "30.00",
"date_created": "2023-12-30 12:55:58",
"qNum": "Q6",
"answer_options": []
},
{
"assign_qnum": "y",
"instrumentId": "FVBJ",
"include_in_export": "y",
"allow_NotAnswered": "y",
"question_status": "ACTIVE",
"question_text": "What is your current employment status?",
"question_order": 7,
"question_type": "pick_one",
"textbox_max_chars": 2,
"textbox_input_type": "number",
"textbox_min_value": "0.00",
"textbox_max_value": "99.00",
"date_created": "2023-12-30 12:55:58",
"qNum": "Q7",
"answer_options": [
{
"answer_text": "Full-time",
"answer_order": 1,
"answer_severity": null,
"answer_value": "1.00",
"answer_status": "ACTIVE",
"clients_colName": "",
"date_created": "2023-12-30 12:55:29"
},
{
"answer_text": "Part-time",
"answer_order": 2,
"answer_severity": null,
"answer_value": "2.00",
"answer_status": "ACTIVE",
"clients_colName": "",
"date_created": "2023-12-30 12:55:29"
},
{
"answer_text": "Unemployed - seeking employment",
"answer_order": 3,
"answer_severity": null,
"answer_value": "3.00",
"answer_status": "ACTIVE",
"clients_colName": "",
"date_created": "2023-12-30 12:55:29"
},
{
"answer_text": "Unemployed - not seeking employment (retired, on disability, other source of income, etc...)",
"answer_order": 4,
"answer_severity": null,
"answer_value": "4.00",
"answer_status": "ACTIVE",
"clients_colName": "",
"date_created": "2023-12-30 12:55:29"
},
{
"answer_severity": null,
"answer_value": null,
"answer_text": "Not Answered",
"answer_status": "ACTIVE"
}
]
},
{
"assign_qnum": "y",
"instrumentId": "FVBJ",
"include_in_export": "y",
"allow_NotAnswered": "y",
"question_status": "ACTIVE",
"question_text": "Have you experienced a relapse since discharging from treatment?",
"question_order": 8,
"question_type": "pick_one",
"textbox_max_chars": 3,
"textbox_input_type": "number",
"textbox_min_value": "0.00",
"textbox_max_value": "30.00",
"date_created": "2023-12-30 12:55:58",
"qNum": "Q8",
"answer_options": [
{
"answer_text": "No",
"answer_order": 1,
"answer_severity": null,
"answer_value": "1.00",
"answer_status": "ACTIVE",
"clients_colName": "",
"date_created": "2023-12-30 12:55:29"
},
{
"answer_text": "Yes",
"answer_order": 2,
"answer_severity": null,
"answer_value": "2.00",
"answer_status": "ACTIVE",
"clients_colName": "",
"date_created": "2023-12-30 12:55:29"
},
{
"answer_severity": null,
"answer_value": null,
"answer_text": "Not Answered",
"answer_status": "ACTIVE"
}
]
},
{
"assign_qnum": "y",
"instrumentId": "FVBJ",
"include_in_export": "y",
"allow_NotAnswered": "y",
"question_status": "ACTIVE",
"question_text": "How would you rate your quality of life?",
"question_order": 9,
"question_type": "pick_one",
"textbox_max_chars": null,
"textbox_input_type": null,
"textbox_min_value": null,
"textbox_max_value": null,
"date_created": "2023-12-30 12:55:58",
"qNum": "Q9",
"answer_options": [
{
"answer_text": "Very poor",
"answer_order": 1,
"answer_severity": null,
"answer_value": "1.00",
"answer_status": "ACTIVE",
"clients_colName": "",
"date_created": "2023-12-30 12:55:29"
},
{
"answer_text": "Poor",
"answer_order": 2,
"answer_severity": null,
"answer_value": "2.00",
"answer_status": "ACTIVE",
"clients_colName": "",
"date_created": "2023-12-30 12:55:29"
},
{
"answer_text": "Neither poor nor good",
"answer_order": 3,
"answer_severity": null,
"answer_value": "3.00",
"answer_status": "ACTIVE",
"clients_colName": "",
"date_created": "2023-12-30 12:55:29"
},
{
"answer_text": "Good",
"answer_order": 4,
"answer_severity": null,
"answer_value": "4.00",
"answer_status": "ACTIVE",
"clients_colName": "",
"date_created": "2023-12-30 12:55:29"
},
{
"answer_text": "Very good",
"answer_order": 5,
"answer_severity": null,
"answer_value": "5.00",
"answer_status": "ACTIVE",
"clients_colName": "",
"date_created": "2023-12-30 12:55:29"
},
{
"answer_severity": null,
"answer_value": null,
"answer_text": "Not Answered",
"answer_status": "ACTIVE"
}
]
},
{
"assign_qnum": "y",
"instrumentId": "FVBJ",
"include_in_export": "y",
"allow_NotAnswered": "y",
"question_status": "ACTIVE",
"question_text": "How frequently are you using nicotine (smoking, vaping, or dipping)?",
"question_order": 11,
"question_type": "pick_one",
"textbox_max_chars": null,
"textbox_input_type": null,
"textbox_min_value": null,
"textbox_max_value": null,
"date_created": "2023-12-30 12:55:58",
"qNum": "Q10",
"answer_options": [
{
"answer_text": "Daily",
"answer_order": 2,
"answer_severity": null,
"answer_value": "1.00",
"answer_status": "ACTIVE",
"clients_colName": "",
"date_created": "2023-12-30 12:55:29"
},
{
"answer_text": "Weekly",
"answer_order": 3,
"answer_severity": null,
"answer_value": "2.00",
"answer_status": "ACTIVE",
"clients_colName": "",
"date_created": "2023-12-30 12:55:29"
},
{
"answer_text": "Less than weekly",
"answer_order": 4,
"answer_severity": null,
"answer_value": "3.00",
"answer_status": "ACTIVE",
"clients_colName": "",
"date_created": "2023-12-30 12:55:29"
},
{
"answer_text": "Not at all",
"answer_order": 5,
"answer_severity": null,
"answer_value": "4.00",
"answer_status": "ACTIVE",
"clients_colName": "",
"date_created": "2023-12-30 12:55:29"
},
{
"answer_severity": null,
"answer_value": null,
"answer_text": "Not Answered",
"answer_status": "ACTIVE"
}
]
}
]
}
Example Push for developers
URL Endpoint:
https://naatpdata.com/v2/api/surveys.php
Authentication
$FACILITY_ID = '123DEMO'; Provided By Us
$SECRET_KEY = 'aaaaaabbbbbbbbccccccccdddddddeeeeeefffffgggggg'; Provided By Us
$API_DATE = gmdate( time() ); Current UNIX UTC time = 1743748745
$API_SIGNATURE = hash_hmac('sha256', $API_DATE . $FACILITY_ID, $SECRET_KEY); 91939449e7a5260c416d8a6c2bc761629fb208e18e06e30ca539a4ff06a7919f
Complete Post
{
"facilityId": "123DEMO",
"apiDate": "1743748745",
"apiSignature": "91939449e7a5260c416d8a6c2bc761629fb208e18e06e30ca539a4ff06a7919f",
"surveys": [
{
"instrumentId": "FVBJ",
"sessionId": "123session",
"clientId": "123client",
"assignedToType": "Client",
"yearOfAdmit": "2024",
"yearCompleted": "2024",
"daysFromAdmit": -99,
"daysFromDischarge": 180,
"completedWhile": "postDischarge",
"answerStyle": "byText",
"Q1": "Partial Hospitalization (\u2265 20 hrs of services weekly)|Intensive Outpatient (9-20 hrs of services weekly)",
"Q2": 61,
"Q3": 15,
"Q4": "None|Medication not listed",
"Q5": 19,
"Q6": 15,
"Q7": "Not Answered",
"Q8": "Not Answered",
"Q9": "Very good",
"Q10": "Not at all"
},
{
"instrumentId": "FVBJ",
"sessionId": "123session",
"clientId": "123client",
"assignedToType": "Client",
"yearOfAdmit": "2024",
"yearCompleted": "2024",
"daysFromAdmit": 30,
"daysFromDischarge": -99,
"completedWhile": "inTreatment",
"answerStyle": "byValue",
"Q1": "1|3",
"Q2": 41,
"Q3": 12,
"Q4": "6|11",
"Q5": 20,
"Q6": 4,
"Q7": "Not Answered",
"Q8": 2,
"Q9": 2,
"Q10": 4
}
]
}
