📄️ 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.
📄️ 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.
📄️ contact
This query fetches the contact with the specified identifier.
📄️ contacts
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).
📄️ 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.
📄️ 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 perscriptions that were issued within the specified DateRange. The query can be further refined through the use of QueryOptions to only fetch prescriptions that were created or modified (or both) within specified dates.
📄️ product
This query fetches the product with the specfifed identifier.
📄️ products
This query returns a collection of products where the product code or product name matches the supplied search text.
📄️ record
This query fetches the record with the requested identifier.
📄️ records
This query fetches a collection of records held in the system.
📄️ 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.