Tross
Demo dataBook a demo
ATHENA

Fetch patient procedures

Fetch patient procedures in Athena

POSThttps://preview.ontross.com/api/integrations/athena/fetch-patient-procedures
Request Fields
input.org_id
integer
required
Athena practice ID.
Example
64200
input.department_id
integer
required
Chart department ID.
Example
12
input.patient_id
integer
required
Practice patient ID.
Example
842701
input.limit
integer
required
Maximum records from one bounded source response.
Example
10
input.offset
integer
Local offset; pages refetch the source.
Example
0
Default
0
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
Requested practice patient ID.
Example
"842701"
chart_id
string
Resolved chart ID.
Example
"920415"
procedures
array
Surgical history records in source order.
procedures[].source_id
string
Athena surgical history record ID.
Example
"540325"
procedures[].name
string
Source procedure name.
Example
"laparoscopic cholecystectomy"
procedures[].source_status
string
Status supplied by Athena.
Example
"completed"
procedures[].source
string
Source category supplied by Athena.
Example
"backfill"
procedures[].note
string
Procedure note supplied by Athena.
procedures[].effective_date
string
Source date without inferred precision.
Example
"2019-03-22"
procedures[].date_mask
string
Source date precision mask.
Example
"MM/DD/YYYY"
procedures[].code
string
Primary procedure code.
Example
"47562"
procedures[].code_system
string
Source primary coding system.
Example
"2.16.840.1.113883.6.12"
procedures[].snomed_code
string
Source SNOMED code.
Example
"45595009"
procedures[].snomed_system
string
Source SNOMED system label.
Example
"SNOMED"
total_matching
integer
Records in the one source response.
Example
1
limit
integer
Requested local page size.
Example
10
offset
integer
Requested local offset.
Example
0
has_more
boolean
Whether that source response has more records.
Example
false
next_offset
integer
Next local offset, when present.
Example
10
Code
curl --request POST \
  --url https://preview.ontross.com/api/integrations/athena/fetch-patient-procedures \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"department_id":12,"limit":10,"offset":0,"org_id":64200,"patient_id":842701},"auth_id":"auth_uuid_here"}'
Request BODY
{
  "input": {
    "department_id": 12,
    "limit": 10,
    "offset": 0,
    "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",
    "has_more": false,
    "limit": 10,
    "offset": 0,
    "patient_id": "842701",
    "procedures": [
      {
        "code": "47562",
        "code_system": "2.16.840.1.113883.6.12",
        "date_mask": "MM/DD/YYYY",
        "effective_date": "2019-03-22",
        "name": "laparoscopic cholecystectomy",
        "note": "Laparoscopic cholecystectomy for symptomatic gallstones; recovery without complications.",
        "snomed_code": "45595009",
        "snomed_system": "SNOMED",
        "source": "backfill",
        "source_id": "540325",
        "source_status": "completed"
      }
    ],
    "total_matching": 1
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}