# RequestGroup

Canonical page: https://docs.ovok.com/api/fhir/r4/request-group

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".

These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.

| **Interaction** | **Method** | **Path** |
| --- | --- | --- |
| Read | `GET` | `/fhir/R4/RequestGroup/[id]` |
| Vread | `GET` | `/fhir/R4/RequestGroup/[id]/_history/[vid]` |
| Update | `PUT` | `/fhir/R4/RequestGroup/[id]` |
| Patch | `PATCH` | `/fhir/R4/RequestGroup/[id]` |
| Delete | `DELETE` | `/fhir/R4/RequestGroup/[id]` |
| Create | `POST` | `/fhir/R4/RequestGroup` |
| Search | `GET` | `/fhir/R4/RequestGroup` |
| History | `GET` | `/fhir/R4/RequestGroup/[id]/_history` |

## Top-level elements [#top-level-elements]

| **Element** | **Type** | **Cardinality** | **Description** |
| --- | --- | --- | --- |
| <span id="element-id"></span>`id` | [string](/fhir-elements/primitive/string) | `0..1` | Logical id of this artifact |
| <span id="element-meta"></span>`meta` | [Meta](/fhir-elements/complex/meta) | `0..1` | Metadata about the resource |
| <span id="element-implicit-rules"></span>`implicitRules` | [uri](/fhir-elements/primitive/uri) | `0..1` | A set of rules under which this content was created |
| <span id="element-language"></span>`language` | [code](/fhir-elements/primitive/code) | `0..1` | Language of the resource content |
| <span id="element-text"></span>`text` | [Narrative](/fhir-elements/complex/narrative) | `0..1` | Text summary of the resource, for human interpretation |
| <span id="element-contained"></span>`contained` | [Resource](/fhir-elements/foundation/resource) | `0..*` | Contained, inline Resources |
| <span id="element-extension"></span>`extension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Additional content defined by implementations |
| <span id="element-modifier-extension"></span>`modifierExtension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Extensions that cannot be ignored |
| <span id="element-identifier"></span>`identifier` | [Identifier](/fhir-elements/complex/identifier) | `0..*` | Business identifier |
| <span id="element-instantiates-canonical"></span>`instantiatesCanonical` | [canonical](/fhir-elements/primitive/canonical) | `0..*` | Instantiates FHIR protocol or definition |
| <span id="element-instantiates-uri"></span>`instantiatesUri` | [uri](/fhir-elements/primitive/uri) | `0..*` | Instantiates external protocol or definition |
| <span id="element-based-on"></span>`basedOn` | [Reference](/fhir-elements/complex/reference) | `0..*` | Fulfills plan, proposal, or order |
| <span id="element-replaces"></span>`replaces` | [Reference](/fhir-elements/complex/reference) | `0..*` | Request(s) replaced by this request |
| <span id="element-group-identifier"></span>`groupIdentifier` | [Identifier](/fhir-elements/complex/identifier) | `0..1` | Composite request this is part of |
| <span id="element-status"></span>`status` | [code](/fhir-elements/primitive/code) | `1..1` | draft \| active \| on-hold \| revoked \| completed \| entered-in-error \| unknown |
| <span id="element-intent"></span>`intent` | [code](/fhir-elements/primitive/code) | `1..1` | proposal \| plan \| directive \| order \| original-order \| reflex-order \| filler-order \| instance-order \| option |
| <span id="element-priority"></span>`priority` | [code](/fhir-elements/primitive/code) | `0..1` | routine \| urgent \| asap \| stat |
| <span id="element-code"></span>`code` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | What's being requested/ordered |
| <span id="element-subject"></span>`subject` | [Reference](/fhir-elements/complex/reference) | `0..1` | Who the request group is about |
| <span id="element-encounter"></span>`encounter` | [Reference](/fhir-elements/complex/reference) | `0..1` | Created as part of |
| <span id="element-authored-on"></span>`authoredOn` | [dateTime](/fhir-elements/primitive/date-time) | `0..1` | When the request group was authored |
| <span id="element-author"></span>`author` | [Reference](/fhir-elements/complex/reference) | `0..1` | Device or practitioner that authored the request group |
| <span id="element-reason-code"></span>`reasonCode` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | Why the request group is needed |
| <span id="element-reason-reference"></span>`reasonReference` | [Reference](/fhir-elements/complex/reference) | `0..*` | Why the request group is needed |
| <span id="element-note"></span>`note` | [Annotation](/fhir-elements/complex/annotation) | `0..*` | Additional notes about the response |
| <span id="element-action"></span>`action` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Proposed actions, if any |

## Resource-specific search parameters [#resource-specific-search-parameters]

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

## Reference [#reference]

Official FHIR R4 spec: [RequestGroup](https://hl7.org/fhir/R4/requestgroup.html).  
Maturity: Trial Use 2 (FMM 2).
