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
| Element | Type | Cardinality | Description |
|---|---|---|---|
id | string | 0..1 | Logical id of this artifact |
meta | Meta | 0..1 | Metadata about the resource |
implicitRules | uri | 0..1 | A set of rules under which this content was created |
language | code | 0..1 | Language of the resource content |
text | Narrative | 0..1 | Text summary of the resource, for human interpretation |
contained | Resource | 0..* | Contained, inline Resources |
extension | Extension | 0..* | Additional content defined by implementations |
modifierExtension | Extension | 0..* | Extensions that cannot be ignored |
identifier | Identifier | 0..* | Unique id |
active | boolean | 0..1 | Whether this group's record is in active use |
type | code | 1..1 | person | animal | practitioner | device | medication | substance |
actual | boolean | 1..1 | Descriptive or actual |
code | CodeableConcept | 0..1 | Kind of Group members |
name | string | 0..1 | Label for Group |
quantity | unsignedInt | 0..1 | Number of members |
managingEntity | Reference | 0..1 | Entity that is the custodian of the Group's definition |
characteristic | BackboneElement | 0..* | Include / Exclude group members by Trait |
member | BackboneElement | 0..* | Who or what is in group |
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
Official FHIR R4 spec: Group.
Maturity: Trial Use 1 (FMM 1).