Tross
Demo dataBook a demo
ECLINICALWORKS

Write family history

Write the family history note.

POSThttps://preview.ontross.com/api/integrations/ecw/write-family-history
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.familyHistoryNotes
string
Free-text Family History narrative. Family History has no note categories.
Example
"Father has hypertension; mother has type 2 diabetes."
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-family-history \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"patientId":"407069","encounterId":"1870494","familyHistoryNotes":"Father has hypertension; mother has type 2 diabetes.","append_input":true},"auth_id":"auth_uuid_here"}'
Request BODY
{
  "input": {
    "patientId": "407069",
    "encounterId": "1870494",
    "familyHistoryNotes": "Father has hypertension; mother has type 2 diabetes.",
    "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"
}