GET api/v1/{practiceid}/patientevent/waitingroom/summary
Get list of patient visits in waiting room with summary
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| practiceid |
Practice ID, default value 00000000-0000-0000-0000-000000000000 |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
Array of patient visit information
Collection of Com.Healthbridge.Hhas.Cloud.WebRole.Models.ApiModels.PatientInWaitingRoom| Name | Description | Type | Additional information |
|---|---|---|---|
| PatientEvent | Com.Healthbridge.Hhas.PatientEvent.Interface.ValueObjects.PatientEventVo |
None. |
|
| HasSummmaryOfCare | boolean |
None. |
|
| HasQuote | boolean |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"PatientEvent": {
"PatientEventId": "faa19736-adc0-4f31-a764-7c3108fa1d30",
"PatientEventXRef": "sample string 2",
"BranchXRef": "sample string 3",
"BranchName": "sample string 4",
"PracticeId": "e38ddb48-677b-4473-8d9a-fd8b0cb0ffc5",
"Patient": {
"PatientId": "3dd11e7d-4105-463b-bc5e-b749c0c24de5",
"PatientXRef": "sample string 2",
"PracticeId": "633c5981-dd83-4587-94a8-60422843cbc8",
"FileNo": "sample string 4",
"KnownAs": "sample string 5",
"Occupation": "sample string 6",
"Employer": "sample string 7",
"PreferredLanguage": "sample string 8",
"MaritalStatus": "sample string 9",
"PatientDetails": {
"Title": "sample string 1",
"FirstName": "sample string 2",
"Surname": "sample string 3",
"DateOfBirth": "2025-04-16T12:12:21Z",
"IdentityNo": "sample string 5",
"Gender": "sample string 6",
"ContactNo": "sample string 7",
"EmailAddress": "sample string 8"
},
"PatientAccountDetails": {
"AccountId": "dfb9a091-6107-43df-a2e9-b419f6cad968",
"AccountNo": "sample string 2",
"IsCashAccount": true,
"MedicalAidName": "sample string 4",
"MedicalAidPlan": "sample string 5",
"MedicalAidPlanOption": "sample string 6",
"MedicalAidMembershipNumber": "sample string 7",
"MedicalAidDependentCode": "sample string 8",
"MedicalAidMainMemberDetails": {
"Title": "sample string 1",
"FirstName": "sample string 2",
"Surname": "sample string 3",
"DateOfBirth": "2025-04-16T12:12:21Z",
"IdentityNo": "sample string 5",
"Gender": "sample string 6",
"ContactNo": "sample string 7",
"EmailAddress": "sample string 8"
},
"MedicalAidRoutingCode": "sample string 9",
"MedicalAidOptionCode": "sample string 10",
"MedicalAidSchemeCode": "sample string 11",
"MedicalAidPlanCode": "sample string 12"
},
"PhysicalAddress": {
"Line1": "sample string 1",
"Line2": "sample string 2",
"Line3": "sample string 3",
"Code": "sample string 4"
},
"PostalAddress": {
"Line1": "sample string 1",
"Line2": "sample string 2",
"Line3": "sample string 3",
"Code": "sample string 4"
},
"Deceased": true
},
"ScheduledTime": "2025-04-16T12:12:21Z",
"CheckInTime": "2025-04-16T12:12:21Z",
"Status": 0,
"Type": "sample string 6",
"MedicalInsurance": {
"MedicalInsurer": {
"Id": "bb150cb3-b22c-4632-99b4-16b5391ed6de",
"InsurerXRef": "sample string 2",
"Name": "sample string 3",
"AccountNo": "sample string 4",
"Email": "sample string 5",
"Phone1": "sample string 6",
"Phone2": "sample string 7",
"AddressLine1": "sample string 8",
"AddressLine2": "sample string 9",
"AddressLine3": "sample string 10",
"PostalCode": "sample string 11"
},
"Broker": "sample string 1",
"PolicyNo": "sample string 2",
"PatientIdentityNo": "sample string 3"
},
"CompletedTime": "2025-04-16T12:12:21Z",
"Completed": true,
"Cancelled": true,
"CheckedIn": true,
"BenefitCheckStatus": "sample string 10",
"VideoChatLink": "sample string 11",
"BenefitCheckPdfLink": "sample string 12",
"AccountBalance": "sample string 13",
"ProviderNote": "sample string 14",
"QuoteXRef": "sample string 15"
},
"HasSummmaryOfCare": true,
"HasQuote": true
},
{
"PatientEvent": {
"PatientEventId": "faa19736-adc0-4f31-a764-7c3108fa1d30",
"PatientEventXRef": "sample string 2",
"BranchXRef": "sample string 3",
"BranchName": "sample string 4",
"PracticeId": "e38ddb48-677b-4473-8d9a-fd8b0cb0ffc5",
"Patient": {
"PatientId": "3dd11e7d-4105-463b-bc5e-b749c0c24de5",
"PatientXRef": "sample string 2",
"PracticeId": "633c5981-dd83-4587-94a8-60422843cbc8",
"FileNo": "sample string 4",
"KnownAs": "sample string 5",
"Occupation": "sample string 6",
"Employer": "sample string 7",
"PreferredLanguage": "sample string 8",
"MaritalStatus": "sample string 9",
"PatientDetails": {
"Title": "sample string 1",
"FirstName": "sample string 2",
"Surname": "sample string 3",
"DateOfBirth": "2025-04-16T12:12:21Z",
"IdentityNo": "sample string 5",
"Gender": "sample string 6",
"ContactNo": "sample string 7",
"EmailAddress": "sample string 8"
},
"PatientAccountDetails": {
"AccountId": "dfb9a091-6107-43df-a2e9-b419f6cad968",
"AccountNo": "sample string 2",
"IsCashAccount": true,
"MedicalAidName": "sample string 4",
"MedicalAidPlan": "sample string 5",
"MedicalAidPlanOption": "sample string 6",
"MedicalAidMembershipNumber": "sample string 7",
"MedicalAidDependentCode": "sample string 8",
"MedicalAidMainMemberDetails": {
"Title": "sample string 1",
"FirstName": "sample string 2",
"Surname": "sample string 3",
"DateOfBirth": "2025-04-16T12:12:21Z",
"IdentityNo": "sample string 5",
"Gender": "sample string 6",
"ContactNo": "sample string 7",
"EmailAddress": "sample string 8"
},
"MedicalAidRoutingCode": "sample string 9",
"MedicalAidOptionCode": "sample string 10",
"MedicalAidSchemeCode": "sample string 11",
"MedicalAidPlanCode": "sample string 12"
},
"PhysicalAddress": {
"Line1": "sample string 1",
"Line2": "sample string 2",
"Line3": "sample string 3",
"Code": "sample string 4"
},
"PostalAddress": {
"Line1": "sample string 1",
"Line2": "sample string 2",
"Line3": "sample string 3",
"Code": "sample string 4"
},
"Deceased": true
},
"ScheduledTime": "2025-04-16T12:12:21Z",
"CheckInTime": "2025-04-16T12:12:21Z",
"Status": 0,
"Type": "sample string 6",
"MedicalInsurance": {
"MedicalInsurer": {
"Id": "bb150cb3-b22c-4632-99b4-16b5391ed6de",
"InsurerXRef": "sample string 2",
"Name": "sample string 3",
"AccountNo": "sample string 4",
"Email": "sample string 5",
"Phone1": "sample string 6",
"Phone2": "sample string 7",
"AddressLine1": "sample string 8",
"AddressLine2": "sample string 9",
"AddressLine3": "sample string 10",
"PostalCode": "sample string 11"
},
"Broker": "sample string 1",
"PolicyNo": "sample string 2",
"PatientIdentityNo": "sample string 3"
},
"CompletedTime": "2025-04-16T12:12:21Z",
"Completed": true,
"Cancelled": true,
"CheckedIn": true,
"BenefitCheckStatus": "sample string 10",
"VideoChatLink": "sample string 11",
"BenefitCheckPdfLink": "sample string 12",
"AccountBalance": "sample string 13",
"ProviderNote": "sample string 14",
"QuoteXRef": "sample string 15"
},
"HasSummmaryOfCare": true,
"HasQuote": true
}
]
application/xml, text/xml
Sample:
<ArrayOfPatientInWaitingRoom xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.Cloud.WebRole.Models.ApiModels">
<PatientInWaitingRoom>
<HasQuote>true</HasQuote>
<HasSummmaryOfCare>true</HasSummmaryOfCare>
<PatientEvent xmlns:d3p1="http://mpsapi.healthbridge.com/clinical/patientevent/v1/patientevent/">
<d3p1:AccountBalance>sample string 13</d3p1:AccountBalance>
<d3p1:BenefitCheckPdfLink>sample string 12</d3p1:BenefitCheckPdfLink>
<d3p1:BenefitCheckStatus>sample string 10</d3p1:BenefitCheckStatus>
<d3p1:BranchName>sample string 4</d3p1:BranchName>
<d3p1:BranchXRef>sample string 3</d3p1:BranchXRef>
<d3p1:Cancelled>true</d3p1:Cancelled>
<d3p1:CheckInTime>2025-04-16T12:12:21.2728212+02:00</d3p1:CheckInTime>
<d3p1:CheckedIn>true</d3p1:CheckedIn>
<d3p1:Completed>true</d3p1:Completed>
<d3p1:CompletedTime>2025-04-16T12:12:21.2728212+02:00</d3p1:CompletedTime>
<d3p1:MedicalInsurance xmlns:d4p1="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.PatientEvent.Interface.ValueObjects">
<d4p1:Broker>sample string 1</d4p1:Broker>
<d4p1:MedicalInsurer>
<d4p1:AccountNo>sample string 4</d4p1:AccountNo>
<d4p1:AddressLine1>sample string 8</d4p1:AddressLine1>
<d4p1:AddressLine2>sample string 9</d4p1:AddressLine2>
<d4p1:AddressLine3>sample string 10</d4p1:AddressLine3>
<d4p1:Email>sample string 5</d4p1:Email>
<d4p1:Id>bb150cb3-b22c-4632-99b4-16b5391ed6de</d4p1:Id>
<d4p1:InsurerXRef>sample string 2</d4p1:InsurerXRef>
<d4p1:Name>sample string 3</d4p1:Name>
<d4p1:Phone1>sample string 6</d4p1:Phone1>
<d4p1:Phone2>sample string 7</d4p1:Phone2>
<d4p1:PostalCode>sample string 11</d4p1:PostalCode>
</d4p1:MedicalInsurer>
<d4p1:PatientIdentityNo>sample string 3</d4p1:PatientIdentityNo>
<d4p1:PolicyNo>sample string 2</d4p1:PolicyNo>
</d3p1:MedicalInsurance>
<d3p1:Patient xmlns:d4p1="http://mpsapi.healthbridge.com/clinical/patient/v1/patient/">
<d4p1:Deceased>true</d4p1:Deceased>
<d4p1:Employer>sample string 7</d4p1:Employer>
<d4p1:FileNo>sample string 4</d4p1:FileNo>
<d4p1:KnownAs>sample string 5</d4p1:KnownAs>
<d4p1:MaritalStatus>sample string 9</d4p1:MaritalStatus>
<d4p1:Occupation>sample string 6</d4p1:Occupation>
<d4p1:PatientAccountDetails>
<d4p1:AccountId>dfb9a091-6107-43df-a2e9-b419f6cad968</d4p1:AccountId>
<d4p1:AccountNo>sample string 2</d4p1:AccountNo>
<d4p1:IsCashAccount>true</d4p1:IsCashAccount>
<d4p1:MedicalAidDependentCode>sample string 8</d4p1:MedicalAidDependentCode>
<d4p1:MedicalAidMainMemberDetails>
<d4p1:ContactNo>sample string 7</d4p1:ContactNo>
<d4p1:DateOfBirth>2025-04-16T12:12:21.2728212+02:00</d4p1:DateOfBirth>
<d4p1:EmailAddress>sample string 8</d4p1:EmailAddress>
<d4p1:FirstName>sample string 2</d4p1:FirstName>
<d4p1:Gender>sample string 6</d4p1:Gender>
<d4p1:IdentityNo>sample string 5</d4p1:IdentityNo>
<d4p1:Surname>sample string 3</d4p1:Surname>
<d4p1:Title>sample string 1</d4p1:Title>
</d4p1:MedicalAidMainMemberDetails>
<d4p1:MedicalAidMembershipNumber>sample string 7</d4p1:MedicalAidMembershipNumber>
<d4p1:MedicalAidName>sample string 4</d4p1:MedicalAidName>
<d4p1:MedicalAidOptionCode>sample string 10</d4p1:MedicalAidOptionCode>
<d4p1:MedicalAidPlan>sample string 5</d4p1:MedicalAidPlan>
<d4p1:MedicalAidPlanCode>sample string 12</d4p1:MedicalAidPlanCode>
<d4p1:MedicalAidPlanOption>sample string 6</d4p1:MedicalAidPlanOption>
<d4p1:MedicalAidRoutingCode>sample string 9</d4p1:MedicalAidRoutingCode>
<d4p1:MedicalAidSchemeCode>sample string 11</d4p1:MedicalAidSchemeCode>
</d4p1:PatientAccountDetails>
<d4p1:PatientDetails>
<d4p1:ContactNo>sample string 7</d4p1:ContactNo>
<d4p1:DateOfBirth>2025-04-16T12:12:21.2728212+02:00</d4p1:DateOfBirth>
<d4p1:EmailAddress>sample string 8</d4p1:EmailAddress>
<d4p1:FirstName>sample string 2</d4p1:FirstName>
<d4p1:Gender>sample string 6</d4p1:Gender>
<d4p1:IdentityNo>sample string 5</d4p1:IdentityNo>
<d4p1:Surname>sample string 3</d4p1:Surname>
<d4p1:Title>sample string 1</d4p1:Title>
</d4p1:PatientDetails>
<d4p1:PatientId>3dd11e7d-4105-463b-bc5e-b749c0c24de5</d4p1:PatientId>
<d4p1:PatientXRef>sample string 2</d4p1:PatientXRef>
<d4p1:PhysicalAddress>
<d4p1:Code>sample string 4</d4p1:Code>
<d4p1:Line1>sample string 1</d4p1:Line1>
<d4p1:Line2>sample string 2</d4p1:Line2>
<d4p1:Line3>sample string 3</d4p1:Line3>
</d4p1:PhysicalAddress>
<d4p1:PostalAddress>
<d4p1:Code>sample string 4</d4p1:Code>
<d4p1:Line1>sample string 1</d4p1:Line1>
<d4p1:Line2>sample string 2</d4p1:Line2>
<d4p1:Line3>sample string 3</d4p1:Line3>
</d4p1:PostalAddress>
<d4p1:PracticeId>633c5981-dd83-4587-94a8-60422843cbc8</d4p1:PracticeId>
<d4p1:PreferredLanguage>sample string 8</d4p1:PreferredLanguage>
</d3p1:Patient>
<d3p1:PatientEventId>faa19736-adc0-4f31-a764-7c3108fa1d30</d3p1:PatientEventId>
<d3p1:PatientEventXRef>sample string 2</d3p1:PatientEventXRef>
<d3p1:PracticeId>e38ddb48-677b-4473-8d9a-fd8b0cb0ffc5</d3p1:PracticeId>
<d3p1:ProviderNote>sample string 14</d3p1:ProviderNote>
<d3p1:QuoteXRef>sample string 15</d3p1:QuoteXRef>
<d3p1:ScheduledTime>2025-04-16T12:12:21.2728212+02:00</d3p1:ScheduledTime>
<d3p1:Status>Scheduled</d3p1:Status>
<d3p1:Type>sample string 6</d3p1:Type>
<d3p1:VideoChatLink>sample string 11</d3p1:VideoChatLink>
</PatientEvent>
</PatientInWaitingRoom>
<PatientInWaitingRoom>
<HasQuote>true</HasQuote>
<HasSummmaryOfCare>true</HasSummmaryOfCare>
<PatientEvent xmlns:d3p1="http://mpsapi.healthbridge.com/clinical/patientevent/v1/patientevent/">
<d3p1:AccountBalance>sample string 13</d3p1:AccountBalance>
<d3p1:BenefitCheckPdfLink>sample string 12</d3p1:BenefitCheckPdfLink>
<d3p1:BenefitCheckStatus>sample string 10</d3p1:BenefitCheckStatus>
<d3p1:BranchName>sample string 4</d3p1:BranchName>
<d3p1:BranchXRef>sample string 3</d3p1:BranchXRef>
<d3p1:Cancelled>true</d3p1:Cancelled>
<d3p1:CheckInTime>2025-04-16T12:12:21.2728212+02:00</d3p1:CheckInTime>
<d3p1:CheckedIn>true</d3p1:CheckedIn>
<d3p1:Completed>true</d3p1:Completed>
<d3p1:CompletedTime>2025-04-16T12:12:21.2728212+02:00</d3p1:CompletedTime>
<d3p1:MedicalInsurance xmlns:d4p1="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.PatientEvent.Interface.ValueObjects">
<d4p1:Broker>sample string 1</d4p1:Broker>
<d4p1:MedicalInsurer>
<d4p1:AccountNo>sample string 4</d4p1:AccountNo>
<d4p1:AddressLine1>sample string 8</d4p1:AddressLine1>
<d4p1:AddressLine2>sample string 9</d4p1:AddressLine2>
<d4p1:AddressLine3>sample string 10</d4p1:AddressLine3>
<d4p1:Email>sample string 5</d4p1:Email>
<d4p1:Id>bb150cb3-b22c-4632-99b4-16b5391ed6de</d4p1:Id>
<d4p1:InsurerXRef>sample string 2</d4p1:InsurerXRef>
<d4p1:Name>sample string 3</d4p1:Name>
<d4p1:Phone1>sample string 6</d4p1:Phone1>
<d4p1:Phone2>sample string 7</d4p1:Phone2>
<d4p1:PostalCode>sample string 11</d4p1:PostalCode>
</d4p1:MedicalInsurer>
<d4p1:PatientIdentityNo>sample string 3</d4p1:PatientIdentityNo>
<d4p1:PolicyNo>sample string 2</d4p1:PolicyNo>
</d3p1:MedicalInsurance>
<d3p1:Patient xmlns:d4p1="http://mpsapi.healthbridge.com/clinical/patient/v1/patient/">
<d4p1:Deceased>true</d4p1:Deceased>
<d4p1:Employer>sample string 7</d4p1:Employer>
<d4p1:FileNo>sample string 4</d4p1:FileNo>
<d4p1:KnownAs>sample string 5</d4p1:KnownAs>
<d4p1:MaritalStatus>sample string 9</d4p1:MaritalStatus>
<d4p1:Occupation>sample string 6</d4p1:Occupation>
<d4p1:PatientAccountDetails>
<d4p1:AccountId>dfb9a091-6107-43df-a2e9-b419f6cad968</d4p1:AccountId>
<d4p1:AccountNo>sample string 2</d4p1:AccountNo>
<d4p1:IsCashAccount>true</d4p1:IsCashAccount>
<d4p1:MedicalAidDependentCode>sample string 8</d4p1:MedicalAidDependentCode>
<d4p1:MedicalAidMainMemberDetails>
<d4p1:ContactNo>sample string 7</d4p1:ContactNo>
<d4p1:DateOfBirth>2025-04-16T12:12:21.2728212+02:00</d4p1:DateOfBirth>
<d4p1:EmailAddress>sample string 8</d4p1:EmailAddress>
<d4p1:FirstName>sample string 2</d4p1:FirstName>
<d4p1:Gender>sample string 6</d4p1:Gender>
<d4p1:IdentityNo>sample string 5</d4p1:IdentityNo>
<d4p1:Surname>sample string 3</d4p1:Surname>
<d4p1:Title>sample string 1</d4p1:Title>
</d4p1:MedicalAidMainMemberDetails>
<d4p1:MedicalAidMembershipNumber>sample string 7</d4p1:MedicalAidMembershipNumber>
<d4p1:MedicalAidName>sample string 4</d4p1:MedicalAidName>
<d4p1:MedicalAidOptionCode>sample string 10</d4p1:MedicalAidOptionCode>
<d4p1:MedicalAidPlan>sample string 5</d4p1:MedicalAidPlan>
<d4p1:MedicalAidPlanCode>sample string 12</d4p1:MedicalAidPlanCode>
<d4p1:MedicalAidPlanOption>sample string 6</d4p1:MedicalAidPlanOption>
<d4p1:MedicalAidRoutingCode>sample string 9</d4p1:MedicalAidRoutingCode>
<d4p1:MedicalAidSchemeCode>sample string 11</d4p1:MedicalAidSchemeCode>
</d4p1:PatientAccountDetails>
<d4p1:PatientDetails>
<d4p1:ContactNo>sample string 7</d4p1:ContactNo>
<d4p1:DateOfBirth>2025-04-16T12:12:21.2728212+02:00</d4p1:DateOfBirth>
<d4p1:EmailAddress>sample string 8</d4p1:EmailAddress>
<d4p1:FirstName>sample string 2</d4p1:FirstName>
<d4p1:Gender>sample string 6</d4p1:Gender>
<d4p1:IdentityNo>sample string 5</d4p1:IdentityNo>
<d4p1:Surname>sample string 3</d4p1:Surname>
<d4p1:Title>sample string 1</d4p1:Title>
</d4p1:PatientDetails>
<d4p1:PatientId>3dd11e7d-4105-463b-bc5e-b749c0c24de5</d4p1:PatientId>
<d4p1:PatientXRef>sample string 2</d4p1:PatientXRef>
<d4p1:PhysicalAddress>
<d4p1:Code>sample string 4</d4p1:Code>
<d4p1:Line1>sample string 1</d4p1:Line1>
<d4p1:Line2>sample string 2</d4p1:Line2>
<d4p1:Line3>sample string 3</d4p1:Line3>
</d4p1:PhysicalAddress>
<d4p1:PostalAddress>
<d4p1:Code>sample string 4</d4p1:Code>
<d4p1:Line1>sample string 1</d4p1:Line1>
<d4p1:Line2>sample string 2</d4p1:Line2>
<d4p1:Line3>sample string 3</d4p1:Line3>
</d4p1:PostalAddress>
<d4p1:PracticeId>633c5981-dd83-4587-94a8-60422843cbc8</d4p1:PracticeId>
<d4p1:PreferredLanguage>sample string 8</d4p1:PreferredLanguage>
</d3p1:Patient>
<d3p1:PatientEventId>faa19736-adc0-4f31-a764-7c3108fa1d30</d3p1:PatientEventId>
<d3p1:PatientEventXRef>sample string 2</d3p1:PatientEventXRef>
<d3p1:PracticeId>e38ddb48-677b-4473-8d9a-fd8b0cb0ffc5</d3p1:PracticeId>
<d3p1:ProviderNote>sample string 14</d3p1:ProviderNote>
<d3p1:QuoteXRef>sample string 15</d3p1:QuoteXRef>
<d3p1:ScheduledTime>2025-04-16T12:12:21.2728212+02:00</d3p1:ScheduledTime>
<d3p1:Status>Scheduled</d3p1:Status>
<d3p1:Type>sample string 6</d3p1:Type>
<d3p1:VideoChatLink>sample string 11</d3p1:VideoChatLink>
</PatientEvent>
</PatientInWaitingRoom>
</ArrayOfPatientInWaitingRoom>