Tross
Demo dataBook a demo
ECLINICALWORKS

Submit smart form tobacco

Submit the tobacco control screening form.

POSThttps://preview.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_date
  • smoking_frequency and cigarettes_per_day
  • first_cigarette_after_waking and quit_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_date
  • Current some day smoker → current_some_day_smoker_start_date
  • Light tobacco smoker → light_tobacco_smoker_start_date
  • Heavy 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.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.tobacco_use
string
required
Tobacco status, which decides the follow-up answers and dates allowed.
Example
"Current smoker"
Accepted values
Current smokerFormer smokerNonsmokerCurrent every day smokerCurrent some day smokerSmoker, current status unknownUnknown if ever smokedLight tobacco smokerHeavy tobacco smokerUses tobacco in other forms
input.smoking_frequency
string
Whether current smoking is daily or only some days.
Example
"Every day"
Accepted values
Every daySome days, but not every day
input.cigarettes_per_day
string
Cigarettes smoked per day, asked only of current smokers.
Example
"6-10"
Accepted values
5 or less6-1011-2021-3031 or more
input.first_cigarette_after_waking
string
How soon after waking the patient smokes, for current smokers.
Example
"6-30 minutes"
Accepted values
Within 5 minutes6-30 minutes31-60 minutesAfter 60 minutes
input.quit_interest
string
How ready the patient is to quit tobacco.
Example
"Thinking about quitting"
Accepted values
Ready to quitThinking about quittingNot ready to quit
input.current_smoker_start_date
string
Optional start date for tobacco_use 'Current smoker'. Required format: MM/DD/YYYY (for example, 06/17/2020). Do not send ISO dates such as 2020-06-17.
Example
"06/17/2020"
input.former_smoker_start_date
string
Optional start date for tobacco_use 'Former smoker'. Required format: MM/DD/YYYY (for example, 06/17/2020). Do not send ISO dates such as 2020-06-17.
Example
"06/17/2005"
input.former_smoker_stop_date
string
Optional stop date for tobacco_use 'Former smoker'. Required format: MM/DD/YYYY (for example, 06/17/2020). Do not send ISO dates such as 2020-06-17.
Example
"06/17/2020"
input.current_every_day_smoker_start_date
string
Optional start date for tobacco_use 'Current every day smoker'. Required format: MM/DD/YYYY (for example, 06/17/2020). Do not send ISO dates such as 2020-06-17.
Example
"06/17/2020"
input.current_some_day_smoker_start_date
string
Optional start date for tobacco_use 'Current some day smoker'. Required format: MM/DD/YYYY (for example, 06/17/2020). Do not send ISO dates such as 2020-06-17.
Example
"06/17/2020"
input.light_tobacco_smoker_start_date
string
Optional start date for tobacco_use 'Light tobacco smoker'. Required format: MM/DD/YYYY (for example, 06/17/2020). Do not send ISO dates such as 2020-06-17.
Example
"06/17/2020"
input.heavy_tobacco_smoker_start_date
string
Optional start date for tobacco_use 'Heavy tobacco smoker'. Required format: MM/DD/YYYY (for example, 06/17/2020). Do not send ISO dates such as 2020-06-17.
Example
"06/17/2020"
input.time_since_last_smoked
string
How long since the patient last smoked, for former smokers.
Example
"1-5 years"
Accepted values
Less than 1 month1-3 months3-6 months6-12 months1-5 years5-10 yearsGreater than 10 years
input.additional_tobacco_user_findings
array
Extra tobacco-user findings, each adding its own form row.
Example
["Cigar smoker","Rolls own cigarettes"]
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 tobacco
input.additional_tobacco_nonuser_findings
array
Extra nonsmoker findings, each adding its own form row.
Example
["Current nonsmoker","Never chewed tobacco"]
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 tobacco
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-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"
}
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"
}