Tross
Demo dataBook a demo
ECLINICALWORKS

Smart forms for encounter id

List smart forms for an encounter.

POSThttps://preview.ontross.com/api/integrations/ecw/smart-forms-for-encounter-id
Request Fields
input.encounter_id
string
required
Same encounter identifier, in the snake_case spelling these operations expect.
Example
"9620412"
input.patient_id
string
required
Same patient identifier, in the snake_case spelling these operations expect.
Example
"348144"
input.is_from_sf_dropdown
boolean
Smart-form dropdown context, which changes which forms are returned.
Example
true
Default
true
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
smart_forms
array
Smart forms attached to the requested encounter.
smart_forms[].tempId
integer
eCW template id behind this smart form.
Example
790
smart_forms[].tempName
string
Template name of this smart form.
Example
"Jane Doe"
smart_forms[].enableScore
integer
Nonzero when the smart form computes a score.
Example
0
smart_forms[].partialScoring
integer
Whether the form allows partial scoring, as 0 or 1.
Example
0
smart_forms[].categoryId
integer
Chart category for the section being written, from fetch-chart-catalog.
Example
0
smart_forms[].displayIndex
integer
Row position, either the smart form's order or the allergy's.
Example
0
smart_forms[].modiby
integer
eCW user id that last modified the form.
Example
0
smart_forms[].modiTime
string
Time this smart form was last modified.
Example
"09:30:00"
smart_forms[].entryId
integer
Identifier of the filled form instance, zero when unfilled.
Example
0
smart_forms[].isCompleted
integer
Whether this smart form is filled in, as 0 or 1.
Example
0
smart_forms[].formUrl
string
eCW page path that renders this smart form.
Example
"Example text."
smart_forms[].formType
string
Which kind of smart form this entry is.
Example
"Example text."
smart_forms[].newlyAdded
boolean
Whether the smart form was just added, may be null.
Example
false
smart_forms[].encounterId
integer
Encounter being read or written, from fetch-appointments.
Example
9000001
smart_forms[].smartFormsCount
integer
Total smart forms on the encounter, repeated per form.
Example
0
smart_forms[].providerName
string
Provider on the encounter or smart form, may be null.
Example
"Example,Alex"
smart_forms[].modiDate
string
Date this smart form was last modified.
Example
"10/06/2026"
Code
curl --request POST \
  --url https://preview.ontross.com/api/integrations/ecw/smart-forms-for-encounter-id \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"encounter_id":"9620412","patient_id":"348144","is_from_sf_dropdown":true},"auth_id":"auth_uuid_here"}'
Request BODY
{
  "input": {
    "encounter_id": "9620412",
    "patient_id": "348144",
    "is_from_sf_dropdown": true
  },
  "auth_id": "auth_uuid_here"
}
Response BODY
{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "smart_forms": []
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}