groups

Create Group

post
/organizations/{organizationId}/fhir/3/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.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringGroupThis is a Group resource
identifierarray(Identifier)A unique business identifier for this group.
activebooleanIndicates whether the record for the group is available for use or is merely being retained for historical purposes.
typestringperson|animal|practitioner|device|medication|substanceIdentifies the broad classification of the kind of resources the group includes.
actualbooleanIf true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals.
codeCodeableConceptProvides a specific type of resource the group includes; e.g. "cow", "syringe", etc.
namestringA label assigned to the group for human identification and communication.
quantitynumberA count of the number of resource instances that are part of the group.
characteristicarray(Group_Characteristic)Identifies the traits shared by members of the group.
memberarray(Group_Member)Identifies the resource instances that are members of the group.

Response

Patch Group

patch
/organizations/{organizationId}/fhir/3/Group/{resourceId}

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.

Request

Headers

content-type*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringGroupThis is a Group resource
identifierarray(Identifier)A unique business identifier for this group.
activebooleanIndicates whether the record for the group is available for use or is merely being retained for historical purposes.
typestringperson|animal|practitioner|device|medication|substanceIdentifies the broad classification of the kind of resources the group includes.
actualbooleanIf true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals.
codeCodeableConceptProvides a specific type of resource the group includes; e.g. "cow", "syringe", etc.
namestringA label assigned to the group for human identification and communication.
quantitynumberA count of the number of resource instances that are part of the group.
characteristicarray(Group_Characteristic)Identifies the traits shared by members of the group.
memberarray(Group_Member)Identifies the resource instances that are members of the group.

Response

Read Group

get
/organizations/{organizationId}/fhir/3/Group/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Group

get
/organizations/{organizationId}/fhir/3/Group/{resourceId}/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Group

get
/organizations/{organizationId}/fhir/3/Group/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Group

delete
/organizations/{organizationId}/fhir/3/Group/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Group

get
/organizations/{organizationId}/fhir/3/Group

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
actualstring
characteristicstring
characteristic-valuestring
codestring
excludestring
identifierstring
memberstring
typestring
valuestring

Params

organizationId*string|stringid|slug

Response

Search History Group

get
/organizations/{organizationId}/fhir/3/Group/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

Search Post Group

post
/organizations/{organizationId}/fhir/3/Group/_search

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.

Request

Headers

content-type*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
actualstring
characteristicstring
characteristic-valuestring
codestring
excludestring
identifierstring
memberstring
typestring
valuestring

Params

organizationId*string|stringid|slug

Body

resourceType*stringGroupThis is a Group resource
identifierarray(Identifier)A unique business identifier for this group.
activebooleanIndicates whether the record for the group is available for use or is merely being retained for historical purposes.
typestringperson|animal|practitioner|device|medication|substanceIdentifies the broad classification of the kind of resources the group includes.
actualbooleanIf true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals.
codeCodeableConceptProvides a specific type of resource the group includes; e.g. "cow", "syringe", etc.
namestringA label assigned to the group for human identification and communication.
quantitynumberA count of the number of resource instances that are part of the group.
characteristicarray(Group_Characteristic)Identifies the traits shared by members of the group.
memberarray(Group_Member)Identifies the resource instances that are members of the group.

Response

Update Group

put
/organizations/{organizationId}/fhir/3/Group/{resourceId}

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.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringGroupThis is a Group resource
identifierarray(Identifier)A unique business identifier for this group.
activebooleanIndicates whether the record for the group is available for use or is merely being retained for historical purposes.
typestringperson|animal|practitioner|device|medication|substanceIdentifies the broad classification of the kind of resources the group includes.
actualbooleanIf true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals.
codeCodeableConceptProvides a specific type of resource the group includes; e.g. "cow", "syringe", etc.
namestringA label assigned to the group for human identification and communication.
quantitynumberA count of the number of resource instances that are part of the group.
characteristicarray(Group_Characteristic)Identifies the traits shared by members of the group.
memberarray(Group_Member)Identifies the resource instances that are members of the group.

Response