Tross
ECLINICALWORKS

Write Hpi Notes

Write hpi notes in eClinicalWorks

POSThttps://api.ontross.com/api/integrations/ecw/write-hpi-notes
Request Fields
input
object
required
Input object.
input.patientId
string
required
Patient id
input.encounterId
string
required
Encounter id
input.hpiData
string
required
Hpi data
input.categoryId
string
Numeric HPI category id from fetch-chart-catalog (keyName=HPI). Preferred over category name.
Default
""
input.category
string
HPI category name fallback used only when categoryId is not provided.
Default
""
input.append_input
boolean
Append input
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.
Default
false
auth_id
string
required
Auth id
Output Fields
writeSuccess
boolean
Write success
Code
curl --request POST \
  --url https://api.ontross.com/api/integrations/ecw/write-hpi-notes \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"patientId":"string_id","encounterId":"string_id","hpiData":"string","categoryId":"540017","category":"General","append_input":false,"prepend_input":false},"auth_id":"auth_uuid_here"}'
Request BODY
{
  "input": {
    "patientId": "string_id",
    "encounterId": "string_id",
    "hpiData": "string",
    "categoryId": "540017",
    "category": "General",
    "append_input": false,
    "prepend_input": false
  },
  "auth_id": "auth_uuid_here"
}