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*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug

Body


resourceType*	string	Group	This is a Group resource
identifier	array(Identifier)		A unique business identifier for this group.
active	boolean		Indicates whether the record for the group is available for use or is merely being retained for historical purposes.
type	string	person\|animal\|practitioner\|device\|medication\|substance	Identifies the broad classification of the kind of resources the group includes.
actual	boolean		If true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals.
code	CodeableConcept		Provides a specific type of resource the group includes; e.g. "cow", "syringe", etc.
name	string		A label assigned to the group for human identification and communication.
quantity	number		A count of the number of resource instances that are part of the group.
characteristic	array(Group_Characteristic)		Identifies the traits shared by members of the group.
member	array(Group_Member)		Identifies the resource instances that are members of the group.

Response

201 400 401 404

Patch Group

patch

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

Request

Headers


content-type*	string	application/json-patch+json	application/json-patch+json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*	string	Group	This is a Group resource
identifier	array(Identifier)		A unique business identifier for this group.
active	boolean		Indicates whether the record for the group is available for use or is merely being retained for historical purposes.
type	string	person\|animal\|practitioner\|device\|medication\|substance	Identifies the broad classification of the kind of resources the group includes.
actual	boolean		If true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals.
code	CodeableConcept		Provides a specific type of resource the group includes; e.g. "cow", "syringe", etc.
name	string		A label assigned to the group for human identification and communication.
quantity	number		A count of the number of resource instances that are part of the group.
characteristic	array(Group_Characteristic)		Identifies the traits shared by members of the group.
member	array(Group_Member)		Identifies the resource instances that are members of the group.

Response

200 201 400 401 404 409

Read Group

get

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 401 404

Read History Group

get

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_count	string
_since	string

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 401 404

Read Version Group

get

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string	id\|slug
resourceId*
versionId*

Response

200 400 401 404

Remove Group

delete

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 204 400 401 404 409

Search Get Group

get

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_id	string
_language	string
actual	string
characteristic	string
characteristic-value	string
code	string
exclude	string
identifier	string
member	string
type	string
value	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search History Group

get

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_count	string
_since	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search Post Group

post

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

Request

Headers


content-type*	string	application/json\|application/x-www-form-urlencoded	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_id	string
_language	string
actual	string
characteristic	string
characteristic-value	string
code	string
exclude	string
identifier	string
member	string
type	string
value	string

Params


organizationId*	string\|string		id\|slug

Body


resourceType*	string	Group	This is a Group resource
identifier	array(Identifier)		A unique business identifier for this group.
active	boolean		Indicates whether the record for the group is available for use or is merely being retained for historical purposes.
type	string	person\|animal\|practitioner\|device\|medication\|substance	Identifies the broad classification of the kind of resources the group includes.
actual	boolean		If true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals.
code	CodeableConcept		Provides a specific type of resource the group includes; e.g. "cow", "syringe", etc.
name	string		A label assigned to the group for human identification and communication.
quantity	number		A count of the number of resource instances that are part of the group.
characteristic	array(Group_Characteristic)		Identifies the traits shared by members of the group.
member	array(Group_Member)		Identifies the resource instances that are members of the group.

Response

200 401 404

Update Group

put

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*	string	Group	This is a Group resource
identifier	array(Identifier)		A unique business identifier for this group.
active	boolean		Indicates whether the record for the group is available for use or is merely being retained for historical purposes.
type	string	person\|animal\|practitioner\|device\|medication\|substance	Identifies the broad classification of the kind of resources the group includes.
actual	boolean		If true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals.
code	CodeableConcept		Provides a specific type of resource the group includes; e.g. "cow", "syringe", etc.
name	string		A label assigned to the group for human identification and communication.
quantity	number		A count of the number of resource instances that are part of the group.
characteristic	array(Group_Characteristic)		Identifies the traits shared by members of the group.
member	array(Group_Member)		Identifies the resource instances that are members of the group.

Response

200 201 400 401 404 409