Skip to main content

Group

Trial Use 1 Base

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.

Endpoints​

alphahttps://api.dev.ovok.com/fhir/R4/Group
InteractionMethodPath
ReadGET/fhir/R4/Group/[id]
VreadGET/fhir/R4/Group/[id]/_history/[vid]
UpdatePUT/fhir/R4/Group/[id]
PatchPATCH/fhir/R4/Group/[id]
DeleteDELETE/fhir/R4/Group/[id]
CreatePOST/fhir/R4/Group
SearchGET/fhir/R4/Group
HistoryGET/fhir/R4/Group/[id]/_history

Top-level elements​

ElementType(s)CardinalityDescription
identifierIdentifier0..*Unique id
activeboolean0..1Whether this group's record is in active use
typecode1..1person | animal | practitioner | device | medication | substance
actualboolean1..1Descriptive or actual
codeCodeableConcept0..1Kind of Group members
namestring0..1Label for Group
quantityunsignedInt0..1Number of members
managingEntityReference0..1Entity that is the custodian of the Group's definition
characteristicBackboneElement0..*Include / Exclude group members by Trait
memberBackboneElement0..*Who or what is in group

Resource-specific search parameters​

ParameterTypeDescription
_compartmentstring
_countstringhttps://www.hl7.org/fhir/search.html#_count
_elementsstringhttps://www.hl7.org/fhir/search.html#_elements
_idstring
_lastUpdatedstring
_profilestring
_securitystring
_sortstringhttps://www.hl7.org/fhir/search.html#_sort
_sourcestring
_summarystringhttps://www.hl7.org/fhir/search.html#_summary
_tagstring
_totalstringhttps://www.hl7.org/fhir/search.html#_total
actualstringhttp://hl7.org/fhir/SearchParameter/Group-actual
characteristicstringhttp://hl7.org/fhir/SearchParameter/Group-characteristic
characteristic-rangestringhttps://medplum.com/fhir/SearchParameter/Group-characteristic-range
characteristic-referencestringhttp://hl7.org/fhir/SearchParameter/Group-characteristic-reference
characteristic-valuestringhttp://hl7.org/fhir/SearchParameter/Group-characteristic-value
codestringhttp://hl7.org/fhir/SearchParameter/Group-code
excludestringhttp://hl7.org/fhir/SearchParameter/Group-exclude
identifierstringhttp://hl7.org/fhir/SearchParameter/Group-identifier
managing-entitystringhttp://hl7.org/fhir/SearchParameter/Group-managing-entity
memberstringhttp://hl7.org/fhir/SearchParameter/Group-member
namestringhttps://medplum.com/fhir/SearchParameter/Group-name
typestringhttp://hl7.org/fhir/SearchParameter/Group-type
valuestringhttp://hl7.org/fhir/SearchParameter/Group-value

Reference​

  • Official FHIR R4 spec: Group
  • Maturity: Trial Use 1 (FMM 1).