Skip to main content
GET
/
patient
/
:id
/
medical-record
Get Medical Record Summary
curl --request GET \
  --url https://api.sandbox.metriport.com/patient/:id/medical-record \
  --header 'x-api-key: <api-key>'
import { MetriportMedicalApi } from "@metriport/api-sdk";

const metriport = new MetriportMedicalApi("YOUR_API_KEY");
const metriportPatientId = "018a80c4-292a-7486-a223-6dcbc636c44c";

const url = await metriport.getMedicalRecordSummary(
  metriportPatientId,
  "pdf"
);

Documentation Index

Fetch the complete documentation index at: https://docs.metriport.com/llms.txt

Use this file to discover all available pages before exploring further.

This endpoint returns the URL to download the patient’s Medical Record Summary in the PDF or HTML format, if it exists. To create a Medical Record Summary, you need to use the Start Consolidated Data Query.
The URL will only be valid for 600 seconds (10 minutes) before you need to request a new one.

​
Path Params

​
id
string
required
The ID of the Patient.

​
Query Params

​
conversionType
string
required
The doc type to convert to. Either html or pdf.
This parameter is to indicate how the medical record should be rendered.

​
Response

If the Medical Record Summary exists, it will return a JSON object containing the downloadable URL. Otherwise, will throw a NotFoundError.
​
url
string
The downloadable URL.
import { MetriportMedicalApi } from "@metriport/api-sdk";

const metriport = new MetriportMedicalApi("YOUR_API_KEY");
const metriportPatientId = "018a80c4-292a-7486-a223-6dcbc636c44c";

const url = await metriport.getMedicalRecordSummary(
  metriportPatientId,
  "pdf"
);