Properties

Search Parameters

Inherited Properties

Prospective warnings of potential issues when providing care to the patient.

Flag

x-api-key

Metriport

Follow this guide to start exchanging comprehensive patient medical data.

Quickstart

Learn more about API key security best practices.

API Keys

Receive data as soon as it becomes available.

Implementing Webhooks

Build your application using example clinical data

Sandbox Mode

Get a brief summary of the most relevant medical history you need to know about your patient

AI Summaries

Consolidate Medical Records Into a Single Document

Medical Record Summary

Receive status updates as soon as data becomes available.

Receiving Webhooks

Monitor your patient's journey through health systems in real-time

Realtime Patient Notifications

Transform your data for analytics and pipe it into warehouses like Snowflake, Redshift, BigQuery, and more

Data Analytics and Warehousing

Filtering data

Pagination

How to contribute data back to Health Information Exchange (HIE) networks

Contributing Data

Learn more about how Metriport leverages FHIR for interoperability.

FHIR Overview

Comprehensive guide to Metriport's API structure, including schemas, endpoints, and integration tools

OpenAPI

Explore Metriport's Medical API using Postman

Postman

How to access the Medical API using our SDK

Software Development Kit

General information about Metriport's Medical API

General Information

Learn more about our standardized error responses.

Error Responses

SAML/Enterprise SSO

User Roles & Permissions

ETag support to prevent mid-air collisions

Avoid mid-air collisions

Information about Metriport's limits related to request size and request frequency.

Limits and throttling

Overview

Athena

Canvas

Elation

Follow this guide to get started converting C-CDA documents to FHIR.

FHIR Converter API

Medical API

Dashboard

EHR Apps

Converter API

Home

Get Started

Contact Us

Github

Creates a Facility in Metriport where your patients receive care.

Create Facility

Get Facility

Updates a Facility in Metriport where your patients receive care.

Update Facility

List Facilities

Deletes a Facility. Returns 400 if there are patients associated with the Facility.

Delete Facility

Creates a Patient in Metriport for the specified Facility where the patient is receiving care.

Create Patient

Get Patient

Get a Patient based on External Identifier.

Get Patient by External ID

Update Patient

Searches for a Patient previously created in Metriport, based on demographic data. Returns a 404 if the patient is not found.

Match Patient

List Patients

Delete Patient

Update a patient's HIE (Health Information Exchange) opt-out status

HIE Opt-Out

Creates a batch of patients in Metriport, and initiates Document Queries for all of them.

Bulk Patient Create

Triggers a document query for the specified patient across HIEs.

Start Document Query

Returns the document query status for the specified patient.

Get Document Query Status

Lists all Documents that can be retrieved for a Patient.

List Documents

Gets a downloadable URL for downloading the specified document.

Get Document URL

Creates a DocumentReference and returns its ID and a URL to use for a medical document upload to our servers.

Upload Document

Triggers a process to generate a list of download URLs for all of the patient's documents.

Start Bulk Get Document URL

Trigger a consolidated data query for the given patient

Start Consolidated Data Query

Get the status of a single query for patient's consolidated data.

Get Single Consolidated Data Query Status

Get the status of querying for patient's consolidated data.

Get Consolidated Data Query Status

Get a count of a Patient's data per resource.

Count Patient Data

Create Patient's Consolidated Data with a FHIR Bundle.

Create Patient's Consolidated Data

Check if a Medical Record Summary for a patient already exists, and when it was generated.

Get Medical Record Summary Status

Get the Medical Record Summary in PDF or HTML formats.

Get Medical Record Summary

Lists all network entries available through Metriport

List Network Entries

Get Settings

Update Settings

Gets the status of communication with your app's webhook.

Get Webhook status

Retry Webhook requests

Base StructureDefinition for Address Type: An address expressed using postal conventions (as opposed to GPS or other location definition formats).  This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery.  There are a variety of postal address formats defined around the world.

Address

Base StructureDefinition for Age Type: A duration of time during which an organism (or a process) has existed.

Base StructureDefinition for Annotation Type: A  text note which also  contains information about who made the statement and when.

Annotation

Base StructureDefinition for Attachment Type: For referring to data content defined in other formats.

Attachment

Base StructureDefinition for CodeableConcept Type: A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

CodeableConcept

Base StructureDefinition for Coding Type: A reference to a code defined by a terminology system.

Coding

Base StructureDefinition for ContactDetail Type: Specifies contact information for a person or organization.

ContactDetail

Base StructureDefinition for ContactPoint Type: Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.

ContactPoint

Base StructureDefinition for Contributor Type: A contributor to the content of a knowledge asset, including authors, editors, reviewers, and endorsers.

Contributor

Base StructureDefinition for Count Type: A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.

Count

Base StructureDefinition for DataRequirement Type: Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.

DataRequirement

Base StructureDefinition for Distance Type: A length - a value with a unit that is a physical distance.

Distance

Base StructureDefinition for Dosage Type: Indicates how the medication is/was taken or should be taken by the patient.

Dosage

Base StructureDefinition for Duration Type: A length of time.

Duration

Base StructureDefinition for ElementDefinition Type: Captures constraints on each element within the resource, profile, or extension.

ElementDefinition

Base StructureDefinition for Expression Type: A expression that is evaluated in a specified context and returns a value. The context of use of the expression must specify the context in which the expression is evaluated, and how the result of the expression is used.

