Tross
ECLINICALWORKS

Fetch Appointment

Fetch appointment in eClinicalWorks

POSThttps://api.ontross.com/api/integrations/ecw/fetch-appointment
Request Fields
input
object
required
Fetch one appointment by its eCW encounter ID.
input.encounterId
string
required
Encounter id
auth_id
string
required
Auth id
Output Fields
appointment
object
Appointment object.
appointment.encounterId
string
Encounter id
appointment.reason
string
Reason
appointment.title
string
Title
appointment.patientId
string
Patient id
appointment.patientName
string
Patient name
appointment.patientPhoneNumber
string
Patient phone number
appointment.patientEmail
string
Patient email
appointment.patientUpPhone
string
Patient up phone
appointment.patientDob
string
Patient dob
appointment.patientPreferredName
string
Patient preferred name
appointment.doctorName
string
Doctor name
appointment.doctorId
string
Doctor id
appointment.facilityName
string
Facility name
appointment.facilityId
string
Facility id
appointment.start
string
Start
appointment.end
string
End
appointment.generalNotes
string
General notes
appointment.visitType
string
Visit type
appointment.visitStatus
string
Visit status
appointment.billableVisitStatus
boolean
Billable visit status
appointment.color
string
Color
appointment.encLock
string
Enc lock
appointment.eligibilityMessage
string
Eligibility message
appointment.groupId
string
Group id
appointment.claimRequired
boolean
Claim required
appointment.transitionOfCare
string
Transition of care
appointment.encType
string
Enc type
appointment.dx
string
Dx
appointment.RTServiceAuthorization
string
Rtservice authorization
appointment.selfPay
string
Self pay
appointment.deptId
string
Dept id
appointment.resources
string
Resources
appointment.ShowInsEligOnAppt
boolean
Show ins elig on appt
appointment.userId
integer
User id
appointment.eligibilityStatus
string
Eligibility status
appointment.POS
string
Pos
appointment.newPt
string
New pt
appointment.status
string
Status
Code
curl --request POST \
  --url https://api.ontross.com/api/integrations/ecw/fetch-appointment \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"encounterId":"string_id"},"auth_id":"auth_uuid_here"}'
Request BODY
{
  "input": {
    "encounterId": "string_id"
  },
  "auth_id": "auth_uuid_here"
}