If you have ever wished that your different systems could talk to each other, sharing patient details, clinical information, or appointments automatically, you are not alone. That is exactly what MediRecords Connect was designed to do.
In simple terms, MediRecords Connect uses something called an API (Application Programming Interface). APIs allow two different software systems to communicate and exchange information securely and efficiently, acting as a digital bridge between them.
For many healthcare organisations, APIs might sound technical or unfamiliar, but they are actually designed to make your work easier. With MediRecords Connect, you can:
Automatically share data between MediRecords and other applications you use.
Eliminate manual double-entry and reduce errors.
Save valuable time by allowing systems to exchange information in real time.
This article provides a straightforward explanation of what APIs are, how they work within MediRecords Connect, and the practical ways they can benefit your medical practice, without requiring any technical background.
Contents:
Why Connect Matters for Your Practice
In a busy medical practice, every minute counts. Staff time is valuable, and even small inefficiencies can add up over the course of a day. When systems are disconnected, team members often spend time entering the same information in multiple places, double-checking details, or waiting for updates to appear.
MediRecords Connect helps remove these barriers by allowing your systems to share information automatically and accurately. APIs and webhooks make this possible behind the scenes, so your team can focus on patient care rather than data management.
If you're unfamiliar with APIs and Webhooks, you can keep reading below for more information. If you are familiar with APIs and Webhooks, you may prefer to move onto the next article in the series instead: MediRecords Connect: Getting Started with Connect & FHIR APIs.
Intended Audience
This article has been created to help assist customers who are less familiar with APIs and Integrations with understanding how APIs and Webhooks can benefit their practice. Please keep reading if you are interested in learning the basics of APIs.
If you are familiar with APIs and Webhooks, you may prefer to move onto the next article in the series instead which provides more information on the capabilities and options available: MediRecords Connect: Getting Started with Connect & FHIR APIs.
What is an API?
An API, or Application Programming Interface, is a simple way for different software systems to talk to each other. You can think of it like a secure translator that helps two systems understand one another and share information safely.
For example, when you use your banking app to check your account balance, that app is using an API to talk to the bank’s servers and get the latest information. In the same way, MediRecords Connect uses APIs to allow your MediRecords system to share data with other applications your practice uses.
What is a Webhook?
A webhook is a type of automatic notification that tells one system when something has changed in another system. You can think of it like a text message between systems. When something important happens in MediRecords, such as an update to a patient record or a new appointment being created, a webhook can instantly let another connected system know.
For example:
When a new prescription is created in MediRecords, a webhook can alert your patient portal immediately so the patient may see their prescription record within your portal.
When a patient booking is created, a webhook can notify another tool that manages appointment reminders, recalls, etc.
Without webhooks, systems would need to keep checking each other regularly to see if anything has changed. That process can be slow and inefficient. A webhook saves time by automatically pushing the update to the right place as soon as it happens.
In short, APIs let systems communicate, while webhooks help them stay in sync in real time. Together, they make MediRecords Connect a powerful tool for keeping your practice’s digital systems connected, accurate, and efficient.
What Kind of Webhooks are Available?
The available Webhooks depend on whether you are using the Connect API or FHIR API, or both.
If you would like to browse the available Webhooks, follow the links below:
The below are a list of the types of records that can be transmitted via API. The ability to create, update and delete vary per API, depending on the feature. Have a look through the lists provided in the links above for more information.
Connect API:
| Patient Record | Patient Address | Patient Settings | Appointments | Group Appointments |
FHIR API:
| Patient Record | Observations / Vitals | Document Reference |
| Encounters | Pathology or Radiology Request | Episode of Care |
| Allergies / Intolerances | Pathology or Radiology Result | Admissions Encounter |
| Conditions | Correspondence In / Document In | Admissions Progress Notes |
| Prescriptions / Medication Requests | Correspondence Out / Document Out | Consent Records |
| Immunisations |
Choosing between Connect & FHIR
Connect and FHIR are two variations of APIs offered by MediRecords that fulfill different business needs, but can be easily combined for a full integration of both demographic and clinical information.
Connect has designed for sharing patient, appointment and correspondence data between MediRecords and other applications using the main operations of creating, reading, updating and deleting information.
FHIR has been designed for sharing clinical records such as Results, Requests, Medical Conditions, & Allergies.
In short, if you intend to use APIs for demographic purposes, such as creating patients or updating their address details, Connect is the best option for you. If you are interested in creating clinical records via API such as consult notes, FHIR will be a better fit. If you need both clinical and demographic information, a combination of both Connect and FHIR are needed.
Purchasing Connect
If you are interested in purchasing the Connect product or would like a conversation, you can reach out to your Customer Success Manager. If you are not sure who your Customer Success Manager is, you can reach out to the team on success@medirecords.com.
Helpful Connect Resources
- MediRecords Connect: Getting Started with Connect & FHIR APIs
- Connect & FHIR APIs: Troubleshooting and FAQs
Still need help?
If this article did not fully answer your question, our Support team is here to help. We can assist with troubleshooting, guidance, or clarifying how MediRecords works.
Contact MediRecords Support
Phone: 1300 103 903
Email:
support@medirecords.com
Live chat: Available directly within the MediRecords app or via
the Knowledge Base
Want to build confidence using MediRecords?
We offer tailored software training for individuals and teams, whether you need help with specific workflows or a broader overview of the platform.
To enquire about training, contact your Customer Success Manager or email success@medirecords.com.
Comments
0 comments