Getting Started
API Reference
Handling Data
FHIR
Create Cohort
Copy
Ask AI
curl --request POST \
--url https://api.sandbox.metriport.com/medical/v1/cohort \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"color": "<string>",
"description": "<string>",
"settings": {
"monitoring": {
"hie": {
"enabled": true,
"frequency": "<string>"
},
"adt": {
"enabled": true
},
"pharmacy": {
"notifications": true,
"schedule": {
"enabled": true,
"frequency": "<string>"
}
},
"laboratory": {
"notifications": true
}
}
}
}
'Copy
Ask AI
import { MetriportMedicalApi } from "@metriport/api-sdk";
const metriport = new MetriportMedicalApi("YOUR_API_KEY");
const cohort = await metriport.createCohort({
name: "High Risk",
color: "red",
description: "Patients that need frequent and robust monitoring.",
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"
}
},
},
}
});
Create Cohort
Creates a new cohort for organizing and managing groups of patients. Cohort names must be unique within your organization.
POST
/
medical
/
v1
/
cohort
Create Cohort
Copy
Ask AI
curl --request POST \
--url https://api.sandbox.metriport.com/medical/v1/cohort \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"color": "<string>",
"description": "<string>",
"settings": {
"monitoring": {
"hie": {
"enabled": true,
"frequency": "<string>"
},
"adt": {
"enabled": true
},
"pharmacy": {
"notifications": true,
"schedule": {
"enabled": true,
"frequency": "<string>"
}
},
"laboratory": {
"notifications": true
}
}
}
}
'Copy
Ask AI
import { MetriportMedicalApi } from "@metriport/api-sdk";
const metriport = new MetriportMedicalApi("YOUR_API_KEY");
const cohort = await metriport.createCohort({
name: "High Risk",
color: "red",
description: "Patients that need frequent and robust monitoring.",
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"
}
},
},
}
});
For more information, see the guide about Cohorts
Body
The name of the cohort. The name must be unique within your organization.
The color associated with the cohort. Must be one of:
red, green, blue, yellow, purple, orange, pink, brown, gray, black, white. Defaults to white on creation if no color is given.A description of the cohort and its purpose.
Configuration settings for the cohort.
Show Settings properties
Show Settings properties
Hide monitoring object properties
Hide monitoring object properties
HIE-based document monitoring - subscribes patients to HIE-based
document monitoring (non-ADT) / medical record refresh based on the cadence.
Show hie object properties
Show hie object properties
Enable or disable scheduled data pulls for HIE monitoring. Defaults to disabled.
When disabled, no scheduled pulls will occur regardless of the frequency setting.
How often scheduled data pulls should occur, can be one of
weekly or biweekly or monthly. Defaults to monthly.See scheduled queries
for timing details.
HIE monitoring is coming soon! While this feature is not yet live, you can configure
your HIE monitoring settings now. These settings will automatically take effect when the feature launches.
ADT (Admission, Discharge, Transfer) monitoring - subscribes patients to ADT notifications
based on their primary address.
Show adt object properties
Show adt object properties
Enable or disable ADT monitoring notifications. Defaults to disabled.
Pharmacy / medication history monitoring - enables retail fill data monitoring where available.
Show pharmacy object properties
Show pharmacy object properties
Enable/disable pharmacy monitoring notifications. Defaults to disabled.
Enable pharmacy data pulls at scheduled dates.
Show schedule object properties
Show schedule object properties
Enable or disable scheduled data pulls for pharmacy monitoring. When disabled, no
scheduled pulls will occur regardless of the frequency setting. Defaults to disabled.
How often scheduled data pulls should occur, can be one of
weekly or biweekly or monthly. Defaults to monthly.See scheduled queries
for timing details.
Pharmacy monitoring is coming soon! While this feature is not yet live, you can configure
your Pharmacy monitoring settings now. These settings will automatically take effect when the feature launches.
Response
The unique identifier for the cohort (UUID format, e.g.,
00000000-0000-0000-0000-000000000000).The entity tag for optimistic concurrency control.
The unique name of the cohort within your organization.
The description of the cohort.
The color associated with the cohort.
Configuration settings for the cohort.
Show Settings properties
Show Settings properties
Hide monitoring object properties
Hide monitoring object properties
HIE-based document monitoring - subscribes patients to HIE-based
document monitoring (non-ADT) / medical record refresh based on the cadence.
Show hie object properties
Show hie object properties
Enable or disable scheduled data pulls for HIE monitoring. Defaults to disabled.
When disabled, no scheduled pulls will occur regardless of the frequency setting.
How often scheduled data pulls should occur, can be one of
weekly or biweekly or monthly. Defaults to monthly.See scheduled queries
for timing details.
HIE monitoring is coming soon! While this feature is not yet live, you can configure
your HIE monitoring settings now. These settings will automatically take effect when the feature launches.
ADT (Admission, Discharge, Transfer) monitoring - subscribes patients to ADT notifications
based on their primary address.
Show adt object properties
Show adt object properties
Enable or disable ADT monitoring notifications. Defaults to disabled.
Pharmacy / medication history monitoring - enables retail fill data monitoring where available.
Show pharmacy object properties
Show pharmacy object properties
Enable/disable pharmacy monitoring notifications. Defaults to disabled.
Enable pharmacy data pulls at scheduled dates.
Show schedule object properties
Show schedule object properties
Enable or disable scheduled data pulls for pharmacy monitoring. When disabled, no
scheduled pulls will occur regardless of the frequency setting. Defaults to disabled.
How often scheduled data pulls should occur, can be one of
weekly or biweekly or monthly. Defaults to monthly.See scheduled queries
for timing details.
Pharmacy monitoring is coming soon! While this feature is not yet live, you can configure
your Pharmacy monitoring settings now. These settings will automatically take effect when the feature launches.
The number of patients assigned to this cohort.
Copy
Ask AI
import { MetriportMedicalApi } from "@metriport/api-sdk";
const metriport = new MetriportMedicalApi("YOUR_API_KEY");
const cohort = await metriport.createCohort({
name: "High Risk",
color: "red",
description: "Patients that need frequent and robust monitoring.",
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"
}
},
},
}
});
Copy
Ask AI
{
"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
}
}
},
"size": 0
}
⌘I