Medical API

​

Overview

Getting started with our Medical API is pretty easy, you’ll just need take the following steps:

1. Create a developer account.
2. Request API access.
3. Generate an API key.
4. Integrate your app with Metriport.
5. Register your Organization.
6. Create Facilities and Patients.
7. Get Patient Medical Documents.
8. Get Patient FHIR Resources. 🎉🎉🎉

Feel free to check this demo video out before getting started to get a high level overview of the platform:

Let’s get into it! 🤘

​

1. Create a developer account

​

2. Request API access

Once you’ve created an account and confirmed your email, you’ll be taken to the dashboard home page. From here, take the following steps to request API access:

• In the left hand menu, click Products & Billing.
• Click Get Started on the Medical API product.
• Fill out the form, and click Request Access to submit the request.

Once the form is submitted, we will review your request promptly and contact you if we need any further information.

​

3. Generate an API key

After we approve your access request, take the following steps to get your API key:

Once you’ve created an account and confirmed your email, you’ll be taken to the dashboard home page. From here, take the following steps to get your API key:

• In the left hand menu, click “Products & Billing”.
• Click Get Started on the Medical API product, and add your payment info.
• In the left hand menu, click Developers.
• On the Developers page, you’ll be able to click the “Generate Secret Key” button.

​

4. Integrate your app with Metriport

Note that there are two ways to receive data from Metriport:

• Webhook: Metriport sends patient data to your app when it becomes available:
  • your application exposes a webhook (endpoint), which Metriport calls when there’s Patient data available after initiating a query;
  • to learn more about how the Webhook flow works, see our Webhooks guide.
• API: Your app requests data from Metriport:
  • your application polls Metriport for Patients’ medical data after initiating a query to fetch a Patient’s documents;

​

5. Register your Organization

import { MetriportMedicalApi } from "@metriport/api-sdk";

const metriportClient = new MetriportMedicalApi("YOUR_API_KEY");

First, you’ll need to register an Organization in Metriport.

You only need to register your Organization once, and you can do so by either:

​

Using the API

See the Create Organization endpoint in our API reference.

​

Using the Dashboard

• In the left hand menu, click Medical API.
• In the Organization section, click Create.
• Fill in the details and submit the form to register your Organization.

​

6. Create Facilities and Patients

Once your Organization is registered, you can now create Facilities and Patients. First, you’ll need to create your Facilities.

You can create a Facility by either:

​

Creating Facilities using the API

See the Create Facility endpoint in our API reference.

​

Creating Facilities using the Dashboard

• On the Medical API page, in the Facilities section, click Add.
• Fill in the details and submit the form to add your Facility.

Once you’ve created all of your Facilities, you can create the Patients that you treat each facility. You can create Patients by either:

​

Creating Patients using the API

See the Create Patient endpoint in our API reference.

​

Creating Patients using the Dashboard

• On the Medical API page, in the Facilities section, click Patients for the Facility under which to add Patients.
• In the Patients section, click Add.
• Fill in the details and submit the form to add your Patient.

​

7. Get Patient Medical Documents

Now, you’re able to access your Patients’ medical Documents. This involves 2 main steps:

1. Querying for available Documents to get a list of metadata describing the available records.
2. Downloading the Document data from the URL returned in the metadata.

To query for a Patient’s available Documents, you can either:

​

Query for Documents using the API

1. Start an asynchronous Document Query across HIEs;
2. Then, either process the inbound Webhook message which will be sent if you have Webhooks configured, or poll the API to List Documents to get the available document references returned from HIEs.

​

Query for Documents using the Dashboard

• On the Medical API page, in the Facilities section, click Patients for the Facility where the Patient is located.
• In the desired Patient’s row, click Documents.
• You’ll see all available Documents in the side panel.
• To update the list of documents from HIEs, click on Query Documents.

Once you’ve identified the Document you want to retrieve, you can download them by either:

​

Downloading a Document using the API

See the Get Document endpoint in our API reference.

​

Downloading a Document using the Dashboard

• In the side panel that comes up after clicking Documents, simply click Download on the desired Document.

​

8. Get Patient FHIR Resources 🎉🎉🎉

As we query for Documents we will automatically convert XML C-CDA docs into FHIR resources.

After the conversion from CDA to FHIR, we will store the resulting FHIR resources and make them available to be queried. This will allow you to get the necessary data you might need to better understand and treat your Patients.

To learn more on how to obtain a Patient’s resources, please see the Start Consolidated Data Query endpoint.

We also provide the ability to add any FHIR resources to a Patient with our Create Patient’s Consolidated Data endpoint.

​

Wrapping up

That’s it! You’re now well equiped to use the Metriport API to access and manage your Patients’ medical data.

As next steps, we’d recommend scoping out our Medical API Reference in further detail to see the other things you can do with the API.