addContactPhoneNumber
This mutation adds a phone number to a contact.
addInvoicePayment
This mutation is for recording payment made against an invoice.
addLineItem
This mutation is for adding a line item to an existing invoice.
addPatientAccessGroup
This mutation adds a patient to an access group.
addPatientAttribute
This mutation is for adding a patient attribute.
addPatientLabel
This mutation is for adding a patient label.
addPatientMembership
This mutation is for adding a membership to a patient.
addPatientNumber
This mutation is for adding a patient number (such as NHS number).
addPatientPhoneNumber
This mutation is for adding a patient phone number.
addPatientRelationship
Adds a PatientRelationship to a Patient.
addProductLabel
This mutation is for adding a digital label to a specific product.
archiveEpisodeType
This mutation is for archiving an episode type.
archivePatient
This mutation archives a patient record.
cancelScheduledPatientCommunication
This mutation cancels a scheduled patient communication.
createAllergyRecord
This mutation creates an allergy record.
createBooking
This mutation creates a new booking.
createClinicalPathway
Not available for public API use yet. This operation is documented for future use only.
createContact
This mutation is for creating a new external contact in Semble.
createEpisodeType
This mutation is for creating a new episode type.
createEpisode
Not available for public API use yet. This operation is documented for future use only.
createFreeTextRecord
This mutation creates a free text record.
createIntegrationToken
This mutation is for creating a new interation token for a patient.
createInvoice
This mutation is for creating a new invoice.
createLabel
This mutation is for creating a new label.
createLetter
This mutation is for creating a new letter.
createOutOfOfficeBooking
This mutation creates a new out of office booking.
createPatientDocument
This mutation is for creating a new patient document.
createPatient
This mutation is for creating a new patient.
createPracticeTemplateDocument
This mutation creates a practice template document.
createPriceProfilePeriod
Creates a period under a price profile.
createPriceProfile
Creates a practice-scoped price profile record.
createPriceRule
Creates a price rule for a product and profile period.
createProduct
This mutation creates a new product.
createTask
This mutation creates a task.
createWebhook
Registers a webhook URL for the current practice. Returns the webhook id and secret. Rejects if URL is invalid, duplicate (same URL + event), or webhooks are disabled.
deleteBookingMetadata
This mutation removes a metadata entry by key. If the key does not exist, no error is returned and the booking is returned unchanged.
deleteBooking
This mutation deletes an existing booking.
deleteClinicalPathway
Not available for public API use yet. This operation is documented for future use only.
deleteConsultation
This mutation deletes a consultation.
deleteContactMetadata
This mutation removes a metadata entry by key. If the key does not exist, no error is returned and the contact is returned unchanged.
deleteContact
This mutation deletes a contact.
deleteEpisode
Not available for public API use yet. This operation is documented for future use only.
deleteInvoiceMetadata
This mutation removes a metadata entry by key. If the key does not exist, no error is returned and the invoice is returned unchanged.
deleteInvoicePayment
This mutation is for deleting the record of a payment made against an invoice.
deleteInvoice
This mutation is for deleting an exising invoice.
deleteLabel
This mutation is for deleting a label.
deleteLetter
This mutation is for deleting an existing letter.
deleteLineItem
This mutation is for deleting a line item from an exising invoice.
deleteLocationMetadata
This mutation removes a metadata entry by key. If the key does not exist, no error is returned and the location is returned unchanged.
deletePatient
This mutation deletes a patient.
deletePriceProfilePeriod
Soft-deletes a price profile period.
deletePriceProfile
Soft-deletes a price profile.
deletePriceRule
Soft-deletes a price rule.
deleteProductMetadata
This mutation removes a metadata entry by key. If the key does not exist, no error is returned and the product is returned unchanged.
deleteProduct
This mutation deletes a product.
deleteRecord
This mutation deletes a record.
deleteTask
This mutation deletes a task.
deleteUserMetadata
This mutation removes a metadata entry by key. If the key does not exist, no error is returned and the user is returned unchanged.
deleteWebhook
Deletes a webhook subscription for the current practice. Only the practice that created it can delete it. Rejects if webhooks are disabled or the webhook is not found.
fillQuestionnaire
This mutation is for filling in a questionnaire.
removeContactPhoneNumber
This mutation removes a phone number from a contact.
removePatientAccessGroup
This mutation removes a patient from an access group.
removePatientAttribute
This mutation is for removing a patient attribute.
removePatientLabel
This mutation is for removing a patient label.
removePatientMembership
This mutation is for removing a membership from a patient.
removePatientNumber
This mutation is for removing a patient number (such as NHS number).
removePatientPhoneNumber
This mutation is for removing a patient phone number.
removePatientRelationship
Removes an existing PatientRelationship from a Patient.
removeProductLabel
This mutation removes a digital label from a specific product.
sendEmail
This mutation sends an Email to a patient.
sendSms
This mutation sends an SMS to a patient.
signIn
This mutation generates an authentication token used for signing into the API.
unarchiveEpisodeType
This mutation is for unarchiving an episode type.
unarchivePatient
This mutation unarchives a patient record.
updateAllergyRecord
This mutation updates an allergy record.
updateBookingJourney
This mutation updates the journey of a patient for a booking.
updateBookingMetadata
This mutation adds or updates metadata. Max key length is 40, Max value length is 500, Maximum of 50 total keys
updateBooking
This mutation updates an existing booking.
updateClinicalPathway
Not available for public API use yet. This operation is documented for future use only.
updateContactMetadata
This mutation adds or updates metadata. Max key length is 40, Max value length is 500, Maximum of 50 total keys
updateContactPhoneNumber
This mutation updates a contact's phone number.
updateContact
This mutation updates the details of a contact.
updateEpisode
Not available for public API use yet. This operation is documented for future use only.
updateFreeTextRecord
This mutation updates a free text record.
updateInvoiceMetadata
This mutation adds or updates metadata. Max key length is 40, Max value length is 500, Maximum of 50 total keys
updateInvoicePayment
This mutation is for updating the record of a payment made against an invoice.
updateInvoice
This mutation is for updating an exising invoice.
updateLabel
This mutation is for updating a label.
updateLetter
This mutation is for updating an existing letter.
updateLineItem
This mutation updates line items in an invoice.
updateLocationMetadata
This mutation adds or updates metadata. Max key length is 40, Max value length is 500, Maximum of 50 total keys
updatePatientAttribute
This mutation is for updating a patient attribute.
updatePatientNumber
This mutation is for updating a patient number (such as NHS number).
updatePatientPhoneNumber
This mutation is for updating a patient phone number.
updatePatientRelationship
Updates an existing PatientRelationship held by a Patient. Note that the relationshipType and relationshipLabel fields cannot be updated using this mutation.
updatePatient
This mutation updates the details of an existing patient.
updatePriceProfilePeriod
Updates a price profile period.
updatePriceProfile
Updates the price profile name.
updatePriceRule
Updates a price rule.
updateProductMetadata
This mutation adds or updates metadata. Max key length is 40, Max value length is 500, Maximum of 50 total keys
updateProduct
This mutation updates the details of a product.
updateTask
This mutation updates a task.
updateUserMetadata
This mutation adds or updates metadata. Max key length is 40, Max value length is 500, Maximum of 50 total keys
updateWebhook
Updates an existing webhook subscription for the current practice. Requires editWebhooks permission.