GET api/ProviderService/WaitingPatients?practiceID={practiceID}&userEntityID={userEntityID}

Get Waiting Patients

Request Information

URI Parameters

Name	Description	Type	Additional information
practiceID		globally unique identifier	Required
userEntityID		globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

Collection of AppointmentInfo

Name	Type	Additional information
NewPatient	boolean	None.
Appointment_Id	globally unique identifier	None.
Appointment_Type_Id	integer	None.
Title	string	None.
Start_Date	date	None.
End_Date	date	None.
Duration	decimal number	None.
Description	string	None.
Priority	string	None.
Appointment_Status_Id	integer	None.
Parent_Appointment_Id	integer	None.
Cancelled_On	date	None.
Cancelled_By	string	None.
Cancelled_Reason	string	None.
Patient_Id	globally unique identifier	None.
Practice_Id	globally unique identifier	None.
Provider_Id	globally unique identifier	None.
Recurrence_Id	string	None.
Recurrence_Rule	string	None.
Recurrence_Exception	string	None.
Is_All_Day	boolean	None.
Start_Timezone	integer	None.
End_Timezone	integer	None.
Full_Name	string	None.
Mobile_Number	string	None.
InConsult_Id	globally unique identifier	None.
Arrival_Date	date	None.
WaitingTime	integer	None.
InConsultTime	integer	None.
AppointmentStatus	string	None.
InConsult_EndDate	date	None.
History	string	None.
Examination	string	None.
Diagnosis	string	None.
Treatment_Plan	string	None.
Room_Id	globally unique identifier	None.
Room_Name	string	None.
ImageName	string	None.
Default_UI_Color	string	None.
ProviderUserName	string	None.
ProviderFullName	string	None.
ExtraInfo	string	None.
FacilityID	globally unique identifier	None.
FacilityName	string	None.
Consulted	boolean	None.
Appt_Room_Id	globally unique identifier	None.
CheckIn_DateInitial	date	None.
PatientFlags	string	None.
Billing_Amount	decimal number	None.
Billing_Msg	string	None.
MRNValue	string	None.
MRN_Seed	integer	None.
DOB	date	None.
First_Name	string	None.
Middle_Name	string	None.
Sur_Name	string	None.
Maiden_Name	string	None.
IsNewPatientAppointment	boolean	None.
InitialCheckInTime	string	None.
taskId	globally unique identifier	None.
IsInWaitingRoom	boolean	None.
PatientName	string	None.
Patient_Name	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "NewPatient": true,
    "Appointment_Id": "aae831e9-d55c-4ce5-a00f-6926a58c9be0",
    "Appointment_Type_Id": 1,
    "Title": "sample string 2",
    "Start_Date": "2025-06-08T01:38:29.1619366+00:00",
    "End_Date": "2025-06-08T01:38:29.1619366+00:00",
    "Duration": 1.1,
    "Description": "sample string 4",
    "Priority": "sample string 5",
    "Appointment_Status_Id": 1,
    "Parent_Appointment_Id": 1,
    "Cancelled_On": "2025-06-08T01:38:29.1619366+00:00",
    "Cancelled_By": "sample string 6",
    "Cancelled_Reason": "sample string 7",
    "Patient_Id": "7968af1c-ece2-4870-811c-c679d2a1a801",
    "Practice_Id": "7672b0ef-6d0a-4cfa-9281-57af75b1206b",
    "Provider_Id": "45068f46-f26b-4522-af78-f1c0bd2ce045",
    "Recurrence_Id": "sample string 11",
    "Recurrence_Rule": "sample string 12",
    "Recurrence_Exception": "sample string 13",
    "Is_All_Day": true,
    "Start_Timezone": 1,
    "End_Timezone": 1,
    "Full_Name": "sample string 14",
    "Mobile_Number": "sample string 15",
    "InConsult_Id": "8f538da0-02ff-41e2-bc80-57b5651499bb",
    "Arrival_Date": "2025-06-08T01:38:29.1619366+00:00",
    "WaitingTime": 1,
    "InConsultTime": 1,
    "AppointmentStatus": "sample string 16",
    "InConsult_EndDate": "2025-06-08T01:38:29.1619366+00:00",
    "History": "sample string 17",
    "Examination": "sample string 18",
    "Diagnosis": "sample string 19",
    "Treatment_Plan": "sample string 20",
    "Room_Id": "4b9e0d66-d49f-421c-a63a-a00d38731390",
    "Room_Name": "sample string 21",
    "ImageName": "sample string 22",
    "Default_UI_Color": "sample string 23",
    "ProviderUserName": "sample string 24",
    "ProviderFullName": "sample string 25",
    "ExtraInfo": "sample string 26",
    "FacilityID": "be11e82c-2d38-430c-8a4e-9c6ff1dcbefd",
    "FacilityName": "sample string 27",
    "Consulted": true,
    "Appt_Room_Id": "e5984c28-c2e6-42dd-b9a1-ce2b4a5a385c",
    "CheckIn_DateInitial": "2025-06-08T01:38:29.1619366+00:00",
    "PatientFlags": "sample string 28",
    "Billing_Amount": 29.1,
    "Billing_Msg": "sample string 30",
    "MRNValue": "sample string 31",
    "MRN_Seed": 32,
    "DOB": "2025-06-08T01:38:29.1619366+00:00",
    "First_Name": "sample string 33",
    "Middle_Name": "sample string 34",
    "Sur_Name": "sample string 35",
    "Maiden_Name": "sample string 36",
    "IsNewPatientAppointment": true,
    "InitialCheckInTime": "sample string 37",
    "taskId": "aae831e9-d55c-4ce5-a00f-6926a58c9be0",
    "IsInWaitingRoom": true,
    "PatientName": "sample string 39",
    "Patient_Name": "sample string 39"
  },
  {
    "NewPatient": true,
    "Appointment_Id": "aae831e9-d55c-4ce5-a00f-6926a58c9be0",
    "Appointment_Type_Id": 1,
    "Title": "sample string 2",
    "Start_Date": "2025-06-08T01:38:29.1619366+00:00",
    "End_Date": "2025-06-08T01:38:29.1619366+00:00",
    "Duration": 1.1,
    "Description": "sample string 4",
    "Priority": "sample string 5",
    "Appointment_Status_Id": 1,
    "Parent_Appointment_Id": 1,
    "Cancelled_On": "2025-06-08T01:38:29.1619366+00:00",
    "Cancelled_By": "sample string 6",
    "Cancelled_Reason": "sample string 7",
    "Patient_Id": "7968af1c-ece2-4870-811c-c679d2a1a801",
    "Practice_Id": "7672b0ef-6d0a-4cfa-9281-57af75b1206b",
    "Provider_Id": "45068f46-f26b-4522-af78-f1c0bd2ce045",
    "Recurrence_Id": "sample string 11",
    "Recurrence_Rule": "sample string 12",
    "Recurrence_Exception": "sample string 13",
    "Is_All_Day": true,
    "Start_Timezone": 1,
    "End_Timezone": 1,
    "Full_Name": "sample string 14",
    "Mobile_Number": "sample string 15",
    "InConsult_Id": "8f538da0-02ff-41e2-bc80-57b5651499bb",
    "Arrival_Date": "2025-06-08T01:38:29.1619366+00:00",
    "WaitingTime": 1,
    "InConsultTime": 1,
    "AppointmentStatus": "sample string 16",
    "InConsult_EndDate": "2025-06-08T01:38:29.1619366+00:00",
    "History": "sample string 17",
    "Examination": "sample string 18",
    "Diagnosis": "sample string 19",
    "Treatment_Plan": "sample string 20",
    "Room_Id": "4b9e0d66-d49f-421c-a63a-a00d38731390",
    "Room_Name": "sample string 21",
    "ImageName": "sample string 22",
    "Default_UI_Color": "sample string 23",
    "ProviderUserName": "sample string 24",
    "ProviderFullName": "sample string 25",
    "ExtraInfo": "sample string 26",
    "FacilityID": "be11e82c-2d38-430c-8a4e-9c6ff1dcbefd",
    "FacilityName": "sample string 27",
    "Consulted": true,
    "Appt_Room_Id": "e5984c28-c2e6-42dd-b9a1-ce2b4a5a385c",
    "CheckIn_DateInitial": "2025-06-08T01:38:29.1619366+00:00",
    "PatientFlags": "sample string 28",
    "Billing_Amount": 29.1,
    "Billing_Msg": "sample string 30",
    "MRNValue": "sample string 31",
    "MRN_Seed": 32,
    "DOB": "2025-06-08T01:38:29.1619366+00:00",
    "First_Name": "sample string 33",
    "Middle_Name": "sample string 34",
    "Sur_Name": "sample string 35",
    "Maiden_Name": "sample string 36",
    "IsNewPatientAppointment": true,
    "InitialCheckInTime": "sample string 37",
    "taskId": "aae831e9-d55c-4ce5-a00f-6926a58c9be0",
    "IsInWaitingRoom": true,
    "PatientName": "sample string 39",
    "Patient_Name": "sample string 39"
  }
]

