The Group resource implements the FHIR R4 Group specification
Fields
| Name | Type | Cardinality | Required | Description |
|---|---|---|---|---|
| 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 | Custodian | |
| characteristic | BackboneElement | 0..* | Include / Exclude group members by Trait | |
| member | BackboneElement | 0..* | Who or what is in group | |
| member.entity | Reference | 1..1 | * | Reference to the group member |
Interactions
Read
Get an Group entry by id
GET /Group/:id
Example
Request
https://r4cert.medicasoft.us/api/fhir/Group/453
Search
Query Group resources
GET /Group?:query_parameters
Parameters
| Name | Type | Description |
|---|---|---|
| actual | token | Descriptive or actual |
| code | token | The kind of resource contained |
| member | reference | Reference to group member |
| type | token | The type of resources group contains |
| _revinclude | Provenance:target |
Errors
| Code | Description |
|---|---|
| 400 | Invalid parameters |
| 404 | Resource not found |