Peer Group

A peer group is a grouping of patients that can be used to tailor their experience on the platform.

The peer group model

The peer group model contains information about the name of the peer group and the patients in it.

Properties

  • Name
    id
    Type
    string
    Description

    Unique identifier for the peer group.

  • Name
    object
    Type
    string
    Description

    Always 'peer_group'.

  • Name
    name
    Type
    string
    Description

    Name of the peer group. Patients can't see this name.

  • Name
    members
    Type
    array of strings
    Description

    List of all the patients in the peer group.

  • Name
    created_by
    Type
    string
    Description

    Creator of the peer group.

  • Name
    created_at
    Type
    number
    Description

    Timestamp (in Unix epoch time in milliseconds) of when the peer group was created.

  • Name
    last_updated_at
    Type
    number
    Description

    Timestamp (in Unix epoch time in milliseconds) of when the peer group was last updated.

Response

{
    "id": "pgrp_zRX1SV0oK7vQ5f0j8Vjk",
    "object": "peer_group",
    "name": "Diabetes",
    "members": [
    "user_Z1zXZKvqrpwxbznuW6lJ",
    "user_IsW3SoxZQxW0agHKyP2V",
    "user_o14kEdLdUloOyS4RGkII",
    ],
    "created_by": "user_xeDpGyt67wTor93qKtS7",
    "created_at": 1653798303000,
    "last_updated_at": 1653798303000
}