Getting Started
API Reference
Handling Data
FHIR
List Patients in Cohort
Copy
Ask AI
curl --request GET \
--url https://api.sandbox.metriport.com/medical/v1/cohort/{id}/patient \
--header 'x-api-key: <api-key>'Copy
Ask AI
import { MetriportMedicalApi } from "@metriport/api-sdk";
const metriport = new MetriportMedicalApi("YOUR_API_KEY");
const cohortId = "00000000-0000-0000-0000-000000000000";
const cohortPatients = await metriport.listPatientsInCohort(cohortId);
Cohort
List Patients in Cohort
Returns a paginated list of all patients that are members of the specified cohort.
GET
/
medical
/
v1
/
cohort
/
{id}
/
patient
List Patients in Cohort
Copy
Ask AI
curl --request GET \
--url https://api.sandbox.metriport.com/medical/v1/cohort/{id}/patient \
--header 'x-api-key: <api-key>'Copy
Ask AI
import { MetriportMedicalApi } from "@metriport/api-sdk";
const metriport = new MetriportMedicalApi("YOUR_API_KEY");
const cohortId = "00000000-0000-0000-0000-000000000000";
const cohortPatients = await metriport.listPatientsInCohort(cohortId);
For more information, see the guide about Cohorts
Path Params
The ID of the cohort whose patients are to be returned.
Query Params
Optional pagination parameter to start from a specific item.
Optional pagination parameter to end at a specific item.
Optional number of items per page (max 100).
Optional sort parameter (e.g., “id=asc,createdAt=desc”).
Response
Array of patients that are members of the cohort.
Show Patient properties
Show Patient properties
The ID assigned to this Patient. This ID will be used to uniquely identify this Patient in medical
documents.
The ID of the Patient on your internal system to associate to a Patient in Metriport.
A map containing additional external identifiers. If the patient is created or mapped in Metriport through one of
our EHR apps - this property will be populated with the ID from the EHR, and included
within the webhook payloads.
Show AdditionalIdentifiers properties
Show AdditionalIdentifiers properties
Athena patient ID. If more than one patient in Athena maps to a Metriport patient, they
will all be included.
Canvas patient ID. If more than one patient in Canvas maps to a Metriport patient, they
will all be included.
Elation Patient ID. If more than one patient in Elation maps to a Metriport patient, they
will all be included.
The Patient's first name(s).
The Patient's last name(s).
The Patient's date of birth (DOB), formatted
YYYY-MM-DD as per ISO 8601.The Patient's gender at birth, can be one of
M or F or O or U. Use O (other) when the patient's gender is known but it is not M or F, i.e intersex or hermaphroditic.
Use U (unknown) when the patient's gender is not known.An array of the Patient's personal IDs, such as a driver's license. May be empty.
Array of the IDs of the Facilities where the Patient is receiving care.
Pagination metadata for the response.
Show Pagination properties
Show Pagination properties
The number of items on the current page.
The total number of items across all pages (only available on the first page).
URL to get the next page (only present if there is a next page).
URL to get the previous page (only present if there is a previous page).
Copy
Ask AI
import { MetriportMedicalApi } from "@metriport/api-sdk";
const metriport = new MetriportMedicalApi("YOUR_API_KEY");
const cohortId = "00000000-0000-0000-0000-000000000000";
const cohortPatients = await metriport.listPatientsInCohort(cohortId);
Copy
Ask AI
{
"patients": [
{
"id": "11111111-1111-1111-1111-111111111111",
"eTag": "1",
"firstName": "John",
"lastName": "Doe",
"dob": "1990-01-01",
"genderAtBirth": "M",
"address": [
{
"addressLine1": "123 Fake Street",
"city": "Fake City",
"state": "NY",
"zip": "12345",
"country": "USA"
}
],
"personalIdentifiers": [
{
"type": "drivers_license",
"value": "FAKE123456789",
"state": "NY"
}
],
"facilityIds": ["22222222-2222-2222-2222-222222222222"]
},
{
"id": "33333333-3333-3333-3333-333333333333",
"eTag": "1",
"firstName": "Jane",
"lastName": "Smith",
"dob": "1985-05-15",
"genderAtBirth": "F",
"address": [
{
"addressLine1": "456 Example Avenue",
"city": "Sample Town",
"state": "CA",
"zip": "54321",
"country": "USA"
}
],
"personalIdentifiers": [
{
"type": "drivers_license",
"value": "FAKE987654321",
"state": "CA"
}
],
"facilityIds": ["44444444-4444-4444-4444-444444444444"]
}
],
"meta": {
"itemsOnPage": 2,
"itemsInTotal": 2
}
}
⌘I