Properties

x-api-key

Metriport

Medical API

Dashboard

EHR Integrations

Converter API

Home

Get Started

Contact Us

Github

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

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

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

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

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 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

Get Settings

Update Settings

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

Get Webhook status

Retry Webhook requests

Consolidate Medical Records Into a Single Document

Medical Record Summary

Receive status updates as soon as data becomes available.

Receiving Webhooks

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

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.

CapabilityStatement

An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency that was notified about a reportable condition.

Communication

A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.).

Composition

A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.

Condition

A record of a healthcare consumer’s  choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.

Consent

Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.

Coverage

A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device.

Device

The findings and interpretation of diagnostic  tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports.

DiagnosticReport

A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), clinical notes, scanned paper, and non-patient specific documents like policy text.

DocumentReference

An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.

Encounter

Significant health conditions for a person related to the patient relevant in the context of care for the patient.

FamilyMemberHistory

Describes the intended objective(s) for a patient, group or organization care, for example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.

Goal

Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.

Immunization

Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.

Location

This resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use.

Medication

Describes the event of a patient consuming or otherwise being administered a medication.  This may be as simple as swallowing a tablet or it may be a long running infusion.  Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner.

MedicationAdministration

Indicates that a medication product is to be or has been dispensed for a named person/patient.  This includes a description of the medication product (supply) provided and the instructions for administering the medication.  The medication dispense is the result of a pharmacy system responding to a medication order.

MedicationDispense

An order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called MedicationRequest rather than MedicationPrescription or MedicationOrder to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns.

MedicationRequest

A record of a medication that is being consumed by a patient.   A MedicationStatement may indicate that the patient may be taking the medication now or has taken the medication in the past or will be taking the medication in the future.  The source of this information can be the patient, significant other (such as a family member or spouse), or a clinician.  A common scenario where this information is captured is during the history taking process during a patient visit or stay.   The medication information may come from sources such as the patient's memory, from a prescription bottle,  or from a list of medications the patient, clinician or other party maintains.
The primary difference between a medication statement and a medication administration is that the medication administration has complete administration information and is based on actual administration information from the person who administered the medication.  A medication statement is often, if not always, less specific.  There is no required date/time when the medication was administered, in fact we only know that a source has reported the patient is taking this medication, where details such as time, quantity, or rate or even medication product may be incomplete or missing or less precise.  As stated earlier, the medication statement information may come from the patient's memory, from a prescription bottle or from a list of medications the patient, clinician or other party maintains.  Medication administration is more formal and is not missing detailed information.

MedicationStatement

Measurements and simple assertions made about a patient, device or other subject.

Observation

A collection of error, warning, or information messages that result from a system action.

OperationOutcome

A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action.  Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.

Organization

Demographics and other administrative information about an individual or animal receiving care or other health-related services.

Name	Required	Type	Description
id	No	string	Unique id for inter-element referencing
extension	No	Extension[]	Additional content defined by implementations
use	No	code	home / work / temp / old / billing - purpose of this address
type	No	code	postal / physical / both
text	No	string	Text representation of the address
line	No	string[]	Street name, number, direction & P.O. Box etc.
city	No	string	Name of city, town etc.
district	No	string	District name (aka county)
state	No	string	Sub-unit of country (abbreviations ok)
postalCode	No	string	Postal code for area
country	No	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period	No	Period	Time period when address was/is in use

Getting Started

API Reference

Handling Data

FHIR

API Tools

More Info

Address

Properties

Getting Started

API Reference

Handling Data

FHIR

API Tools

More Info

​Properties

Properties