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

Patients

Partner-facing endpoints for retrieving patients within a domain.

Operations

Reporting

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

Operations

List pending reporting appointments

Request

Returns the clinical appointment view for appointments in the PENDING REPORTING status. Supports cursor-based pagination via pageSize and nextToken.

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
Query
pageSizeinteger or string(int32)^-?(?:0|[1-9]\d*)$

Maximum number of items to return in a page. Defaults to 100 when omitted.

Example: pageSize=100
nextTokenstring

Opaque continuation token from a previous paged response. Omit for the first page.

Example: nextToken=eyJwYWdlIjoyfQ==
curl -i -X GET \
  'https://partners.qubs.io/_mock/openapi/integrations/v1/acme/reporting/appointments/pending?pageSize=100&nextToken=eyJwYWdlIjoyfQ%3D%3D' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Page of appointments that are pending reporting for the requested domain.

Bodyapplication/json
itemsArray of objects(AppointmentResponse)required

Appointments in the current page.

items[].​domainstringrequired

Domain this appointment belongs to.

Example: "Example domain"
items[].​keystringrequired
Example: "Example key"
items[].​appointmentIdstringrequired

Appointment identifier.

Example: "123"
items[].​appointmentDatestring

Appointment date string as stored in QUBS.

Example: "Example appointmentDate"
items[].​arrivalDateTimenull or string(date-time)
Example: "2020-01-01T00:00:00Z"
items[].​attendedBynull or UserSummaryResponse (object)
One of:
null
items[].​authorisationDateTimenull or string(date-time)
Example: "2020-01-01T00:00:00Z"
items[].​authorisedBynull or UserSummaryResponse (object)
One of:
null
items[].​authorisedSitestring
Example: "Example authorisedSite"
items[].​authorisedTimeStampnull or integer or string(int64)^-?(?:0|[1-9]\d*)$
Example: 1
items[].​batchSkstring
Example: "Example batchSk"
items[].​billingStatusstring
Example: "active"
items[].​billingTypestring
Example: "Example billingType"
items[].​clinicalInfostring
Example: "Example clinicalInfo"
items[].​clinicNamestring
Example: "Example Name"
items[].​copyToListArray of strings
Example: ["Example copyToList"]
items[].​countrystring
Example: "Example country"
items[].​createdBynull or UserSummaryResponse (object)
One of:
null
items[].​createdDatestring
Example: "Example createdDate"
items[].​dateOfBirthstring
Example: "Example dateOfBirth"
items[].​deliverEmailClinicboolean
Example: true
items[].​deliverEmailDoctorboolean
Example: true
items[].​doctorFirstNamestring
Example: "Example Name"
items[].​doctorLastNamestring
Example: "Example Name"
items[].​doctorNamestring
Example: "Example Name"
items[].​emailstring
Example: "user@example.com"
items[].​endTimestring

Scheduled end time string as stored in QUBS.

Example: "Example endTime"
items[].​examCodesArray of objects(AppointmentExamCodeResponse)

Exam codes attached to the appointment.

items[].​firstNamestring
Example: "Example Name"
items[].​genderstring
Example: "Example gender"
items[].​invoiceCreationErrorstring
Example: "Example invoiceCreationError"
items[].​invoiceNumberstring
Example: "Example invoiceNumber"
items[].​invoiceSkstring
Example: "Example invoiceSk"
items[].​isBillingsCheckedboolean
Example: true
items[].​lastModifiedBynull or UserSummaryResponse (object)
One of:
null
items[].​lastModifiedDateTimenull or string(date-time)
Example: "2020-01-01T00:00:00Z"
items[].​lastNamestring
Example: "Example Name"
items[].​latitudenull or number or string(double)^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$...
Example: 1.23
items[].​longitudenull or number or string(double)^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$...
Example: 1.23
items[].​medicareExpiryDatestring
Example: "Example medicareExpiryDate"
items[].​medicareIrnstring
Example: "Example medicareIrn"
items[].​medicareNumberstring
Example: "Example medicareNumber"
items[].​mobilePhonestring
Example: "Example mobilePhone"
items[].​mobilePhoneCountrystring
Example: "Example mobilePhoneCountry"
items[].​modalitystring
Example: "Example modality"
items[].​numericDatestring
Example: "Example numericDate"
items[].​objectTypestring
Example: "Example objectType"
items[].​pacsSkstring
Example: "Example pacsSk"
items[].​pacsStudyInstanceUidstring
Example: "123"
items[].​pacsUniqueIdstring
Example: "123"
items[].​patientIdstring

