# Group

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

Represents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively, and are not formally or legally recognized; i.e. a collection of entities that isn't an Organization.

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/Group/[id]` |
| Vread | `GET` | `/fhir/R4/Group/[id]/_history/[vid]` |
| Update | `PUT` | `/fhir/R4/Group/[id]` |
| Patch | `PATCH` | `/fhir/R4/Group/[id]` |
| Delete | `DELETE` | `/fhir/R4/Group/[id]` |
| Create | `POST` | `/fhir/R4/Group` |
| Search | `GET` | `/fhir/R4/Group` |
| History | `GET` | `/fhir/R4/Group/[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..*` | Unique id |
| <span id="element-active"></span>`active` | [boolean](/fhir-elements/primitive/boolean) | `0..1` | Whether this group's record is in active use |
| <span id="element-type"></span>`type` | [code](/fhir-elements/primitive/code) | `1..1` | person \| animal \| practitioner \| device \| medication \| substance |
| <span id="element-actual"></span>`actual` | [boolean](/fhir-elements/primitive/boolean) | `1..1` | Descriptive or actual |
| <span id="element-code"></span>`code` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | Kind of Group members |
| <span id="element-name"></span>`name` | [string](/fhir-elements/primitive/string) | `0..1` | Label for Group |
| <span id="element-quantity"></span>`quantity` | [unsignedInt](/fhir-elements/primitive/unsigned-int) | `0..1` | Number of members |
| <span id="element-managing-entity"></span>`managingEntity` | [Reference](/fhir-elements/complex/reference) | `0..1` | Entity that is the custodian of the Group's definition |
| <span id="element-characteristic"></span>`characteristic` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Include / Exclude group members by Trait |
| <span id="element-member"></span>`member` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Who or what is in group |

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

| **Parameter** | **Type** | **Description** |
| --- | --- | --- |
| `actual` | token | Descriptive or actual |
| `characteristic` | token | Kind of characteristic |
| `characteristic-value` | composite | A composite of both characteristic and value |
| `code` | token | The kind of resources contained |
| `exclude` | token | Group includes or excludes |
| `identifier` | token | Unique id |
| `managing-entity` | reference | Entity that is the custodian of the Group's definition |
| `member` | reference | Reference to the group member |
| `type` | token | The type of resources the group contains |
| `value` | token | Value held by characteristic |

## Reference [#reference]

Official FHIR R4 spec: [Group](https://hl7.org/fhir/R4/group.html).  
Maturity: Trial Use 1 (FMM 1).
