Group

Overview

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.

This API supports the Group-level export FHIR Operation (i.e. GET [base url]/Group/[id]/$export). The '$export' operation is invoked using the FHIR Asynchronous Request Pattern. Refer to the FHIR Bulk Data Export Documentation for more information about Bulk Data Export.

Group By Id

Get Group by ID.

METHOD GET

[base url]/Group/[id]

[base url]/Group?_id=[id]

PARAMS
[base url] - FHIR base url
[id] - Id for Group resource

HEADERS

The Authorization token SHALL be obtained during Authentication and Authorization process. Goto Authentication and Authorization for further details.

Header	Type	Required/Optional	Value
Authorization	string	required	'Bearer'

RESPONSES

Code	Description	Comment
200	OK	The request was processed successfully
400	Bad request	Invalid request parameters or FHIR operation outcome resource returned
401	Unauthorized	This code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource
404	no Route matched with those values	The request was able to communicate with a given server, but the server could not find what was requested
500	Internal Server Error	The server has encountered a situation it doesn't know how to handle

EXAMPLE:

curl --location --request GET 'https://sandbox.fhir.elationemr.com/fhir/Group/a12b7cf5-1237-a31b-a31c-b1a3ba1fa0b2' \
--header 'Authorization: Bearer fe1cd986-1ac7-4c26-b8b3-d632a48408fd'

Operations

$export

FHIR Operation to obtain a detailed set of FHIR resources of diverse resource types pertaining to all patients in specified Group.