Queries overview | Semble API

📄️ 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.

📄️ availabilitySettings

Fetches all recurring and blocker availabilities. 'Availability settings'

📄️ bookings

This query is for fetching data about patient bookings held in the system.

📄️ 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.

This query fetches a collection of contacts that match the requested search text. The requested search text is compared against the contacts name, email address, telephone number(s), medical specialisation and numbers (such as NHS Number).

📄️ episode

This query fetches the episode of care with the specified identifier.

📄️ episodes

This query fetches a collection of episodes of care that match the supplied search criteria. 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.

📄️ 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.

📄️ 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.

📄️ letter

This query is for fetching the letter with the specified identifier.

📄️ letters

This query fetches the letters within a specified DateRange.

📄️ 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.

📄️ 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.

📄️ practiceTemplateDocument

This query fetches the document template with the requested identifier.

📄️ practiceTemplateDocuments

This query fetches a collection of document templates.

📄️ 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.