Athena Write hpi note

POSThttps://preview.ontross.com/api/integrations/athena/write-hpi-note

input.encounter_id

string

required

Encounter whose note is read or written, from fetch-encounters-patient.

Example

"19706"

input.org_id

string

required

Practice context, shown in the athenanet portal URL.

Example

47902

input.hpi_note

string

required

History of present illness text for the encounter's HPI section.

Example

"Patient reports two weeks of worsening anxiety and disrupted sleep."

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"

success

boolean

Whether the note save returned an HTTP success, nothing more.

Example

true

status

integer

HTTP response code from saving, or zero when unavailable.

Example

200

curl --request POST \
  --url https://preview.ontross.com/api/integrations/athena/write-hpi-note \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"encounter_id":"19706","org_id":47902,"hpi_note":"Patient reports two weeks of worsening anxiety and disrupted sleep."},"auth_id":"auth_uuid_here"}'

Request BODY

{
  "input": {
    "encounter_id": "19706",
    "org_id": 47902,
    "hpi_note": "Patient reports two weeks of worsening anxiety and disrupted sleep."
  },
  "auth_id": "auth_uuid_here"
}

Response BODY

{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "success": true,
    "status": 200
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}