accountStatement
This query is for fetching a specific financial AccountStatement by it's unique idenfier.
accountStatements
This query is for fetching a collection of AccountStatements within the given DateRange.
availabilities
Fetches a collection of all Availabilities held by a Practice Location.
availabilityRule
Fetches an availability rule by ID.
availabilityRules
Fetches availability rules for users and rooms.
availabilitySettings
Returns all availability settings: recurring slots and blocker exceptions.
availabilitySlots
Fetches bookable availability slots for users and rooms within a date range, after subtracting overlapping bookings and unavailabilities.
bookingTerminalPaymentStatus
Returns the current server-authoritative state of a Terminal payment for a booking.
booking
Retrieve a single booking by id
bookingsById
Retrieve patient bookings by list ids
bookings
This query is for fetching data about patient bookings held in the system.
clinicalPathway
Not available for public API use yet. This operation is documented for future use only.
clinicalPathways
Not available for public API use yet. This operation is documented for future use only.
clinicalReport
Fetches a completed clinical report by id.
clinicalReports
Fetches completed clinical reports for the practice.
consultation
This query fetches a consultation with the specified identifier.
consultations
This query fetches a collection of consultations that match the supplied search criteria.
contact
This query fetches the contact with the specified identifier.
contacts
This query fetches a collection of contacts that match the requested filters. Optional free-text search is compared against the contact's name, email address, telephone number(s), medical specialisation, and numbers (such as NHS Number). Prefer cursorPagination for large result sets (for example sync/export); deep offset pages remain expensive even with indexes. Existing pagination: { page, pageSize } behaviour is unchanged. Do not provide pagination and cursorPagination together.
diagnosisCodes
This query returns valid diagnosis codes. Results can be searched by code or description and are paginated.
episodeTypes
Not available for public API use yet. This operation is documented for future use only.
episode
Not available for public API use yet. This operation is documented for future use only.
episodes
Not available for public API use yet. This operation is documented for future use only.
forms
This query fetches a collection of hospital booking form responses (HospitalBookingFormData), optionally filtered by clinical pathway. Prefer cursorPagination for large result sets (for example sync/export); deep offset pages remain expensive even with indexes. Existing pagination: { page, pageSize } behaviour is unchanged. Do not provide pagination and cursorPagination together.
integrationToken
This query is for fetching the integration token of a patient.
invoice
This query fetches the invoice with the specified identifier.
invoices
This query fetches a collection of invoices where the invoice date falls within the requested range. The query can be further refined through the use of QueryOptions to only fetch invoices that were created or modified (or both) within specified dates. Use filters.metadata to filter by stored customerMetadata entries. Optional filters.invoiceNumbers allows filtering by invoice numbers. Use filters.submittedToHealthcode to return only invoices submitted to Healthcode (or only those not submitted). Use filters.healthcodeStatus to match or exclude specific Healthcode statuses, for example healthcodeStatus [Validated, AwaitingCollection] } or healthcodeStatus [AwaitingCorrection, Cancelled] }. Prefer cursorPagination for large result sets (for example sync/export); deep offset pages remain expensive even with indexes. Existing pagination: { page, pageSize } behaviour is unchanged. Do not provide pagination and cursorPagination together.
lab
This query fetches the pathology request with the specified identifier.
labels
This query is for fetching label data.
labs
This query fetches a collection of pathology requests that were submitted to the processing lab within the specified date range. The collection can be furter refined through the use of LabQueryOptions. Prefer cursorPagination for large result sets (for example sync/export); deep offset pages remain expensive even with indexes. Existing pagination: { page, pageSize } behaviour is unchanged. Do not provide pagination and cursorPagination together.
letter
This query is for fetching the letter with the specified identifier.
letters
This query fetches the letters within a specified DateRange. Prefer cursorPagination for large result sets (for example sync/export); deep offset pages remain expensive even with indexes. Existing pagination: { page, pageSize } behaviour is unchanged. Do not provide pagination and cursorPagination together.
onlineBookingConfiguration
This query is for fetching data for an online-booking confiuration.
onlineBookingConfigurations
This query is for fetching data for all online-booking configurations. If a location/doctor ID is provided, only online-booking configurations that are assocaited with the location/doctor are served.
patientCommunication
This query is for fetching a specific PatientCommunication by it's unique identifier. This includes sent and scheduled patient communications. Patient communications of type Share are not supported.
patientCommunications
This query is for fetching a collection of PatientCommunication, filtered using the following parameters. Patient communications of type Share are not supported.
patientDocument
This query fetches the patient document with the requested identifier.
patientDocuments
This query fetches a collection of patient documents held in the system. Prefer cursorPagination for large result sets (for example sync/export); deep offset pages remain expensive even with indexes. Existing pagination: { page, pageSize } behaviour is unchanged. Do not provide pagination and cursorPagination together.
patientRelationships
Fetches a collection of all PatientRelationships held by a Patient.
patient
This query fetches patient data for the patient with the specified identifier.
patients
This query fetches a collection of patients that match the supplied search criteria. Prefer cursorPagination for large result sets (for example sync/export); deep offset pages remain expensive even with indexes. Existing pagination: { page, pageSize } behaviour is unchanged. Do not provide pagination and cursorPagination together.
paymentOnAccount
This query fetches a Payment on Account by its identifier, including allocation history.
paymentTerminalReaders
Returns Stripe Terminal readers, prioritising readers assigned to the supplied location group.
paymentsOnAccount
This query fetches Payments on Account that still have an unallocated or partially allocated balance. dateRange.start is required and defines the incremental sync watermark: records created or updated on or after that timestamp are returned. An optional dateRange.end bounds the upper limit. Use Pagination to page through results.
practiceTemplateDocument
This query fetches the document template with the requested identifier.
practiceTemplateDocuments
This query fetches a collection of document templates. Prefer cursorPagination for large result sets (for example sync/export); deep offset pages remain expensive even with indexes. Existing pagination: { page, pageSize } behaviour is unchanged. Do not provide pagination and cursorPagination together.
practice
This query returns the current API user's practice.
prescription
This query fetches a prescription with the specified identifier.
prescriptions
This query fetches a collection of prescriptions that were issued within the specified DateRange. The query can be further refined through the use of QueryOptions to include records that have been deleted, it should be noted that createdAt and updatedAt are not applicable to prescriptions. Prefer cursorPagination for large result sets (for example sync/export); deep offset pages remain expensive even with indexes. Existing pagination: { page, pageSize } behaviour is unchanged. Do not provide pagination and cursorPagination together.
priceAdjustmentRule
Fetches one immutable practice-scoped price adjustment rule.
priceAdjustmentRules
Fetches immutable practice-scoped price adjustment rules.
product
This query fetches the product with the specfifed identifier.
products
This query returns a collection of products that match the requested filters. Optional free-text search is compared against the product code or product name. Custom metadata is not included in search; use filters.metadata to filter by stored customerMetadata entries (same sanitisation rules as updateProductMetadata). Prefer cursorPagination for large result sets (for example sync/export); deep offset pages remain expensive even with indexes. Existing pagination: { page, pageSize } behaviour is unchanged. Do not provide pagination and cursorPagination together.
questionnaire
This query fetches questionnaire data for the questionnaire with the specified identifier.
questionnaires
This query fetches a collection of questionnaires that match the supplied search criteria. Prefer cursorPagination for large result sets (for example sync/export); deep offset pages remain expensive even with indexes. Existing pagination: { page, pageSize } behaviour is unchanged. Do not provide pagination and cursorPagination together.
record
This query fetches the record with the requested identifier.
records
This query fetches a collection of records held in the system. Prefer cursorPagination for large result sets (for example sync/export); deep offset pages remain expensive even with indexes. Existing pagination: { page, pageSize } behaviour is unchanged. Do not provide pagination and cursorPagination together.
resolveEffectivePriceRule
Resolves the effective price rule for a product on a given day.
task
This query is for fetching a specific Task by it's unique idenfier.
tasks
This query is for fetching a collection of Tasks, filtered using the following parameters. Prefer cursorPagination for large result sets (for example sync/export); deep offset pages remain expensive even with indexes. Existing pagination: { page, pageSize } behaviour is unchanged. Do not provide pagination and cursorPagination together.
user
This query fetches the user with the specified identifier if that user belongs to the same practice as the API user making the request.
users
This query fetches a collection of users that belong to the same practice as the API user making the request. The results are paginated depending on the requested paging parameters. The query can be further refined through the use of UsersQueryOptions to filter users by their creation date or last update date, search by name, email, or metadata values, or set includeDeleted to true to include users who have been deleted in Semble. Use filters.isClinician to filter clinicians, filters.metadata to filter by stored customerMetadata entries. options.cliniciansOnly is deprecated; use filters.isClinician instead.
webhook
Returns a single webhook subscription by id for the current practice, or null if not found.
webhooks
Returns webhook subscriptions for the current practice.
workingDiagnoses
Not available for public API use yet. This operation is documented for future use only.