Title
PHQ-9
instrumentId
9X2F
Description
Instructions
Over the last 2 weeks, how often have you been bothered by any of the following problems?

Questions

Q1: Little interest or pleasure in doing things

 
Question Number Q1
Allow 'Not Answered'? Yes
Question Type pick_one
Answer Options pick_one
Value Text
0 Not at all
1 Several days
2 More than half the days
3 Nearly every day
Not Answered Not Answered

Q2: Feeling down, depressed, or hopeless.

 
Question Number Q2
Allow 'Not Answered'? Yes
Question Type pick_one
Answer Options pick_one
Value Text
0 Not at all
1 Several days
2 More than half the days
3 Nearly every day
Not Answered Not Answered

Q3: Trouble falling asleep or staying asleep, or sleeping too much.

 
Question Number Q3
Allow 'Not Answered'? Yes
Question Type pick_one
Answer Options pick_one
Value Text
0 Not at all
1 Several days
2 More than half the days
3 Nearly every day
Not Answered Not Answered

Q4: Feeling tired or having little energy.

 
Question Number Q4
Allow 'Not Answered'? Yes
Question Type pick_one
Answer Options pick_one
Value Text
0 Not at all
1 Several days
2 More than half the days
3 Nearly every day
Not Answered Not Answered

Q5: Poor appetite or overeating.

 
Question Number Q5
Allow 'Not Answered'? Yes
Question Type pick_one
Answer Options pick_one
Value Text
0 Not at all
1 Several days
2 More than half the days
3 Nearly every day
Not Answered Not Answered

Q6: Feeling bad about yourself - or that you are a failure or have let yourself or your family down.

 
Question Number Q6
Allow 'Not Answered'? Yes
Question Type pick_one
Answer Options pick_one
Value Text
0 Not at all
1 Several days
2 More than half the days
3 Nearly every day
Not Answered Not Answered

Q7: Trouble concentrating on things, such as reading the newspaper or watching television.

 
Question Number Q7
Allow 'Not Answered'? Yes
Question Type pick_one
Answer Options pick_one
Value Text
0 Not at all
1 Several days
2 More than half the days
3 Nearly every day
Not Answered Not Answered

Q8: Moving or speaking so slowly that other people could have noticed. Or the opposite - being so fidgety or restless that you have been moving around a lot more than usual.

 
Question Number Q8
Allow 'Not Answered'? Yes
Question Type pick_one
Answer Options pick_one
Value Text
0 Not at all
1 Several days
2 More than half the days
3 Nearly every day
Not Answered Not Answered

Q9: Thoughts that you would be better off dead, or of hurting yourself.

 
Question Number Q9
Allow 'Not Answered'? Yes
Question Type pick_one
Answer Options pick_one
Value Text
0 Not at all
1 Several days
2 More than half the days
3 Nearly every day
Not Answered Not Answered

Q10: If you check off any problems, how difficult have these problems made it for you to do your work, take care of things at home, or get along with other people?

 
Question Number Q10
Allow 'Not Answered'? Yes
Question Type pick_one
Answer Options pick_one
Value Text
0 Not difficult at all
1 Somewhat difficult
2 Very difficult
3 Extremely difficult
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.

Score: Score

Question Numbers Q1, Q2, Q3, Q4, Q5, Q6, Q7, Q8, Q9
Scoring Source Sum of answered Values
Scoring Ranges
Short Label Long Label Min Max
Minimal depression Minimal depression 0 4.99
Mild depression Mild depression 5 9.99
Moderate depression Moderate depression 10 14.99
Moderately severe depression Moderately severe depression 15 19.99
Severe depression Severe depression 20 27

JSON Instrument Definition for developers

