Tross
Demo dataBook a demo
ECLINICALWORKS

Write hpi notes

Write HPI notes for a category.

POSThttps://preview.ontross.com/api/integrations/ecw/write-hpi-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.hpiData
string
required
History of Present Illness text for the chosen HPI category.
Example
"Patient reports three days of worsening sore throat."
input.categoryId
string
Numeric HPI category id from fetch-chart-catalog (keyName=HPI). Preferred over category name.
Example
"540017"
Default
""
input.category
string
HPI category name fallback used only when categoryId is not provided.
Example
"General"
Default
""
input.append_input
boolean
Appends text after the stored note instead of replacing it.
Example
true
Default
false
input.prepend_input
boolean
When true, prepend hpiData to the existing HPI note for the selected category. Cannot be used with append_input.
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-hpi-notes \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"patientId":"407069","encounterId":"1870494","hpiData":"Patient reports three days of worsening sore throat.","categoryId":"540017","category":"General","append_input":true,"prepend_input":true},"auth_id":"auth_uuid_here"}'
Request BODY
{
  "input": {
    "patientId": "407069",
    "encounterId": "1870494",
    "hpiData": "Patient reports three days of worsening sore throat.",
    "categoryId": "540017",
    "category": "General",
    "append_input": true,
    "prepend_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"
}