Guides

Refer to the below table to get familiar with the commonly used terminologies throughout the API documentation.

TermsDescription
EHRAn Electronic Health Record (EHR) is an electronic version of a patients medical history.
PMSA Practice Management Software is software that helps a practice run day to day operations like scheduling and billing. It often includes EHR like capabilities as well.
Health Record SystemA general term for an EHR or PMS that NexHealth can connect to.
Integrated resourceAn API resource that reads/writes data to/from the integrated system.
Non-integrated resourceAn API resource that does not read/write back to the integrated system.
OperatoryOperatory is a term for the vertical columns in scheduling software and represents the physical space where a medical or dental procedure takes place. The term is often interchangeable with 'room', 'chair' or 'column'.

NB: Most scheduling softwares require all appointments to be assigned to a provider and operatory. A provider might work exclusively out of one operatory or they may share it with other providers. Office scheduling practices will vary greatly so be sure to consult with your partner office before configuring operatory settings for appointment availability.
ProviderAny staff member that can provide services.
InstitutionInstitution is a term used by NexHealth to describe the office or group of offices that you are connecting your app with via the NexHealth Synchronizer. An Institution could have one sync or many syncs depending on the health record systems used or locations corresponding to that Institution. All practice based resources are members of an institution.
SyncA sync can refer to a location or a server computer where the Synchronizer API is actively reading the health record system.
Multi-locationMulti-location practices are generally grouped under one Institution with multiple syncs corresponding to the multiple locations.
Product keyA unique token created during installation that links the Synchronizer to the intended health record system. There is one product key per sync.
Foreign idThe foreign_id is the id of the record in the third party database. For example, the foreign_id of a patient of an Eaglesoft practice is the patient's id from within the Eaglesoft database.