Tross
Demo dataBook a demo
ECLINICALWORKS

Submit smart form phq2

Submit the PHQ-2 depression screening form.

POSThttps://preview.ontross.com/api/integrations/ecw/submit-smart-form-phq2
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
Little interest or pleasure in doing things? One of: Not at all, Several days, More than half the days, Nearly every day, Declined to specify
Example
"Several days"
Accepted values
Not at allSeveral daysMore than half the daysNearly every dayDeclined to specify
input.q2_answer
string
required
Feeling down, depressed, or hopeless? One of: Not at all, Several days, More than half the days, Nearly every day, Declined to specify
Example
"Not at all"
Accepted values
Not at allSeveral daysMore than half the daysNearly every dayDeclined to specify
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-phq2 \
  --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"},"auth_id":"auth_uuid_here"}'
Request BODY
{
  "input": {
    "patientId": "407069",
    "encounterId": "1870494",
    "q1_answer": "Several days",
    "q2_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"
}