Tross
Demo dataBook a demo
ECLINICALWORKS

Fetch referrals

List incoming and outgoing referrals.

POSThttps://preview.ontross.com/api/integrations/ecw/fetch-referrals
Request Fields
input.patientId
string
required
Patient chart being read or written, from fetch-patients.
Example
"348144"
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
incoming
array
Referrals sent to your practice for this patient.
incoming[].referralId
string
eCW record id for this referral.
Example
"9000101"
incoming[].direction
string
Incoming means the referral came to your practice, outgoing means it left.
Example
"outgoing"
incoming[].specialty
string
Specialty the referral was sent to.
Example
"Cardiology"
incoming[].status
string
Current disposition recorded for the care referral.
Example
"Open"
incoming[].referralDate
string
Date eCW records on the referral itself.
Example
"10/06/2026"
incoming[].startDate
string
Authorization start date on the referral.
Example
"10/06/2026"
incoming[].endDate
string
Date the referral authorization stops being valid.
Example
"01/06/2027"
incoming[].referringProvider
string
Provider who made the referral.
Example
"Example,Alex"
incoming[].referredToProvider
string
Provider the patient was referred to.
Example
"Example,Taylor"
incoming[].reason
string
Why the call or hospitalization happened, saved as row text.
Example
"Evaluation of intermittent palpitations"
outgoing
array
Referrals the practice sent out for this patient.
outgoing[].referralId
string
eCW record id for this referral.
Example
"9000101"
outgoing[].direction
string
Incoming means the referral came to your practice, outgoing means it left.
Example
"outgoing"
outgoing[].specialty
string
Specialty the referral was sent to.
Example
"Cardiology"
outgoing[].status
string
Current disposition recorded for the care referral.
Example
"Open"
outgoing[].referralDate
string
Date eCW records on the referral itself.
Example
"10/06/2026"
outgoing[].startDate
string
Authorization start date on the referral.
Example
"10/06/2026"
outgoing[].endDate
string
Date the referral authorization stops being valid.
Example
"01/06/2027"
outgoing[].referringProvider
string
Provider who made the referral.
Example
"Example,Alex"
outgoing[].referredToProvider
string
Provider the patient was referred to.
Example
"Example,Taylor"
outgoing[].reason
string
Why the call or hospitalization happened, saved as row text.
Example
"Evaluation of intermittent palpitations"
Code
curl --request POST \
  --url https://preview.ontross.com/api/integrations/ecw/fetch-referrals \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"patientId":"348144"},"auth_id":"auth_uuid_here"}'
Request BODY
{
  "input": {
    "patientId": "348144"
  },
  "auth_id": "auth_uuid_here"
}
Response BODY
{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "incoming": [
      {
        "referralId": "9000101",
        "direction": "outgoing",
        "specialty": "Cardiology",
        "status": "Open",
        "referralDate": "10/06/2026",
        "startDate": "10/06/2026",
        "endDate": "01/06/2027",
        "referringProvider": "Example,Alex",
        "referredToProvider": "Example,Taylor",
        "reason": "Evaluation of intermittent palpitations"
      }
    ],
    "outgoing": [
      {
        "referralId": "9000101",
        "direction": "outgoing",
        "specialty": "Cardiology",
        "status": "Open",
        "referralDate": "10/06/2026",
        "startDate": "10/06/2026",
        "endDate": "01/06/2027",
        "referringProvider": "Example,Alex",
        "referredToProvider": "Example,Taylor",
        "reason": "Evaluation of intermittent palpitations"
      }
    ]
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}