> ## Documentation Index
> Fetch the complete documentation index at: https://docs.metriport.com/llms.txt
> Use this file to discover all available pages before exploring further.

# RequestGroup

> A group of related requests that can be used to capture intended activities that have inter-dependencies such as give this medication after that one.

## Properties

| Name                  | Required | Type                                                                                                                                                                                                                                                                                                    | Description                                                                                                                     |
| --------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| identifier            | No       | [Identifier](/medical-api/fhir/data-types/identifier)\[]                                                                                                                                                                                                                                                | Business identifier                                                                                                             |
| instantiatesCanonical | No       | canonical\[]                                                                                                                                                                                                                                                                                            | Instantiates FHIR protocol or definition                                                                                        |
| instantiatesUri       | No       | uri\[]                                                                                                                                                                                                                                                                                                  | Instantiates external protocol or definition                                                                                    |
| basedOn               | No       | Reference\<Resource>\[]                                                                                                                                                                                                                                                                                 | Fulfills plan, proposal, or order                                                                                               |
| replaces              | No       | Reference\<Resource>\[]                                                                                                                                                                                                                                                                                 | Request(s) replaced by this request                                                                                             |
| groupIdentifier       | No       | [Identifier](/medical-api/fhir/data-types/identifier)                                                                                                                                                                                                                                                   | Composite request this is part of                                                                                               |
| status                | Yes      | code                                                                                                                                                                                                                                                                                                    | draft / active / on-hold / revoked / completed / entered-in-error / unknown                                                     |
| intent                | Yes      | code                                                                                                                                                                                                                                                                                                    | proposal / plan / directive / order / original-order / reflex-order / filler-order / instance-order / option                    |
| priority              | No       | code                                                                                                                                                                                                                                                                                                    | routine / urgent / asap / stat                                                                                                  |
| code                  | No       | [CodeableConcept](/medical-api/fhir/data-types/codeableconcept)                                                                                                                                                                                                                                         | What's being requested/ordered                                                                                                  |
| subject               | No       | Reference\<[Patient](/medical-api/fhir/resources/patient) / [Group](/medical-api/fhir/resources/group)>                                                                                                                                                                                                 | Who the request group is about                                                                                                  |
| encounter             | No       | Reference\<[Encounter](/medical-api/fhir/resources/encounter)>                                                                                                                                                                                                                                          | Created as part of                                                                                                              |
| authoredOn            | No       | dateTime                                                                                                                                                                                                                                                                                                | When the request group was authored                                                                                             |
| author                | No       | Reference\<[Device](/medical-api/fhir/resources/device) / [Practitioner](/medical-api/fhir/resources/practitioner) / [PractitionerRole](/medical-api/fhir/resources/practitionerrole)>                                                                                                                  | Device or practitioner that authored the request group                                                                          |
| reasonCode            | No       | [CodeableConcept](/medical-api/fhir/data-types/codeableconcept)\[]                                                                                                                                                                                                                                      | Why the request group is needed                                                                                                 |
| reasonReference       | No       | Reference\<[Condition](/medical-api/fhir/resources/condition) / [Observation](/medical-api/fhir/resources/observation) / [DiagnosticReport](/medical-api/fhir/resources/diagnosticreport) / [DocumentReference](/medical-api/fhir/resources/documentreference)>\[]                                      | Why the request group is needed                                                                                                 |
| note                  | No       | [Annotation](/medical-api/fhir/data-types/annotation)\[]                                                                                                                                                                                                                                                | Additional notes about the response                                                                                             |
| action                | No       | RequestGroupAction                                                                                                                                                                                                                                                                                      | Proposed actions, if any                                                                                                        |
| - id                  | No       | string                                                                                                                                                                                                                                                                                                  | Unique id for inter-element referencing                                                                                         |
| - extension           | No       | [Extension](/medical-api/fhir/data-types/extension)\[]                                                                                                                                                                                                                                                  | Additional content defined by implementations                                                                                   |
| - modifierExtension   | No       | [Extension](/medical-api/fhir/data-types/extension)\[]                                                                                                                                                                                                                                                  | Extensions that cannot be ignored even if unrecognized                                                                          |
| - prefix              | No       | string                                                                                                                                                                                                                                                                                                  | User-visible prefix for the action (e.g. 1. or A.)                                                                              |
| - title               | No       | string                                                                                                                                                                                                                                                                                                  | User-visible title                                                                                                              |
| - description         | No       | string                                                                                                                                                                                                                                                                                                  | Short description of the action                                                                                                 |
| - textEquivalent      | No       | string                                                                                                                                                                                                                                                                                                  | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system                 |
| - priority            | No       | code                                                                                                                                                                                                                                                                                                    | routine / urgent / asap / stat                                                                                                  |
| - code                | No       | [CodeableConcept](/medical-api/fhir/data-types/codeableconcept)\[]                                                                                                                                                                                                                                      | Code representing the meaning of the action or sub-actions                                                                      |
| - documentation       | No       | [RelatedArtifact](/medical-api/fhir/data-types/relatedartifact)\[]                                                                                                                                                                                                                                      | Supporting documentation for the intended performer of the action                                                               |
| - condition           | No       | RequestGroupActionCondition                                                                                                                                                                                                                                                                             | Whether or not the action is applicable                                                                                         |
| - id                  | No       | string                                                                                                                                                                                                                                                                                                  | Unique id for inter-element referencing                                                                                         |
| - extension           | No       | [Extension](/medical-api/fhir/data-types/extension)\[]                                                                                                                                                                                                                                                  | Additional content defined by implementations                                                                                   |
| - modifierExtension   | No       | [Extension](/medical-api/fhir/data-types/extension)\[]                                                                                                                                                                                                                                                  | Extensions that cannot be ignored even if unrecognized                                                                          |
| - kind                | Yes      | code                                                                                                                                                                                                                                                                                                    | applicability / start / stop                                                                                                    |
| - expression          | No       | [Expression](/medical-api/fhir/data-types/expression)                                                                                                                                                                                                                                                   | Boolean-valued expression                                                                                                       |
| - relatedAction       | No       | RequestGroupActionRelatedAction                                                                                                                                                                                                                                                                         | Relationship to another action                                                                                                  |
| - id                  | No       | string                                                                                                                                                                                                                                                                                                  | Unique id for inter-element referencing                                                                                         |
| - extension           | No       | [Extension](/medical-api/fhir/data-types/extension)\[]                                                                                                                                                                                                                                                  | Additional content defined by implementations                                                                                   |
| - modifierExtension   | No       | [Extension](/medical-api/fhir/data-types/extension)\[]                                                                                                                                                                                                                                                  | Extensions that cannot be ignored even if unrecognized                                                                          |
| - actionId            | Yes      | id                                                                                                                                                                                                                                                                                                      | What action this is related to                                                                                                  |
| - relationship        | Yes      | code                                                                                                                                                                                                                                                                                                    | before-start / before / before-end / concurrent-with-start / concurrent / concurrent-with-end / after-start / after / after-end |
| - offset\[x]          | No       | [Duration](/medical-api/fhir/data-types/duration), [Range](/medical-api/fhir/data-types/range)                                                                                                                                                                                                          | Time offset for the relationship                                                                                                |
| - timing\[x]          | No       | dateTime, [Age](/medical-api/fhir/data-types/age), [Period](/medical-api/fhir/data-types/period), [Duration](/medical-api/fhir/data-types/duration), [Range](/medical-api/fhir/data-types/range), [Timing](/medical-api/fhir/data-types/timing)                                                         | When the action should take place                                                                                               |
| - participant         | No       | Reference\<[Patient](/medical-api/fhir/resources/patient) / [Practitioner](/medical-api/fhir/resources/practitioner) / [PractitionerRole](/medical-api/fhir/resources/practitionerrole) / [RelatedPerson](/medical-api/fhir/resources/relatedperson) / [Device](/medical-api/fhir/resources/device)>\[] | Who should perform the action                                                                                                   |
| - type                | No       | [CodeableConcept](/medical-api/fhir/data-types/codeableconcept)                                                                                                                                                                                                                                         | create / update / remove / fire-event                                                                                           |
| - groupingBehavior    | No       | code                                                                                                                                                                                                                                                                                                    | visual-group / logical-group / sentence-group                                                                                   |
| - selectionBehavior   | No       | code                                                                                                                                                                                                                                                                                                    | any / all / all-or-none / exactly-one / at-most-one / one-or-more                                                               |
| - requiredBehavior    | No       | code                                                                                                                                                                                                                                                                                                    | must / could / must-unless-documented                                                                                           |
| - precheckBehavior    | No       | code                                                                                                                                                                                                                                                                                                    | yes / no                                                                                                                        |
| - cardinalityBehavior | No       | code                                                                                                                                                                                                                                                                                                    | single / multiple                                                                                                               |
| - resource            | No       | Reference\<Resource>                                                                                                                                                                                                                                                                                    | The target of the action                                                                                                        |
| - action              | No       | \[]                                                                                                                                                                                                                                                                                                     | Sub action                                                                                                                      |