application/xml, text/xml

Sample:

<ArrayOfAppointmentInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CSP.EMRContexts.Common.ViewModels">
  <AppointmentInfo>
    <AppointmentStatus>sample string 16</AppointmentStatus>
    <Appointment_Id>aae831e9-d55c-4ce5-a00f-6926a58c9be0</Appointment_Id>
    <Appointment_Status_Id>1</Appointment_Status_Id>
    <Appointment_Type_Id>1</Appointment_Type_Id>
    <Appt_Room_Id>e5984c28-c2e6-42dd-b9a1-ce2b4a5a385c</Appt_Room_Id>
    <Arrival_Date>2025-06-08T01:38:29.1619366+00:00</Arrival_Date>
    <Billing_Amount>29.1</Billing_Amount>
    <Billing_Msg>sample string 30</Billing_Msg>
    <Cancelled_By>sample string 6</Cancelled_By>
    <Cancelled_On>2025-06-08T01:38:29.1619366+00:00</Cancelled_On>
    <Cancelled_Reason>sample string 7</Cancelled_Reason>
    <CheckIn_DateInitial>2025-06-08T01:38:29.1619366+00:00</CheckIn_DateInitial>
    <Consulted>true</Consulted>
    <DOB>2025-06-08T01:38:29.1619366+00:00</DOB>
    <Default_UI_Color>sample string 23</Default_UI_Color>
    <Description>sample string 4</Description>
    <Diagnosis>sample string 19</Diagnosis>
    <Duration>1.1</Duration>
    <End_Date>2025-06-08T01:38:29.1619366+00:00</End_Date>
    <End_Timezone>1</End_Timezone>
    <Examination>sample string 18</Examination>
    <ExtraInfo>sample string 26</ExtraInfo>
    <FacilityID>be11e82c-2d38-430c-8a4e-9c6ff1dcbefd</FacilityID>
    <FacilityName>sample string 27</FacilityName>
    <First_Name>sample string 33</First_Name>
    <Full_Name>sample string 14</Full_Name>
    <History>sample string 17</History>
    <ImageName>sample string 22</ImageName>
    <InConsultTime>1</InConsultTime>
    <InConsult_EndDate>2025-06-08T01:38:29.1619366+00:00</InConsult_EndDate>
    <InConsult_Id>8f538da0-02ff-41e2-bc80-57b5651499bb</InConsult_Id>
    <InitialCheckInTime>sample string 37</InitialCheckInTime>
    <IsInWaitingRoom>true</IsInWaitingRoom>
    <IsNewPatientAppointment>true</IsNewPatientAppointment>
    <Is_All_Day>true</Is_All_Day>
    <MRNValue>sample string 31</MRNValue>
    <MRN_Seed>32</MRN_Seed>
    <Maiden_Name>sample string 36</Maiden_Name>
    <Middle_Name>sample string 34</Middle_Name>
    <Mobile_Number>sample string 15</Mobile_Number>
    <NewPatient>true</NewPatient>
    <Parent_Appointment_Id>1</Parent_Appointment_Id>
    <PatientFlags>sample string 28</PatientFlags>
    <PatientName>sample string 39</PatientName>
    <Patient_Id>7968af1c-ece2-4870-811c-c679d2a1a801</Patient_Id>
    <Practice_Id>7672b0ef-6d0a-4cfa-9281-57af75b1206b</Practice_Id>
    <Priority>sample string 5</Priority>
    <ProviderFullName>sample string 25</ProviderFullName>
    <ProviderUserName>sample string 24</ProviderUserName>
    <Provider_Id>45068f46-f26b-4522-af78-f1c0bd2ce045</Provider_Id>
    <Recurrence_Exception>sample string 13</Recurrence_Exception>
    <Recurrence_Id>sample string 11</Recurrence_Id>
    <Recurrence_Rule>sample string 12</Recurrence_Rule>
    <Room_Id>4b9e0d66-d49f-421c-a63a-a00d38731390</Room_Id>
    <Room_Name>sample string 21</Room_Name>
    <Start_Date>2025-06-08T01:38:29.1619366+00:00</Start_Date>
    <Start_Timezone>1</Start_Timezone>
    <Sur_Name>sample string 35</Sur_Name>
    <Title>sample string 2</Title>
    <Treatment_Plan>sample string 20</Treatment_Plan>
    <WaitingTime>1</WaitingTime>
  </AppointmentInfo>
  <AppointmentInfo>
    <AppointmentStatus>sample string 16</AppointmentStatus>
    <Appointment_Id>aae831e9-d55c-4ce5-a00f-6926a58c9be0</Appointment_Id>
    <Appointment_Status_Id>1</Appointment_Status_Id>
    <Appointment_Type_Id>1</Appointment_Type_Id>
    <Appt_Room_Id>e5984c28-c2e6-42dd-b9a1-ce2b4a5a385c</Appt_Room_Id>
    <Arrival_Date>2025-06-08T01:38:29.1619366+00:00</Arrival_Date>
    <Billing_Amount>29.1</Billing_Amount>
    <Billing_Msg>sample string 30</Billing_Msg>
    <Cancelled_By>sample string 6</Cancelled_By>
    <Cancelled_On>2025-06-08T01:38:29.1619366+00:00</Cancelled_On>
    <Cancelled_Reason>sample string 7</Cancelled_Reason>
    <CheckIn_DateInitial>2025-06-08T01:38:29.1619366+00:00</CheckIn_DateInitial>
    <Consulted>true</Consulted>
    <DOB>2025-06-08T01:38:29.1619366+00:00</DOB>
    <Default_UI_Color>sample string 23</Default_UI_Color>
    <Description>sample string 4</Description>
    <Diagnosis>sample string 19</Diagnosis>
    <Duration>1.1</Duration>
    <End_Date>2025-06-08T01:38:29.1619366+00:00</End_Date>
    <End_Timezone>1</End_Timezone>
    <Examination>sample string 18</Examination>
    <ExtraInfo>sample string 26</ExtraInfo>
    <FacilityID>be11e82c-2d38-430c-8a4e-9c6ff1dcbefd</FacilityID>
    <FacilityName>sample string 27</FacilityName>
    <First_Name>sample string 33</First_Name>
    <Full_Name>sample string 14</Full_Name>
    <History>sample string 17</History>
    <ImageName>sample string 22</ImageName>
    <InConsultTime>1</InConsultTime>
    <InConsult_EndDate>2025-06-08T01:38:29.1619366+00:00</InConsult_EndDate>
    <InConsult_Id>8f538da0-02ff-41e2-bc80-57b5651499bb</InConsult_Id>
    <InitialCheckInTime>sample string 37</InitialCheckInTime>
    <IsInWaitingRoom>true</IsInWaitingRoom>
    <IsNewPatientAppointment>true</IsNewPatientAppointment>
    <Is_All_Day>true</Is_All_Day>
    <MRNValue>sample string 31</MRNValue>
    <MRN_Seed>32</MRN_Seed>
    <Maiden_Name>sample string 36</Maiden_Name>
    <Middle_Name>sample string 34</Middle_Name>
    <Mobile_Number>sample string 15</Mobile_Number>
    <NewPatient>true</NewPatient>
    <Parent_Appointment_Id>1</Parent_Appointment_Id>
    <PatientFlags>sample string 28</PatientFlags>
    <PatientName>sample string 39</PatientName>
    <Patient_Id>7968af1c-ece2-4870-811c-c679d2a1a801</Patient_Id>
    <Practice_Id>7672b0ef-6d0a-4cfa-9281-57af75b1206b</Practice_Id>
    <Priority>sample string 5</Priority>
    <ProviderFullName>sample string 25</ProviderFullName>
    <ProviderUserName>sample string 24</ProviderUserName>
    <Provider_Id>45068f46-f26b-4522-af78-f1c0bd2ce045</Provider_Id>
    <Recurrence_Exception>sample string 13</Recurrence_Exception>
    <Recurrence_Id>sample string 11</Recurrence_Id>
    <Recurrence_Rule>sample string 12</Recurrence_Rule>
    <Room_Id>4b9e0d66-d49f-421c-a63a-a00d38731390</Room_Id>
    <Room_Name>sample string 21</Room_Name>
    <Start_Date>2025-06-08T01:38:29.1619366+00:00</Start_Date>
    <Start_Timezone>1</Start_Timezone>
    <Sur_Name>sample string 35</Sur_Name>
    <Title>sample string 2</Title>
    <Treatment_Plan>sample string 20</Treatment_Plan>
    <WaitingTime>1</WaitingTime>
  </AppointmentInfo>
</ArrayOfAppointmentInfo>