GET
/
medical
/
v1
/
patient
curl --request GET \
  --url https://api.sandbox.metriport.com/medical/v1/patient \
  --header 'x-api-key: <api-key>'
import { MetriportMedicalApi } from "@metriport/api-sdk";

const metriport = new MetriportMedicalApi("YOUR_API_KEY");

const facilityId = "018a80c4-292a-7486-a1234-9uiu76yhe234";
const filters = "john doe";
const { patients } = await metriport.listPatients(facilityId, filters);

This is a paginated endpoint. For more information see pagination.

​
Query Params

​
facilityId
string

The ID of the Facility where the patient is receiving care, optional. If not provided, Patients from all Facilities will be returned.

​
filters
string

How to filter patients. It uses Metriport’s filter/search criteria based on the main properties of a Patient: first name, last name, date of birth, ID, external ID, facility ID, facility name, and additional identifiers.

One can combine fields as needed, for example:

  • john or doe will return all patients with the first and/or last name equal to john or doe.
  • john -doe will return all patients with the first and/or last name equal to john but without any doe either on first or last names.
  • john 2000 will return all patients with the first and/or last name equal to john and born in the year 2000.
  • 2000-02-03 will return all patients born on 2020-02-03.
  • ABCD1234 will return all patients with that external ID.

Date of birth should follow the format ISO 8601 (YYYY-MM-DD), but partial values are accepted (YYYY, YYYY-MM)

​
Response

All Patients receiving care at the specified Facility, or all Patients if no Facility is specified.

​
patients
Patient[]
import { MetriportMedicalApi } from "@metriport/api-sdk";

const metriport = new MetriportMedicalApi("YOUR_API_KEY");

const facilityId = "018a80c4-292a-7486-a1234-9uiu76yhe234";
const filters = "john doe";
const { patients } = await metriport.listPatients(facilityId, filters);
{
  "meta": {
    "itemsOnPage": 2
  },
  "patients": [
    {
      "id": "018a80c4-292a-7486-a1234-76yuhe23yu14",
      "externalId": "123456789",
      "additionalIds": { 
        "athenahealth": ["43210"], 
        "canvas": ["1234567890"], 
        "elation": ["0987654321"] 
      },
      "facilityIds": ["018a80c4-292a-7486-a1234-9uiu76yhe234"],
      "firstName": "Jose",
      "lastName": "Juarez",
      "dob": "1951-05-05",
      "genderAtBirth": "M",
      "personalIdentifiers": [
        {
          "type": "driversLicense",
          "state": "CA",
          "value": "51227265"
        }
      ],
      "address": [
        {
          "zip": "12345",
          "city": "San Diego",
          "state": "CA",
          "country": "USA",
          "addressLine1": "Guadalajara St"
        }
      ],
      "contact": [
        {
          "phone": "1234567899",
          "email": "jose@domain.com"
        }
      ],
    },
    {
      "id": "018a80c4-292a-7486-a1234-5ert32uij123",
      "externalId": "123456777",
      "facilityIds": ["018a80c4-292a-7486-a1234-9uiu76yhe234"],
      "firstName": "Josita",
      "lastName": "Juarez,Diaz",
      "dob": "1949-06-09",
      "genderAtBirth": "F",
      "address": [
        {
          "zip": "12345",
          "city": "San Diego",
          "state": "CA",
          "country": "USA",
          "addressLine1": "Guadalajara St"
        }
      ]
    }
  ]
}