GET api/v1/{practiceid}/patientevent/patientevents/bypatient/{patientId}
Get a specific patient event in the practice by patient id
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| practiceid |
Practice Id, default value 00000000-0000-0000-0000-000000000000 |
globally unique identifier |
Required |
| patientId | globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
patient event details
Com.Healthbridge.Hhas.PatientEvent.Interface.ValueObjects.PatientEventVo| Name | Description | Type | Additional information |
|---|---|---|---|
| PatientEventId |
Unique identifier for the patient event |
globally unique identifier |
None. |
| PatientEventXRef |
Unique identifier for the patient event, from another |
string |
None. |
| BranchXRef | string |
None. |
|
| BranchName | string |
None. |
|
| PracticeId |
Unique identifier of the provider's practice that provided the service for the patient event |
globally unique identifier |
None. |
| Patient |
The patient to whom the service was provided |
Com.Healthbridge.Hhas.Patient.Interface.ValueObjects.PatientVo |
None. |
| ScheduledTime |
The date and time for when the patient event was originally scheduled for. This is optional as some patient events can be impromptu (e.g. patient walk ins in a practice) |
date |
None. |
| CheckInTime |
The date and time when the patient was checked-in (prepared for the service provider). In case of a doctor's practice this is time when the patient has arrived to the waiting room and registered with the front-office staff |
date |
None. |
| Status |
Status of patient visit (Scheduled,CheckedIn,InProgress,Completed,Canceled) |
Com.Healthbridge.Hhas.PatientEvent.Interface.ValueObjects.PatientVisitStatus |
None. |
| Type |
Patient Visit Type (RegularConsultation, NoCharge,OutOfRooms, MedicalInsurance, etc) |
string |
None. |
| MedicalInsurance |
Medical Insurance details (policy no, broker, insurer, etc) |
Com.Healthbridge.Hhas.PatientEvent.Interface.ValueObjects.MedicalInsuranceVo |
None. |
| CompletedTime |
The date and time when the patient visit was completed |
date |
None. |
| Completed | boolean |
None. |
|
| Cancelled | boolean |
None. |
|
| CheckedIn |
Indicates if the patient has been checked-in and ready for the provider to treat the patient. Typically it refers to patient arriving in doctor's rooms |
boolean |
None. |
| BenefitCheckStatus |
Benefit check status |
string |
None. |
| VideoChatLink | string |
None. |
|
| BenefitCheckPdfLink |
Link to benefit check report pdf |
string |
None. |
| AccountBalance |
Outstanding balance for account |
string |
None. |
| ProviderNote |
Notes from doctor |
string |
None. |
| QuoteXRef |
Reference to quote (iHealth related) |
string |
None. |
Response Formats
application/json, text/json
Sample:
{
"PatientEventId": "46d19ed5-c3f3-4a84-a6c9-ede4a5c56702",
"PatientEventXRef": "sample string 2",
"BranchXRef": "sample string 3",
"BranchName": "sample string 4",
"PracticeId": "75e8753a-5699-424e-9b54-750849e8ff26",
"Patient": {
"PatientId": "beb7328e-4e22-43e7-b7ed-ce27dadb4e77",
"PatientXRef": "sample string 2",
"PracticeId": "6495d743-9f21-4103-a549-f3fea56dd36d",
"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-11-19T09:07:19Z",
"IdentityNo": "sample string 5",
"Gender": "sample string 6",
"ContactNo": "sample string 7",
"EmailAddress": "sample string 8"
},
"PatientAccountDetails": {
"AccountId": "85cbe8b1-4361-445d-ac7e-d35ed3368405",
"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-11-19T09:07:19Z",
"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-11-19T09:07:19Z",
"CheckInTime": "2025-11-19T09:07:19Z",
"Status": 0,
"Type": "sample string 6",
"MedicalInsurance": {
"MedicalInsurer": {
"Id": "37ba90c4-fc6d-47f9-80c5-28764205eeed",
"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-11-19T09:07:19Z",
"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"
}
application/xml, text/xml
Sample:
<PatientEvent xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://mpsapi.healthbridge.com/clinical/patientevent/v1/patientevent/">
<AccountBalance>sample string 13</AccountBalance>
<BenefitCheckPdfLink>sample string 12</BenefitCheckPdfLink>
<BenefitCheckStatus>sample string 10</BenefitCheckStatus>
<BranchName>sample string 4</BranchName>
<BranchXRef>sample string 3</BranchXRef>
<Cancelled>true</Cancelled>
<CheckInTime>2025-11-19T09:07:19.5555569+02:00</CheckInTime>
<CheckedIn>true</CheckedIn>
<Completed>true</Completed>
<CompletedTime>2025-11-19T09:07:19.5555569+02:00</CompletedTime>
<MedicalInsurance xmlns:d2p1="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.PatientEvent.Interface.ValueObjects">
<d2p1:Broker>sample string 1</d2p1:Broker>
<d2p1:MedicalInsurer>
<d2p1:AccountNo>sample string 4</d2p1:AccountNo>
<d2p1:AddressLine1>sample string 8</d2p1:AddressLine1>
<d2p1:AddressLine2>sample string 9</d2p1:AddressLine2>
<d2p1:AddressLine3>sample string 10</d2p1:AddressLine3>
<d2p1:Email>sample string 5</d2p1:Email>
<d2p1:Id>37ba90c4-fc6d-47f9-80c5-28764205eeed</d2p1:Id>
<d2p1:InsurerXRef>sample string 2</d2p1:InsurerXRef>
<d2p1:Name>sample string 3</d2p1:Name>
<d2p1:Phone1>sample string 6</d2p1:Phone1>
<d2p1:Phone2>sample string 7</d2p1:Phone2>
<d2p1:PostalCode>sample string 11</d2p1:PostalCode>
</d2p1:MedicalInsurer>
<d2p1:PatientIdentityNo>sample string 3</d2p1:PatientIdentityNo>
<d2p1:PolicyNo>sample string 2</d2p1:PolicyNo>
</MedicalInsurance>
<Patient xmlns:d2p1="http://mpsapi.healthbridge.com/clinical/patient/v1/patient/">
<d2p1:Deceased>true</d2p1:Deceased>
<d2p1:Employer>sample string 7</d2p1:Employer>
<d2p1:FileNo>sample string 4</d2p1:FileNo>
<d2p1:KnownAs>sample string 5</d2p1:KnownAs>
<d2p1:MaritalStatus>sample string 9</d2p1:MaritalStatus>
<d2p1:Occupation>sample string 6</d2p1:Occupation>
<d2p1:PatientAccountDetails>
<d2p1:AccountId>85cbe8b1-4361-445d-ac7e-d35ed3368405</d2p1:AccountId>
<d2p1:AccountNo>sample string 2</d2p1:AccountNo>
<d2p1:IsCashAccount>true</d2p1:IsCashAccount>
<d2p1:MedicalAidDependentCode>sample string 8</d2p1:MedicalAidDependentCode>
<d2p1:MedicalAidMainMemberDetails>
<d2p1:ContactNo>sample string 7</d2p1:ContactNo>
<d2p1:DateOfBirth>2025-11-19T09:07:19.5555569+02:00</d2p1:DateOfBirth>
<d2p1:EmailAddress>sample string 8</d2p1:EmailAddress>
<d2p1:FirstName>sample string 2</d2p1:FirstName>
<d2p1:Gender>sample string 6</d2p1:Gender>
<d2p1:IdentityNo>sample string 5</d2p1:IdentityNo>
<d2p1:Surname>sample string 3</d2p1:Surname>
<d2p1:Title>sample string 1</d2p1:Title>
</d2p1:MedicalAidMainMemberDetails>
<d2p1:MedicalAidMembershipNumber>sample string 7</d2p1:MedicalAidMembershipNumber>
<d2p1:MedicalAidName>sample string 4</d2p1:MedicalAidName>
<d2p1:MedicalAidOptionCode>sample string 10</d2p1:MedicalAidOptionCode>
<d2p1:MedicalAidPlan>sample string 5</d2p1:MedicalAidPlan>
<d2p1:MedicalAidPlanCode>sample string 12</d2p1:MedicalAidPlanCode>
<d2p1:MedicalAidPlanOption>sample string 6</d2p1:MedicalAidPlanOption>
<d2p1:MedicalAidRoutingCode>sample string 9</d2p1:MedicalAidRoutingCode>
<d2p1:MedicalAidSchemeCode>sample string 11</d2p1:MedicalAidSchemeCode>
</d2p1:PatientAccountDetails>
<d2p1:PatientDetails>
<d2p1:ContactNo>sample string 7</d2p1:ContactNo>
<d2p1:DateOfBirth>2025-11-19T09:07:19.5555569+02:00</d2p1:DateOfBirth>
<d2p1:EmailAddress>sample string 8</d2p1:EmailAddress>
<d2p1:FirstName>sample string 2</d2p1:FirstName>
<d2p1:Gender>sample string 6</d2p1:Gender>
<d2p1:IdentityNo>sample string 5</d2p1:IdentityNo>
<d2p1:Surname>sample string 3</d2p1:Surname>
<d2p1:Title>sample string 1</d2p1:Title>
</d2p1:PatientDetails>
<d2p1:PatientId>beb7328e-4e22-43e7-b7ed-ce27dadb4e77</d2p1:PatientId>
<d2p1:PatientXRef>sample string 2</d2p1:PatientXRef>
<d2p1:PhysicalAddress>
<d2p1:Code>sample string 4</d2p1:Code>
<d2p1:Line1>sample string 1</d2p1:Line1>
<d2p1:Line2>sample string 2</d2p1:Line2>
<d2p1:Line3>sample string 3</d2p1:Line3>
</d2p1:PhysicalAddress>
<d2p1:PostalAddress>
<d2p1:Code>sample string 4</d2p1:Code>
<d2p1:Line1>sample string 1</d2p1:Line1>
<d2p1:Line2>sample string 2</d2p1:Line2>
<d2p1:Line3>sample string 3</d2p1:Line3>
</d2p1:PostalAddress>
<d2p1:PracticeId>6495d743-9f21-4103-a549-f3fea56dd36d</d2p1:PracticeId>
<d2p1:PreferredLanguage>sample string 8</d2p1:PreferredLanguage>
</Patient>
<PatientEventId>46d19ed5-c3f3-4a84-a6c9-ede4a5c56702</PatientEventId>
<PatientEventXRef>sample string 2</PatientEventXRef>
<PracticeId>75e8753a-5699-424e-9b54-750849e8ff26</PracticeId>
<ProviderNote>sample string 14</ProviderNote>
<QuoteXRef>sample string 15</QuoteXRef>
<ScheduledTime>2025-11-19T09:07:19.5555569+02:00</ScheduledTime>
<Status>Scheduled</Status>
<Type>sample string 6</Type>
<VideoChatLink>sample string 11</VideoChatLink>
</PatientEvent>