Interface / 4.0.1 (R4) / Group

Group

The Group resource represents a group of patients.

Overview

See the FHIR documentation for more information about Group resources.

Mapped Concepts in HIEBus

  • PatientGroup
  • PatientGroupMember

Supported Interactions

Group resources support the following interactions.

Search Parameters

When searching for Group resources, the following search parameters are supported.

Name Type Prefixes
Modifiers
Can be Chained? Description
_count Special The maximum number of resources to return in a result page.
_elements Special Used to request a specific set of elements be returned as part of a resource.
_id Token Resource id.
_summary Special Used to return only a portion of the resouces. Defaults to 'false', which returns the whole resource.
_total Special Use the value 'estimate' to populate the result bundle's 'total' element with an estimate of the matching number of resources.
code Token :not  :in  :notin  :missing  The kind of resources contained.
identifier Token :missing  Unique id.
member Reference :missing  yes The patient the Group is about. Functionally identical to the "patient" search parameter.
name String :contains  :exact  :missing  Searches for groups by their name.

Sortable Parameters

When searching Group resources, it is possible to sort the returned values by the following search parameters.

  • name
  • _id

Only one sort parameter may be specified.

Supported Includes

When searching Group resources, it is possible to include the resources referenced by the following field names.

  • Member

Back to Resources