Skip to content

QUBS Integrations API (v1)

Partner-facing API providing read-only access to selected QUBS configuration and scheduling data for integration purposes.

Authentication is via a bearer JWT in the Authorization header. Authorization is domain-scoped; all requests include a {domain} path parameter.

Errors are returned as RFC7807 Problem Details (application/problem+json).

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server
https://partners.qubs.io/_mock/openapi/
Relative to the current host
https://partners.qubs.io/

Site Settings

Partner-facing endpoints for listing sites and retrieving site configuration within a domain.

Operations

Exam Codes

Partner-facing endpoints for retrieving exam code configuration for a site within a domain.

Operations

Staff Skills

Partner-facing endpoints for retrieving the staff skill grid and related metadata for a site within a domain.

Operations

Appointments

Partner-facing endpoints for retrieving appointments within a domain.

Operations

Attachments

Partner-facing endpoints for retrieving appointment attachments and generating short-lived presigned URLs.

Operations

Comments

Partner-facing endpoints for retrieving appointment and patient comments/alerts associated with an appointment.

Operations

List comments for an appointment

Request

Returns all appointment comments/alerts plus patient comments/alerts for the appointment's patient when the caller is authorized.

Security
Bearer
Path
domainstringrequired

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

Example: acme
appointmentIdstringrequired

Appointment identifier within the specified domain.

Example: A123456
curl -i -X GET \
  https://partners.qubs.io/_mock/openapi/integrations/v1/acme/appointments/A123456/comments \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

List of appointment and patient comments/alerts for the requested appointment.

Bodyapplication/jsonArray [
guidstringrequired

Comment GUID.

Example: "123"
commentTypestringrequired

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

Example: "Example commentType"
appointmentIdstring

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 when available.

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

Whether this comment should be treated as an alert.

Example: true
commentBynull or UserSummaryResponse (object)

Who created the comment when available.

One of:

Who created the comment when available.

null
lastModifiedDateTimenull or string(date-time)

When the comment was last modified.

Example: "2020-01-01T00:00:00Z"
lastModifiedBynull or UserSummaryResponse (object)

Who last modified the comment when available.

One of:

Who last modified the comment when available.

null
]
Response
application/json
[
  {
    "guid": "123",
    "commentType": "Example commentType",
    "appointmentId": "123",
    "patientId": "123",
    "commentText": "Example commentText",
    "commentDateTime": "2020-01-01T00:00:00Z",
    "isAlert": true,
    "commentBy": {},
    "lastModifiedDateTime": "2020-01-01T00:00:00Z",
    "lastModifiedBy": {}
  }
]

Get a single comment for an appointment

Request

Returns a single appointment comment/alert or patient comment/alert (for the appointment's patient) when the caller is authorized.

Security
Bearer
Path
domainstringrequired

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

Example: acme
appointmentIdstringrequired

Appointment identifier within the specified domain.

Example: A123456
commentGuidstringrequired

Comment GUID for the requested appointment/patient comment.

Example: ed6ef45a-4e3d-41b2-8049-7aec53bb9ab1
curl -i -X GET \
  https://partners.qubs.io/_mock/openapi/integrations/v1/acme/appointments/A123456/comments/ed6ef45a-4e3d-41b2-8049-7aec53bb9ab1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Comment metadata for the requested comment (appointment or patient) for the requested appointment.

Bodyapplication/json
guidstringrequired

Comment GUID.

Example: "123"
commentTypestringrequired

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

Example: "Example commentType"
appointmentIdstring

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 when available.

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

Whether this comment should be treated as an alert.

Example: true
commentBynull or UserSummaryResponse (object)

Who created the comment when available.

One of:

Who created the comment when available.

null
lastModifiedDateTimenull or string(date-time)

When the comment was last modified.

Example: "2020-01-01T00:00:00Z"
lastModifiedBynull or UserSummaryResponse (object)

Who last modified the comment when available.

One of:

Who last modified the comment when available.

null
Response
application/json
{
  "guid": "123",
  "commentType": "Example commentType",
  "appointmentId": "123",
  "patientId": "123",
  "commentText": "Example commentText",
  "commentDateTime": "2020-01-01T00:00:00Z",
  "isAlert": true,
  "commentBy": {},
  "lastModifiedDateTime": "2020-01-01T00:00:00Z",
  "lastModifiedBy": {}
}

Patients

Partner-facing endpoints for retrieving patients within a domain.

Operations

Reporting

Partner-facing endpoints for retrieving appointments that are pending reporting.

Operations