Skip to main content

ModMed FHIR Adapter

Overview

The ModMed FHIR adapter is designed to provide a template for getting started with ModMed FHIR integrations. It leverages the MODMED Library to authenticate with the ModMed FHIR Server via OAuth2.0 and perform various interactions against the ModMed FHIR Server.

This component can be customized and adapted according to your workflow needs.

Modernizing Medicine (ModMed) warns international customers that you may require a US-based VPN in-order to authenticate and interact with ModMed services including the sandboxes.

Requirements

  • The base URL of the FHIR Server including the firm prefix (also referred to as “firm_url_prefix”).

    • ModMed provides sandboxes for potential customers, but registration is required.
  • ModMed username and password combo.

  • The API key (also referred to as “x-api-key”).

Running the Component

STEP 1: Import the ModMed FHIR Adapter component

Using +COMPONENT, import the ModMed FHIR Adapter component.

STEP 2: Set up the component configurations

Bolded fields are required, otherwise default values defined in config.json are used:

Field

Description

Default Value

Username

ModMed username used for authentication.

 

Password

The password associated with the ModMed user.

 

Base URL

The base URL for your FHIR ModMed endpoint including the firm_url_prefix (e.g., https://stage.ema-api.com/ema-dev/firm/<firm_url_prefix>/<ema/mmpm>)

 

API Key

Unique identifier used to authenticate with the ModMed endpoint. Also called "x-api-key"

These configurations should be provided by ModMed during sandbox or production setup.

STEP 3: Start the component and view the results in the component card