Skip to main content

AvailableSlotsResponse

Description

This is the format of the response you will receive for a AvailableSlots query.

API endpoints for

Sync REST API Endpoint to call the API: https://{base_url}/api/v1/scheduling/available-slots-response.

Async REST API Endpoint to call the API: https://{base_url}/api/v1/endpoint.

Data Model JSON for AvailableSlotsResponse​

AvailableSlotsResponse - Sample Payload
{
   "Meta": {
      "DataModel": "Scheduling",
      "EventType": "AvailableSlotsResponse",
      "EventDateTime": "2022-08-16T14:21:20.733Z",
      "Test": true,
      "Source": {
         "ID": "8e3c3607-0f19-40a0-875d-79c2377bc7fd ",
         "Name": "EHR Bridge Dev Tools"
      },
      "Destinations": [
         {
            "ID": "8e3c3607-0f19-40a0-875d-79c2377bc7fd ",
            "Name": "Destinations EMR"
         }
      ],
      "Logs": [
         {
            "ID": "2e776702-3769-490a-a0d8-5cd21c7c8ac4",
            "AttemptID": "c32bf04a-938a-4207-8026-86c38ca977e4"
         }
      ],
      "Message": {
         "ID": 5565
      },
      "Transmission": {
         "ID": 12414
      },
      "FacilityCode": null,
      "IsIncomplete": false
   },
   "AvailableSlots": [
      {
         "ID": null,
         "DateTime": "2016-08-01T10:00:00Z",
         "Reason": "Follow Up",
         "Duration": 15,
         "Provider": {
            "ID": "4356789876",
            "IDType": "NPI",
            "FirstName": "Bobby",
            "LastName": "Grant",
            "Credentials": [
               "MD"
            ],
            "Address": {
               "StreetAddress": "123 Main St.",
               "City": "San Jose"",
               "State": "CA",
               "ZIP": "53703",
               "County": "Santa Clara",
               "Country": "USA"
            },
            "EmailAddresses": [],
            "PhoneNumber": {
               "Office": "+16085551234"
            },
            "Location": {
               "Type": null,
               "Facility": null,
               "Department": null,
               "Room": null
            }
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": "Clinic A",
            "Room": null
         },
         "Notes": []
      },
      {
         "ID": null,
         "DateTime": "2016-08-01T11:00:00Z",
         "Reason": "Follow Up",
         "Duration": 15,
         "Provider": {
            "ID": "4356789876",
            "IDType": "NPI",
            "FirstName": "Bobby",
            "LastName": "Grant",
            "Credentials": [
               "MD"
            ],
            "Address": {
               "StreetAddress": "123 Main St.",
               "City": "San Jose"",
               "State": "CA",
               "ZIP": "53703",
               "County": "Santa Clara",
               "Country": "USA"
            },
            "EmailAddresses": [],
            "PhoneNumber": {
               "Office": "+16085551234"
            },
            "Location": {
               "Type": null,
               "Facility": null,
               "Department": null,
               "Room": null
            }
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": "Clinic A",
            "Room": null
         },
         "Notes": []
      },
      {
         "ID": null,
         "DateTime": "2016-08-01T12:00:00Z",
         "Reason": "Follow Up",
         "Duration": 15,
         "Provider": {
            "ID": "4356789876",
            "IDType": "NPI",
            "FirstName": "Bobby",
            "LastName": "Grant",
            "Credentials": [
               "MD"
            ],
            "Address": {
               "StreetAddress": "123 Main St.",
               "City": "San Jose"",
               "State": "CA",
               "ZIP": "53703",
               "County": "Santa Clara",
               "Country": "USA"
            },
            "EmailAddresses": [],
            "PhoneNumber": {
               "Office": "+16085551234"
            },
            "Location": {
               "Type": null,
               "Facility": null,
               "Department": null,
               "Room": null
            }
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": "Clinic A",
            "Room": null
         },
         "Notes": []
      },
      {
         "ID": null,
         "DateTime": "2016-08-01T13:00:00Z",
         "Reason": "Follow Up",
         "Duration": 15,
         "Provider": {
            "ID": "4356789876",
            "IDType": "NPI",
            "FirstName": "Bobby",
            "LastName": "Grant",
            "Credentials": [
               "MD"
            ],
            "Address": {
               "StreetAddress": "123 Main St.",
               "City": "San Jose"",
               "State": "CA",
               "ZIP": "53703",
               "County": "Santa Clara",
               "Country": "USA"
            },
            "EmailAddresses": [],
            "PhoneNumber": {
               "Office": "+16085551234"
            },
            "Location": {
               "Type": null,
               "Facility": null,
               "Department": null,
               "Room": null
            }
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": "Clinic A",
            "Room": null
         },
         "Notes": []
      }
   ]
}