Search
K
< Back

Enroll Patients

Clinical Alerts enrollment can be configured to monitor specific patients or all patients in your tenant.

  • Group enrollment uses the FHIR Group resource to list only the patients you want to monitor.
  • All-tenant enrollment automatically monitors every patient in your tenant without group maintenance.

Note: The name field in the Group resource must be Clinical Alerts Roster for enrollment to be processed correctly.

Prerequisites

Before enrolling patients using a FHIR Group, verify that:

  • Clinical Alerts are enabled for your tenant
  • Patients have a valid Patient resource in the Health Gorilla system
  • Your system supports authenticated FHIR POST, PUT, and GET requests

To enroll patients using a FHIR Group

  1. Send a POST request to create a Group resource. Include the type, actual, and member fields to define the patient roster.
POST /fhir/R4/Group
Authorization: Bearer {access_token}
Content-Type: application/fhir+json
Accept: application/fhir+json

Sample payload:

{
  "resourceType": "Group",
  "type": "person",
  "actual": true,
  "name": "Clinical Alerts Roster",
  "member": [
    { "entity": { "reference": "Patient/123" } },
    { "entity": { "reference": "Patient/456" } }
  ]
}
  1. Record the Group ID from the response. You will need this ID to manage enrollment and make future updates.
  2. Send a PUT request to update the Group membership. Replace the entire member array when modifying the list.
  PUT /fhir/R4/Group/{group_id}
  Authorization: Bearer {access_token}
  Content-Type: application/fhir+json
  Accept: application/fhir+json
  1. Confirm the Group membership using a GET request.
GET /fhir/R4/Group/{group_id}
Authorization: Bearer {access_token}
Accept: application/fhir+json
  1. Retrieve the current list of enrolled patients to validate the update.

Notes:

  • Each Group must include all patients you want enrolled—partial updates are not supported.
  • Group updates may take a few minutes to take effect.
  • Use separate Group resources for different alerting programs or patient populations.
  • If you delete a Group or remove a patient, Clinical Alerts will stop for that patient immediately.

To request all-tenant enrollment

  1. Contact Health Gorilla Support and provide:
  • Your tenant ID
  • Confirmation that Clinical Alerts are enabled for your tenant
  • Confirmation that you want every patient in the tenant monitored
  1. Health Gorilla Support configures your tenant so that all patients are automatically enrolled.
  2. No API calls are required to maintain the roster. New patients added to your tenant will be monitored automatically.

Note: When Health Gorilla enables all-tenant enrollment, the following Group structure is used to create a Group using the all-patients characteristic.

{
"resourceType": "Group",
"name": "Clinical Alerts Roster",
"characteristic": [
{
  "code": {
    "coding": [
      {
        "system": "https://www.healthgorilla.com/group-characteristic",
        "code": "all-patients",
        "display": "all patients"
      }
    ]
  },
  "valueBoolean": true,
  "exclude": false
}
]
}