Skip to main content

Mutations overview

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

📄️ cancelScheduledPatientCommunication

This mutation cancels a scheduled patient communication.

📄️ createAllergyRecord

This mutation creates an allergy record.

📄️ createBooking

This mutation creates a new booking.

📄️ createContact

This mutation is for creating a new external contact in Semble.

📄️ createEpisode

This mutation creates an episode of care.

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

📄️ createProduct

This mutation creates a new product.

📄️ createTask

This mutation creates a task.

📄️ deleteBooking

This mutation deletes an existing booking.

📄️ deleteConsultation

This mutation deletes a consultation.

📄️ deleteContact

This mutation deletes a contact.

📄️ deleteEpisode

This mutation deletes an episode of care.

📄️ deleteInvoicePayment

This mutation is for deleting the record of a payment made against an invoice.

📄️ deleteInvoice

This mutation is for deleting an exising invoice.

📄️ deleteLetter

This mutation is for deleting an existing letter.

📄️ deleteLineItem

This mutation is for deleting a line item from an exising invoice.

📄️ deletePatient

This mutation deletes a patient.

📄️ deleteProduct

This mutation deletes a product.

📄️ deleteRecord

This mutation deletes a record.

📄️ deleteTask

This mutation deletes a task.

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

📄️ updateAllergyRecord

This mutation updates an allergy record.

📄️ updateBookingJourney

This mutation updates the journey of a patient for a booking.

📄️ updateBooking

This mutation updates an existing booking.

📄️ updateContactPhoneNumber

This mutation updates a contact's phone number.

📄️ updateContact

This mutation updates the details of a contact.

📄️ updateEpisode

This mutation updates an episode of care.

📄️ updateFreeTextRecord

This mutation updates a free text record.

📄️ updateInvoicePayment

This mutation is for updating the record of a payment made against an invoice.

📄️ updateInvoice

This mutation is for updating an exising invoice.

📄️ updateLetter

This mutation is for updating an existing letter.

📄️ updateLineItem

This mutation updates line items in an invoice.

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

📄️ updateProduct

This mutation updates the details of a product.

📄️ updateTask

This mutation updates a task.