Update Cohort

Updates the details of an existing cohort (name, description, color).

PATCH /medical/v1/cohort/{id}

Update Cohort

cURL

curl --request PATCH \
  --url https://api.sandbox.metriport.com/medical/v1/cohort/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "color": "<string>",
  "description": "<string>"
}
'

import requests

url = "https://api.sandbox.metriport.com/medical/v1/cohort/{id}"

payload = {
    "name": "<string>",
    "color": "<string>",
    "description": "<string>"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', color: '<string>', description: '<string>'})
};

fetch('https://api.sandbox.metriport.com/medical/v1/cohort/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.metriport.com/medical/v1/cohort/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'color' => '<string>',
    'description' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.metriport.com/medical/v1/cohort/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"color\": \"<string>\",\n  \"description\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.sandbox.metriport.com/medical/v1/cohort/{id}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"color\": \"<string>\",\n  \"description\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.metriport.com/medical/v1/cohort/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"color\": \"<string>\",\n  \"description\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

Metriport SDK

import { MetriportMedicalApi } from "@metriport/api-sdk";

const metriport = new MetriportMedicalApi("YOUR_API_KEY");

const cohort = await metriport.updateCohort(
  {
    id: "00000000-0000-0000-0000-000000000000",
    name: "High Risk",
    description: "Patients that need frequent and robust monitoring."
  }
);

For more information, see the guide about Cohorts

Path Params

id · string · required

The ID of the cohort to update.

Headers

If-Match · string

The ETag value for optimistic concurrency control. If provided, the update will only succeed if the current ETag matches this value.

Body

All fields are optional for updates. The API performs partial updates:

• Omitted fields remain unchanged - only include fields you want to modify
• To update a field - simply include the new value

name · string

The name of the cohort. The name must be unique within your organization.

color · string

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.

description · string

A description of the cohort and its purpose.

Examples

Partial update example:

{
  "name": "Updated Cohort Name"
}

In this example, only the name field is updated. All other fields remain unchanged.

Clearing fields example:

{
  "description": ""
}

This removes the description and leaves the rest of the details the same.

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.

Show Settings properties

monitoring · object

Hide monitoring object properties

hie · object

HIE-based document monitoring - subscribes patients to HIE-based document monitoring (non-ADT) / medical record refresh based on the cadence.

Show hie object properties

enabled · boolean

Enable or disable scheduled data pulls for HIE monitoring. Defaults to disabled. When disabled, no scheduled pulls will occur regardless of the frequency setting.

frequency · string

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 · object

ADT (Admission, Discharge, Transfer) monitoring - subscribes patients to ADT notifications based on their primary address.

Show adt object properties

enabled · boolean

Enable or disable ADT monitoring notifications. Defaults to disabled.

pharmacy · object

Pharmacy / medication history monitoring - enables retail fill data monitoring where available.

Show pharmacy object properties

notifications · boolean

Enable/disable pharmacy monitoring notifications. Defaults to disabled.

schedule · object

Enable pharmacy data pulls at scheduled dates.

Show schedule object properties

enabled · boolean

Enable or disable scheduled data pulls for pharmacy monitoring. When disabled, no scheduled pulls will occur regardless of the frequency setting. Defaults to disabled.

frequency · string

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.

laboratory · object

Laboratory / lab results monitoring - enables laboratory test results monitoring where available.

Show laboratory object properties

notifications · boolean

Enable/disable laboratory monitoring notifications. Defaults to disabled.

size · number · required

The number of patients assigned to this cohort.

Metriport SDK

import { MetriportMedicalApi } from "@metriport/api-sdk";

const metriport = new MetriportMedicalApi("YOUR_API_KEY");

const cohort = await metriport.updateCohort(
  {
    id: "00000000-0000-0000-0000-000000000000",
    name: "High Risk",
    description: "Patients that need frequent and robust monitoring."
  }
);

{
  "id": "00000000-0000-0000-0000-000000000000",
  "eTag": "2",
  "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
}