Tross
Demo dataBook a demo
ECLINICALWORKS

Update visit status

Set the visit status on an appointment.

POSThttps://preview.ontross.com/api/integrations/ecw/update-visit-status
Request Fields
input.encounterId
string
required
Encounter being read or written, from fetch-appointments.
Example
"1870494"
input.visitStatus
string
required
New appointment status, limited to check-out and no-show here.
Example
"Checked out"
Accepted values
Checked outNo Show
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
updated
boolean
Whether the write was accepted, or a raw phone-slot flag.
Example
true
Code
curl --request POST \
  --url https://preview.ontross.com/api/integrations/ecw/update-visit-status \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"encounterId":"1870494","visitStatus":"Checked out"},"auth_id":"auth_uuid_here"}'
Request BODY
{
  "input": {
    "encounterId": "1870494",
    "visitStatus": "Checked out"
  },
  "auth_id": "auth_uuid_here"
}
Response BODY
{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "updated": true
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}