Managing Availability

The VCM system uses the concept of availability to determine if an appointment can be scheduled and for what purpose. You manage your telemedicine schedule by adding, editing, and removing availability blocks.

Note: This page is still being built out. If you don't see what you feel you need, please contact us for support.

Listing Availability Blocks

To see your scheduled availability, you can request a list of availability blocks entered in the system.

To use this endpoint, make a get request to v2.1/clinicians/availability-blocks?providerId=***. The "ProviderId" query string parameter is required and must be set to your provider ID. This is the same ID used as the "hospital" ID in other calls.

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:

startDate - (string) A string in ISO 8601 format representing a date or date and time for the beginning of your search.
endDate - (string) A string in ISO 8601 format representing a date or date and time for the end of your search.

It is important to set at least a startDate when requesting a list. If you do not provide either parameter, you will get back all appointments at all times for your site.

If you have appointments in the date range, you will get back an object with an array of availability blocks in the data field.

Note that you must provide a bearer authentication token for a user that has permission to view availability blocks for the provider.

Example:

The following example shows us requesting the availability blocks for one specific day.

Request

GET https://sandbox.connectedcare.md/api/v2.1/clinicians/availability-blocks?providerId=131&startDate=2016-05-06T00%3A00%3A00%2B0100&endDate=2016-05-06T23%3A59%3A59%2B0100

Headers Sent:

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

Response

Response Code (Success): 200 OK

{
  "data": [
    {
      "id": "9c114c90-2ec1-4506-b21b-768d142b23c8",
      "clinician": {
        "availabilityBlockId": "9c114c90-2ec1-4506-b21b-768d142b23c8",
        "createdByUserId": 687,
        "createdDate": "2016-05-03T19:28:47.373+01:00",
        "clinicianId": 31031,
        "locked": false,
        "private": false
      },
      "createdByUserId": 687,
      "createdDate": "2016-05-03T19:28:47.373+01:00",
      "endTime": "2016-05-06T13:00:00+01:00",
      "startTime": "2016-05-06T12:00:00+01:00",
      "allowOnDemandAppt": false,
      "allowProviderAppt": false,
      "allowSelfAppt": false,
      "isAllDay": false,
      "isAvailable": false,
      "optimizationTypeCode": 0
    },
    {
      "id": "6f54cd14-80bc-40b7-9ba7-89f8eb4546f2",
      "clinician": {
        "availabilityBlockId": "6f54cd14-80bc-40b7-9ba7-89f8eb4546f2",
        "createdByUserId": 687,
        "createdDate": "2016-05-03T19:28:14.967+01:00",
        "clinicianId": 31031,
        "locked": false,
        "private": false
      },
      "createdByUserId": 687,
      "createdDate": "2016-05-03T19:28:14.967+01:00",
      "endTime": "2016-05-06T12:00:00+01:00",
      "startTime": "2016-05-06T08:00:00+01:00",
      "allowOnDemandAppt": false,
      "allowProviderAppt": true,
      "allowSelfAppt": true,
      "isAllDay": false,
      "isAvailable": true,
      "optimizationTypeCode": 0
    }
  ],
  "total": 2
}

Contents

Managing Availability