POST api/v1/{practiceid}/patientevent/patientevents/dumpoldvisits?cutoffDate={cutoffDate}
Delete from memory old visits (not standard visit cancel) just clear read side
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| practiceid | globally unique identifier |
Required |
|
| cutoffDate | date |
Required |
Body Parameters
None.
Response Information
Resource Description
Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects.RestApiResultOfCom.Healthbridge.Hhas.PatientEvent.Interface.ValueObjects.PatientEventVo[]| Name | Description | Type | Additional information |
|---|---|---|---|
| Sucess | boolean |
None. |
|
| ResponseCode | integer |
None. |
|
| ResponseMessage | string |
None. |
|
| Data | Collection of Com.Healthbridge.Hhas.PatientEvent.Interface.ValueObjects.PatientEventVo |
None. |
|
| Links | Collection of Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects.RestApiLink |
None. |
Response Formats
application/json, text/json
Sample:
{
"Sucess": true,
"ResponseCode": 2,
"ResponseMessage": "sample string 3",
"Data": [
{
"PatientEventId": "8ffe4d95-f2d4-4b60-b861-4282d63782dd",
"PatientEventXRef": "sample string 2",
"BranchXRef": "sample string 3",
"BranchName": "sample string 4",
"PracticeId": "5469942a-4f88-46a2-a236-93e3462065a5",
"Patient": {
"PatientId": "502d5bf9-8606-49e8-b6ff-b45edd8f78cf",
"PatientXRef": "sample string 2",
"PracticeId": "b8808ed3-2978-41bc-8ad9-2b12db63e17a",
"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-06-17T09:11:43Z",
"IdentityNo": "sample string 5",
"Gender": "sample string 6",
"ContactNo": "sample string 7",
"EmailAddress": "sample string 8"
},
"PatientAccountDetails": {
"AccountId": "e76e0e57-7d2a-42a1-9cca-5d591adb057a",
"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-06-17T09:11:43Z",
"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-06-17T09:11:43Z",
"CheckInTime": "2025-06-17T09:11:43Z",
"Status": 0,
"Type": "sample string 6",
"MedicalInsurance": {
"MedicalInsurer": {
"Id": "290f878a-f141-4856-af24-89e4b6bd023b",
"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-06-17T09:11:43Z",
"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"
},
{
"PatientEventId": "8ffe4d95-f2d4-4b60-b861-4282d63782dd",
"PatientEventXRef": "sample string 2",
"BranchXRef": "sample string 3",
"BranchName": "sample string 4",
"PracticeId": "5469942a-4f88-46a2-a236-93e3462065a5",
"Patient": {
"PatientId": "502d5bf9-8606-49e8-b6ff-b45edd8f78cf",
"PatientXRef": "sample string 2",
"PracticeId": "b8808ed3-2978-41bc-8ad9-2b12db63e17a",
"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-06-17T09:11:43Z",
"IdentityNo": "sample string 5",
"Gender": "sample string 6",
"ContactNo": "sample string 7",
"EmailAddress": "sample string 8"
},
"PatientAccountDetails": {
"AccountId": "e76e0e57-7d2a-42a1-9cca-5d591adb057a",
"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-06-17T09:11:43Z",
"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-06-17T09:11:43Z",
"CheckInTime": "2025-06-17T09:11:43Z",
"Status": 0,
"Type": "sample string 6",
"MedicalInsurance": {
"MedicalInsurer": {
"Id": "290f878a-f141-4856-af24-89e4b6bd023b",
"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-06-17T09:11:43Z",
"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"
}
],
"Links": [
{
"Rel": "sample string 1",
"HRef": "sample string 2"
},
{
"Rel": "sample string 1",
"HRef": "sample string 2"
}
]
}
application/xml, text/xml
Sample:
<RestApiResultOfArrayOfPatientEventAlC_P4xBD xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects">
<Data xmlns:d2p1="http://mpsapi.healthbridge.com/clinical/patientevent/v1/patientevent/">
<d2p1:PatientEvent>
<d2p1:AccountBalance>sample string 13</d2p1:AccountBalance>
<d2p1:BenefitCheckPdfLink>sample string 12</d2p1:BenefitCheckPdfLink>
<d2p1:BenefitCheckStatus>sample string 10</d2p1:BenefitCheckStatus>
<d2p1:BranchName>sample string 4</d2p1:BranchName>
<d2p1:BranchXRef>sample string 3</d2p1:BranchXRef>
<d2p1:Cancelled>true</d2p1:Cancelled>
<d2p1:CheckInTime>2025-06-17T09:11:43.1780724+02:00</d2p1:CheckInTime>
<d2p1:CheckedIn>true</d2p1:CheckedIn>
<d2p1:Completed>true</d2p1:Completed>
<d2p1:CompletedTime>2025-06-17T09:11:43.1780724+02:00</d2p1:CompletedTime>
<d2p1: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>290f878a-f141-4856-af24-89e4b6bd023b</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>
</d2p1:MedicalInsurance>
<d2p1: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>e76e0e57-7d2a-42a1-9cca-5d591adb057a</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-06-17T09:11:43.1780724+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-06-17T09:11:43.1780724+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>502d5bf9-8606-49e8-b6ff-b45edd8f78cf</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>b8808ed3-2978-41bc-8ad9-2b12db63e17a</d4p1:PracticeId>
<d4p1:PreferredLanguage>sample string 8</d4p1:PreferredLanguage>
</d2p1:Patient>
<d2p1:PatientEventId>8ffe4d95-f2d4-4b60-b861-4282d63782dd</d2p1:PatientEventId>
<d2p1:PatientEventXRef>sample string 2</d2p1:PatientEventXRef>
<d2p1:PracticeId>5469942a-4f88-46a2-a236-93e3462065a5</d2p1:PracticeId>
<d2p1:ProviderNote>sample string 14</d2p1:ProviderNote>
<d2p1:QuoteXRef>sample string 15</d2p1:QuoteXRef>
<d2p1:ScheduledTime>2025-06-17T09:11:43.1780724+02:00</d2p1:ScheduledTime>
<d2p1:Status>Scheduled</d2p1:Status>
<d2p1:Type>sample string 6</d2p1:Type>
<d2p1:VideoChatLink>sample string 11</d2p1:VideoChatLink>
</d2p1:PatientEvent>
<d2p1:PatientEvent>
<d2p1:AccountBalance>sample string 13</d2p1:AccountBalance>
<d2p1:BenefitCheckPdfLink>sample string 12</d2p1:BenefitCheckPdfLink>
<d2p1:BenefitCheckStatus>sample string 10</d2p1:BenefitCheckStatus>
<d2p1:BranchName>sample string 4</d2p1:BranchName>
<d2p1:BranchXRef>sample string 3</d2p1:BranchXRef>
<d2p1:Cancelled>true</d2p1:Cancelled>
<d2p1:CheckInTime>2025-06-17T09:11:43.1780724+02:00</d2p1:CheckInTime>
<d2p1:CheckedIn>true</d2p1:CheckedIn>
<d2p1:Completed>true</d2p1:Completed>
<d2p1:CompletedTime>2025-06-17T09:11:43.1780724+02:00</d2p1:CompletedTime>
<d2p1: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>290f878a-f141-4856-af24-89e4b6bd023b</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>
</d2p1:MedicalInsurance>
<d2p1: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>e76e0e57-7d2a-42a1-9cca-5d591adb057a</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-06-17T09:11:43.1780724+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-06-17T09:11:43.1780724+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>502d5bf9-8606-49e8-b6ff-b45edd8f78cf</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>b8808ed3-2978-41bc-8ad9-2b12db63e17a</d4p1:PracticeId>
<d4p1:PreferredLanguage>sample string 8</d4p1:PreferredLanguage>
</d2p1:Patient>
<d2p1:PatientEventId>8ffe4d95-f2d4-4b60-b861-4282d63782dd</d2p1:PatientEventId>
<d2p1:PatientEventXRef>sample string 2</d2p1:PatientEventXRef>
<d2p1:PracticeId>5469942a-4f88-46a2-a236-93e3462065a5</d2p1:PracticeId>
<d2p1:ProviderNote>sample string 14</d2p1:ProviderNote>
<d2p1:QuoteXRef>sample string 15</d2p1:QuoteXRef>
<d2p1:ScheduledTime>2025-06-17T09:11:43.1780724+02:00</d2p1:ScheduledTime>
<d2p1:Status>Scheduled</d2p1:Status>
<d2p1:Type>sample string 6</d2p1:Type>
<d2p1:VideoChatLink>sample string 11</d2p1:VideoChatLink>
</d2p1:PatientEvent>
</Data>
<Links>
<RestApiLink>
<HRef>sample string 2</HRef>
<Rel>sample string 1</Rel>
</RestApiLink>
<RestApiLink>
<HRef>sample string 2</HRef>
<Rel>sample string 1</Rel>
</RestApiLink>
</Links>
<ResponseCode>2</ResponseCode>
<ResponseMessage>sample string 3</ResponseMessage>
<Sucess>true</Sucess>
</RestApiResultOfArrayOfPatientEventAlC_P4xBD>