Tross
ECLINICALWORKS

Write Examination Notes

Write examination notes in eClinicalWorks

POSThttps://api.ontross.com/api/integrations/ecw/write-examination-notes
Request Fields
input
object
required
Input object.
input.patientId
string
required
Patient id
input.encounterId
string
required
Encounter id
input.examItems
array
List of exam Items.
input.examItems[].category
string
Examination category name fallback (used when categoryId is not provided).
Default
""
input.examItems[].categoryId
string
Numeric Examination category id from fetch-chart-catalog (keyName=Examination). Preferred over category name.
Default
""
input.examItems[].data
string
Free-text examination note content to write for the selected category.
input.examItems[].propId
string
Optional ECW propId for structured templates. Defaults to 0 when omitted.
Default
""
input.append_input
boolean
Append input
Default
false
auth_id
string
required
Auth id
Output Fields
writeSuccess
boolean
Write success
written
array
List of written.
written[].category
string
Category
written[].categoryId
string
Category id
written[].propId
string
Prop id
written[].dataWritten
string
Data written
Code
curl --request POST \
  --url https://api.ontross.com/api/integrations/ecw/write-examination-notes \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"patientId":"string_id","encounterId":"string_id","examItems":[],"append_input":false},"auth_id":"auth_uuid_here"}'
Request BODY
{
  "input": {
    "patientId": "string_id",
    "encounterId": "string_id",
    "examItems": [],
    "append_input": false
  },
  "auth_id": "auth_uuid_here"
}