Tross
Demo dataBook a demo
ECLINICALWORKS

Write examination notes

Write physical examination notes by category.

POSThttps://preview.ontross.com/api/integrations/ecw/write-examination-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.examItems
array
Examination entries, each pairing a category with its note text.
input.examItems[].category
string
Examination category name fallback (used when categoryId is not provided).
Example
"General Examination"
Default
""
input.examItems[].categoryId
string
Numeric Examination category id from fetch-chart-catalog (keyName=Examination). Preferred over category name.
Example
"55"
Default
""
input.examItems[].data
string
Free-text examination note content to write for the selected category.
Example
"General appearance: well developed, no acute distress."
input.examItems[].propId
string
Optional ECW propId for structured templates. Defaults to 0 when omitted.
Example
"0"
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
written
array
The rows eCW actually wrote, with assigned ids.
written[].category
string
Category display name, used only as a fallback for categoryId.
Example
"General Examination"
written[].categoryId
string
Chart category for the section being written, from fetch-chart-catalog.
Example
"900103"
written[].propId
string
Structured examination template id, sent as 0 when unused.
Example
"0"
written[].dataWritten
string
Examination text eCW held for this category after writing.
Example
"General appearance: well developed, no acute distress."
Code
curl --request POST \
  --url https://preview.ontross.com/api/integrations/ecw/write-examination-notes \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"patientId":"407069","encounterId":"1870494","examItems":[{"categoryId":"455294","data":"General appearance: well developed, no acute distress."}],"append_input":true},"auth_id":"auth_uuid_here"}'
Request BODY
{
  "input": {
    "patientId": "407069",
    "encounterId": "1870494",
    "examItems": [
      {
        "categoryId": "455294",
        "data": "General appearance: well developed, no acute distress."
      }
    ],
    "append_input": true
  },
  "auth_id": "auth_uuid_here"
}
Response BODY
{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "writeSuccess": true,
    "written": []
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}