Ecw Fetch appointment

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

input.encounterId

string

required

Encounter being read or written, from fetch-appointments.

Example

"9620412"

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"

appointment

object

The appointment record as eCW holds it after this call.

appointment.encounterId

string

Encounter being read or written, from fetch-appointments.

Example

"100001"

appointment.reason

string

Why the call or hospitalization happened, saved as row text.

Example

"Annual wellness visit"

appointment.title

string

Appointment title eCW shows on the schedule.

Example

"Annual wellness visit"

appointment.patientId

string

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

Example

"100002"

appointment.patientName

string

Name text matched against the live patient lookup.

Example

"Example,Jordan"

appointment.patientPhoneNumber

string

Phone number copied onto the appointment record.

Example

"202-555-0142"

appointment.patientEmail

string

Email copied onto the appointment record.

Example

"jordan.example@example.com"

appointment.patientUpPhone

string

Raw eCW patientUpPhone value carried on the appointment.

Example

"903-278-8495"

appointment.patientDob

string

Date of birth copied onto the appointment.

Example

"01/05/2012"

appointment.patientPreferredName

string

Preferred name copied onto the appointment record.

Example

"Jordan"

appointment.doctorName

string

Provider name, the appointment's provider or the patient's assigned one.

Example

"Example,Alex"

appointment.doctorId

string

Provider identifier, a string on appointments and an integer on orders.

Example

"100003"

appointment.facilityName

string

Facility where the appointment is booked.

Example

"Example Clinic"

appointment.facilityId

string

Facility the telephone encounter is booked at, from the facility list.

Example

"100004"

appointment.start

string

Appointment start as an ISO timestamp.

Example

"2026-01-15T09:00:00"

appointment.end

string

When the appointment slot ends.

Example

"2026-01-15T09:30:00"

appointment.generalNotes

string

Replaces the appointment's General Notes entirely, and empty string clears it.

Example

"Bring updated medication list."

appointment.visitType

string

Visit type such as office visit or telephone.

Example

"Office visit"

appointment.visitStatus

string

New appointment status, limited to check-out and no-show here.

Example

"scheduled"

appointment.billableVisitStatus

boolean

Whether the visit status counts as billable.

Example

true

appointment.color

string

Calendar color eCW paints this appointment block.

Example

"#66CC99"

appointment.encLock

string

Whether the encounter is locked against further edits.

Example

"0"

appointment.eligibilityMessage

string

Message from the last insurance eligibility check.

Example

"Coverage active"

appointment.groupId

string

Group appointment this slot belongs to, empty when individual.

Example

"9001501"

appointment.claimRequired

boolean

Whether a claim must be generated for this appointment.

Example

true

appointment.transitionOfCare

string

Raw eCW transition of care flag on the appointment.

Example

"0"

appointment.encType

string

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

Example

"1"

appointment.dx

string

Diagnosis text attached to the appointment, often empty.

Example

"Essential hypertension"

appointment.RTServiceAuthorization

string

Real-time service authorization eCW returned for the visit.

Example

"AUTH9001502"

appointment.selfPay

string

Raw eCW self pay flag on the appointment.

Example

"0"

appointment.deptId

string

Department eCW books this appointment under.

Example

"14"

appointment.resources

string

Bookable resource list, or the appointment's raw resource string.

Example

"247093"

appointment.ShowInsEligOnAppt

boolean

Whether eCW shows insurance eligibility on the appointment screen.

Example

false

appointment.userId

integer

Raw eCW userId carried on the appointment record.

Example

100005

appointment.eligibilityStatus

string

Result of the last insurance eligibility check.

Example

"Active"

appointment.POS

string

Place of service code billed for the visit.

Example

"11"

appointment.newPt

string

Whether the appointment is for a new patient.

Example

"0"

appointment.status

string

Additional source disposition value passed through without interpretation.

Example

"Active"

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

Request BODY

{
  "input": {
    "encounterId": "9620412"
  },
  "auth_id": "auth_uuid_here"
}

Response BODY

{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "appointment": {
      "encounterId": "100001",
      "reason": "Annual wellness visit",
      "title": "Annual wellness visit",
      "patientId": "100002",
      "patientName": "Example,Jordan",
      "patientPhoneNumber": "202-555-0142",
      "patientEmail": "jordan.example@example.com",
      "patientUpPhone": "903-278-8495",
      "patientDob": "01/05/2012",
      "patientPreferredName": "Jordan",
      "doctorName": "Example,Alex",
      "doctorId": "100003",
      "facilityName": "Example Clinic",
      "facilityId": "100004",
      "start": "2026-01-15T09:00:00",
      "end": "2026-01-15T09:30:00",
      "generalNotes": "Bring updated medication list.",
      "visitType": "Office visit",
      "visitStatus": "scheduled",
      "billableVisitStatus": true,
      "color": "#66CC99",
      "encLock": "0",
      "eligibilityMessage": "Coverage active",
      "groupId": "9001501",
      "claimRequired": true,
      "transitionOfCare": "0",
      "encType": "1",
      "dx": "Essential hypertension",
      "RTServiceAuthorization": "AUTH9001502",
      "selfPay": "0",
      "deptId": "14",
      "resources": "247093",
      "ShowInsEligOnAppt": false,
      "userId": 100005,
      "eligibilityStatus": "Active",
      "POS": "11",
      "newPt": "0",
      "status": "Active"
    }
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}