Tross
Demo dataBook a demo
ECLINICALWORKS

Submit smart form auditc

Submit the AUDIT-C alcohol screening form.

POSThttps://preview.ontross.com/api/integrations/ecw/submit-smart-form-auditc

How to complete this screening

Required

patientId, encounterId, and drank_in_past_year.

If the answer is No

Omit all follow-up fields. eCW records a negative screen with a score of 0.

If the answer is Yes

All three follow-ups are required:

  • drinking_frequency
  • typical_drinks
  • six_or_more_drinks_frequency

Calculated by eCW

Do not send a date, score, interpretation, or patient sex. The live form supplies them.

Use the exact values listed below. The request body on the right is a valid copy-and-paste starting point.

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.drank_in_past_year
string
required
Did the patient have a drink containing alcohol in the past year?
Example
"Yes"
Accepted values
YesNo
input.drinking_frequency
string
How often the patient drinks, required when drank_in_past_year is Yes.
Example
"Monthly or less"
Accepted values
NeverMonthly or less2 to 4 times a month2 to 3 times a weekDaily or almost dailyDeclined to specify
input.typical_drinks
string
Drinks on a typical drinking day, required when drank_in_past_year is Yes.
Example
"1 or 2 drinks"
Accepted values
1 or 2 drinks3 or 4 drinks5 or 6 drinks7 to 9 drinks10 or more drinksDeclined to specify
input.six_or_more_drinks_frequency
string
How often the patient has six or more drinks at once.
Example
"Less than monthly"
Accepted values
NeverLess than monthly2 to 4 times a month2 to 3 times per week4 or more times a weekDeclined 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
score
integer
AUDIT-C total computed from the answers, 0 to 12.
Example
2
interpretation
string
Positive once the score hits 3, or 4 for males.
Example
"Negative"
Code
curl --request POST \
  --url https://preview.ontross.com/api/integrations/ecw/submit-smart-form-auditc \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"patientId":"patient_id","encounterId":"encounter_id","drank_in_past_year":"Yes","drinking_frequency":"Monthly or less","typical_drinks":"1 or 2 drinks","six_or_more_drinks_frequency":"Never"},"auth_id":"auth_uuid_here"}'
Request BODY
{
  "input": {
    "patientId": "patient_id",
    "encounterId": "encounter_id",
    "drank_in_past_year": "Yes",
    "drinking_frequency": "Monthly or less",
    "typical_drinks": "1 or 2 drinks",
    "six_or_more_drinks_frequency": "Never"
  },
  "auth_id": "auth_uuid_here"
}
Response BODY
{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "submitted": true,
    "score": 2,
    "interpretation": "Negative"
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}