Tross
Demo dataBook a demo
ECLINICALWORKS

Create telephonic encounter

Create a telephonic encounter.

POSThttps://preview.ontross.com/api/integrations/ecw/create-telephonic-encounter
Request Fields
input.patientId
string
required
Patient chart being read or written, from fetch-patients.
Example
"407069"
input.providerId
string
required
Provider the telephone encounter is booked under, from fetch-providers.
Example
"6086"
input.assignedToId
string
required
Staff member assigned the telephone encounter, from the practice user list.
Example
"6018"
input.reason
string
required
Why the call or hospitalization happened, saved as row text.
Example
"Medication refill request"
input.facilityId
string
required
Facility the telephone encounter is booked at, from the facility list.
Example
"24"
input.encDate
string
Date of the telephone encounter, defaulting to today.
Example
"03/14/2026"
Default
""
input.encTime
string
Time of the telephone encounter, 12-hour or 24-hour, defaulting to now.
Example
"10:00 AM"
Default
""
input.assignedToLabel
string
Display label for the assignee, sent alongside assignedToId.
Example
"Patel,Rina"
Default
""
input.pos
integer
Place-of-service code for the telephone encounter, defaulting to 11.
Example
40
Default
11
input.priority
integer
Priority stored on the telephone encounter, defaulting to 1.
Example
1
Default
1
input.strictPrechecks
boolean
Confirms the assignee is active, permitted, and in office first.
Example
true
Default
false
input.pd
string
Opaque query token, left empty unless the session supplies one.
Example
"8d395fa4e7ba65d90f33c6059d112ce4"
Default
""
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
encounterId
string
Encounter being read or written, from fetch-appointments.
Example
"9000003"
created
boolean
Whether eCW accepted the new telephonic encounter.
Example
true
warnings
array
Precheck messages raised while creating the telephonic encounter.
Code
curl --request POST \
  --url https://preview.ontross.com/api/integrations/ecw/create-telephonic-encounter \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"patientId":"407069","providerId":"6086","assignedToId":"6018","reason":"Medication refill request","facilityId":"24","encDate":"03/14/2026","encTime":"10:00 AM","assignedToLabel":"Patel,Rina","pos":40,"priority":1,"strictPrechecks":true,"pd":"8d395fa4e7ba65d90f33c6059d112ce4"},"auth_id":"auth_uuid_here"}'
Request BODY
{
  "input": {
    "patientId": "407069",
    "providerId": "6086",
    "assignedToId": "6018",
    "reason": "Medication refill request",
    "facilityId": "24",
    "encDate": "03/14/2026",
    "encTime": "10:00 AM",
    "assignedToLabel": "Patel,Rina",
    "pos": 40,
    "priority": 1,
    "strictPrechecks": true,
    "pd": "8d395fa4e7ba65d90f33c6059d112ce4"
  },
  "auth_id": "auth_uuid_here"
}
Response BODY
{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "encounterId": "9000003",
    "created": true,
    "warnings": [
      "string"
    ]
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}