Properties

Medical API

Converter API

Website

GitHub

x-api-key

Metriport

Home

Get Started

Contact Us

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

ContactDetail

Metriport helps you access and manage your users' and patients' health and medical data, through an open-source universal API.

Welcome!

Learn more about API key security best practices.

API Keys

Receive data as soon as it becomes available.

Webhooks

Learn more about our standardized error responses.

Error Responses

Follow this guide to start exchanging comprehensive patient medical data.

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

FHIR Converter API

Converts the provided C-CDA document to a FHIR R4 Bundle.

Convert C-CDA to FHIR R4

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

Lists all Patients receiving care at the specified Facility.

List Patients at Facility

Delete Patient

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

Learn more about how Metriport leverages FHIR for interoperability.

FHIR Overview

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

A financial tool for tracking value accrued for a particular purpose.  In the healthcare field, used to track charges for a patient, cost centers, etc.

Account

This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.

ActivityDefinition

Actual or potential/avoided event causing unintended physical injury resulting from or contributed to by medical care, a research study or other healthcare setting factors that requires additional monitoring, treatment, or hospitalization, or that results in death.

AdverseEvent

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

AllergyIntolerance

A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).

Appointment

A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.

AppointmentResponse

A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.

AuditEvent

Basic is used for handling concepts not yet defined in FHIR, narrative-only resources that don't map to an existing resource, and custom resources not appropriate for inclusion in the FHIR specification.

Basic

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 material substance originating from a biological entity intended to be transplanted or infused into another (possibly the same) biological entity.

BiologicallyDerivedProduct

Record details about an anatomical structure.  This resource may be used when a coded concept does not provide the necessary detail needed for the use case.

BodyStructure

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

Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.

CarePlan

The Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care for a patient.

CareTeam

Catalog entries are wrappers that contextualize items included in a catalog.

CatalogEntry

The resource ChargeItem describes the provision of healthcare provider products for a certain patient, therefore referring not only to the product, but containing in addition details of the provision, like date, time, amounts and participating organizations and persons. Main Usage of the ChargeItem is to enable the billing process and internal cost allocation.

ChargeItem

The ChargeItemDefinition resource provides the properties that apply to the (billing) codes necessary to calculate costs and prices. The properties may differ largely depending on type and realm, therefore this resource gives only a rough structure and requires profiling for each type of billing code system.

ChargeItemDefinition

A provider issued list of professional services and products which have been provided, or are to be provided, to a patient which is sent to an insurer for reimbursement.

Claim

This resource provides the adjudication details from the processing of a Claim resource.

ClaimResponse

A record of a clinical assessment performed to determine what problem(s) may affect the patient and before planning the treatments or management strategies that are best to manage a patient's condition. Assessments are often 1:1 with a clinical consultation / encounter,  but this varies greatly depending on the clinical workflow. This resource is called "ClinicalImpression" rather than "ClinicalAssessment" to avoid confusion with the recording of assessment tools such as Apgar score.

ClinicalImpression

The CodeSystem resource is used to declare the existence of and describe a code system or code system supplement and its key properties, and optionally define a part or all of its content.

CodeSystem

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 request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.

CommunicationRequest

A compartment definition that defines how resources are accessed on a server.

CompartmentDefinition

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 statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, or classes in class models.

ConceptMap

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

Legally enforceable, formally recorded unilateral or bilateral directive i.e., a policy or agreement.

Contract

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

Name	Required	Type	Description
id	No	string	Unique id for inter-element referencing
extension	No	Extension[]	Additional content defined by implementations
name	No	string	Name of an individual to contact
telecom	No	ContactPoint[]	Contact details for individual or organization

Getting Started

API Reference

FHIR

More Info

ContactDetail

Properties

Getting Started

API Reference

FHIR

More Info

​Properties

Properties