groups

Create Group

post

/organizations/{organizationId}/fhir/4/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*			This is a Group resource
id	id		The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta		The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules	uri		A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language	code		The base language in which the resource is written.
text	Narrative		A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
contained	array(ResourceList)		These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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		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	unsignedInt		A count of the number of resource instances that are part of the group.
managingEntity	Reference		Entity responsible for defining and maintaining Group characteristics and/or registered members.
characteristic	array(Group_Characteristic)		Identifies traits whose presence r absence is 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/4/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*			This is a Group resource
id	id		The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta		The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules	uri		A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language	code		The base language in which the resource is written.
text	Narrative		A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
contained	array(ResourceList)		These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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		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	unsignedInt		A count of the number of resource instances that are part of the group.
managingEntity	Reference		Entity responsible for defining and maintaining Group characteristics and/or registered members.
characteristic	array(Group_Characteristic)		Identifies traits whose presence r absence is 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/4/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/4/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/4/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/4/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/4/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
managing-entity	string
member	string
type	string
value	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search History Group

get

/organizations/{organizationId}/fhir/4/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/4/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
managing-entity	string
member	string
type	string
value	string

Params


organizationId*	string\|string		id\|slug

Body


resourceType*			This is a Group resource
id	id		The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta		The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules	uri		A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language	code		The base language in which the resource is written.
text	Narrative		A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
contained	array(ResourceList)		These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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		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	unsignedInt		A count of the number of resource instances that are part of the group.
managingEntity	Reference		Entity responsible for defining and maintaining Group characteristics and/or registered members.
characteristic	array(Group_Characteristic)		Identifies traits whose presence r absence is 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/4/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*			This is a Group resource
id	id		The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta		The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules	uri		A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language	code		The base language in which the resource is written.
text	Narrative		A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
contained	array(ResourceList)		These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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		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	unsignedInt		A count of the number of resource instances that are part of the group.
managingEntity	Reference		Entity responsible for defining and maintaining Group characteristics and/or registered members.
characteristic	array(Group_Characteristic)		Identifies traits whose presence r absence is 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