Tross
Demo dataBook a demo
ECLINICALWORKS

Write social history

Write the social history note.

POSThttps://preview.ontross.com/api/integrations/ecw/write-social-history
Request Fields
input.patientId
string
required
eClinicalWorks patient identifier for the current chart.
Example
"100001"
input.encounterId
string
required
Encounter identifier where the Social History note will be written.
Example
"200001"
input.socialHistoryNotes
string
Free-text Social History note content to write. Social History has no note categories.
Example
"Lives with family and reports regular weekly exercise."
Default
""
input.append_input
boolean
If true, append socialHistoryNotes to existing note content. If false, write only the provided socialHistoryNotes value.
Example
false
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-social-history \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"patientId":"100001","encounterId":"200001","socialHistoryNotes":"Lives with family and reports regular weekly exercise.","append_input":false},"auth_id":"auth_uuid_here"}'
Request BODY
{
  "input": {
    "patientId": "100001",
    "encounterId": "200001",
    "socialHistoryNotes": "Lives with family and reports regular weekly exercise.",
    "append_input": false
  },
  "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"
}