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

List exam codes for a site

Request

Returns exam codes for the specified domain and site 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
siteNamestringrequired

Site name within the specified domain.

Example: Example Site
curl -i -X GET \
  'https://partners.qubs.io/_mock/openapi/integrations/v1/acme/sites/Example Site/exam-codes' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

List of exam codes for the requested domain and site.

Bodyapplication/jsonArray [
examCodeIdstringrequired

Unique exam code identifier.

Example: "123"
keystringrequired

QUBS internal key for the exam code record.

Example: "Example key"
sitestringrequired

Site this exam code belongs to.

Example: "Example site"
descriptionstringrequired

Human-readable exam description.

Example: "Example description"
categorystring

Optional exam category.

Example: "Example category"
modalitystring

Optional imaging modality.

Example: "Example modality"
totalDurationinteger or string(int32)^-?(?:0|[1-9]\d*)$

Configured duration in minutes.

Example: 1
showOnlineboolean

Whether this exam code is visible/available online.

Example: true
lastModifiedDateTimestring(date-time)

When the exam code was last updated.

Example: "2020-01-01T00:00:00Z"
]
Response
application/json
[
  {
    "examCodeId": "123",
    "key": "Example key",
    "site": "Example site",
    "description": "Example description",
    "category": "Example category",
    "modality": "Example modality",
    "totalDuration": 1,
    "showOnline": true,
    "lastModifiedDateTime": "2020-01-01T00:00:00Z"
  }
]

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

Patients

Partner-facing endpoints for retrieving patients within a domain.

Operations

Reporting

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

Operations