Follow this guide to start exchanging comprehensive patient medical data.
Getting started with our Medical API is pretty easy, you’ll just need take the following steps:
Let’s get into it! 🤘
This will take you to the Metriport developer dashboard where you can create your Metriport account, if you don't have one already.
After we approve your access request, take the following steps to get your API key:
Sandbox
switch in the Dashboard navbar to enter Sandbox
mode (learn more about this
here).Developers
.Generate API Key
button.The API key will only be displayed once. Please make sure to save it to a secure location before leaving the page.
This API Key will allow you to start making requests to the entire Metriport API on your behalf. Treat this like a password, and keep it somewhere safe! You can read the API Keys page to learn more about API key security best practices.
If you believe your key has been compromised, you can always revoke it and then generate a new one on the Developers page by clicking the trash button beside the key.
Note that there are two ways to receive data from Metriport:
We recommend using Webhooks to ensure you’re able to get patient data as quickly and easily as possible.
For the remainder of the steps, you are able to either use the Dashboard UI, or the API - whatever you prefer!
Pro-tip: you can use our handy SDK on your server if you’re using Node:
Now you can now create Facilities
and Patients
. First,
you’ll need to create your Facilities
.
In Metriport, a Facility
is a location that a Patient
receives some form of treatment. You can
create multiple Facilities
to represent each of your care locations. Note that for telehealth
practices, these can be virtual locations.
1234567893
when creating Facilities.You can create a Facility
by either:
See the Create Facility endpoint in our API reference.
Facilities
page, click Create Facility
.Once you’ve created all of your Facilities
, you can create the Patients
that you treat in each facility.
In Sandbox mode, you can create Patients with pre-defined patient demographics to simulate a match and pull example clinical data - see our Sandbox guide for more details.
You can create Patients
by either:
See the Create Patient endpoint in our API reference.
Patients
page, click Create Patient
.When you create a Patient, Metriport automatically links the Patient to all HIE data sources related to the Patient based on the demographic and/or identification information provided when creating the Patient.
Now, you’re able to query for your Patients’ medical Documents
(outside medical records).
As we query for Documents, we automatically convert outside records (like XML C-CDA docs) into FHIR
resources 🔥,
deduplicate the data, standardize it, enrich it with medical code lookups and crosswalks, and store the resulting data
on our servers for you to access at any time through a single endpoint.
To query for a Patient’s available Documents
, you can either:
Start an asynchronous Document Query to initiate a query for the Patient’s medical documents from all external sources.
When this process completes, we’ll send you a medical.document-conversion
webhook - see the respective section on the webhooks page
for more details.
If you don’t have webhooks integrated, you can use the Get Document Query Status endpoint to check the status of the query.
Patients
page, click on the desired Patient row to be taken to their interactive medical record chart summary page.Refresh Patient Data
anytime to get the latest medical documents from external sources.The aforementioned deduplicated, standardized, and enriched FHIR
data will allow you to get the source of truth for a Patient’s medical data to better understand and treat your Patients.
We refer to this as Consolidated Data
in Metriport.
Read our FHIR guide to learn more about how Metriport leverages FHIR.
To learn more on how to obtain a Patient’s Consolidated data via API, please see the Start Consolidated Data Query endpoint - note that this same data is also available via the Dashboard.
To render this data in a single summary document, refer to the Medical Record Summary guide.
If you need to access the raw unprocessed Documents, see the Start Bulk Get Document URL endpoint.
To uphold data quality with Metriport’s data sources, and improve patient health outcomes, it’s required that your organization reciprocates medical data exchange by making net-new patient clinical data available to the networks. Some examples of this include:
Metriport makes it easy to contribute this data - you can:
For more details on how to contribute data back, see the Data Contribution guide.
Access to our Medical API will require you to make requests on behalf of a covered entity with an NPI number for a valid Treatment purpose of use.
To start using the Medical API for production workloads, with real patient data, you can take the following steps to request production API access:
Products & Billing
.Get Started
on the Medical API product.Book an Intro Call
and select a time and a date to talk to us.After the call, we will promptly setup your account.
That’s it! 🤘
You’re now well equiped to use the Metriport API to access, manage, and exchange 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 Metriport.
Follow this guide to start exchanging comprehensive patient medical data.
Getting started with our Medical API is pretty easy, you’ll just need take the following steps:
Let’s get into it! 🤘
This will take you to the Metriport developer dashboard where you can create your Metriport account, if you don't have one already.
After we approve your access request, take the following steps to get your API key:
Sandbox
switch in the Dashboard navbar to enter Sandbox
mode (learn more about this
here).Developers
.Generate API Key
button.The API key will only be displayed once. Please make sure to save it to a secure location before leaving the page.
This API Key will allow you to start making requests to the entire Metriport API on your behalf. Treat this like a password, and keep it somewhere safe! You can read the API Keys page to learn more about API key security best practices.
If you believe your key has been compromised, you can always revoke it and then generate a new one on the Developers page by clicking the trash button beside the key.
Note that there are two ways to receive data from Metriport:
We recommend using Webhooks to ensure you’re able to get patient data as quickly and easily as possible.
For the remainder of the steps, you are able to either use the Dashboard UI, or the API - whatever you prefer!
Pro-tip: you can use our handy SDK on your server if you’re using Node:
Now you can now create Facilities
and Patients
. First,
you’ll need to create your Facilities
.
In Metriport, a Facility
is a location that a Patient
receives some form of treatment. You can
create multiple Facilities
to represent each of your care locations. Note that for telehealth
practices, these can be virtual locations.
1234567893
when creating Facilities.You can create a Facility
by either:
See the Create Facility endpoint in our API reference.
Facilities
page, click Create Facility
.Once you’ve created all of your Facilities
, you can create the Patients
that you treat in each facility.
In Sandbox mode, you can create Patients with pre-defined patient demographics to simulate a match and pull example clinical data - see our Sandbox guide for more details.
You can create Patients
by either:
See the Create Patient endpoint in our API reference.
Patients
page, click Create Patient
.When you create a Patient, Metriport automatically links the Patient to all HIE data sources related to the Patient based on the demographic and/or identification information provided when creating the Patient.
Now, you’re able to query for your Patients’ medical Documents
(outside medical records).
As we query for Documents, we automatically convert outside records (like XML C-CDA docs) into FHIR
resources 🔥,
deduplicate the data, standardize it, enrich it with medical code lookups and crosswalks, and store the resulting data
on our servers for you to access at any time through a single endpoint.
To query for a Patient’s available Documents
, you can either:
Start an asynchronous Document Query to initiate a query for the Patient’s medical documents from all external sources.
When this process completes, we’ll send you a medical.document-conversion
webhook - see the respective section on the webhooks page
for more details.
If you don’t have webhooks integrated, you can use the Get Document Query Status endpoint to check the status of the query.
Patients
page, click on the desired Patient row to be taken to their interactive medical record chart summary page.Refresh Patient Data
anytime to get the latest medical documents from external sources.The aforementioned deduplicated, standardized, and enriched FHIR
data will allow you to get the source of truth for a Patient’s medical data to better understand and treat your Patients.
We refer to this as Consolidated Data
in Metriport.
Read our FHIR guide to learn more about how Metriport leverages FHIR.
To learn more on how to obtain a Patient’s Consolidated data via API, please see the Start Consolidated Data Query endpoint - note that this same data is also available via the Dashboard.
To render this data in a single summary document, refer to the Medical Record Summary guide.
If you need to access the raw unprocessed Documents, see the Start Bulk Get Document URL endpoint.
To uphold data quality with Metriport’s data sources, and improve patient health outcomes, it’s required that your organization reciprocates medical data exchange by making net-new patient clinical data available to the networks. Some examples of this include:
Metriport makes it easy to contribute this data - you can:
For more details on how to contribute data back, see the Data Contribution guide.
Access to our Medical API will require you to make requests on behalf of a covered entity with an NPI number for a valid Treatment purpose of use.
To start using the Medical API for production workloads, with real patient data, you can take the following steps to request production API access:
Products & Billing
.Get Started
on the Medical API product.Book an Intro Call
and select a time and a date to talk to us.After the call, we will promptly setup your account.
That’s it! 🤘
You’re now well equiped to use the Metriport API to access, manage, and exchange 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 Metriport.