Skip to main content
Link
Menu
Expand
(external link)
Document
Search
Copy
Copied
Home
Patient Portal API
Communication overview
URL format
POST data format
Response data format
Client authentication
JavaScript API library
Authentication
Authentication Token
Login
Direct Login
ValidateLogin
Logout
ValidateRegCode
GetRegCodeInfo
GetAllowedTitles
ValidateProfileData
RegisterPatient
SendActivationEmail
SubmitActivationEmail
SendActivationSMS
SubmitActicationSMS
SendValidationEmail
SubmitValidationEmail
SendValidationSMS
SubmitValidationSMS
SendPasswordResetEmail
SubmitPasswordResetEmail
GetServerState
AddressLookup
GetTermsAndConditions
GetConfig
GetDepartmentsAndDivisions
GetSSOLoginDetails
Send2faCode
Send2faCodeEmail/Send2faCodeSMS
Submit2faCode
Address Finder
Search
FuzzySearch
Address
Patient
GetAllowedTitles
GetDemographicData
GetEmployerDemographicData
UpdateDemographicData
AcceptTermsAndConditions
GetDepartmentsAndDivisions
GetEmployeeStatuses
GetInsurer
SetInsurer
Password reset
SendLink
ValidateKey
SendValidationSMS
SubmitValidationCode
SetPassword
\[OBSOLETE\] SetPasswordUsingDemographics
Appointments
GetPayerTypes
GetAppointmentTypes
GetServiceTypes
GetServices
GetSites
GetClinicians
GetProposedAppointments
BookProposedAppointment
GetExistingAppointments
GetAppointments
GetAppointmentCancellationInfo
CancelExistingAppointment
GetQuestionnairesForFutureAppointments
GetQuestionnaires
GetQuestionnaireDetail
SaveQuestionnaire
SubmitQuestionnaire
SaveAndSubmitQuestionnaire
GetProposedTimeSlots
BookProposedTimeSlot
Anonymous Appointment Search
GetAppointmentTypes
GetSites
GetClinicians
GetServiceTypes
GetServices
GetProposedAppointments
GetProposedTimeSlots
Anonymous Appointment Booking
RegisterPatient
ResendValidationCode
SubmitValidationCode
BookProposedAppointment
BookProposedTimeSlot
Finance
GetInvoices
GetInvoiceDetail
SendInvoiceByEmail
ProvidePayment
PayerAccounts
RemovePayerAccount
PaymentCountries
Feeds
GetFeeds
GetFeed
AddFeed
AddMessage
Notifications
GetNotifications
ConfirmNotification
Membership scheme
ValidateCode
GetSchemeInfo
GetSchemes
GetCurrent
Join
SetupOnlinePayment
RemoveOnlinePayment
Medical history
GetMedicalHistoryTreeNode
Reading the Medical History tree
Referral Portal API
Users
GetAllowedTitles
GetDepartmentsAndDivisions
GetEmployeeStatuses
GetUserRights
GetUsers
GetUser
CreateUser
UpdateUser
RemoveAccess
ResetPassword
Patients
QuickSearch
FullSearch
FullSearchOrCreate
GetPatients
GetPatient
UpdatePatient
GetManagers
Documents
GetDocuments
AttachDocument
GetDocument
GetTypes
Referrals
GetReferrals
GetReferral
Start
StartFromQuestionnaireRequest
AttachDocument
Send
Cancel
FindUserToReallocate
Reallocate
BulkReallocate
FollowUp
GetBasicStatistics
Patient Medical Report Review
SendValidationSMS
SendValidationEmail
SubmitValidationCode
ValidateKey
GetMedicalReportData
SubmitAuthorisation
Manager Medical Report Review
SendValidationSMS
SendValidationEmail
SubmitValidationCode
ValidateKey
GetMedialReportData
Recalls
GetRecalls
DeleteRecall
Questionnaires
GetQuestionnaireForms
GetModules
GetQuestionnaires
GetQuestionnaireResults
SaveModule
DeleteModule
CreateRequest
Questionnaire Request
SendValidationSMS
SendValidationEmail
SubmitValidationCode
ValidateKey
SaveQuestionnaire
SubmitQuestionnaire
SaveAndSubmitQuestionnaire
Telemedicine
Authorise
Single sign-on
Pathways
Pathway structure and task types
GetPathways
GetPathway
GetTask
AcceptTask
ChooseOption
AttachDocument
GetDefinitions
Availability
StartPathway
Absence Management
GetAbsences
GetAbsence
SaveAbsence
GetPatientAbsenceOverview
ResendRTW
ApproveAndClose
GetManagers
Absence questionnaire
SendValidationSMS
SubmitValidationCode
ValidateKey
SubmitQuestionnaire
Companies
Insurers
Ethnicities
Referrers
Case Management
GetCases
GetCase
OpenCase
CloseCase
FollowUp
DefaultTitles
Gender Identity
Genders
Pronouns
Objects and data types
AbsenceData
AbsenceOverviewData
AbsenceRTWQuestionnaireData
ActivationConfirmation
AddressData
AppointmentCancellationData
AppointmentData
AppointmentModuleData
AppointmentSlot
AppointmentTaskData
AppointmentTypeData
AttachDocumentTaskData
AuthenticationData
AuthorizeTelemedicineData
CaseData
CaseOverviewData
ChargeBandData
ChoiceTaskData
ClinicianData
CompanyData
CompanyDemographicData
ConfigData
ContactDemographicData
CountryData
CurrencyData
CurrentMembershipSchemeData
DateTime
DepartmentData
DivisionData
DocumentData
DocumentType
EmployeeStatus
EthnicityData
FeedData
FeedMessageData
GenderData
InsurerData
InvoiceAddressData
InvoiceCreditNoteData
InvoiceData
InvoiceItemData
LocalDateTime
LocationData
LostWork
ManagerReportReviewData
MedicalHistoryNodeData
MembershipSchemeData
NextOfKinDemographicData
NotificationData
PathwayData
PathwayOverviewData
PathwayTaskData
PathwayTaskOverviewData
PathwayDefinitionData
PathwayAvailabilityData
PatientAbsenceOverviewData
PatientContactOption
PatientRegistrationResultData
PatientReportReviewData
PatientReportReviewState
PayerAccountData
PayerAccountInputData
PayerType
PersonDemographicData
PrescriptionData
PronounData
QuestionnaireAnswerData
QuestionnaireData
QuestionnaireFormData
QuestionnaireModuleData
QuestionnaireOverviewData
QuestionnaireResultData
QuestionnaireTaskData
RecallData
ReferralData
ReferralOverviewData
ReferrerData
ServerStateData
ServiceData
ServiceExceptionData
ServiceTypeData
ShallowSearchResultData
SiteData
SSOStatus
TermsAndConditions
TimeSlotsData
TimeSlotData
UserData
UserRights
Error handling
HTTP status codes
EventCode
Questionnaire markup
Patient Portal API
Gender Identity
Gender Identity
Table of contents
Genders
Pronouns