Get a pending reporting appointment

Request

Returns the tele reporting appointment view for the specified opaque appointment id when it is in the PENDING REPORTING status.

Returns 404 when the appointment is not found or is not in the PENDING REPORTING status.

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

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

Responses

Pending reporting appointment view for the requested opaque 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"

statusstringrequired

Appointment status.

Enum:"NOT ARRIVED""ARRIVED""DID NOT ATTEND""APPPOINTMENT CANCELLED""CANCELLATION LIST""DICTATION INPROGRESS""DICTATED""TYPED""AUTHORISING""AUTHORISED"

Example:"NOT ARRIVED"

scheduledSitestringrequired

Scheduled site name.

Example:"Example scheduledSite"

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"

patientIdstring

Patient identifier when available.

Example:"123"

patientNamestring

Patient display name.

Example:"Example Name"

firstNamestring

Patient first name.

Example:"Example Name"

lastNamestring

Patient last name.

Example:"Example Name"

dateOfBirthnull or string, (date)

Patient date of birth (ISO 8601, yyyy-MM-dd).

Example:"2020-01-01"

genderstring

Patient gender/sex string as stored in QUBS. No enum is enforced by this API; values can be blank, so map blank, unknown, or unrecognized values to your local Unknown value if required.

Example:"Example gender"

modalitystring

Exam modality string as stored in QUBS.

Example:"Example modality"

studyDescriptionstring

Study description as stored in QUBS.

Example:"Example description"

clinicalInfostring

Clinical history/reason for study as stored in QUBS. Display this as clinical context for the reporting clinician when available.

Example:"Example clinicalInfo"

specialtyProfileboolean

Example:true

doctorNamestring

Referring doctor display name.

Example:"Example Name"

clinicNamestring

Referring clinic name when available.

Example:"Example Name"

prioritystring

Appointment/reporting priority string as stored in QUBS.

Example:"Example priority"

reportNeededBynull or string, (date-time)

Optional deadline timestamp for reporting (UTC, ISO 8601) when available.

Example:"2020-01-01T00:00:00Z"

studyInstanceUidstring

PACS study instance UID when available. Use it for study/PACS correlation when your workflow needs it; this API does not require a specific PACS viewer integration.

Example:"123"

radiologistUserobject(UserSummaryResponse)

Radiologist user assigned to the appointment when available. Honour this assignment when your integration supports external assignment.

serviceItemsArray of objects(PendingReportingServiceItemResponse)

Service items attached to the appointment.

Response

{
  "domain": "acme",
  "appointmentId": "200006",
  "status": "PENDING REPORTING",
  "scheduledSite": "Central Clinic",
  "appointmentDate": "2025-01-12",
  "startTime": "13:45:00",
  "endTime": "14:15:00",
  "patientId": "220000",
  "patientName": "Jane Doe",
  "firstName": "Jane",
  "lastName": "Doe",
  "dateOfBirth": "1988-03-03",
  "gender": "F",
  "modality": "CT",
  "studyDescription": "CT Chest",
  "clinicalInfo": "Shortness of breath",
  "doctorName": "Dr Smith",
  "clinicName": "Example Clinic",
  "priority": "Routine",
  "reportNeededBy": "2025-01-13T02:00:00Z",
  "studyInstanceUid": "1.2.3.4.5",
  "radiologistUser": {
    "username": "rsmith",
    "firstName": "Rory",
    "initials": "RS",
    "lastName": "Smith",
    "role": "Radiologist"
  },
  "serviceItems": [
    { … }
  ]
}