Skip to content

List comments for a pending reporting appointment

Request

Returns appointment comments/alerts plus patient comments/alerts for the specified appointment when it is in the PENDING REPORTING status.

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

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

Responses

Array of appointment and patient comments/alerts for the requested pending reporting appointment.

Headers
X-Correlation-Idstring

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

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

Comment GUID.

Example:"123"
commentTypestringrequired

Comment type. One of: AC (Appointment Comment), AA (Appointment Alert), PC (Patient Comment), PA (Patient Alert).

Enum:"AC""AA""PC""PA"
Example:"AC"
appointmentIdstring

Opaque appointment identifier for appointment comments; empty for patient-level comments.

Example:"123"
patientIdstring

Patient identifier associated with the comment when available.

Example:"123"
commentTextstring

Comment text.

Example:"Example commentText"
commentDateTimenull or string, (date-time)

When the comment was created (UTC) when available.

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

Whether this comment should be treated as an alert.

Example:true
commentByobject(UserSummaryResponse)

Who created the comment when available.

lastModifiedDateTimenull or string, (date-time)

When the comment was last modified (UTC).

Example:"2020-01-01T00:00:00Z"
]
Response
[
  {
    "guid": "ed6ef45a-4e3d-41b2-8049-7aec53bb9ab1",
    "commentType": "AC",
    "appointmentId": "200006",
    "patientId": "220000",
    "commentText": "Patient requires wheelchair access.",
    "commentDateTime": "2025-01-10T02:03:04Z",
    "isAlert": false,
    "commentBy": { … },
    "lastModifiedDateTime": "2025-01-10T02:03:04Z"
  }
]