AvailableSlots

Description

This query is used to search for available appointment slots within a specified time range. The response for this query will provide information about the available appointment times, which can be used for booking appointments.

API endpoints for Available slots

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

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

Data Model JSON for AvailableSlots

AvailableSlots - Sample Payload

{
   "Meta": {
      "DataModel": "Scheduling",
      "EventType": "AvailableSlots",
      "EventDateTime": "2022-08-16T14:21:20.733Z",
      "Test": true,
      "Destinations": [
         {
            "ID": "8e3c3607-0f19-40a0-875d-79c2377bc7fd ",
            "Name": "Destinations EMR"
         }
      ],
      "Logs": [
         {
            "ID": "2e776702-3769-490a-a0d8-5cd21c7c8ac4",
            "AttemptID": "c32bf04a-938a-4207-8026-86c38ca977e4"
         }
      ],
      "FacilityCode": null
   },
   "Patient": {
      "Identifiers": [
         {
            "ID": "0000000001",
            "IDType": "MR"
         },
         {
            "ID": "53184619-486f-4ec3-a8e2-61047291f237 ",
            "IDType": "EHRID"
         },
         {
            "ID": "b94fb34f-2cd1-435c-a460-8206ac67aac9",
            "IDType": "NIST"
         }
      ],
      "Demographics": {
         "FirstName": "James",
         "MiddleName": "Alex",
         "LastName": "Smith",
         "DOB": "2008-01-06",
         "SSN": "101-01-0001",
         "Sex": "Male",
         "Race": "White",
         "IsHispanic": null,
         "Religion": null,
         "MaritalStatus": "Single",
         "IsDeceased": null,
         "DeathDateTime": null,
         "PhoneNumber": {
            "Home": "+18088675301",
            "Office": null,
            "Mobile": null
         },
         "EmailAddresses": [],
         "Language": "en",
         "Citizenship": [],
         "Address": {
            "StreetAddress": "4762 Hill Street",
            "City": "San Jose"",
            "State": "CA",
            "ZIP": "53566",
            "County": "Santa Clara",
            "Country": "USA"
         }
      },
      "Notes": [],
      "Diagnoses": [
         {
            "Code": "R07.0",
            "Codeset": "ICD-10",
            "Name": "Throat infection",
            "Type": null,
            "DocumentedDateTime": null
         }
      ]
   },
   "StartDateTime": "2022-08-16T14:21:21.696Z",
   "EndDateTime": null,
   "Visit": {
      "Reasons": [
         "Check up"
      ],
      "AttendingProviders": [],
      "Locations": [
         {
            "Type": "Inpatient",
            "Facility": "MGM Hospital",
            "Department": "3N",
            "SpecialtyDepartment": {
               "Code": null,
               "Codeset": null,
               "Description": null
            },
            "Room": "136",
            "ID": null
         }
      ],
      "VisitType": [
         {
            "Code": "210",
            "Codeset": "DNER15",
            "Description": "Office Visit"
         }
      ],
      "VisitPreference": [
         {
            "Duration": "30",
            "DurationUnit": "minutes",
            "Day": [
               "Tues",
               "Fri"
            ],
            "Time": [
               "1000"
            ]
         }
      ]
   }
}