Data structures used across SageBridge API

expand all collapse
Notes:
  • 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.

General data

APIResponseAPI Response structure. Used as a wrapper for responses to all SageBridge API calls.
AppointmentData container to represent an appointment.
AddressData container to represent address information.
ContactInfoData container to represent a communication.
LocationData container to represent a practice location
PracticeData container to represent general practice information.
VisitTypeData container to represent a practice visit type.
ProviderData container to represent a practice provider.
PatientData container to represent a patient.
DictionaryData container to represent different dictionaries.
ImageData container to represent images or attachments.
InsuranceData container to represent insurance.
PolicyHolderData container to represent insurance policy holder.

R10 Registration data

R10CommonDataCommon data elemtents used for every Get and Post requests
R10RelativeInfoPatient relative data

EMR data

Mu2MetricsItemSingle item in Mu2Metrics data
PatientCredentialsRequest to post patient' credentlas in PostPatientLoginInfo and PostPatientTokenInfo functions.
PostCredentialsResponseResponse to post patient' credentlas in PostPatientLoginInfo and PostPatientTokenInfo functions.
DocumentData to represent different documents such as Charts, Clinical Summaries, Message Attachments etc.
EducationalDocumentData to represent Educational documents.
Patient Chart Data to represent Patient Chart (CDDA) documents.
Clinical Summary Data to represent Clinical Summary documents.
Secure Message Data to represent Secure Message with attachments.
Message Attachment Data to represent Secure Message attachments.

Portal Management data

PortalProvider Portal Provider data.
PortalLocation Portal Location data.
PortalVisitType Portal Visit Type data.

See Also:

API Functions, API Methods