Tross
EZDERM

List patient encounters

List a patient's encounters within optional service-date bounds.

POSThttps://api.ontross.com/api/integrations/ezderm/list-patient-encounters
Request Fields
input.patient_id
string
required
EZDerm patient UUID returned by list-patients.
Example
"3f2504e0-4f89-11d3-9a0c-0305e82c3301"
input.start_date
string
Inclusive start of the encounter service-date range. Omit to leave it unbounded.
Example
"2026-09-01"
input.end_date
string
Inclusive end of the encounter service-date range. Omit to leave it unbounded.
Example
"2026-09-30"
input.time_zone_id
string
IANA time zone used to interpret encounter service timestamps for date filtering.
Example
"America/New_York"
Default
"UTC"
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"
Output Fields
patient_id
string
Requested EZDerm patient UUID.
Example
"b93d4826-78a1-4c5e-9f02-3a6d7e814bc0"
encounters
array
Encounters within the requested service-date range, in server order with all statuses and fields retained; all encounters when no bounds are supplied.
encounters[].id
string
Encounter UUID, preserving EZDerm's original letter case.
encounters[].status
string
EZDerm encounter status, unchanged; the caller decides which statuses to process.
encounters[].dateOfService
string
Encounter service date in EZDerm's original format, when present.
encounters[].patientInfo
object
Patient identity and lightweight chart fields returned with the encounter.
encounters[].patientInfo.id
string
EZDerm patient UUID, used to verify encounter ownership.
encounters[].patientInfo.medicalRecordNumber
string
Patient medical record number, when present.
encounters[].active
boolean
Whether EZDerm marks the encounter active.
encounters[].dateOfArrival
string
Patient arrival date, when present.
encounters[].duration
integer
Scheduled encounter duration.
encounters[].chiefComplaintName
string
Chief complaint label.
encounters[].clinicId
string
EZDerm clinic identifier.
encounters[].clinicName
string
Clinic name.
encounters[].clinicAddress
string
Clinic address text.
encounters[].clinicPhone
string
Clinic phone text.
encounters[].encounterRoleInfoList
array
Encounter clinicians and staff in EZDerm's order.
encounters[].appointmentType
object
EZDerm appointment type record.
encounters[].virtualEncounter
boolean
Whether this is a virtual encounter.
encounters[].reviewVirtualEncounter
boolean
Virtual encounter review flag.
encounters[].bridgeEncounter
boolean
EZDerm bridge encounter flag.
encounters[].room
integer
Room number, when present.
encounters[].codingReportAvailable
boolean
Whether EZDerm has a coding report for this encounter.
encounters[].establishedPatient
boolean
Whether EZDerm marks the patient established for this encounter.
encounters[].resources
array
Assigned encounter resources.
encounters[].objectiveLock
boolean
Objective section lock flag.
encounters[].hasCustomSmsPermission
boolean
Custom SMS permission flag.
encounters[].hasSmsEzlinkPermission
boolean
EZLink SMS permission flag.
Code
curl curl %s %s POST \
  --url https://api.ontross.com/api/integrations/ezderm/list-patient-encounters \
  %s %s 'X-API-Key: REPLACE_KEY_VALUE' \
  %s %s 'content-type: application/json' \
  %s %s '{"input":{"patient_id":"3f2504e0-4f89-11d3-9a0c-0305e82c3301","start_date":"2026-09-01","end_date":"2026-09-30","time_zone_id":"America/New_York"},"auth_id":"auth_uuid_here"}'
Request BODY
{
  "input": {
    "patient_id": "3f2504e0-4f89-11d3-9a0c-0305e82c3301",
    "start_date": "2026-09-01",
    "end_date": "2026-09-30",
    "time_zone_id": "America/New_York"
  },
  "auth_id": "auth_uuid_here"
}
Response BODY
{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "patient_id": "b93d4826-78a1-4c5e-9f02-3a6d7e814bc0",
    "encounters": [
      {
        "id": "string",
        "status": "string",
        "dateOfService": "2019-08-24",
        "patientInfo": {
          "id": "string",
          "medicalRecordNumber": "string"
        },
        "active": true,
        "dateOfArrival": "2019-08-24",
        "duration": 0,
        "chiefComplaintName": "string",
        "clinicId": "string",
        "clinicName": "string",
        "clinicAddress": "string",
        "clinicPhone": "string",
        "encounterRoleInfoList": [
          {}
        ],
        "appointmentType": {},
        "virtualEncounter": true,
        "reviewVirtualEncounter": true,
        "bridgeEncounter": true,
        "room": 0,
        "codingReportAvailable": true,
        "establishedPatient": true,
        "resources": [
          null
        ],
        "objectiveLock": true,
        "hasCustomSmsPermission": true,
        "hasSmsEzlinkPermission": true
      }
    ]
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}