Provider Group API Request Response Structures

Provider Group API Request / Response Structures

---

ClinicianGroupRequest

Group information to create/modify. All properties are used, but when updating existing group, only non-null properties are used.

Name	Description	Type	Additional information
ClinicianIds	User ids of providers 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:
{
  "clinicianIds": [
    1,
    2
  ],
  "groupId": 1,
  "groupsIds": [
    1,
    2
  ],
  "name": "sample string 1",
  "description": "sample string 2",
  "statusCode": 0,
  "parentGroupId": 1
}

---

ClinicianGroupResponse

The group content after it was created/updated. SubGroups and Members properties are also filled, so actually entire subtree is returned.

Name	Description	Type	Additional information
ClinicianId		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 ClinicianGroupResponse	None.
Members	Providers assigned to this group. May not be used for some API methods.	Collection of ClinicianProfilesResult	None.
ClinicianIds	User ids of providers 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:

{
  "clinicianId": 1,
  "hospitalId": 1,
  "modifiedDate": "2018-02-22T21:50:17.0578752Z",
  "subGroups": [
    {
      "$ref": "1"
    },
    {
      "$ref": "1"
    }
  ],
  "members": [
    {
      "$id": "2",
      "profileId": 1,
      "clinicianId": 1,
      "businessAddress": "sample string 1",
      "firstName": "sample string 2",
      "fullName": "sample string 2 sample string 6",
      "email": "sample string 3",
      "gender": "sample string 4",
      "hospitalId": 5,
      "lastName": "sample string 6",
      "medicalLicense": "sample string 7",
      "medicalSpeciality": "sample string 8",
      "medicalSchool": "sample string 9",
      "profileImage": "sample string 10",
      "profileImagePath": "sample string 10",
      "statesLicenced": "sample string 11",
      "subSpeciality": "sample string 12",
      "dob": "2018-02-22T21:50:17.0578752Z"
    },
    {
      "$ref": "2"
    }
  ],
  "clinicianIds": [
    1,
    2
  ],
  "groupId": 1,
  "groupsIds": [
    1,
    2
  ],
  "name": "sample string 1",
  "description": "sample string 2",
  "statusCode": 0,
  "parentGroupId": 1
}

---

List of ClinicianGroupResponse

If clinicianId!=null, returns a list of all groups at any hierarchy level, where that provider is assigned.
If clinicianId==null, returns a list of all top-level groups along with their members and subgroups.

Name	Description	Type	Additional information
Data	The payload being returned to the requestor.	Collection of ClinicianGroupResponse	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",
      "clinicianId": 1,
      "hospitalId": 1,
      "modifiedDate": "2018-02-22T22:19:27.2551639Z",
      "subGroups": [
        {
          "$ref": "2"
        },
        {
          "$ref": "2"
        }
      ],
      "members": [
        {
          "$id": "3",
          "profileId": 1,
          "clinicianId": 1,
          "businessAddress": "sample string 1",
          "firstName": "sample string 2",
          "fullName": "sample string 2 sample string 6",
          "email": "sample string 3",
          "gender": "sample string 4",
          "hospitalId": 5,
          "lastName": "sample string 6",
          "medicalLicense": "sample string 7",
          "medicalSpeciality": "sample string 8",
          "medicalSchool": "sample string 9",
          "profileImage": "sample string 10",
          "profileImagePath": "sample string 10",
          "statesLicenced": "sample string 11",
          "subSpeciality": "sample string 12",
          "dob": "2018-02-22T22:19:27.2551639Z"
        },
        {
          "$ref": "3"
        }
      ],
      "clinicianIds": [
        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
}