AccountStatementData
This type encompasses a collection of AccountStatement and Pagination information.
AccountStatement
This type allows you to display the output of a query for a patient's account statement.
Address
An address.
AllergyRecordResponsePayload
An allergy record in a consultation or the error related to the operation.
AllergyRecord
An allergy record entry in a consultation.
AppointmentType
The type of an appointment.
Appointment
An appointment.
AvailabilityData
A collection of Availabilities
AvailabilitySettings
A single availability setting: either a recurring slot (day of week + time range)
Availability
An availability block with a start and end date/time.
BookingAddress
Physical location of the booking.
BookingData
A collection of bookings and the associated pagination information.
BookingLocation
The location of the booking.
BookingResponsePayload
The requested/resulting booking or the error associated with the operation.
Booking
A booking.
BrandingColors
Branding colors for a practice.
ClinicalPathwayResponsePayload
Not available for public API use yet. This payload is documented for future clinical pathway support only.
ClinicalPathway
Not available for public API use yet. This object is documented for future clinical pathway support only.
CommunicationPreferences
A patient's communication preferences.
ConsultationData
Multiple consultations and information regarding pagination.
ConsultationResponsePayload
The data that defines the consultation response payload
Consultation
The data that defines a consultation
ContactData
A collection of contacts and the associated pagination information.
ContactResponsePayload
A contact in the application or the error related to the operation on the contact.
Contact
A contact.
CreateWebhookPayload
Result of creating a webhook subscription.
CurrentUser
User information
CustomAttribute
Defines a custom attribute.
DeleteWebhookData
Data returned on successful delete.
DeleteWebhookPayload
Result of deleting a webhook subscription.
No description
EpisodeLabel
Not available for public API use yet. This object is documented for future episode support only.
EpisodeResponsePayload
Not available for public API use yet. This payload is documented for future episode support only.
EpisodeTitle
Display name and practice episode-type id for an episode of care.
EpisodeTypeData
A collection of existing episode types
EpisodeTypeResponsePayload
The requested episode type or error message related to its operation.
Episode
An episode of care for a patient.
FreeTextRecordResponsePayload
A free text record in a consultation or the error related to the operation.
FreeTextRecord
A free text record in a consultation.
HideFormFields
No description
HospitalBookingFormData
No description
INS
Defines the INS properties of a patient. Only applicable to practices in France which are INS certified.
IntegrationTokenPayload
This includes the fields required for creating a new integration token.
IntegrationToken
Inregration token for a patient that can be used in a questionnaire or online booking.
InvoiceData
A collection of invoices and the associated pagination information.
InvoicePayment
A payment made against an invoice.
InvoiceRefund
A refund made against a payment.
Invoice
Invoices are used to record the information related to charges incurred by patients.
Journey
The progression of a booking.
LabComments
Comments relating to a pathology request.
LabData
A collection of pathology requests and the related pagination information.
Lab
Representation of a pathology request for sending to a lab.
LabelData
A collection of existing labels and the related pagination information.
LabelResponsePayload
The requested label or error message related to its operation.
Label
A digital label.
LetterContact
The letter contact.
LetterData
A collection of letters and the related pagination information.
LetterRecipient
No description
LetterResponsePayload
The requested letter or error message related to its retrieval.
Letter
A letter in the system.
LineItem
An entry in an invoice.
MetadataEntry
A key-value metadata entry. Max key length 40, max value length 500, maximum 50 entries per resource.
NewContactPayload
The type representing the contact to create.
NewInvoiceResponsePayload
The newly created invoice or an error related to the failed creation of the invoice.
NewPatientDocumentPayload
The type representing the patient document to create.
NewPracticeTemplateDocumentPayload
Type type representing the practice document template to create.
OnlineBookingConfigurationSettings
No description
OnlineBookingConfiguration
No description
PageInfoForCursorPagination
Information regarding how the requested data are paginated.
PageInfoWithTotalCount
No description
PageInfo
Information regarding how the requested data are paginated. This type is soon to phased out in preferece for the better performing PageInfoForCursorPagination.
PatientAccessGroup
An access group to which the patient belongs.
PatientArchivedInfo
No description
PatientBookingsData
No description
PatientCommunicationData
This type encompasses a collection of PatientCommunication information.
PatientCommunicationPayload
The response received when querying for patient communication information.
PatientData
A collection of patient data and how this data are paginated.
PatientDocumentData
A collection of patient documents and the related pagination information.
PatientDocument
A document that is associated with a patient.
PatientLabel
The data defining a label applied to a patient.
PatientNumber
A number that belongs to the patient.
PatientRelationshipContact
Details for a Patient/Contact that have been linked to in a PatientRelationship.
PatientRelationshipData
A collection of PatientRelationships
PatientRelationship
A patient relationship held by a Patient.
PatientResponsePayload
The response received when querying for patient information.
Patient
The data defining a patient.
Phone
A telephone number.
PlaceOfBirth
Defines the place of birth.
PracticeAccessGroups
Access groups for a practice control who has access to what patients.
PracticeBranding
Branding settings for a practice.
PracticeEpisodeType
A practice-configured episode type for episodes of care.
PracticeLocation
Information about a location at a practice.
PracticeNumbers
Numbers that can be assigned to a patient.
PracticePaymentType
Information about a payment type on an invoice.
PracticeTemplateDocumentData
A collection of document templates and the related pagination information.
PracticeTemplateDocument
A document template used by the practice.
Practice
Information about your practice.
PrescriptionData
A collection of prescriptions and the related pagination information.
PrescriptionDrug
A drug entry in a prescription.
PrescriptionItem
An non-drug entry in a prescription.
Prescription
A prescription for a patient.
PrivacyPolicy
A privacy policy.
ProductData
A collection of products and the relevant pagination information.
ProductLabel
A digital label that is applied to the product for tagging/grouping purposes.
ProductResponsePayload
The requested product or a related error.
Product
The representation of a product.
QuestionnaireData
A collection of questionnaire data and how this data are paginated.
QuestionnaireDependency
The data defining a dependency of a section/question
QuestionnaireGenericQuestion
The data defining a generic question
QuestionnaireMedicalTermQuestion
The data defining a question of type "Medical Term"
QuestionnaireMultipleChoiceQuestion
The data defining a question of type "Multiple Choice"
QuestionnaireRelationshipQuestionSettings
The data defining the settings for a question of type "Relationship"
QuestionnaireRelationshipQuestion
The data defining a question of type "Relationship"
QuestionnaireResponsePayloadData
No description
QuestionnaireResponsePayload
The data defining the response payload after submitting a questionnaire response
QuestionnaireSection
The data defining a section
QuestionnaireSettings
The data defining questionnaire settings
QuestionnaireSignatureQuestion
The data defining a question of type "Signature"
QuestionnaireStyling
The data defining questionnaire styling
Questionnaire
The data defining a questionnaire.
RecordData
Multiple records and information regarding pagination.
RecordResponsePayload
A record in the application or the error related to the operation on the contact.
Record
An entry in a consultation.
RepeatPrescriptionDetails
Repeat prescription details
SendCancellationMessages
The types of notifications that were sent to the patient when the booking was deleted. It defaults to true.
SendEmailPayload
The response received when sending an Email to a patient.
SendPatientMessages
The types of notifications that were sent to the patient when the booking was created, or last updated. It defaults to true.
SendSMSPayload
The response received when sending an SMS to a patient.
SharingComment
No description
SharingRecipient
Information about who a document was shared with
SharingToken
Token that can be used to access the patient portal.
Sharing
No description
SMS
No description
Snomed
An entry in the Snomed dataset.
TaskData
This type encompasses a collection of Task and Pagination information.
TaskResponsePayload
A record in the application or the error related to the operation on the contact.
Task
A task.
Tax
A tax that is applied to a product.
Token
No description
UpdateWebhookPayload
Result of updating a webhook subscription.
UserAccessGroup
The access group for a user.
UserData
A collection of users and information regarding how the colllection is paginated.
User
A user in the application.
WebhookHeader
Key-value header sent with webhook deliveries.
WebhookSubscription
No description