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

const metriport = new MetriportMedicalApi("YOUR_API_KEY");
const cohortId = "00000000-0000-0000-0000-000000000000";

const cohortDetails = await metriport.getCohort(cohortId);
For more information, see the guide about Cohorts

​
Path Params

​
id
string
required
The ID of the cohort to get.

​
Response

​
id
string
required
The unique identifier for the cohort (UUID format, e.g., 00000000-0000-0000-0000-000000000000).
​
eTag
string
required
The entity tag for optimistic concurrency control.
​
name
string
required
The unique name of the cohort within your organization.
​
description
string
required
The description of the cohort.
​
color
string
required
The color associated with the cohort.
​
settings
object
required
Configuration settings for the cohort.
​
size
number
required
The number of patients assigned to this cohort.
import { MetriportMedicalApi } from "@metriport/api-sdk";

const metriport = new MetriportMedicalApi("YOUR_API_KEY");
const cohortId = "00000000-0000-0000-0000-000000000000";

const cohortDetails = await metriport.getCohort(cohortId);

{
  "id": "00000000-0000-0000-0000-000000000000",
  "eTag": "1",
  "name": "High Risk",
  "description": "Patients that need frequent and robust monitoring.",
  "color": "red",
  "settings": {
    "monitoring": {
      "hie": {
        "enabled": true,
        "frequency": "weekly"
      },
      "adt": {
        "enabled": true
      },
      "pharmacy": {
        "notifications": true,
        "schedule": {
          "enabled": false,
          "frequency": "monthly"
        }
      },
      "laboratory": {
        "notifications": true,
        "schedule": {
          "enabled": false,
          "frequency": "monthly"
        }
      }
    }
  },
  "size": 0
}