Tross
ECLINICALWORKS

Get patient insurance

Get a patient's insurance coverages and financial guarantor.

POSThttps://api.ontross.com/api/integrations/ecw/get-patient-insurance
Request Fields
input.patientId
string
required
Patient chart whose coverage records are read, from fetch-patients.
Example
"407069"
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
patientId
string
Patient chart the coverage records were read for.
Example
"407069"
insurances
array
Coverage records held for this patient, in the order ECW returns them.
insurances[].name
string
Coverage carrier display label from the patient record.
Example
"Example Health Plan"
insurances[].state
string
Regional address value returned for the coverage record.
Example
"CO"
insurances[].subscriberNo
string
Policyholder membership identifier returned with the coverage record.
Example
"05162828"
insurances[].rel
string
Patient relationship to the policyholder on this coverage.
Example
"1"
insurances[].insured
string
Covered policyholder wording returned with the insurance record.
Example
"Doe, Jane"
insurances[].coPay
string
Patient contribution amount returned with the coverage record.
Example
"25.00"
insurances[].groupNo
string
Employer or plan grouping identifier for this coverage.
Example
"EXG900123"
insurances[].city
string
Municipality address value returned for the coverage record.
Example
"Riverton"
insurances[].insType
string
Coverage classification returned with the patient insurance record.
Example
"QG"
insurances[].active
string
Raw indicator of whether this coverage is current.
Example
"F"
insurances[].feeSchedName
string
Display label of the associated billing rate schedule.
Example
"Standard"
responsibleParty
object
Financial guarantor recorded alongside the coverage records, when ECW returns one.
responsibleParty.grId
string
Source identifier for the patient's financial guarantor.
Example
"900002"
responsibleParty.grName
string
Display label of the patient's financial guarantor.
Example
"Example,Casey"
responsibleParty.grPhone
string
Telephone contact number for the patient's financial guarantor.
Example
"202-555-0145"
responsibleParty.grRel
string
Relationship between the patient and the financial guarantor.
Example
"Spouse"
responsibleParty.isGrPt
string
Raw flag indicating the patient guarantees their own charges.
Example
"0"
Code
curl --request POST \
  --url https://api.ontross.com/api/integrations/ecw/get-patient-insurance \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"patientId":"407069"},"auth_id":"auth_uuid_here"}'
Request BODY
{
  "input": {
    "patientId": "407069"
  },
  "auth_id": "auth_uuid_here"
}
Response BODY
{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "patientId": "407069",
    "insurances": [
      {
        "name": "Example Health Plan",
        "state": "CO",
        "subscriberNo": "05162828",
        "rel": "1",
        "insured": "Doe, Jane",
        "coPay": "25.00",
        "groupNo": "EXG900123",
        "city": "Riverton",
        "insType": "QG",
        "active": "F",
        "feeSchedName": "Standard"
      }
    ],
    "responsibleParty": {
      "grId": "900002",
      "grName": "Example,Casey",
      "grPhone": "202-555-0145",
      "grRel": "Spouse",
      "isGrPt": "0"
    }
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}