AddContactPhoneData
Used to add a telephone number to a contact.
AddCustomAttributeData
The data defining the custom attribute to be added.
AddPatientNumberData
A number that is to be added to a patient. NHS number as an example.
AddPhoneData
The data defining the phone number to be added.
AvailabilityRecurrenceInput
No description
AvailabilitySlotsDateRange
Date range used by availabilitySlots.
BookingDataInput
Data representing a new booking.
BookingJourneyInput
No description
BookingQueryFilters
No description
BookingUpdateDataInput
Data representing updating a booking.
ConsultationsQueryFilters
Filters for the consultations list query.
ContactsQueryFilters
No description
CreateAllergyRecordDataInput
Data representing the created free text record.
CreateClinicalPathwayDataInput
Not available for public API use yet. This operation is documented for future use only.
CreateEpisodeDataInput
Not available for public API use yet. This operation is documented for future use only.
CreateFreeTextRecordDataInput
Data representing the created free text record.
CreateLabelData
Used to define a new label.
CreateLetterDataInput
Data defining a new letter.
CreatePatientDataInput
The data used to create a new patient.
CreatePatientNumberInput
Input for creating a Practice Number definition.
CreatePriceAdjustmentRuleDataInput
No description
CreatePriceProfileDataInput
No description
CreatePriceProfilePeriodDataInput
No description
CreatePriceRuleDataInput
No description
CreateResourceAvailabilityInput
No description
CreateTaskDataInput
Data representing the created task.
CreateUserInput
Input for creating a practice user.
CreateWebhookInput
Input for creating a webhook subscription.
CursorPagination
For pagination that is cursor-based.
DateRange
A date range used when considering the relevance of results. No assumptions or adjustments are made to the times in the supplied dates, most cases will require the user to define the times as appropriate.
EpisodeLabelInput
Not available for public API use yet. This operation is documented for future use only.
FormsQueryFilters
No description
HealthcodeStatusFilter
No description
INSInput
Defines the INS properties of a patient. Only applicable to practices in France which are INS certified.
InvoicesQueryFilters
No description
LabQueryOptions
Used for further refining lab search results.
LetterQueryFilters
No description
MetadataEntryInput
Not available for public API use yet. This operation is documented for future use only.
MetadataFilter
Filter by a stored customer metadata entry
NewInvoiceDataInput
Used for creating a new invoice.
NewInvoicePaymentDataInput
Used for recording a new payment against an invoice.
NewInvoiceRefundDataInput
Used for recording a new refund against a payment.
NewLineItemDataInput
Used for creating a new line item in an invoice.
OutOfOfficeBookingDataInput
Data representing a new out of office booking.
Pagination
Information regarding how requested data has been paginated.
PathwayDiagnosisCodeInput
Not available for public API use yet. This operation is documented for future use only.
PatientCommunicationPreferencesInput
The data defining patient communication options.
PatientCommunicationQueryOptions
No description
PatientDocumentQueryFilters
No description
PatientRelationshipContactInput
Used to specify details for a Patient/Contact that is being linked to in a PatientRelationship.
PlaceOfBirthInput
The data defining the place of birth.
PrescriptionQueryFilters
No description
PriceAdjustmentBookingDayOfTheWeekTriggerInput
No description
PriceAdjustmentBookingTimeOfDayTriggerInput
No description
PriceAdjustmentBoundsInput
No description
PriceAdjustmentDiscountCodeTriggerInput
No description
PriceAdjustmentEffectInput
No description
PriceAdjustmentPatientLabelTriggerInput
No description
PriceAdjustmentPatientMembershipTriggerInput
No description
PriceAdjustmentPatientMetadataTriggerInput
No description
PriceAdjustmentRoundingInput
No description
PriceAdjustmentRuleFiltersInput
No description
PriceAdjustmentScopeInput
No description
PriceAdjustmentTriggerInput
No description
PriceAdjustmentUsageLimitInput
No description
PriceAdjustmentUsageLimitPeriodInput
No description
ProductDataInput
The data used to define a new product.
ProductsQueryFilters
No description
QueryAvailabilityRuleInput
No description
QueryOptions
Additional filtering options used in some queries to refine results.
QuestionnaireAnswerInput
The data used as an answer to a question
QuestionnairesQueryOptions
Additional filtering options used in the questionnaires query to refine results.
SendPatientMessagesInput
The types of notifications that can be sent to the patient when creating/updating a booking. It defaults to true.
TaskQueryOptions
Used for further refining task search results.
UpdateAllergyRecordDataInput
Data representing the updated free text record.
UpdateClinicalPathwayDataInput
Not available for public API use yet. This operation is documented for future use only.
UpdateClinicalReportGovernanceInput
No description
UpdateContactDataAddressInput
Used to update the address of an existing contact.
UpdateContactDataInput
Data representing the updated contact.
UpdateContactDataPhoneInput
Used to update an exising phone number for a contact.
UpdateContactPhoneData
Used to update an exising phone number for a contact.
UpdateCustomAttributeData
The data defining the custom attribute to be updated.
UpdateEpisodeDataInput
Not available for public API use yet. This operation is documented for future use only.
UpdateFreeTextRecordDataInput
Data representing the updated free text record.
UpdateInvoiceDataInput
Used to update an existing invoice.
UpdateInvoiceHealthcodeInput
Healthcode submission outcome recorded by an external integrator.
UpdateInvoicePaymentDataInput
Used to update a payment already made against an invoice.
UpdateLabelData
Used to update a label.
UpdateLetterDataInput
Data defining how an existing letter should be updated.
UpdateLineItemDataInput
Used to update an already existing invoice line item.
UpdatePatientDataInput
The data used to update a patient.
UpdatePatientNumberDefinitionInput
Input for updating a Practice Number definition.
UpdatePhoneData
The data defining the phone number to be added.
UpdatePriceProfileDataInput
No description
UpdatePriceProfilePeriodDataInput
No description
UpdatePriceRuleDataInput
No description
UpdateResourceAvailabilityInput
No description
UpdateTaskDataInput
Data representing the updated task.
UpdateUserInput
Input for updating a practice user. Omitted fields are left unchanged; null clears optional fields (same as the Semble UI).
UpdateWebhookInput
Partial input for updating a webhook subscription. Omitted fields are left unchanged.
UserAnnuaireSanteAddressInput
No description
UserAnnuaireSanteIdsInput
No description
UserAnnuaireSanteOrganizationInput
No description
UserAnnuaireSanteProfileCreateInput
Identifies a practitioner in Annuaire Santé on create. The server resolves and stores the full profile from RPPS.
UserAnnuaireSanteProfileUpdateInput
Mutable Annuaire Santé profile fields on update. Directory identifiers (RPPS, idnps, annuaireSanteIds) are read-only.
UserAnnuaireSanteSpecialtyInput
No description
UserCalendarSettingsInput
No description
UserDefaultDocumentSharingInput
No description
UserDocumentSharingPreferenceInput
No description
UserFrenchComplianceInput
French practice compliance fields. Only applicable when the practice is in France and isDoctor is true. On create, annuaireSante is required for regulated clinicians (with RPPS).
UserFrenchComplianceUpdateInput
French practice compliance fields on update. Use annuaireSanteLookup when the user has no profile yet.
UserHealthcodeIntegrationInput
No description
UserIntegrationsInput
Third-party integration identifiers and credentials for the user.
UserMedicalSettingsInput
No description
UserMobileNumberInput
No description
UserNotificationsInput
Email and in-app notification preferences for the user.
UserOneWelbeckIntegrationInput
No description
UserPatientSearchSettingsInput
No description
UserServiceProvidedInput
No description
UserServicesInput
Appointment products the user can provide.
UserSettingsInput
User preferences grouped by area (calendar, medical, patient search).
UsersQueryFilters
No description
UsersQueryOptions
Query options specifically for the users query.
WebhookHeaderInput
Key-value pair for webhook request headers.