Staff Management

Staff Management

There are many tasks you can accomplish with staff accounts, and the below calls should cover most of what you will need in order to add staff into our system and manage them. You will need to be logged in as a user with the correct roles in order to use these calls.

Note: This page is still being built out. If you need to do tasks other than those listed here, please contact us for support.

Listing Staff accounts

Many calls, including checking for availability blocks and scheduling appointments require the ID/IDs of the provider in question.

To use this endpoint, make a get request to v2/clinicians/staffaccounts. There are many query string parameters you can use to narrow the list, but if you do not include any, you will get a full list. The optional query string parameters you can use include:

• staffNameFilter - (string required) A string that is used for a staff name search. Will do partial matches against all staff members.
• includePendingDoctors - (boolean) A boolean value that can toggle return of staff accounts that have not yet been activated. Defaults to true.
• includeDoctorsWithoutAppointmentPermission - (boolean) A boolean value that can toggle return of staff accounts that do not have appointment permission. Defaults to true.

Examples:

The following example shows us requesting all staff accounts.

Request

GET https://yourdomain.com/api/v2/clinicians/staffaccounts?staffNameFilter=john%20doe

Headers Sent:

• X-Developer-Id: ****
• X-Api-Key: ****
• Authorization: ****

Response

Response Code (Success): 200 OK

{
  "data": [
    {
      "staffId": 234,
      "userId": 31031,
      "profileImagePath": "/Images/Doctor-Female.gif",
      "fullName": "John Doe",
      "phone": "+15555551212",
      "isActivated": true,
      "emailId": "jdoe123@example.com",
      "canHaveConsultation": true,
      "personId": "278618fa-d553-46b2-849a-51bf07170873",
      "groupIds": [],
      "roleList": [
          "Provider",
            "Patient Presenter"
      ],
      "roles": "Provider, Patient Presenter"
    }
  ],
  "total": 1
}

---

The following example shows us creating a staff with "Patient Presenter" role

If organizations and locations are to be included, organization api should be called first to get the needed ids for the request.

GET v2/organizations

Request

POST https://yourservice.sandbox.connectedcare.md/api/v2/clinicians/staffprofile

Headers Sent:

• X-Developer-Id: ****
• X-Api-Key: ****
• Authorization: ****

Payload:

{
	"userDetails":{
		"firstName":"Presenter 1",
		"lastName":"Staff",
		"email":"jdoe+pp1@example.com",
		"phoneNumber":"+12135551212",
		"cellPhoneNumber":"+13105551212",
		"timeZoneId":83,
		"receiveTextAlerts":false
	},
	"doctorProfileDetails": {
		"dob": "1990-01-01",
		"practicingSinceYear": 2010,
		"department": ""
	},
	"roles":[{"description":"Patient Presenter"}],
	"tags":""
}

Response

Response Code (Success): 200 OK

{
    "data": [
        {
            "userId": 2396
        }
    ],
    "total": 1
}