Expression

Base StructureDefinition for HumanName Type: A human's name with the ability to identify parts and usage.

HumanName

Base StructureDefinition for Identifier Type: An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.

Identifier

Base StructureDefinition for MarketingStatus Type: The marketing status describes the date when a medicinal product is actually put on the market or the date as of which it is no longer available.

MarketingStatus

Base StructureDefinition for Meta Type: The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Money

An amount of money. With regard to precision, see [Decimal Precision](https://www.hl7.org/fhir/datatypes.html#precision)

MoneyQuantity

Base StructureDefinition for Narrative Type: A human-readable summary of the resource conveying the essential clinical and business information for the resource.

Narrative

Base StructureDefinition for ParameterDefinition Type: The parameters to the module. This collection specifies both the input and output parameters. Input parameters are provided by the caller as part of the $evaluate operation. Output parameters are included in the GuidanceResponse.

ParameterDefinition

Base StructureDefinition for Period Type: A time period defined by a start and end date and optionally time.

Period

Base StructureDefinition for Population Type: A populatioof people with some set of grouping criteria.

Population

Base StructureDefinition for ProdCharacteristic Type: The marketing status describes the date when a medicinal product is actually put on the market or the date as of which it is no longer available.

ProdCharacteristic

Base StructureDefinition for ProductShelfLife Type: The shelf-life and storage information for a medicinal product item or container can be described using this class.

ProductShelfLife

Base StructureDefinition for Quantity Type: A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.

Quantity

Base StructureDefinition for Range Type: A set of ordered Quantities defined by a low and high limit.

Range

Base StructureDefinition for Ratio Type: A relationship of two Quantity values - expressed as a numerator and a denominator.

Ratio

Base StructureDefinition for Reference Type: A reference from one resource to another.

Reference

Base StructureDefinition for RelatedArtifact Type: Related artifacts such as additional documentation, justification, or bibliographic references.

RelatedArtifact

Base StructureDefinition for SampledData Type: A series of measurements taken by a device, with upper and lower limits. There may be more than one dimension in the data.

SampledData

Base StructureDefinition for Signature Type: A signature along with supporting context. The signature may be a digital signature that is cryptographic in nature, or some other signature acceptable to the domain. This other signature may be as simple as a graphical image representing a hand-written signature, or a signature ceremony Different signature approaches have different utilities.

Signature

SimpleQuantity

Base StructureDefinition for SubstanceAmount Type: Chemical substances are a single substance type whose primary defining element is the molecular structure. Chemical substances shall be defined on the basis of their complete covalent molecular structure; the presence of a salt (counter-ion) and/or solvates (water, alcohols) is also captured. Purity, grade, physical form or particle size are not taken into account in the definition of a chemical substance or in the assignment of a Substance ID.

SubstanceAmount

Base StructureDefinition for Timing Type: Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.

Timing

Base StructureDefinition for TriggerDefinition Type: A description of a triggering event. Triggering events can be named events, data events, or periodic, as determined by the type element.

TriggerDefinition

Base StructureDefinition for UsageContext Type: Specifies clinical/business/etc. metadata that can be used to retrieve, index and/or categorize an artifact. This metadata can either be specific to the applicable population (e.g., age category, DRG) or the specific context of care (e.g., venue, care setting, provider of care).

UsageContext

Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.

AllergyIntolerance

A resource that represents the data of a single raw artifact as digital content accessible in its native format.  A Binary resource can contain any content, whether text, image, pdf, zip archive, etc.

Binary

A container for a collection of resources.

Bundle

A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.

Name	Required	Type	Description
identifier	No	Identifier[]	Business identifier
status	Yes	code	active / inactive / entered-in-error
category	No	CodeableConcept[]	Clinical, administrative, etc.
code	Yes	CodeableConcept	Coded or textual message to display to user
subject	Yes	Reference<Patient / Location / Group / Organization / Practitioner / PlanDefinition / Medication / Procedure>	Who/What is flag about?
period	No	Period	Time period when flag is active
encounter	No	Reference<Encounter>	Alert relevant during encounter
author	No	Reference<Device / Organization / Patient / Practitioner / PractitionerRole>	Flag creator

Name	Type	Description	Expression
date	date	Time period when flag is active	Flag.period
patient	reference	The identity of a subject to list flags for	Flag.subject
encounter	reference	Alert relevant during encounter	Flag.encounter
author	reference	Flag creator	Flag.author
identifier	token	Business identifier	Flag.identifier
subject	reference	The identity of a subject to list flags for	Flag.subject

Getting Started

API Reference

Handling Data

FHIR

API Tools

More Info

Flag

Properties

Search Parameters

Inherited Properties

Name	Required	Type	Description
id	No	string	Logical id of this artifact
meta	No	Meta	Metadata about the resource
implicitRules	No	uri	A set of rules under which this content was created
language	No	code	Language of the resource content
text	No	Narrative	Text summary of the resource, for human interpretation
contained	No	Resource[]	Contained, inline Resources
extension	No	Extension[]	Additional content defined by implementations
modifierExtension	No	Extension[]	Extensions that cannot be ignored

Getting Started

API Reference

Handling Data

FHIR

API Tools

More Info

​Properties

​Search Parameters

​Inherited Properties

Properties

Search Parameters

Inherited Properties