{
    "instrumentId": "9X2F",
    "title": "PHQ-9",
    "description": "",
    "instructions": "Over the last 2 weeks, how often have you been bothered by any of the following problems?",
    "questions": [
        {
            "assign_qnum": "y",
            "instrumentId": "9X2F",
            "include_in_export": "y",
            "allow_NotAnswered": "y",
            "question_status": "ACTIVE",
            "question_text": "Little interest or pleasure in doing things",
            "question_order": 1,
            "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": "Q1",
            "answer_options": [
                {
                    "answer_text": "Not at all",
                    "answer_order": 1,
                    "answer_severity": 0,
                    "answer_value": "0.00",
                    "answer_status": "ACTIVE",
                    "clients_colName": "",
                    "date_created": "2023-12-30 12:55:29"
                },
                {
                    "answer_text": "Several days",
                    "answer_order": 2,
                    "answer_severity": 1,
                    "answer_value": "1.00",
                    "answer_status": "ACTIVE",
                    "clients_colName": "",
                    "date_created": "2023-12-30 12:55:29"
                },
                {
                    "answer_text": "More than half the days",
                    "answer_order": 3,
                    "answer_severity": 2,
                    "answer_value": "2.00",
                    "answer_status": "ACTIVE",
                    "clients_colName": "",
                    "date_created": "2023-12-30 12:55:29"
                },
                {
                    "answer_text": "Nearly every day",
                    "answer_order": 4,
                    "answer_severity": 3,
                    "answer_value": "3.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": "9X2F",
            "include_in_export": "y",
            "allow_NotAnswered": "y",
            "question_status": "ACTIVE",
            "question_text": "Feeling down, depressed, or hopeless.",
            "question_order": 2,
            "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": "Q2",
            "answer_options": [
                {
                    "answer_text": "Not at all",
                    "answer_order": 1,
                    "answer_severity": 0,
                    "answer_value": "0.00",
                    "answer_status": "ACTIVE",
                    "clients_colName": "",
                    "date_created": "2023-12-30 12:55:29"
                },
                {
                    "answer_text": "Several days",
                    "answer_order": 2,
                    "answer_severity": 1,
                    "answer_value": "1.00",
                    "answer_status": "ACTIVE",
                    "clients_colName": "",
                    "date_created": "2023-12-30 12:55:29"
                },
                {
                    "answer_text": "More than half the days",
                    "answer_order": 3,
                    "answer_severity": 2,
                    "answer_value": "2.00",
                    "answer_status": "ACTIVE",
                    "clients_colName": "",
                    "date_created": "2023-12-30 12:55:29"
                },
                {
                    "answer_text": "Nearly every day",
                    "answer_order": 4,
                    "answer_severity": 3,
                    "answer_value": "3.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": "9X2F",
            "include_in_export": "y",
            "allow_NotAnswered": "y",
            "question_status": "ACTIVE",
            "question_text": "Trouble falling asleep or staying asleep, or sleeping too much.",
            "question_order": 3,
            "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": "Q3",
            "answer_options": [
                {
                    "answer_text": "Not at all",
                    "answer_order": 1,
                    "answer_severity": 0,
                    "answer_value": "0.00",
                    "answer_status": "ACTIVE",
                    "clients_colName": "",
                    "date_created": "2023-12-30 12:55:29"
                },
                {
                    "answer_text": "Several days",
                    "answer_order": 2,
                    "answer_severity": 1,
                    "answer_value": "1.00",
                    "answer_status": "ACTIVE",
                    "clients_colName": "",
                    "date_created": "2023-12-30 12:55:29"
                },
                {
                    "answer_text": "More than half the days",
                    "answer_order": 3,
                    "answer_severity": 2,
                    "answer_value": "2.00",
                    "answer_status": "ACTIVE",
                    "clients_colName": "",
                    "date_created": "2023-12-30 12:55:29"
                },
                {
                    "answer_text": "Nearly every day",
                    "answer_order": 4,
                    "answer_severity": 3,
                    "answer_value": "3.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": "9X2F",
            "include_in_export": "y",
            "allow_NotAnswered": "y",
            "question_status": "ACTIVE",
            "question_text": "Feeling tired or having little energy.",
            "question_order": 4,
            "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": "Q4",
            "answer_options": [
                {
                    "answer_text": "Not at all",
                    "answer_order": 1,
                    "answer_severity": 0,
                    "answer_value": "0.00",
                    "answer_status": "ACTIVE",
                    "clients_colName": "",
                    "date_created": "2023-12-30 12:55:29"
                },
                {
                    "answer_text": "Several days",
                    "answer_order": 2,
                    "answer_severity": 1,
                    "answer_value": "1.00",
                    "answer_status": "ACTIVE",
                    "clients_colName": "",
                    "date_created": "2023-12-30 12:55:29"
                },
                {
                    "answer_text": "More than half the days",
                    "answer_order": 3,
                    "answer_severity": 2,
                    "answer_value": "2.00",
                    "answer_status": "ACTIVE",
                    "clients_colName": "",
                    "date_created": "2023-12-30 12:55:29"
                },
                {
                    "answer_text": "Nearly every day",
                    "answer_order": 4,
                    "answer_severity": 3,
                    "answer_value": "3.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": "9X2F",
            "include_in_export": "y",
            "allow_NotAnswered": "y",
            "question_status": "ACTIVE",
            "question_text": "Poor appetite or overeating.",
            "question_order": 5,
            "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": "Q5",
            "answer_options": [
                {
                    "answer_text": "Not at all",
                    "answer_order": 1,
                    "answer_severity": 0,
                    "answer_value": "0.00",
                    "answer_status": "ACTIVE",
                    "clients_colName": "",
                    "date_created": "2023-12-30 12:55:29"
                },
                {
                    "answer_text": "Several days",
                    "answer_order": 2,
                    "answer_severity": 1,
                    "answer_value": "1.00",
                    "answer_status": "ACTIVE",
                    "clients_colName": "",
                    "date_created": "2023-12-30 12:55:29"
                },
                {
                    "answer_text": "More than half the days",
                    "answer_order": 3,
                    "answer_severity": 2,
                    "answer_value": "2.00",
                    "answer_status": "ACTIVE",
                    "clients_colName": "",
                    "date_created": "2023-12-30 12:55:29"
                },
                {
                    "answer_text": "Nearly every day",
                    "answer_order": 4,
                    "answer_severity": 3,
                    "answer_value": "3.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": "9X2F",
            "include_in_export": "y",
            "allow_NotAnswered": "y",
            "question_status": "ACTIVE",
            "question_text": "Feeling bad about yourself - or that you are a failure or have let yourself or your family down.",
            "question_order": 6,
            "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": "Q6",
            "answer_options": [
                {
                    "answer_text": "Not at all",
                    "answer_order": 1,
                    "answer_severity": 0,
                    "answer_value": "0.00",
                    "answer_status": "ACTIVE",
                    "clients_colName": "",
                    "date_created": "2023-12-30 12:55:29"
                },
                {
                    "answer_text": "Several days",
                    "answer_order": 2,
                    "answer_severity": 1,
                    "answer_value": "1.00",
                    "answer_status": "ACTIVE",
                    "clients_colName": "",
                    "date_created": "2023-12-30 12:55:29"
                },
                {
                    "answer_text": "More than half the days",
                    "answer_order": 3,
                    "answer_severity": 2,
                    "answer_value": "2.00",
                    "answer_status": "ACTIVE",
                    "clients_colName": "",
                    "date_created": "2023-12-30 12:55:29"
                },
                {
                    "answer_text": "Nearly every day",
                    "answer_order": 4,
                    "answer_severity": 3,
                    "answer_value": "3.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": "9X2F",
            "include_in_export": "y",
            "allow_NotAnswered": "y",
            "question_status": "ACTIVE",
            "question_text": "Trouble concentrating on things, such as reading the newspaper or watching television.",
            "question_order": 7,
            "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": "Q7",
            "answer_options": [
                {
                    "answer_text": "Not at all",
                    "answer_order": 1,
                    "answer_severity": 0,
                    "answer_value": "0.00",
                    "answer_status": "ACTIVE",
                    "clients_colName": "",
                    "date_created": "2023-12-30 12:55:29"
                },
                {
                    "answer_text": "Several days",
                    "answer_order": 2,
                    "answer_severity": 1,
                    "answer_value": "1.00",
                    "answer_status": "ACTIVE",
                    "clients_colName": "",
                    "date_created": "2023-12-30 12:55:29"
                },
                {
                    "answer_text": "More than half the days",
                    "answer_order": 3,
                    "answer_severity": 2,
                    "answer_value": "2.00",
                    "answer_status": "ACTIVE",
                    "clients_colName": "",
                    "date_created": "2023-12-30 12:55:29"
                },
                {
                    "answer_text": "Nearly every day",
                    "answer_order": 4,
                    "answer_severity": 3,
                    "answer_value": "3.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": "9X2F",
            "include_in_export": "y",
            "allow_NotAnswered": "y",
            "question_status": "ACTIVE",
            "question_text": "Moving or speaking so slowly that other people could have noticed. Or the opposite - being so fidgety or restless that you have been moving around a lot more than usual.",
            "question_order": 8,
            "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": "Q8",
            "answer_options": [
                {
                    "answer_text": "Not at all",
                    "answer_order": 1,
                    "answer_severity": 0,
                    "answer_value": "0.00",
                    "answer_status": "ACTIVE",
                    "clients_colName": "",
                    "date_created": "2023-12-30 12:55:29"
                },
                {
                    "answer_text": "Several days",
                    "answer_order": 2,
                    "answer_severity": 1,
                    "answer_value": "1.00",
                    "answer_status": "ACTIVE",
                    "clients_colName": "",
                    "date_created": "2023-12-30 12:55:29"
                },
                {
                    "answer_text": "More than half the days",
                    "answer_order": 3,
                    "answer_severity": 2,
                    "answer_value": "2.00",
                    "answer_status": "ACTIVE",
                    "clients_colName": "",
                    "date_created": "2023-12-30 12:55:29"
                },
                {
                    "answer_text": "Nearly every day",
                    "answer_order": 4,
                    "answer_severity": 3,
                    "answer_value": "3.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": "9X2F",
            "include_in_export": "y",
            "allow_NotAnswered": "y",
            "question_status": "ACTIVE",
            "question_text": "Thoughts that you would be better off dead, or of hurting yourself.",
            "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": "Not at all",
                    "answer_order": 1,
                    "answer_severity": 0,
                    "answer_value": "0.00",
                    "answer_status": "ACTIVE",
                    "clients_colName": "",
                    "date_created": "2023-12-30 12:55:29"
                },
                {
                    "answer_text": "Several days",
                    "answer_order": 2,
                    "answer_severity": 1,
                    "answer_value": "1.00",
                    "answer_status": "ACTIVE",
                    "clients_colName": "",
                    "date_created": "2023-12-30 12:55:29"
                },
                {
                    "answer_text": "More than half the days",
                    "answer_order": 3,
                    "answer_severity": 2,
                    "answer_value": "2.00",
                    "answer_status": "ACTIVE",
                    "clients_colName": "",
                    "date_created": "2023-12-30 12:55:29"
                },
                {
                    "answer_text": "Nearly every day",
                    "answer_order": 4,
                    "answer_severity": 3,
                    "answer_value": "3.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": "9X2F",
            "include_in_export": "y",
            "allow_NotAnswered": "y",
            "question_status": "ACTIVE",
            "question_text": "If you check off any problems, how difficult have these problems made it for you to do your work, take care of things at home, or get along with other people?",
            "question_order": 10,
            "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": "Not difficult at all",
                    "answer_order": 1,
                    "answer_severity": 0,
                    "answer_value": "0.00",
                    "answer_status": "ACTIVE",
                    "clients_colName": "",
                    "date_created": "2023-12-30 12:55:29"
                },
                {
                    "answer_text": "Somewhat difficult",
                    "answer_order": 2,
                    "answer_severity": 1,
                    "answer_value": "1.00",
                    "answer_status": "ACTIVE",
                    "clients_colName": "",
                    "date_created": "2023-12-30 12:55:29"
                },
                {
                    "answer_text": "Very difficult",
                    "answer_order": 3,
                    "answer_severity": 2,
                    "answer_value": "2.00",
                    "answer_status": "ACTIVE",
                    "clients_colName": "",
                    "date_created": "2023-12-30 12:55:29"
                },
                {
                    "answer_text": "Extremely difficult",
                    "answer_order": 4,
                    "answer_severity": 3,
                    "answer_value": "3.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 = 1738110003
$API_SIGNATURE = hash_hmac('sha256', $API_DATE . $FACILITY_ID, $SECRET_KEY); fc291588d783b548fb9f6d2bb67ef7e83446d7146b8c7104dd1cc69f1dbed610
 

Complete Post

{
    "facilityId": "123DEMO",
    "apiDate": "1738110003",
    "apiSignature": "fc291588d783b548fb9f6d2bb67ef7e83446d7146b8c7104dd1cc69f1dbed610",
    "surveys": [
        {
            "instrumentId": "9X2F",
            "sessionId": "123session",
            "clientId": "123client",
            "assignedToType": "Client",
            "yearOfAdmit": "2024",
            "yearCompleted": "2024",
            "daysFromAdmit": -99,
            "daysFromDischarge": 180,
            "completedWhile": "postDischarge",
            "answerStyle": "byText",
            "Q1": "More than half the days",
            "Q2": "Several days",
            "Q3": "Not at all",
            "Q4": "Not Answered",
            "Q5": "More than half the days",
            "Q6": "Several days",
            "Q7": "Not Answered",
            "Q8": "More than half the days",
            "Q9": "Nearly every day",
            "Q10": "Somewhat difficult"
        },
        {
            "instrumentId": "9X2F",
            "sessionId": "123session",
            "clientId": "123client",
            "assignedToType": "Client",
            "yearOfAdmit": "2024",
            "yearCompleted": "2024",
            "daysFromAdmit": 30,
            "daysFromDischarge": -99,
            "completedWhile": "inTreatment",
            "answerStyle": "byValue",
            "Q1": "Not Answered",
            "Q2": 2,
            "Q3": 1,
            "Q4": 0,
            "Q5": 2,
            "Q6": 1,
            "Q7": "Not Answered",
            "Q8": 0,
            "Q9": 2,
            "Q10": "Not Answered"
        }
    ]
}