Optional patient identifier.

Example: "123"
items[].​patientIdOnPacsstring
Example: "Example patientIdOnPacs"
items[].​patientNamestring
Example: "Example Name"
items[].​patientSkstring
Example: "Example patientSk"
items[].​postcodestring
Example: "ABC123"
items[].​prioritystring
Example: "Example priority"
items[].​providerNumberstring
Example: "Example providerNumber"
items[].​radiologistUsernull or UserSummaryResponse (object)
One of:
null
items[].​refClinicEmailstring
Example: "user@example.com"
items[].​refClinicFaxstring
Example: "Example refClinicFax"
items[].​refClinicPhonestring
Example: "Example refClinicPhone"
items[].​refCountrystring
Example: "Example refCountry"
items[].​referralDatestring
Example: "Example referralDate"
items[].​refLatitudenull or number or string(double)^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$...
Example: 1.23
items[].​refLongitudenull or number or string(double)^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$...
Example: 1.23
items[].​refPostcodestring
Example: "ABC123"
items[].​refSkstring
Example: "Example refSk"
items[].​refSpecialitystring
Example: "Example refSpeciality"
items[].​refStatestring
Example: "Example refState"
items[].​refStreetNamestring
Example: "Example Name"
items[].​refStreetNostring
Example: "Example refStreetNo"
items[].​refSuburbstring
Example: "Example refSuburb"
items[].​refTitlestring
Example: "Example refTitle"
items[].​reportIdstring
Example: "123"
items[].​reportNeededByDateTimenull or string(date-time)
Example: "2020-01-01T00:00:00Z"
items[].​reportSkstring
Example: "Example reportSk"
items[].​roomstring
Example: "Example room"
items[].​scanEndDateTimenull or string(date-time)
Example: "2020-01-01T00:00:00Z"
items[].​scanStartDateTimenull or string(date-time)
Example: "2020-01-01T00:00:00Z"
items[].​scanTotalTimenull or number or string(double)^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$...
Example: 1.23
items[].​scheduledSitestring

Scheduled site name.

Example: "Example scheduledSite"
items[].​serviceItemNumbersstring
Example: "Example serviceItemNumbers"
items[].​serviceItemsArray of objects(AppointmentServiceItemResponse)

Service items attached to the appointment.

items[].​sourcestring
Example: "Example source"
items[].​startTimestring

Scheduled start time string as stored in QUBS.

Example: "Example startTime"
items[].​statestring
Example: "Example state"
items[].​statusstring

Appointment status.

Enum"NOT ARRIVED""ARRIVED""DID NOT ATTEND""APPPOINTMENT CANCELLED""CANCELLATION LIST""DICTATION INPROGRESS""DICTATED""TYPED""AUTHORISING""AUTHORISED"
Example: "NOT ARRIVED"
items[].​streetNamestring
Example: "Example Name"
items[].​streetNostring
Example: "Example streetNo"
items[].​studyDescriptionstring
Example: "Example description"
items[].​suburbstring
Example: "Example suburb"
items[].​technologist1null or UserSummaryResponse (object)
One of:
null
items[].​titlestring
Example: "Example title"
items[].​typedBynull or UserSummaryResponse (object)
One of:
null
items[].​typedEndDateTimenull or string(date-time)
Example: "2020-01-01T00:00:00Z"
items[].​typedSitestring
Example: "Example typedSite"
items[].​typedStartDateTimenull or string(date-time)
Example: "2020-01-01T00:00:00Z"
items[].​typedTotalTimenull or number or string(double)^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$...
Example: 1.23
items[].​versionstring
Example: "Example version"
items[].​waitingTotalTimenull or number or string(double)^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$...
Example: 1.23
nextTokennull or string

Opaque continuation token to fetch the next page, when more results are available.

Example: "Example nextToken"
Response
application/json
{
  "items": [
    { … }
  ],
  "nextToken": "Example nextToken"
}