Skip to main content

Booked

Description

This query is used to search for booked appointments within a specified time range. The response for this query will provide information about the appointments that have been booked within the specified time range, including details such as patient demographics, appointment time, and appointment status.

API endpoints for Booked Appointments

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

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

Data Model JSON for Booked​

Booked - Sample Payload
{
   "Meta": {
      "DataModel": "Scheduling",
      "EventType": "Booked",
      "EventDateTime": "2022-08-16T14:21:20.733Z",
      "Test": true,
      "Destinations": [
         {
            "ID": "aeced692-dc42-4718-8db3-608e3049557d",
            "Name": "Destinations EMR"
         }
      ],
      "Logs": [
         {
            "ID": "4e7e048e-29d3-403e-a34e-e344cb392180 ",
            "AttemptID": "d265e840-a20b-479b-8767-063d0fd0f58d "
         }
      ],
      "FacilityCode": null
   },
   "StartDateTime": "2022-08-16T14:21:21.708Z",
   "EndDateTime": null,
   "Visit": {
      "Reason": null,
      "VisitNumber": null,
      "AttendingProviders": [
         {
            "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
            }
         }
      ],
      "VisitProvider": {
         "ID": null,
         "IDType": null,
         "FirstName": null,
         "LastName": null,
         "Credentials": [],
         "Address": {
            "StreetAddress": null,
            "City": null,
            "State": null,
            "ZIP": null,
            "County": null,
            "Country": null
         },
         "EmailAddresses": [],
         "PhoneNumber": {
            "Office": null
         },
         "Location": {
            "Type": null,
            "Facility": null,
            "Department": null,
            "Room": null
         }
      },
      "Location": {
         "Type": null,
         "Facility": null,
         "Department": null,
         "Room": null
      },
      "Patients": [
         {
            "Identifiers": [
               {
                  "ID": "0000000001",
                  "IDType": "MR"
               },
               {
                  "ID": "c3ae8712-5bc2-481e-a150-75f9f83ddd8f ",
                  "IDType": "EHRID"
               },
               {
                  "ID": "ebe8bd26-d59c-4dec-9c63-d5bc70cf2c2e",
                  "IDType": "NIST"
               }
            ]
         }
      ]
   }
}