Skip to content

List appointment summaries for a domain

Request

Returns the appointment summary view for the specified domain when the caller is authorized. Supports optional filters via query string and offset paging via skip and take.

Response body is a JSON array. Fields below apply to each array item.

Security
Bearer
Path
domainstringrequired

Partner domain identifier for the organisation/tenant. Your bearer token is scoped to one or more domains and requests outside that scope are rejected.

Example:acme
Query
appointmentDatestring, (date)

Optional appointment date filter (ISO 8601 date, yyyy-MM-dd) in the scheduled site's local timezone.

Example:appointmentDate=2025-01-01
startDatestring, (date)
endDatestring, (date)
clientUtcOffsetMinutesinteger, (int32)
scheduledSitestring

Optional scheduled site filter.

Example:scheduledSite=Example Site
skipinteger, (int32), [ 0 .. 10000 ]

Optional number of items to skip. Defaults to 0 when omitted. Must be between 0 and 10000.

Default:0
Example:skip=0
takeinteger, (int32), [ 1 .. 500 ]

Optional maximum number of items to return. Defaults to 100 when omitted. Must be between 1 and 500.

Default:100
Example:take=100
Headers
X-Correlation-Idstring

Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.

Example:4b7f0a91b4f54f2a
curl -i -X GET \
  'https://partnerdocs.qubs.io/_mock/openapi/integrations/v1/acme/appointments?appointmentDate=2025-01-01&startDate=2019-08-24&endDate=2019-08-24&clientUtcOffsetMinutes=0&scheduledSite=Example%20Site&skip=0&take=100' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'X-Correlation-Id: 4b7f0a91b4f54f2a'

Responses

Array of appointment summaries for the requested domain.

Headers
X-Correlation-Idstring

Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.

Example:"4b7f0a91b4f54f2a"
Bodyapplication/json
Array [
domainstringrequired

Domain this appointment belongs to.

Example:"Example domain"
appointmentIdstringrequired

Opaque appointment identifier within the specified domain. Preserve the value exactly as returned; values may look numeric but are not guaranteed to be numeric, so do not parse as an integer.

Example:"123"
scheduledSitestringrequired

Scheduled site name.

Example:"Example scheduledSite"
statusstringrequired

Appointment status.

Enum:"NOT ARRIVED""ARRIVED""DID NOT ATTEND""APPPOINTMENT CANCELLED""CANCELLATION LIST""DICTATION INPROGRESS""DICTATED""TYPED""AUTHORISING""AUTHORISED"
Example:"NOT ARRIVED"
appointmentDatenull or string, (date)

Appointment date (ISO 8601, yyyy-MM-dd) in the scheduled site's local timezone.

Example:"2020-01-01"
startTimenull or string^([01]\d|2[0-3]):[0-5]\d:[0-5]\d$

Scheduled start time (ISO 8601, HH:mm:ss) in the scheduled site's local timezone.

Example:"13:45:00"
endTimenull or string^([01]\d|2[0-3]):[0-5]\d:[0-5]\d$

Scheduled end time (ISO 8601, HH:mm:ss) in the scheduled site's local timezone.

Example:"13:45:00"
modalitystring
Example:"Example modality"
studyDescriptionstring
Example:"Example description"
]
Response
[
  {
    "domain": "acme",
    "appointmentId": "200006",
    "scheduledSite": "Central Clinic",
    "status": "ARRIVED",
    "appointmentDate": "2025-01-12",
    "startTime": "13:45:00",
    "endTime": "14:15:00",
    "modality": "CT",
    "studyDescription": "CT Chest"
  },
  {
    "domain": "acme",
    "appointmentId": "A123457",
    "scheduledSite": "North Clinic",
    "status": "PENDING REPORTING",
    "appointmentDate": "2025-01-13",
    "startTime": "09:00:00",
    "endTime": "09:30:00",
    "modality": "XR",
    "studyDescription": "XR Chest"
  }
]