List of functions to execute through ExecuteAPICall web-method.

expand all collapse
Notes:
  • All functions marked with (*) do not communicate with practice's systems. They pull data from Sophrona local database only.
  • All IDs used in this documentation are the parameter values as used by the remote PM/EMR system and not Sophrona's identifiers.
  • All time values are practice's local times. Transorm it to your local time based on practice timezone or zip code if needed.

Appointment and Scheduling functions

GetAppointments Retrieve a list of appointments for given criteria. Can be filtered by patient, doctor, location, visit type, and appointment status
GetPatientAppointments Retrieve a list of appointments for a specified list of patients. Can be filtered by doctor, location, visit type, and appointment status
GetAvailableTimeSlots Retrieve a list of time slots available for appointment scheduling. It can be filtered by doctor, location, and visit type.
GetSchedulingOptions (*)Retrieve a list of doctor, location, visit types combinations allowed for scheduling.
BookAppointment Schedule an appointment.
CancelAppointment Cancel scheduled appointment.
ConfirmAppointment Confirm scheduled appointment.
CheckChangedAppointments Get appointment IDs modified in a specific time period for a patients
GetChangedAppointments Get changed appointments
GetPracticeQAStopQuestions Get practice specific questions for Book Appointments
GetReferrals Retrieves referral data from practice management system
GetPracticeReferrals Retrieves referral data from Sophrona Referral Portal
PostReferral Post Referral Request

Patient functions

CheckPatient Get patient id or refresh patient data.
CreatePatient Create a patient in remote system. Performs a check for patient existence in remote system before creating.
SearchPatients Search patients by variety of criteria (wildcard search).
GetBirthDays Retrieve a list of patients with birthdays for a given date range.
UpdateReferralSource Update Patient' Referral Source.
CheckChangedPatients Get patient IDs modified in a specific time period.
GetChangedPatients Get changed patients.
UpdatePatientDemographic Update Patient Demographic.
 
GetPatientChartGet latest Patient Health Record (chart).
GetPatientClinicalSummaryGet latest patient Clinical Summary.
GetEducationalDocumentsGet list of patient educational or preventative care articles.
GetSecureMessagesGet patient Secure Messages.

Support functions

GetAvailablePractices (*)Get full list of practices included in your license.
getAvailableFunctions (*)Get full list of functions enabled in your license for a given practice.
GetLocations Get full list of scheduling locations for a given practice.
GetProviders Get full list of providers for a given practice.
GetVisitTypes Get full list of visit types for a given practice.
GetReferralSources Get full list of practice referral sources.

PM/EMR available functions

GetPatientToken Obtain a patient authorization token.
GetPatientChart Get patient chart(s).
GetPatientChartCategory Get patient chart(s) with specific categories only.
PostPatientChart Post Patient Chart.
PostClinicalSummary Post Patient Clinical Summary.
PostEducationalDocuments Post Educational Documents.
GetMU2Metrics Retrieve a list of MU2 tracking events.
GetMU2Counters Retrieve MU2 counters.
PostPatientLoginInfo Post patient' portal credentials.
PostPatientTokenInfo Post patient' portal access token specified by practice.
PostMessagesToPatient Post Secure Messages from Provider to Patient.
GetMessagesFromPatient Pull Secure Messages from Patient to Provider.
PostPatientAppointments Post appointments to generate email and SMS reminders.
GetPatientRegistration Retrieve a list of patient recent registrations.
GetPatientRegistrationChart Retrieve CCD documents from patient recent registrations.

Portal Management Functions

GetPortalProviders Get a list of portal providers.
CreatePortalProvider Create new Portal Provider.
UpdatePortalProvider Update Portal Provider.
DeletePortalProvider Delete Portal Provider.
 
GetPortalLocations Get a list of portal locations.
CreatePortalLocation Create portal location.
UpdatePortalLocation Update portal location.
DeletePortalLocation Delete portal location.
 
GetPortalVisitTypes Get a list of portal visit types.
CreatePortalVisitType Create a new portal visit type.
UpdatePortalVisitType Update portal visit type.
 
GetPortalProviderAvailability Get a list of locations and visit types associated with providers.
EnablePortalProviderLocation Create or Update Provider Location.
DisablePortalProviderLocation Remove Provider Location.
EnablePortalProviderVisitType Create or Update Provider Visit Type.
DisablePortalProviderVisitType Remove Provider Visit Type.