Tross
Demo dataBook a demo
ECLINICALWORKS

Write ros notes

Write review of systems notes.

POSThttps://preview.ontross.com/api/integrations/ecw/write-ros-notes
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.categoryId
string
required
Numeric Review of Systems category id from fetch-chart-catalog (keyName=ReviewOfSystems). Marks which category node is selected/reviewed in ECW, but rosNotes is stored as a single shared ROS narrative for the whole encounter (not scoped per category) — writing again with a different categoryId overwrites/appends to the same shared note, not a separate one.
Example
"456202"
input.rosNotes
string
Review of Systems narrative, one shared per encounter, not per category.
Example
"All other systems reviewed and negative."
Default
""
input.append_input
boolean
Appends text after the stored note instead of replacing it.
Example
true
Default
false
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
writeSuccess
boolean
Whether eCW accepted the chart write.
Example
true
Code
curl --request POST \
  --url https://preview.ontross.com/api/integrations/ecw/write-ros-notes \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"patientId":"407069","encounterId":"1870494","rosNotes":"All other systems reviewed and negative.","categoryId":"456202","append_input":true},"auth_id":"auth_uuid_here"}'
Request BODY
{
  "input": {
    "patientId": "407069",
    "encounterId": "1870494",
    "rosNotes": "All other systems reviewed and negative.",
    "categoryId": "456202",
    "append_input": true
  },
  "auth_id": "auth_uuid_here"
}
Response BODY
{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "writeSuccess": true
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}