Tross
ATHENA PROD

Fetch patient

Get patient demographics and summary data.

POSThttps://api.ontross.com/api/integrations/athena-prod/fetch-patient
Request Fields
input.org_id
string
required
Existing practice ID string.
Example
"93171"
input.patient_id
string
required
Existing patient ID string; practice-prefixed IDs remain accepted.
Example
"1744"
input.department_id
integer
Department id
Example
3
input.include_context
boolean
Include context
Example
true
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
contact_data
object
Contact data object.
quickview_data
object
Quickview data object.
banner_data
object
Banner data object.
patient_context
object
Patient context object.
patient_context.patient
object
Patient object.
patient_context.patient.patient_id
string
Source identifiers remain strings.
patient_context.patient.first_name
string
First name
patient_context.patient.last_name
string
Last name
patient_context.patient.dob
string
Dob
patient_context.chart_id
string
Chart id
patient_context.current_department_id
string
Current department id
patient_context.current_department_name
string
Current department name
patient_context.registration_department_id
string
Registration department id
patient_context.primary_provider_id
string
Primary provider id
patient_context.context_token
string
Context token
patient_context.expires_at
string
Expires at
Code
curl --request POST \
  --url https://api.ontross.com/api/integrations/athena-prod/fetch-patient \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"org_id":"93171","patient_id":"1744","department_id":1,"include_context":false},"auth_id":"auth_uuid_here"}'
Request BODY
{
  "input": {
    "org_id": "93171",
    "patient_id": "1744",
    "department_id": 1,
    "include_context": false
  },
  "auth_id": "auth_uuid_here"
}
Response BODY
{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "contact_data": {},
    "quickview_data": {},
    "banner_data": {},
    "patient_context": {
      "patient": {
        "patient_id": "string",
        "first_name": "string",
        "last_name": "string",
        "dob": "2019-08-24"
      },
      "chart_id": "string",
      "current_department_id": "string",
      "current_department_name": "string",
      "registration_department_id": "string",
      "primary_provider_id": "string",
      "context_token": "string",
      "expires_at": "2019-08-24T14:15:22Z"
    }
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}