ECLINICALWORKS
Submit Smart Form Tobacco
Submit smart form tobacco in eClinicalWorks
POSThttps://api.ontross.com/api/integrations/ecw/submit-smart-form-tobacco
How to complete this screening
Required
patientId, encounterId, and exactly one tobacco_use.
Current smoker
Optional fields:
current_smoker_start_datesmoking_frequencyandcigarettes_per_dayfirst_cigarette_after_wakingandquit_interest
Former smoker
Optional fields: former_smoker_start_date, former_smoker_stop_date, and time_since_last_smoked.
The start date cannot be after the stop date.
Other status-specific dates
Current every day smoker→current_every_day_smoker_start_dateCurrent some day smoker→current_some_day_smoker_start_dateLight tobacco smoker→light_tobacco_smoker_start_dateHeavy tobacco smoker→heavy_tobacco_smoker_start_date
Additional findings
additional_tobacco_user_findings and additional_tobacco_nonuser_findings each accept zero or more displayed values.
Use the exact values listed below. The request body on the right is a valid copy-and-paste starting point.
Request Fields
input
object
requiredAnswers for eCW's Tobacco Control (Standard) Smart Form.
input.patientId
string
requiredPatient id
input.encounterId
string
requiredEncounter id
input.tobacco_use
string
requiredTobacco use
Accepted values
Current smokerFormer smokerNonsmokerCurrent every day smokerCurrent some day smokerSmoker, current status unknownUnknown if ever smokedLight tobacco smokerHeavy tobacco smokerUses tobacco in other formsinput.smoking_frequency
string
Smoking frequency
Accepted values
Every daySome days, but not every dayinput.cigarettes_per_day
string
Cigarettes per day
Accepted values
5 or less6-1011-2021-3031 or moreinput.first_cigarette_after_waking
string
First cigarette after waking
Accepted values
Within 5 minutes6-30 minutes31-60 minutesAfter 60 minutesinput.quit_interest
string
Quit interest
Accepted values
Ready to quitThinking about quittingNot ready to quitinput.current_smoker_start_date
string
Current smoker start date
input.former_smoker_start_date
string
Former smoker start date
input.former_smoker_stop_date
string
Former smoker stop date
input.current_every_day_smoker_start_date
string
Current every day smoker start date
input.current_some_day_smoker_start_date
string
Current some day smoker start date
input.light_tobacco_smoker_start_date
string
Light tobacco smoker start date
input.heavy_tobacco_smoker_start_date
string
Heavy tobacco smoker start date
input.time_since_last_smoked
string
Time since last smoked
Accepted values
Less than 1 month1-3 months3-6 months6-12 months1-5 years5-10 yearsGreater than 10 yearsinput.additional_tobacco_user_findings
array
List of additional tobacco user findings.
Accepted values
Rolls own cigarettese-cigaretteTrivial cigarette smoker (less than 1 cig/day)Light cigarette smoker (1-9 cigs/day)Moderate cigarette smoker (10-19 cigs/day)Heavy cigarette smoker (20-39 cigs/day)Very heavy cigarette smoker (40+ cigs/day)Chain smokerCigar smokerPipe smokerSnuff userChews fine cut tobaccoChews loose leaf tobaccoChews plug tobaccoChews tobaccoChews twist tobaccoUser of moist powdered tobaccoinput.additional_tobacco_nonuser_findings
array
List of additional tobacco nonuser findings.
Accepted values
Current nonsmokerCurrent nonsmoker, but past smoking history unknownAggressive nonsmokerIntolerant nonsmokerTolerant nonsmokerNonsmoker for medical reasonsNonsmoker for personal reasonsNonsmoker for religious reasonsEx-cigarette smokerEx-cigarette smoker amount unknownEx-trivial cigarette smoker (less than 1/day)Ex-light cigarette smoker (1-9/day)Ex-moderate cigarette smoker (10-19/day)Ex-heavy cigarette smoker (20-30/day)Ex-very heavy cigarette smoker (40+/day)Ex-cigar smokerEx-pipe smokerIntolerant ex-smokerTolerant ex-smokerNever chewed tobaccoDoes not use moist powdered tobaccoEx-user of moist powdered tobaccoNever used moist powdered tobaccoauth_id
string
requiredAuth id
Output Fields
submitted
boolean
Submitted
Code
curl --request POST \
--url https://api.ontross.com/api/integrations/ecw/submit-smart-form-tobacco \
--header 'X-API-Key: REPLACE_KEY_VALUE' \
--header 'content-type: application/json' \
--data '{"input":{"patientId":"patient_id","encounterId":"encounter_id","tobacco_use":"Current smoker","current_smoker_start_date":"06/17/2020","smoking_frequency":"Every day","cigarettes_per_day":"6-10","first_cigarette_after_waking":"6-30 minutes","quit_interest":"Thinking about quitting","additional_tobacco_user_findings":["e-cigarette"],"additional_tobacco_nonuser_findings":["Never chewed tobacco"]},"auth_id":"auth_uuid_here"}'Request BODY
{
"input": {
"patientId": "patient_id",
"encounterId": "encounter_id",
"tobacco_use": "Current smoker",
"current_smoker_start_date": "06/17/2020",
"smoking_frequency": "Every day",
"cigarettes_per_day": "6-10",
"first_cigarette_after_waking": "6-30 minutes",
"quit_interest": "Thinking about quitting",
"additional_tobacco_user_findings": [
"e-cigarette"
],
"additional_tobacco_nonuser_findings": [
"Never chewed tobacco"
]
},
"auth_id": "auth_uuid_here"
}