Skip to content

Get operational appointment by domain and appointment id

Request

Returns the operational appointment view for the specified domain and appointment id when the caller is authorized.

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
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:200006
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/operational/by-id/200006 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'X-Correlation-Id: 4b7f0a91b4f54f2a'

Responses

Operational appointment view for the requested domain and appointment id.

Headers
X-Correlation-Idstring

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

Example:"4b7f0a91b4f54f2a"
Bodyapplication/json
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"
roomstring
Example:"Example room"
prioritystring
Example:"Example priority"
arrivalDateTimenull or string, (date-time)
Example:"2020-01-01T00:00:00Z"
scanStartDateTimenull or string, (date-time)
Example:"2020-01-01T00:00:00Z"
scanEndDateTimenull or string, (date-time)
Example:"2020-01-01T00:00:00Z"
scanTotalTimenull or number, (double)
Example:1.23
waitingTotalTimenull or number, (double)
Example:1.23
examCodesArray of objects(AppointmentExamCodeResponse)

Exam codes attached to the appointment.

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",
  "room": "Room 2",
  "priority": "Routine",
  "arrivalDateTime": "2025-01-12T03:40:00Z",
  "scanStartDateTime": "2025-01-12T03:45:00Z",
  "scanEndDateTime": "2025-01-12T04:05:00Z",
  "scanTotalTime": 20.5,
  "waitingTotalTime": 5,
  "examCodes": [
    { … }
  ]
}