Patient Group API Request Response Structures

Patient Group API Request / Response Structures

Depending on the API method, only a part of field set can be used.

---

PatientsGroupRequest

Name	Description	Type	Additional information
PatientsIds	Ids of patients method operates on.	Collection of integer	None.
GroupId	Id of group method operates on.	integer	None.
GroupsIds	Ids of groups method operates on.	Collection of integer	None.
Name	Name of the group	string	None.
Description	Description of the group	string	None.
StatusCode	Status of the group	GlobalStatusCode	None.
ParentGroupId	Id of the parent group in the hierarchy	integer	None.

Sample:

{
  "patientsIds": [
    1,
    2
  ],
  "groupId": 1,
  "groupsIds": [
    1,
    2
  ],
  "name": "sample string 1",
  "description": "sample string 2",
  "statusCode": 0,
  "parentGroupId": 1
}

---

PatientsGroupResponse

Name	Description	Type	Additional information
PatientId		integer	None.
HospitalId	Id of the hospital holding the group	integer	None.
ModifiedDate	The time when the group was modified lately.	date	None.
SubGroups	List of subgroups. May not be used for some API methods.	Collection of PatientsGroupResponse	None.
Members	Patients assigned to this group. May not be used for some API methods.	Collection of PatientProfilesResult	None.
PatientsIds	Ids of patients method operates on.	Collection of integer	None.
GroupId	Id of group method operates on.	integer	None.
GroupsIds	Ids of groups method operates on.	Collection of integer	None.
Name	Name of the group	string	None.
Description	Description of the group	string	None.
StatusCode	Status of the group	GlobalStatusCode	None.
ParentGroupId	Id of the parent group in the hierarchy	integer	None.

Sample:

{
  "patientId": 1,
  "hospitalId": 1,
  "modifiedDate": "2018-02-22T19:52:47.5717781Z",
  "subGroups": [
    {
      "$ref": "1"
    },
    {
      "$ref": "1"
    }
  ],
  "members": [
    {
      "$id": "2",
      "profileId": 1,
      "hospitalId": 1,
      "firstName": "sample string 2",
      "lastName": "sample string 3",
      "gender": "sample string 4",
      "profileImagePath": "sample string 5",
      "dob": "sample string 6"
    },
    {
      "$ref": "2"
    }
  ],
  "patientsIds": [
    1,
    2
  ],
  "groupId": 1,
  "groupsIds": [
    1,
    2
  ],
  "name": "sample string 1",
  "description": "sample string 2",
  "statusCode": 0,
  "parentGroupId": 1
}

---

List of PatientsGroupResponse

Name	Description	Type	Additional information
Data	The payload being returned to the requestor.	Collection of PatientsGroupResponse	None.
Message	An optional message that may be useful if the response code is greater than 200 and less than 300 but needs more explanation.	string	None.
Total	Used in paginated requests to indicate the number of records available. This feature is not enabled for all calls, so please contact developer support for more information.	integer	None.

Sample:

{
  "data": [
    {
      "$id": "2",
      "patientId": 1,
      "hospitalId": 1,
      "modifiedDate": "2018-02-22T22:34:44.8499857Z",
      "subGroups": [
        {
          "$ref": "2"
        },
        {
          "$ref": "2"
        }
      ],
      "members": [
        {
          "$id": "3",
          "profileId": 1,
          "hospitalId": 1,
          "firstName": "sample string 2",
          "lastName": "sample string 3",
          "gender": "sample string 4",
          "profileImagePath": "sample string 5",
          "dob": "sample string 6"
        },
        {
          "$ref": "3"
        }
      ],
      "patientsIds": [
        1,
        2
      ],
      "groupId": 1,
      "groupsIds": [
        1,
        2
      ],
      "name": "sample string 1",
      "description": "sample string 2",
      "statusCode": 0,
      "parentGroupId": 1
    },
    {
      "$ref": "2"
    }
  ],
  "message": "sample string 1",
  "total": 1
}