ModMed

Connecting your ModMed system to Knack Flows allows you to securely send data from ModMed to your Knack apps.

What You'll Learn

This article explains how to connect ModMed to Knack Flows using API credentials from the ModMed practice solutions team, and covers every trigger and action available for both the ModMed Certified FHIR API and the ModMed Proprietary API. ModMed is a specialty EHR and practice management platform, so this connector is built for practices and health tech teams that need to automate patient records, encounters, and documents.

About ModMed

ModMed (Modernizing Medicine) is a cloud-based EHR and practice management platform built for specialty medical practices. It offers two separate APIs for outside systems to connect to its EMA and gGastro EHRs: a Certified FHIR API built on the HL7 FHIR R4 standard for standards-compliant, read-focused access, and a Proprietary API that supports creating and updating records directly in ModMed. Connecting ModMed to Knack Flows lets you automate patient, encounter, and document workflows using whichever of these two APIs fits your use case.

Please Note

The Knack integration can only be added by the ModMed team. Follow the steps below to request access and get your API credentials.

Prerequisites for Connecting ModMed to Flows

Before you can connect ModMed to Knack, you need a unique set of API credentials. Only ModMed's practice solutions team can provide these.

  1. Submit a request. Before you can set up the Flow connection, reach out to [email protected] to request an integration enablement.
  2. Get your credentials. Once the ModMed team confirms your request, they'll provide a set of API credentials (username and password) to finalize the connection.

Setting Up the ModMed Connection in Knack Flows

  1. Click into the Trigger or Action step within your Flow.
  2. Search for ModMed and select either Certified FHIR API or Proprietary API, whichever matches your use case.

Use the Certified FHIR API if you need the API to be FHIR certified for regulatory or standards compliance. Because of this, most of its actions are read-only.

Use the Proprietary API if you don't need FHIR compliance, or if you need actions that create or update data in your ModMed system.

  1. After selecting the ModMed API type, set up the connection by opening the dropdown under Connect your ModMed EMA.
  1. Add the API credentials provided by the ModMed practice solutions team, as described in the Prerequisites section above.
📘

Not sure which API to choose?

The Certified FHIR API is read-focused and built for standards compliance. The Proprietary API supports creating and updating records. If your Flow needs to write data into ModMed, use the Proprietary API.

ModMed Certified FHIR API Triggers

The ModMed Certified FHIR API offers the following triggers in Flows. You can find full technical detail in ModMed's API Documentation.

TriggerSummary
Charge CreatedFires when a new charge is created in ModMed. Use this to start a Flow the moment billing activity occurs, for example to sync charge data into a Knack table.
Document AddedFires when a new document, such as a visit note or external file, is added to a patient's chart in ModMed. Use this to trigger a Flow whenever new documentation lands in a patient's record.
Encounter / Visit CompletedFires when a patient encounter or visit is marked complete in ModMed. Use this to kick off downstream workflows, like billing or follow-up, right after a visit wraps up.
Patient UpdatedFires when an existing patient's record is updated in ModMed. Use this to keep a patient record in Knack in sync with ModMed instead of checking for changes manually.
Task UpdatedFires when a task in ModMed is updated. Use this to notify staff or update a tracking record in Knack whenever a task's status changes.

ModMed Certified FHIR API Actions

The ModMed Certified FHIR API offers the following actions in Flows. Since this API is built for standards compliance, most actions are read-only. You can find full technical detail in ModMed's API Documentation.

ActionSummary
Create PatientCreates a new patient record in ModMed. Use this when a patient is registered in your Knack app and needs a corresponding record created in ModMed.
Find PatientSearches for a patient using identifying details like name or date of birth. Use this when you don't have a patient ID yet and need to locate the matching patient record first.
Get Encounter Details by IDRetrieves the full details for one specific encounter using its encounter ID. Use this when you already know which visit you need information on.
Retrieve Patient by IDRetrieves the full record for a specific patient using their patient ID. Use this when a Flow needs to pull a patient's information into Knack and you already have their ID.
Search DocumentsSearches for documents in a patient's chart matching your criteria. Use this when you need a patient's visit notes or other chart documents but don't have a specific document ID.
Search Encounter DetailsSearches for encounters matching your criteria, such as patient or date range. Use this when you don't have a specific encounter ID and need to find matching visits first.
Update PatientUpdates an existing patient record in ModMed. Use this when patient details change in your Knack app and need to be reflected back in ModMed.
📘

Write actions on the Certified FHIR API

ModMed's Certified FHIR API is built primarily for read, search, and bulk operations. If Create Patient or Update Patient isn't available on your Certified FHIR API connection, use the Proprietary API instead, which is built to support write operations.

ModMed Proprietary API Triggers

The ModMed Proprietary API offers the following triggers in Flows. You can find full technical detail in ModMed's API Documentation.

TriggerSummary
Charge CreatedFires when a new charge is created in ModMed. Use this to start a Flow the moment billing activity occurs, for example to sync charge data into a Knack table.
Document AddedFires when a new document, such as a visit note or external file, is added to a patient's chart in ModMed. Use this to trigger a Flow whenever new documentation lands in a patient's record.
Encounter / Visit CompletedFires when a patient encounter or visit is marked complete in ModMed. Use this to kick off downstream workflows, like billing or follow-up, right after a visit wraps up.
Patient UpdatedFires when an existing patient's record is updated in ModMed. Use this to keep a patient record in Knack in sync with ModMed instead of checking for changes manually.
Task UpdatedFires when a task in ModMed is updated. Use this to notify staff or update a tracking record in Knack whenever a task's status changes.

ModMed Proprietary API Actions

The ModMed Proprietary API offers the following actions in Flows, including actions that create and update records directly in ModMed. You can find full technical detail in ModMed's API Documentation.

ActionSummary
Create PatientCreates a new patient record in ModMed. Use this when a patient is registered in your Knack app and needs a corresponding record created in ModMed.
Find PatientSearches for a patient using identifying details like name or date of birth. Use this when you don't have a patient ID yet and need to locate the matching patient record first.
Get Encounter Details by IDRetrieves the full details for one specific encounter using its encounter ID. Use this when you already know which visit you need information on.
Retrieve Patient by IDRetrieves the full record for a specific patient using their patient ID. Use this when a Flow needs to pull a patient's information into Knack and you already have their ID.
Search DocumentsSearches for documents in a patient's chart matching your criteria. Use this when you need a patient's visit notes or other chart documents but don't have a specific document ID.
Search Encounter DetailsSearches for encounters matching your criteria, such as patient or date range. Use this when you don't have a specific encounter ID and need to find matching visits first.
Update PatientUpdates an existing patient record in ModMed. Use this when patient details change in your Knack app and need to be reflected back in ModMed.

What You Can Do with ModMed and Flows

A few examples of what you can automate by combining ModMed's triggers and actions:

  • Patient sync. Use the Patient Updated trigger to keep a matching patient record in Knack current whenever details change in ModMed.
  • Post-visit workflows. Use the Encounter / Visit Completed trigger to automatically kick off billing or follow-up tasks in Knack right after a visit wraps up.
  • Patient intake automation. Use the Create Patient action on the Proprietary API to register a new patient in ModMed as soon as they're added to your Knack app.
  • Document tracking. Use the Document Added trigger alongside Search Documents to keep a running log of new chart documents inside a Knack table.

Next Steps

👋

Want to see an action, trigger, or connection added?

We're constantly looking to improve Flows. If you have feedback on the functionality, actions, triggers, or connections, you're welcome to submit feedback to our product team.


Did this page help you?