DENTRIX-ASCEND
Fetch patients
Retrieve demographics and coverage for selected patients.
POSThttps://api.ontross.com/api/integrations/dentrix-ascend/fetch-patients
Request Fields
input.patient_ids
array
requiredPatient ids, e.g. from fetch-appointments.
Example
["64000004467586"]auth_id
string
requiredSaved 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
patients
array
Demographic records and coverage summaries for the requested people.
patients[].id
string
Person identifier returned by the demographics lookup.
Example
"64000004467586"patients[].display_full_name
string
Complete personal display label returned by the demographics lookup.
Example
"Jordan Sample"patients[].last_name
string
Person's family surname returned by the demographics lookup.
Example
"Sample"patients[].age
integer
Person's reported years from the demographics record.
Example
42patients[].status
string
Person's record state returned by the demographics lookup.
Example
"ACTIVE"patients[].primary_provider_id
string
Assigned clinician identifier extracted from nested primaryProvider data.
Example
"64999999026082"patients[].insurance_plans
array
Coverage summaries extracted from the person's nested insurance records.
patients[].insurance_plans[].id
string
Person's coverage record identifier from nested insurance data.
Example
"64999999731842"patients[].insurance_plans[].eligible
string
Coverage qualification indicator returned as text rather than boolean.
Example
"YES"patients[].insurance_plans[].eligibility_response
string
Coverage qualification response text from the nested insurance record.
Example
"Eligible"patients[].insurance_plans[].start_date_epoch_ms
integer
Coverage beginning returned as integer Unix milliseconds.
Example
1767225600000patients[].insurance_plans[].end_date_epoch_ms
integer
Coverage ending returned as integer Unix milliseconds.
Example
1798675200000count
integer
Total people in the returned collection.
Example
12Code
curl --request POST \
--url https://api.ontross.com/api/integrations/dentrix-ascend/fetch-patients \
--header 'X-API-Key: REPLACE_KEY_VALUE' \
--header 'content-type: application/json' \
--data '{"input":{"patient_ids":["64000004467586"]},"auth_id":"auth_uuid_here"}'Request BODY
{
"input": {
"patient_ids": [
"64000004467586"
]
},
"auth_id": "auth_uuid_here"
}Response BODY
{
"id": "string",
"workflow_id": "string",
"auth_id": "string",
"status": "string",
"input": {},
"output": {
"patients": [
{
"id": "64000004467586",
"display_full_name": "Jordan Sample",
"last_name": "Sample",
"age": 42,
"status": "ACTIVE",
"primary_provider_id": "64999999026082",
"insurance_plans": [
{
"id": "64999999731842",
"eligible": "YES",
"eligibility_response": "Eligible",
"start_date_epoch_ms": 1767225600000,
"end_date_epoch_ms": 1798675200000
}
]
}
],
"count": 12
},
"files": null,
"created_at": "2019-08-24T14:15:22Z",
"started_at": "2019-08-24T14:15:22Z",
"completed_at": "2019-08-24T14:15:22Z"
}