Tross
Demo dataBook a demo
ECLINICALWORKS

Submit smart form phq9

Submit the PHQ-9 depression screening form.

POSThttps://preview.ontross.com/api/integrations/ecw/submit-smart-form-phq9
Request Fields
input.patientId
string
required
Patient chart being read or written, from fetch-patients.
Example
"407069"
input.encounterId
string
required
Encounter being read or written, from fetch-appointments.
Example
"1870494"
input.q1_answer
string
required
How often the patient had little interest or pleasure.
Example
"Several days"
Accepted values
Not at allSeveral daysMore than half the daysNearly every day
input.q2_answer
string
required
How often the patient felt down, depressed, or hopeless.
Example
"Not at all"
Accepted values
Not at allSeveral daysMore than half the daysNearly every day
input.q3_answer
string
required
How often the patient had trouble sleeping or slept too much.
Example
"Several days"
Accepted values
Not at allSeveral daysMore than half the daysNearly every day
input.q4_answer
string
required
How often the patient felt tired or had little energy.
Example
"More than half the days"
Accepted values
Not at allSeveral daysMore than half the daysNearly every day
input.q5_answer
string
required
How often the patient had poor appetite or overate.
Example
"Not at all"
Accepted values
Not at allSeveral daysMore than half the daysNearly every day
input.q6_answer
string
required
How often the patient felt bad about themselves or a failure.
Example
"Several days"
Accepted values
Not at allSeveral daysMore than half the daysNearly every day
input.q7_answer
string
required
How often the patient had trouble concentrating.
Example
"Not at all"
Accepted values
Not at allSeveral daysMore than half the daysNearly every day
input.q8_answer
string
required
How often the patient moved slowly or was restless.
Example
"Not at all"
Accepted values
Not at allSeveral daysMore than half the daysNearly every day
input.q9_answer
string
required
How often the patient had thoughts of self-harm or death.
Example
"Not at all"
Accepted values
Not at allSeveral daysMore than half the daysNearly every day
auth_id
string
required
Saved connection to run this operation through, from the Authentication page. It decides which practice and login the call uses.
Example
"00000000-0000-4000-8000-000000000000"
Output Fields
submitted
boolean
Whether eCW accepted the smart form submission.
Example
true
Code
curl --request POST \
  --url https://preview.ontross.com/api/integrations/ecw/submit-smart-form-phq9 \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"patientId":"407069","encounterId":"1870494","q1_answer":"Several days","q2_answer":"Not at all","q3_answer":"Several days","q4_answer":"More than half the days","q5_answer":"Not at all","q6_answer":"Several days","q7_answer":"Not at all","q8_answer":"Not at all","q9_answer":"Not at all"},"auth_id":"auth_uuid_here"}'
Request BODY
{
  "input": {
    "patientId": "407069",
    "encounterId": "1870494",
    "q1_answer": "Several days",
    "q2_answer": "Not at all",
    "q3_answer": "Several days",
    "q4_answer": "More than half the days",
    "q5_answer": "Not at all",
    "q6_answer": "Several days",
    "q7_answer": "Not at all",
    "q8_answer": "Not at all",
    "q9_answer": "Not at all"
  },
  "auth_id": "auth_uuid_here"
}
Response BODY
{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "submitted": true
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}