Tross
ATHENA PROD

Update encounter hpi

Update encounter hpi in Athena Prod

POSThttps://api.ontross.com/api/integrations/athena-prod/update-encounter-hpi
Request Fields
input.org_id
integer
required
Athena practice ID.
Example
64200
input.department_id
integer
required
Encounter department ID.
Example
12
input.patient_id
integer
required
Practice patient ID.
Example
842701
input.encounter_id
string
required
Exact encounter ID; dates do not select encounters.
Example
"650218"
input.note_html
string
required
Replacement HPI HTML; only div, p, br, strong, em, b and i tags without attributes are supported.
input.expected_note_version
string
required
Note version from the preceding HPI read.
Example
"730045"
input.expected_section_version
string
required
Section version from the preceding HPI read.
Example
"730046"
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
patient_id
string
Verified patient ID.
Example
"842701"
chart_id
string
Verified chart ID.
Example
"920415"
encounter_id
string
Verified encounter ID.
Example
"650218"
encounter_status
string
Status supplied by Athena.
Example
"OPEN"
note_html
string
Current HPI free-text HTML.
note_version
string
Current note version token, required for updates.
Example
"730045"
section_version
string
Current HPI section container token, required for updates.
Example
"730046"
outcome
string
Updated after verified read-back, or unchanged when the current note already matches.
Example
"updated"
Code
curl --request POST \
  --url https://api.ontross.com/api/integrations/athena-prod/update-encounter-hpi \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"department_id":12,"encounter_id":"650218","expected_note_version":"730045","expected_section_version":"730046","note_html":"<div>Reports intermittent right knee pain for two weeks, worse after running. No recent injury, fever, swelling, locking, or inability to bear weight.</div><div>Symptoms improve with rest. Able to bear weight.</div>","org_id":64200,"patient_id":842701},"auth_id":"auth_uuid_here"}'
Request BODY
{
  "input": {
    "department_id": 12,
    "encounter_id": "650218",
    "expected_note_version": "730045",
    "expected_section_version": "730046",
    "note_html": "<div>Reports intermittent right knee pain for two weeks, worse after running. No recent injury, fever, swelling, locking, or inability to bear weight.</div><div>Symptoms improve with rest. Able to bear weight.</div>",
    "org_id": 64200,
    "patient_id": 842701
  },
  "auth_id": "auth_uuid_here"
}
Response BODY
{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "chart_id": "920415",
    "encounter_id": "650218",
    "encounter_status": "OPEN",
    "note_html": "<div>Reports intermittent right knee pain for two weeks, worse after running. No recent injury, fever, swelling, locking, or inability to bear weight.</div><div>Symptoms improve with rest. Able to bear weight.</div>",
    "note_version": "730047",
    "outcome": "updated",
    "patient_id": "842701",
    "section_version": "730048"
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}