Ecw Fetch encounters patient

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

input.patientId

string

required

Patient chart being read or written, from fetch-patients.

Example

"100002"

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

Source visit record identifier for this history row.

Example

"100001"

encounters[].date

string

Calendar value returned for the historical visit.

Example

"2026-01-15"

encounters[].startTime

string

Appointment clock time displayed by the source system.

Example

"09:00:00"

encounters[].visitType

string

Scheduled care classification returned on the history row.

Example

"OV"

encounters[].status

string

Source disposition returned for the historical visit.

Example

"CHK"

encounters[].doctorID

string

Clinician identifier returned for the historical visit.

Example

"100003"

encounters[].reason

string

Recorded explanation for the patient's historical visit.

Example

"Annual wellness visit"

encounters[].encType

string

Source encounter classification represented as a string.

Example

"1"

encounters[].name

string

Source display label returned on the encounter row.

Example

"OV"

encounters[].officeVisitType

string

Office care classification returned on the encounter row.

Example

"1"

encounters[].encLock

string

Raw flag indicating whether further encounter edits are locked.

Example

"0"

encounters[].FacName

string

Display label of the historical care location.

Example

"Example Clinic"

encounters[].code

string

Source classification value returned on the encounter row.

Example

"EXAMPLE"

encounters[].EncId

string

Alternate source visit key, normally matching the primary identifier.

Example

"0"

encounters[].InBuffer

string

Raw scheduling buffer flag on the encounter row.

Example

"0"

encounters[].InBumpList

string

Raw flag indicating inclusion on the scheduling bump list.

Example

"0"

encounters[].resourceId

string

Identifier of the resource booked for this visit.

Example

"100003"

encounters[].BookAndCaseNo

string

Raw booking and case reference, usually empty.

Example

"0"

encounters[].ProgDisplay

string

Raw source display value passed through without interpretation.

Example

"0"

encounters[].HL7ID

string

External messaging interface reference, often left empty.

Example

"EXHL79000001"

encounters[].inPatientFlag

string

Raw flag indicating care during an inpatient stay.

Example

"0"

encounters[].ccmrvisit

string

Raw chronic care visit indicator, usually empty.

Example

"0"

encounters[].dermvisit

string

Raw dermatology visit indicator, usually left empty.

Example

"0"

encounters[].addendumId

string

Identifier of an attached amendment, empty when absent.

Example

"9001602"

encounters[].occHealthType

string

Occupational care classification returned on the encounter row.

Example

"0"

encounters[].visitCodeFlag

string

Raw billing classification flag on the encounter row.

Example

"1"

encounters[].visitTypeDetails

string

Additional scheduled care classification detail from the source.

Example

"Office Visit"

encounters[].facilityId

string

Identifier of the historical visit's care location.

Example

"100004"

encounters[].PregVisit

string

Raw flag identifying a pregnancy-related clinical visit.

Example

"0"

encounters[].blockedEncounter

string

Raw flag indicating restricted access to this visit.

Example

"0"

encounters[].ufname

string

Given name returned on the source encounter row.

Example

"Alex"

encounters[].ulname

string

Surname returned on the source encounter row.

Example

"Rivera"

encounters[].ClaimReq

string

Raw flag indicating that billing requires a claim.

Example

"1"

encounters[].isGroupEncounter

string

Raw flag identifying a shared group clinical visit.

Example

"false"

encounters[].rowcounter

string

Source row position in the returned encounter list.

Example

"1"

encounters[].ecwVisitStatusDesc

string

Raw eCW row counter on the encounter list.

Example

"Checked out"

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

Request BODY

{
  "input": {
    "patientId": "100002"
  },
  "auth_id": "auth_uuid_here"
}

Response BODY

{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "encounters": [
      {
        "encounterID": "100001",
        "date": "2026-01-15",
        "startTime": "09:00:00",
        "visitType": "OV",
        "status": "CHK",
        "doctorID": "100003",
        "reason": "Annual wellness visit",
        "encType": "1",
        "name": "OV",
        "officeVisitType": "1",
        "encLock": "0",
        "FacName": "Example Clinic",
        "code": "EXAMPLE",
        "EncId": "0",
        "InBuffer": "0",
        "InBumpList": "0",
        "resourceId": "100003",
        "BookAndCaseNo": "0",
        "ProgDisplay": "0",
        "HL7ID": "EXHL79000001",
        "inPatientFlag": "0",
        "ccmrvisit": "0",
        "dermvisit": "0",
        "addendumId": "9001602",
        "occHealthType": "0",
        "visitCodeFlag": "1",
        "visitTypeDetails": "Office Visit",
        "facilityId": "100004",
        "PregVisit": "0",
        "blockedEncounter": "0",
        "ufname": "Alex",
        "ulname": "Rivera",
        "ClaimReq": "1",
        "isGroupEncounter": "false",
        "rowcounter": "1",
        "ecwVisitStatusDesc": "Checked out"
      }
    ]
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}