## Search Parameters

| Name                   | Type      | Description                                                        | Expression                         |
| ---------------------- | --------- | ------------------------------------------------------------------ | ---------------------------------- |
| author                 | reference | The author of the request group                                    | RequestGroup.author                |
| authored               | date      | The date the request group was authored                            | RequestGroup.authoredOn            |
| code                   | token     | The code of the request group                                      | RequestGroup.code                  |
| encounter              | reference | The encounter the request group applies to                         | RequestGroup.encounter             |
| group-identifier       | token     | The group identifier for the request group                         | RequestGroup.groupIdentifier       |
| identifier             | token     | External identifiers for the request group                         | RequestGroup.identifier            |
| instantiates-canonical | reference | The FHIR-based definition from which the request group is realized | RequestGroup.instantiatesCanonical |
| instantiates-uri       | uri       | The external definition from which the request group is realized   | RequestGroup.instantiatesUri       |
| intent                 | token     | The intent of the request group                                    | RequestGroup.intent                |
| participant            | reference | The participant in the requests in the group                       | RequestGroup.action.participant    |
| patient                | reference | The identity of a patient to search for request groups             | RequestGroup.subject               |
| priority               | token     | The priority of the request group                                  | RequestGroup.priority              |
| status                 | token     | The status of the request group                                    | RequestGroup.status                |
| subject                | reference | The subject that the request group is about                        | RequestGroup.subject               |

## Inherited Properties

| Name              | Required | Type                                                   | Description                                            |
| ----------------- | -------- | ------------------------------------------------------ | ------------------------------------------------------ |
| id                | No       | string                                                 | Logical id of this artifact                            |
| meta              | No       | [Meta](/medical-api/fhir/data-types/meta)              | Metadata about the resource                            |
| implicitRules     | No       | uri                                                    | A set of rules under which this content was created    |
| language          | No       | code                                                   | Language of the resource content                       |
| text              | No       | [Narrative](/medical-api/fhir/data-types/narrative)    | Text summary of the resource, for human interpretation |
| contained         | No       | Resource\[]                                            | Contained, inline Resources                            |
| extension         | No       | [Extension](/medical-api/fhir/data-types/extension)\[] | Additional content defined by implementations          |
| modifierExtension | No       | [Extension](/medical-api/fhir/data-types/extension)\[] | Extensions that cannot be ignored                      |

To view the FHIR specification for this resource, see [RequestGroup](https://www.hl7.org/fhir/StructureDefinition/RequestGroup).
