Patients
📄️ Update versioned visual fields
Updates an existing versioned visual fields record for a specific patient.
📄️ Delete versioned visual fields
Deletes an existing versioned visual fields record for a specific patient.
📄️ Update versioned visit
Updates an existing versioned visit for a specific patient.
📄️ Update versioned pachymetry reading
Updates an existing versioned pachymetry reading record.
📄️ Delete versioned pachymetry reading
Deletes a specific versioned pachymetry reading record.
📄️ Update versioned eye pressure
Updates a versioned eye pressure record by its unique identifier.
📄️ Delete versioned eye pressure
Deletes a versioned eye pressure record by its unique identifier.
📄️ Update versioned exam visit
Updates an existing versioned exam visit for a specific patient.
📄️ Delete versioned visit
Deletes an existing versioned visit for a specific patient.
📄️ Update patient medication
Updates an existing medication record for a patient.
📄️ Delete patient medication
Deletes a medication record by its unique identifier.
📄️ Update patient for web diary
Updates an existing patient record for use with the web diary booking flow.
📄️ Update patient for patient portal
Updates a patient record with the provided details via the patient portal.
📄️ Get patient for patient portal
Retrieves patient portal details by web PID or patient identifier.
📄️ Update medical prescription
Updates an existing medical prescription for the specified patient.
📄️ Delete medical prescription
Deletes an existing medical prescription for the specified patient.
📄️ Update medical prescription notes
Updates the medication notes associated with a patient visit's prescriptions.
📄️ Sync patient medication from ScriptSure mailbox
Synchronises patient prescription data received via the ScriptSure mailbox.
📄️ Sync external patient
Synchronises an external patient record from the external source system for the given patient identifier.
📄️ Get similar patients
Returns a list of patients that are similar to the specified patient, useful for duplicate detection.
📄️ Share patient
Shares a patient record via a share link with the provided patient details.
📄️ Search versioned visual fields
Searches for versioned visual fields for a specific patient.
📄️ Create versioned visual fields
Creates a new versioned visual fields record for a specific patient.
📄️ Search versioned visits
Searches for versioned visits for a specific patient.
📄️ Create versioned visit
Creates a new versioned visit for a specific patient.
📄️ Search versioned social history
Searches for versioned social history records for a patient.
📄️ Create versioned social history
Creates a new versioned social history record for a patient.
📄️ Search versioned pachymetry readings
Searches versioned pachymetry readings for a given patient.
📄️ Create versioned pachymetry reading
Creates a new versioned pachymetry reading record for a patient.
📄️ Search versioned ocular history
Retrieves versioned ocular history records for a specific patient.
📄️ Save versioned ocular history
Creates or updates versioned ocular history records for a specific patient.
📄️ Delete versioned ocular history
Deletes all versioned ocular history records for a given patient and visit.
📄️ Search versioned medical history
Retrieves versioned medical history records for a specific patient.
📄️ Save versioned medical history
Creates or updates versioned medical history records for a specific patient.
📄️ Delete versioned medical history
Deletes all versioned medical history records for a given patient and visit.
📄️ Search versioned eye pressures
Retrieves versioned eye pressure records for a patient using optional filter criteria.
📄️ Create versioned eye pressure
Creates a new versioned eye pressure record for a patient.
📄️ Search versioned exam visits
Searches for versioned exam visits for a specific patient.
📄️ Create versioned exam visit
Creates a new versioned exam visit for a specific patient.
📄️ Get patient pupil distances
Retrieves pupil distance measurements for the provided patient identifier.
📄️ Search patients
Searches for patients matching the provided search criteria.
📄️ Get patient surgeries
Retrieves all surgery records for the specified patient.
📄️ Get patient medications
Retrieves all medication records for the specified patient, grouped by visit.
📄️ Search external patients
Searches for patients in external systems by name, date of birth, or contact details.
📄️ Save patient medications
Saves the complete medication list for a patient, replacing existing entries.
📄️ Save patient bank account
Creates or updates a bank account record associated with a patient.
📄️ Save medical prescription
Creates a new medical prescription for the specified patient.
📄️ Get medical prescriptions
Returns all medical prescriptions for the specified patient, grouped by visit.
📄️ Save medical prescription list
Creates or updates a list of medical prescriptions for the specified patient in a single operation.
📄️ Get patients pending approval
Returns a list of web patients that are pending approval, optionally filtered by business entity.
📄️ Get patient preview
Retrieves a summary preview of the patient record for the provided patient identifier.
📄️ Merge patients
Merges two patient records by moving all data from the source patient to the target patient.
📄️ Get patient bank accounts
Retrieves bank account details for the provided patient identifier.
📄️ Get patient active orders
Retrieves the active dispense orders for the provided patient identifier.
📄️ Initiate ScriptSure medication download
Initiates the download of drug history from ScriptSure for the specified patient.
📄️ Import external patient
Imports a patient record from an external source system by its identifier.
📄️ Get related transactions
Returns transactions related to the specified patient.
📄️ Get patient transactions
Returns transactions associated with the specified patient.
📄️ Get patient gender
Retrieves the patient's gender for the provided unique patient identifier.
📄️ Get patient for web diary edit
Retrieves the flat lite patient record for web diary editing by patient identifier.
📄️ Get patient for edit
Retrieves the full patient record in edit form for the provided patient identifier.
📄️ Get patient diagnoses
Retrieves all diagnoses recorded for the specified patient.
📄️ Get patient details
Retrieves the patient's details for the provided unique patient identifier.
📄️ Get patient details
Retrieves the patient's details for the provided unique patient identifier.
📄️ Get patient contact details
Retrieves the patient's contact details including contact methods (phone, email, address), consents, and communication preferences for the provided unique patient identifier.
📄️ Get patient age
Retrieves the patient's age for the provided unique patient identifier.
📄️ Find patient by web account
Returns the patient identity matching the provided web account identifier.
📄️ Find patient by external reference
Returns the patient identity matching the provided external reference identifier.
📄️ Find existing patients
Returns existing patients matching the provided contact details.
📄️ Download ScriptSure medications
Downloads medications from ScriptSure for the specified patient using a session token.
📄️ Delete versioned social history
Deletes a versioned social history record for a patient.
📄️ Delete versioned ocular history patient
Deletes a specific versioned ocular history patient record by checklist and visit identifiers.
📄️ Delete versioned medical history patient
Deletes a specific versioned medical history patient record by checklist and visit identifiers.
📄️ Delete patient surgery
Deletes a surgery record by its unique identifier.
📄️ Delete patient medications (batch)
Deletes multiple medication records by their unique identifiers.
📄️ Delete patient bank account
Deletes a bank account record associated with a patient by its unique identifier.
📄️ Create versioned procedure codes
Creates versioned procedure codes for a patient.
📄️ Create versioned event and sign visit
Creates a versioned visit event and signs the visit for a patient.
📄️ Create versioned event and increase unlocks
Creates a versioned visit event and increases the unlock count for a patient.
📄️ Create unapproved web patient
Creates a new unapproved web patient with optional contact details and patient identifiers.
📄️ Create patient surgery
Creates one or more surgery records for a patient.
📄️ Create patient medication
Creates a new medication record for a patient.
📄️ Import patient medication history
Bulk-imports a set of historical medication records for a patient.
📄️ Create patient for web diary
Creates a new patient record intended for use with the web diary booking flow.
📄️ Create approved web patient
Creates a new approved web patient with optional contact details and patient identifiers.
📄️ Assign web identifier to patient
Assigns a web identifier to an existing patient record.
📄️ Approve web patient
Approves or updates the approval status of a web patient registration.
📄️ Update Patient All Patient Identifier Types lookup value
Creates or updates a patient all patient identifier types lookup value in the practice management system.
📄️ Get Patient All Patient Identifier Types lookup values
Retrieves all available patient all patient identifier types lookup values from the practice management system.
📄️ Update Patient Campaign No Yes lookup value
Creates or updates a patient campaign no yes lookup value in the practice management system.
📄️ Get Patient Campaign No Yes lookup values
Retrieves all available patient campaign no yes lookup values from the practice management system.
📄️ Update Patient Communication Channels lookup value
Creates or updates a patient communication channels lookup value in the practice management system.
📄️ Get Patient Communication Channels lookup values
Retrieves all available patient communication channels lookup values from the practice management system.
📄️ Update Patient Communication Features lookup value
Creates or updates a patient communication features lookup value in the practice management system.
📄️ Get Patient Communication Features lookup values
Retrieves all available patient communication features lookup values from the practice management system.
📄️ Update Patient Communication Impairment lookup value
Creates or updates a patient communication impairment lookup value in the practice management system.
📄️ Get Patient Communication Impairment lookup values
Retrieves all available patient communication impairment lookup values from the practice management system.
📄️ Update Patient Correspondences lookup value
Creates or updates a patient correspondences lookup value in the practice management system.
📄️ Get Patient Correspondences lookup values
Retrieves all available patient correspondences lookup values from the practice management system.
📄️ Update Patient Correspondence Send Status lookup value
Creates or updates a patient correspondence send status lookup value in the practice management system.
📄️ Get Patient Correspondence Send Status lookup values
Retrieves all available patient correspondence send status lookup values from the practice management system.
📄️ Update Patient Correspondence Source Types lookup value
Creates or updates a patient correspondence source types lookup value in the practice management system.
📄️ Get Patient Correspondence Source Types lookup values
Retrieves all available patient correspondence source types lookup values from the practice management system.
📄️ Update Patient Dp Types lookup value
Creates or updates a patient dp types lookup value in the practice management system.
📄️ Get Patient Dp Types lookup values
Retrieves all available patient dp types lookup values from the practice management system.
📄️ Update Patient Dutch Address Grade lookup value
Creates or updates a patient dutch address grade lookup value in the practice management system.
📄️ Get Patient Dutch Address Grade lookup values
Retrieves all available patient dutch address grade lookup values from the practice management system.
📄️ Update Patient Ethnicity lookup value
Creates or updates a patient ethnicity lookup value in the practice management system.
📄️ Get Patient Ethnicity lookup values
Retrieves all available patient ethnicity lookup values from the practice management system.
📄️ Update Patient Feature Consent Formats lookup value
Creates or updates a patient feature consent formats lookup value in the practice management system.
📄️ Get Patient Feature Consent Formats lookup values
Retrieves all available patient feature consent formats lookup values from the practice management system.
📄️ Update Patient Gender Identity lookup value
Creates or updates a patient gender identity lookup value in the practice management system.
📄️ Get Patient Gender Identity lookup values
Retrieves all available patient gender identity lookup values from the practice management system.
📄️ Update Patient Genders lookup value
Creates or updates a patient genders lookup value in the practice management system.
📄️ Get Patient Genders lookup values
Retrieves all available patient genders lookup values from the practice management system.
📄️ Update Patient General Document Tags lookup value
Creates or updates a patient general document tags lookup value in the practice management system.
📄️ Get Patient General Document Tags lookup values
Retrieves all available patient general document tags lookup values from the practice management system.
📄️ Update Patient Hearing Impairment lookup value
Creates or updates a patient hearing impairment lookup value in the practice management system.
📄️ Get Patient Hearing Impairment lookup values
Retrieves all available patient hearing impairment lookup values from the practice management system.
📄️ Update Patient Hobbies lookup value
Creates or updates a patient hobbies lookup value in the practice management system.
📄️ Get Patient Hobbies lookup values
Retrieves all available patient hobbies lookup values from the practice management system.
📄️ Update Patient Image Folders lookup value
Creates or updates a patient image folders lookup value in the practice management system.
📄️ Get Patient Image Folders lookup values
Retrieves all available patient image folders lookup values from the practice management system.
📄️ Update Patient Image Modalities lookup value
Creates or updates a patient image modalities lookup value in the practice management system.
📄️ Get Patient Image Modalities lookup values
Retrieves all available patient image modalities lookup values from the practice management system.
📄️ Update Patient Initials Types lookup value
Creates or updates a patient initials types lookup value in the practice management system.
📄️ Get Patient Initials Types lookup values
Retrieves all available patient initials types lookup values from the practice management system.
📄️ Update Patient Invoices lookup value
Creates or updates a patient invoices lookup value in the practice management system.
📄️ Get Patient Invoices lookup values
Retrieves all available patient invoices lookup values from the practice management system.
📄️ Update Patient Language lookup value
Creates or updates a patient language lookup value in the practice management system.
📄️ Get Patient Language lookup values
Retrieves all available patient language lookup values from the practice management system.
📄️ Update Patient Map Display Types lookup value
Creates or updates a patient map display types lookup value in the practice management system.
📄️ Get Patient Map Display Types lookup values
Retrieves all available patient map display types lookup values from the practice management system.
📄️ Update Patient Map Types lookup value
Creates or updates a patient map types lookup value in the practice management system.
📄️ Get Patient Map Types lookup values
Retrieves all available patient map types lookup values from the practice management system.
📄️ Update Patient Marital Status lookup value
Creates or updates a patient marital status lookup value in the practice management system.
📄️ Get Patient Marital Status lookup values
Retrieves all available patient marital status lookup values from the practice management system.
📄️ Update Patient Medical Imaging Tags lookup value
Creates or updates a patient medical imaging tags lookup value in the practice management system.
📄️ Get Patient Medical Imaging Tags lookup values
Retrieves all available patient medical imaging tags lookup values from the practice management system.
📄️ Update Patient Mobility Impairment lookup value
Creates or updates a patient mobility impairment lookup value in the practice management system.
📄️ Get Patient Mobility Impairment lookup values
Retrieves all available patient mobility impairment lookup values from the practice management system.
📄️ Update Patient Patient Identifier Types lookup value
Creates or updates a patient patient identifier types lookup value in the practice management system.
📄️ Get Patient Patient Identifier Types lookup values
Retrieves all available patient patient identifier types lookup values from the practice management system.
📄️ Update Patient Patient Share Integration Types lookup value
Creates or updates a patient patient share integration types lookup value in the practice management system.
📄️ Get Patient Patient Share Integration Types lookup values
Retrieves all available patient patient share integration types lookup values from the practice management system.
📄️ Update Patient Patient Sources lookup value
Creates or updates a patient patient sources lookup value in the practice management system.
📄️ Get Patient Patient Sources lookup values
Retrieves all available patient patient sources lookup values from the practice management system.
📄️ Update Patient Race lookup value
Creates or updates a patient race lookup value in the practice management system.
📄️ Get Patient Race lookup values
Retrieves all available patient race lookup values from the practice management system.
📄️ Update Patient Relationships lookup value
Creates or updates a patient relationships lookup value in the practice management system.
📄️ Get Patient Relationships lookup values
Retrieves all available patient relationships lookup values from the practice management system.
📄️ Update Patient Religion lookup value
Creates or updates a patient religion lookup value in the practice management system.
📄️ Get Patient Religion lookup values
Retrieves all available patient religion lookup values from the practice management system.
📄️ Update Patient Sexual Orientation lookup value
Creates or updates a patient sexual orientation lookup value in the practice management system.
📄️ Get Patient Sexual Orientation lookup values
Retrieves all available patient sexual orientation lookup values from the practice management system.
📄️ Update Patient Sources lookup value
Creates or updates a patient sources lookup value in the practice management system.
📄️ Get Patient Sources lookup values
Retrieves all available patient sources lookup values from the practice management system.
📄️ Update Patient Titles lookup value
Creates or updates a patient titles lookup value in the practice management system.
📄️ Get Patient Titles lookup values
Retrieves all available patient titles lookup values from the practice management system.
📄️ Update Patient Ui Postcode Types lookup value
Creates or updates a patient ui postcode types lookup value in the practice management system.
📄️ Get Patient Ui Postcode Types lookup values
Retrieves all available patient ui postcode types lookup values from the practice management system.
📄️ Update Patient Vision Impairment lookup value
Creates or updates a patient vision impairment lookup value in the practice management system.
📄️ Get Patient Vision Impairment lookup values
Retrieves all available patient vision impairment lookup values from the practice management system.
📄️ Update Patient Web Approval Status lookup value
Creates or updates a patient web approval status lookup value in the practice management system.
📄️ Get Patient Web Approval Status lookup values
Retrieves all available patient web approval status lookup values from the practice management system.
📄️ Get Patient All Patient Identifier Types lookup value by key
Retrieves patient all patient identifier types lookup values matching the specified key.
📄️ Get Patient Campaign No Yes lookup value by key
Retrieves patient campaign no yes lookup values matching the specified key.
📄️ Get Patient Communication Channels lookup value by key
Retrieves patient communication channels lookup values matching the specified key.
📄️ Get Patient Communication Features lookup value by key
Retrieves patient communication features lookup values matching the specified key.
📄️ Get Patient Communication Impairment lookup value by key
Retrieves patient communication impairment lookup values matching the specified key.
📄️ Get Patient Correspondences lookup value by key
Retrieves patient correspondences lookup values matching the specified key.
📄️ Get Patient Correspondence Send Status lookup value by key
Retrieves patient correspondence send status lookup values matching the specified key.
📄️ Get Patient Correspondence Source Types lookup value by key
Retrieves patient correspondence source types lookup values matching the specified key.
📄️ Get Patient Dp Types lookup value by key
Retrieves patient dp types lookup values matching the specified key.
📄️ Get Patient Dutch Address Grade lookup value by key
Retrieves patient dutch address grade lookup values matching the specified key.
📄️ Get Patient Ethnicity lookup value by key
Retrieves patient ethnicity lookup values matching the specified key.
📄️ Get Patient Feature Consent Formats lookup value by key
Retrieves patient feature consent formats lookup values matching the specified key.
📄️ Get Patient Gender Identity lookup value by key
Retrieves patient gender identity lookup values matching the specified key.
📄️ Get Patient Genders lookup value by key
Retrieves patient genders lookup values matching the specified key.
📄️ Get Patient General Document Tags lookup value by key
Retrieves patient general document tags lookup values matching the specified key.
📄️ Get Patient Hearing Impairment lookup value by key
Retrieves patient hearing impairment lookup values matching the specified key.
📄️ Get Patient Hobbies lookup value by key
Retrieves patient hobbies lookup values matching the specified key.
📄️ Get Patient Image Folders lookup value by key
Retrieves patient image folders lookup values matching the specified key.
📄️ Get Patient Image Modalities lookup value by key
Retrieves patient image modalities lookup values matching the specified key.
📄️ Get Patient Initials Types lookup value by key
Retrieves patient initials types lookup values matching the specified key.
📄️ Get Patient Invoices lookup value by key
Retrieves patient invoices lookup values matching the specified key.
📄️ Get Patient Language lookup value by key
Retrieves patient language lookup values matching the specified key.
📄️ Get Patient Map Display Types lookup value by key
Retrieves patient map display types lookup values matching the specified key.
📄️ Get Patient Map Types lookup value by key
Retrieves patient map types lookup values matching the specified key.
📄️ Get Patient Marital Status lookup value by key
Retrieves patient marital status lookup values matching the specified key.
📄️ Get Patient Medical Imaging Tags lookup value by key
Retrieves patient medical imaging tags lookup values matching the specified key.
📄️ Get Patient Mobility Impairment lookup value by key
Retrieves patient mobility impairment lookup values matching the specified key.
📄️ Get Patient Patient Identifier Types lookup value by key
Retrieves patient patient identifier types lookup values matching the specified key.
📄️ Get Patient Patient Share Integration Types lookup value by key
Retrieves patient patient share integration types lookup values matching the specified key.
📄️ Get Patient Patient Sources lookup value by key
Retrieves patient patient sources lookup values matching the specified key.
📄️ Get Patient Race lookup value by key
Retrieves patient race lookup values matching the specified key.
📄️ Get Patient Relationships lookup value by key
Retrieves patient relationships lookup values matching the specified key.
📄️ Get Patient Religion lookup value by key
Retrieves patient religion lookup values matching the specified key.
📄️ Get Patient Sexual Orientation lookup value by key
Retrieves patient sexual orientation lookup values matching the specified key.
📄️ Get Patient Sources lookup value by key
Retrieves patient sources lookup values matching the specified key.
📄️ Get Patient Titles lookup value by key
Retrieves patient titles lookup values matching the specified key.
📄️ Get Patient Ui Postcode Types lookup value by key
Retrieves patient ui postcode types lookup values matching the specified key.
📄️ Get Patient Vision Impairment lookup value by key
Retrieves patient vision impairment lookup values matching the specified key.
📄️ Get Patient Web Approval Status lookup value by key
Retrieves patient web approval status lookup values matching the specified key.