Ecw Fetch encounters

POSThttps://preview.ontross.com/api/integrations/ecw/fetch-encounters

input.start_date

string

required

First service date of the encounter list filter range.

Example

"03/01/2026"

input.end_date

string

required

Last service date of the encounter list filter range.

Example

"03/31/2026"

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"

encounters

array

The encounter or appointment rows this call returned.

encounters[].encounterID

string

Encounter this row describes, or the patient's last or next appointment.

Example

"987654321"

encounters[].patientName

string

Name text matched against the live patient lookup.

Example

"Morgan, Avery"

encounters[].PatientId

string

Patient the encounter belongs to.

Example

"876543210"

encounters[].providerName

string

Provider on the encounter or smart form, may be null.

Example

"Jordan Ellis, MD"

encounters[].date

string

Picks the encounter or schedule day when encounterId is omitted.

Example

"03/12/2026"

encounters[].notesstatus

string

Progress note status, lowercase spelling on this operation.

Example

"Signed"

encounters[].encType

string

Encounter type code, an integer or string depending on operation.

Example

"1"

encounters[].resourceName

string

Resource name on the encounter row.

Example

"Jordan Ellis"

encounters[].insuranceid

string

Identifier of the payer on this encounter.

Example

"7654321"

encounters[].insurancename

string

Payer name, lowercase here but insuranceName in encounter review.

Example

"Aetna"

encounters_total

integer

Total encounter count eCW reported for the date filter.

Example

42

curl --request POST \
  --url https://preview.ontross.com/api/integrations/ecw/fetch-encounters \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"start_date":"03/01/2026","end_date":"03/31/2026"},"auth_id":"auth_uuid_here"}'

Request BODY

{
  "input": {
    "start_date": "03/01/2026",
    "end_date": "03/31/2026"
  },
  "auth_id": "auth_uuid_here"
}

Response BODY

{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "encounters": [
      {
        "encounterID": "987654321",
        "patientName": "Morgan, Avery",
        "PatientId": "876543210",
        "providerName": "Jordan Ellis, MD",
        "date": "03/12/2026",
        "notesstatus": "Signed",
        "encType": "1",
        "resourceName": "Jordan Ellis",
        "insuranceid": "7654321",
        "insurancename": "Aetna"
      }
    ],
    "encounters_total": 42
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}