MediRecords Connect: Getting Started with Connect & FHIR APIs

This article explains MediRecords Connect, MediRecords' suite of REST and FHIR APIs for integrating external systems with patient, appointment, correspondence, and clinical data. It covers the difference between the Connect and FHIR APIs, available resources and webhooks, and sandbox testing.

Contents:

1. Benefits of MediRecords Connect
2. Use Cases for Connect
3. Choosing between Connect & FHIR
   • Connect API Supported Resources
   • FHIR API Supported Resources
4. Webhooks
5. API Testing & Sandbox Environments
6. Purchasing the Connect Product

Benefits of MediRecords Connect

Open APIs The greatest barrier to effective virtual healthcare is closed, siloed technology. Our APIs are open, ensuring healthcare platforms can securely connect & share data.	Save Time & Money Digitise communications for a seamless experience, automate routine work & remove data discrepancies so you can focus on patient care, not manual entry or IT maintenance.	Secure Patient Data Advanced security features protect patient data 24/7. Enjoy peace of mind knowing your patients' information is protected with the latest in data protection technology.
Leading Standards Built on the latest REST standards, our APIs send clinically coded SNOMED data that can be easily interpreted by other systems, enabling accurate patient records & powerful analytics.	Rich Integrations Specialty applications can be built on top to enhance the product. From internal integrations to external 3rd-party systems, innovating for your business has never been easier.	Pivot & Scale, Fast MediRecords products rapidly introduce new innovations, allowing you to pivot & scale your business and models of care quickly & effectively.

Use Cases for Connect

Integrated Appointment Booking Problem: Difficulty coordinating patient appointments across systems, leading to scheduling conflicts and fragmented records. API solution: Enable patient booking via MediRecords or third-party apps, managing a single appointment record between systems.	Share Letters & Patient Materials Problem: Ineffective communication of clinical information between providers causes delays and potential gaps in care. API solution: Securely share patient-related materials, such as referrals and certificates, between systems.	Manage a Single Patient Identifier Problem: No unified patient ID causes difficulty syncing and sharing accurate patient info across systems. API solution: Share a single patient identifier across systems for consistent, reliable patient records.
Integrated Patient Record Data Problem: Fragmented data across systems makes it difficult to view complete patient information. API solution: Integrate demographics, allergies, relationships, and conditions into a unified record.	Closed-Loop Medication Ordering Problem: Inefficient tracking of medication orders increases risks of errors and treatment delays. API solution: Monitor prescription and dispensing status updates through the complete order lifecycle.	Integrated Case Management & Shared Care Problem: Poor collaboration between care teams causes disjointed patient management. API solution: Integrate episode-of-care details to manage shared events and coordinated care.
Custom Field Details Problem: Limited ability to capture custom data reduces flexibility in workflows. API solution: Create and retrieve custom fields for bespoke data capture and reporting. Custom Tagging a Patient Problem: No patient grouping model limits cohort management and targeted care. API solution: Create and retrieve custom tags within MediRecords for cohort tracking and reporting.

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 been 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.

Connect API

Best for: Integrating administrative and demographic data between systems.

• Create and update Patients, Appointments, and Referrals.
• Manage Tags, Locations, and other practice-level details.
• Ideal for practice management or scheduling apps.

↓ View supported resources

FHIR API

Best for: Accessing and sharing clinical data.

• Retrieve Observations, Allergies, Conditions, Medications, and more.
• Ideal for digital health, analytics, and patient record apps.
• Supports standard FHIR structures for clinical interoperability.

↓ View supported resources

Connect API Supported Resources

The full list of Connect APIs offered in the Connect Suite can be found on the Connect API Document for Developers .

Click here to access the Connect API documentation. 

FHIR API Supported Resources

The full list of FHIR APIs offered in the Connect Suite can be found on the MediRecords FHIR website for developers .

Click here to access the FHIR documentation. 

Webhooks

MediRecords offers Webhooks for both the Connect APIs and FHIR APIs, to power instantaneous data syncing between platforms.

When do I need Webhooks?

You want your system to automatically receive updates from another system as soon as they happen, without constantly asking for them.

When don't I need Webhooks?

You only need data occasionally or you're happy to request it on demand.

In short, if you would like information to be shared across systems at all times, Webhooks are your answer.

If you would like to browse the available Webhooks, follow the links below:

Available FHIR Webhooks

Available Connect Webhooks

API Testing & Sandbox Environments

MediRecords offers API Testing and Sandbox environments to assist with setting up and testing your API integration prior to the production environment.

The sandbox environment is separate to your real MediRecords environment, and provides a safe, realistic, and cost-effective space to test, debug, and validate API integrations before releasing to your real MediRecords production environment.

If you are interested in purchasing a sandbox environment, please advise your Customer Success Manager or reach out to the team on success@medirecords.com.

Purchasing the Connect Product

If you are a new MediRecords customer, please advise your Onboarding Manager if you would like to add Connect to your onboarding package.

If you are an existing MediRecords customer, you can add Connect onto any existing subscription by contacting your Customer Success Manager. If you are unsure who your Customer Success Manager is, you can reach out to the team on success@medirecords.com.

Further Reading

• Connect & FHIR APIs: Troubleshooting & FAQs
• MediRecords Connect: A Simple Introduction to APIs & Integration