The FHIR R4 RequestGroup resource represents a group of one or more clinical requests that are intended to be executed together. It can include medications, procedures, services, or referrals that form part of a care plan or order set. RequestGroup supports conditional logic, timing, and dependencies between grouped requests.

Use Cases

Represent a care pathway that involves multiple ordered actions
Group related service or medication requests into a coordinated bundle
Define dependencies between requests (e.g., “do A, then B”)

Base URLs

Production: https://api.healthgorilla.com/fhir/R4/RequestGroup
Sandbox: https://sandbox.healthgorilla.com/fhir/R4/RequestGroup

Authentication

All requests require OAuth 2.0 authentication using a Bearer Token. Unauthorized requests return 401 Unauthorized responses.

Required Scopes

requestgroup.read for GET
requestgroup.write for POST, PUT, DELETE

For more information, go to: OAuth 2.0 Authentication

Supported Methods

Method	Operation	Description
`GET`	Read RequestGroup	Retrieves a specific RequestGroup record by its FHIR ID.
`GET`	Search RequestGroup	Searches for RequestGroup records associated with a patient.
`POST`	Create RequestGroup	Submits a new RequestGroup record to the Health Gorilla FHIR server.
`GET`	Download RequestGroup PDF	Retrieves a PDF version of the RequestGroup document, formatted for human-readable display.

Frequently Used Search Parameters

Parameter	Description	FHIR Value Set or Example Values	FHIR Data Type	Required
`patient`	Filters by patient ID	`Patient/{id}`	`Reference`	Yes
`authored`	Filters by date the request was authored	`ge2023-01-01`, `le2023-12-31`	`date`	No
`status`	Filters by status of the request group	`RequestStatus` (`draft`, `active`, `completed`)	`token`	No
`encounter`	Filters by associated encounter	`Encounter/{id}`	`Reference`	No
`identifier`	Searches by group identifier	`12345-abc`	`token`	No

Commonly Returned Resource Attributes

Attribute	Description	Example Values	FHIR Data Type	Required
`id`	Unique FHIR ID for the request group	`requestgroup-1234`	`id`	Yes
`status`	Status of the group	`active`	`code`	Yes
`intent`	Purpose of the request group	`order`, `plan`	`code`	Yes
`subject`	Patient for whom the requests are being ordered	`Patient/{id}`	`Reference(Patient)`	Yes
`encounter`	Associated clinical encounter	`Encounter/{id}`	`Reference(Encounter)`	No
`authoredOn`	When the group was created	2023-07-10T09:00:00-08:00	`dateTime`	No
`author`	Who authored the group	`Practitioner/{id}`	`Reference(Practitioner)`	No
`reasonCode`	Clinical or administrative reason for the request group	`annual checkup`, `chest pain`	`CodeableConcept[]`	No
`action`	Embedded action definitions	Each item in `action` can include timing, conditions, links to referenced requests (e.g., ServiceRequest), and sequence logic.	`RequestGroup.Action`	No

Webhooks

Clients can receive webhook notifications when RequestGroup records are created or updated. These are useful when monitoring care plans or bundled orders initiated during patient encounters. For more information, go to: Webhooks and Polling

Error Handling

All RequestGroup operations follow standard Health Gorilla error handling, including use of FHIR OperationOutcome for structured responses. For more information, go to: Error Handling

Additional Resources

HL7 FHIR RequestGroup