ECLINICALWORKS
Fetch encounter review
List reviewed encounters with notes and coding.
POSThttps://preview.ontross.com/api/integrations/ecw/fetch-encounter-review
Request Fields
input.start_date
string
requiredFirst service date of the encounter list filter range.
Example
"03/01/2026"input.end_date
string
requiredLast service date of the encounter list filter range.
Example
"03/31/2026"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
encounters
array
The encounter or appointment rows this call returned.
encounters[].date
string
Picks the encounter or schedule day when encounterId is omitted.
Example
"02/03/2026"encounters[].EncounterId
string
Encounter this review row describes.
Example
"987650321"encounters[].ClaimId
string
Billing claim eCW attached to this encounter.
Example
"987650654"encounters[].resource
string
Resource name on the encounter under review.
Example
"Morgan Testwell, MD"encounters[].notesStatus
string
Progress note status for the encounter under review.
Example
"Completed"encounters[].Duration
string
Scheduled length of the appointment slot.
Example
"30"encounters[].UsrId
string
eCW user tied to the encounter in Encounter Review.
Example
"987650087"encounters[].created_datetime
string
When the encounter record itself was created in eCW.
Example
"2026-02-02 14:30:00"encounters[].VisitStatus
string
Visit status label such as Checked out or No Show.
Example
"Checked out"encounters[].ApptTime
string
Scheduled time of day for this encounter's appointment.
Example
"09:00 AM"encounters[].encType
string
Encounter type code, an integer or string depending on operation.
Example
"1"encounters[].processid
string
Raw eCW process id on the encounter review row.
Example
"987650042"encounters[].provider
string
Provider name on the encounter under review.
Example
"Morgan Testwell, MD"encounters[].patient
string
Patient name on the encounter under review.
Example
"Example, Avery"encounters[].PatientId
string
Patient the encounter belongs to.
Example
"987650123"encounters[].insuranceName
string
Payer eCW billed for this encounter.
Example
"Aetna"encounters[].VisitType
string
Visit type label the encounter was scheduled under.
Example
"Follow-up"encounters[].validationstatus
string
Raw eCW validation status on the encounter review row.
Example
"1"encounters[].age
string
Patient's age as the Encounter Review grid displays it.
Example
"45"encounters[].EncLock
string
Raw eCW lock flag on the encounter note.
Example
"0"encounters[].notes
object
Catalog item note text, or the encounter's whole note bundle.
encounters[].notes.history_of_present_illness
string
HPI section text as it reads in the note.
Example
"Patient reports a dry cough for three days."encounters[].notes.review_of_systems
string
Review of Systems text from the progress note.
Example
"Denies fever, chest pain, and shortness of breath."encounters[].notes.current_medications
string
Current medications section text as it reads in the note.
Example
"Lisinopril 10 mg tablet, one tablet orally daily."encounters[].notes.examination
string
Examination section text as it reads in the note.
Example
"Lungs clear to auscultation bilaterally."encounters[].notes.assessments
string
Assessment section text as it reads in the note.
Example
"Essential hypertension, controlled."encounters[].notes.treatment
string
Treatment section text from the progress note.
Example
"Continue lisinopril 10 mg daily."encounters[].notes.procedure_codes
array
Procedure code and description pairs parsed from the note.
encounters[].notes.visit_codes
string
Empty from fetch-notes, which never populates this field.
Example
"99213 - Established patient office visit"encounters[].notes.follow_up
string
Follow-up section text as it reads in the note.
Example
"Return in three months for blood pressure follow-up."encounters[].icds
array
ICD rows from the encounter's coding review panel.
encounters_total
integer
Total encounter count eCW reported for the date filter.
Example
24Code
curl --request POST \
--url https://preview.ontross.com/api/integrations/ecw/fetch-encounter-review \
--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": [
{
"date": "02/03/2026",
"EncounterId": "987650321",
"ClaimId": "987650654",
"resource": "Morgan Testwell, MD",
"notesStatus": "Completed",
"Duration": "30",
"UsrId": "987650087",
"created_datetime": "2026-02-02 14:30:00",
"VisitStatus": "Checked out",
"ApptTime": "09:00 AM",
"encType": "1",
"processid": "987650042",
"provider": "Morgan Testwell, MD",
"patient": "Example, Avery",
"PatientId": "987650123",
"insuranceName": "Aetna",
"VisitType": "Follow-up",
"validationstatus": "1",
"age": "45",
"EncLock": "0",
"notes": {
"history_of_present_illness": "",
"review_of_systems": "",
"current_medications": "",
"examination": "",
"assessments": "",
"treatment": "",
"procedure_codes": [],
"visit_codes": "",
"follow_up": ""
},
"icds": []
}
],
"encounters_total": 24
},
"files": null,
"created_at": "2019-08-24T14:15:22Z",
"started_at": "2019-08-24T14:15:22Z",
"completed_at": "2019-08-24T14:15:22Z"
}