GET api/v1/{practiceid}/patient/account/{accountNo}

Get relevant account no. details

Request Information

URI Parameters

NameDescriptionTypeAdditional information
practiceid

Practice NodeId, default value 00000000-0000-0000-0000-000000000000

 globally unique identifier

Required
accountNo

account number search by

 string

Required

Body Parameters

None.

Response Information

Resource Description

Array of medical aids

Com.Healthbridge.Hhas.Patient.Interface.ValueObjects.AccountDetailsVo
NameDescriptionTypeAdditional information
AccountId

The unique identifier of the billing account

 globally unique identifier

None.
AccountNo

(Optional) Human readable account identifier (natural key), as seen and held by the practice. E.g. LAZ001

 string

None.
IsCashAccount

Indicates if the account is a cash account (e.g. all service fees are recovered directly from the patient) or it is a medical aid account (all service fees are claimed from the medical aid and the remaining balance from the patient)

 boolean

None.
MedicalAidName

(In case that this is not a cash account ()) The name of the Medical Aid (per

 string

None.
MedicalAidPlan

(In case that this is not a cash account ()) The name of the Medical Aid Plan

 string

None.
MedicalAidPlanOption

(In case that this is not a cash account ()) The name of the Medical Aid Plan Option

 string

None.
MedicalAidMembershipNumber

(In case that this is not a cash account ()) Medical Aid Membership Number

 string

None.
MedicalAidDependentCode

(In case that this is not a cash account ()) Medical Aid Membership Number

 string

None.
MedicalAidMainMemberDetails

(In case that this is not a cash account ()) The details of the Main Member of the Medical Aid membership

 Com.Healthbridge.Hhas.Patient.Interface.ValueObjects.PersonVo

None.
MedicalAidRoutingCode

(In case that this is not a cash account ()) The Routing Code

 string

None.
MedicalAidOptionCode

(In case that this is not a cash account ()) The Option Code

 string

None.
MedicalAidSchemeCode

string

None.
MedicalAidPlanCode

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "AccountId": "eb68e976-a544-4d69-b37d-bf03650200b7",
  "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-17T13:19:29Z",
    "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"
}

application/xml, text/xml

Sample: 
<AccountDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://mpsapi.healthbridge.com/clinical/patient/v1/patient/">
  <AccountId>eb68e976-a544-4d69-b37d-bf03650200b7</AccountId>
  <AccountNo>sample string 2</AccountNo>
  <IsCashAccount>true</IsCashAccount>
  <MedicalAidDependentCode>sample string 8</MedicalAidDependentCode>
  <MedicalAidMainMemberDetails>
    <ContactNo>sample string 7</ContactNo>
    <DateOfBirth>2025-04-17T13:19:29.1401419+02:00</DateOfBirth>
    <EmailAddress>sample string 8</EmailAddress>
    <FirstName>sample string 2</FirstName>
    <Gender>sample string 6</Gender>
    <IdentityNo>sample string 5</IdentityNo>
    <Surname>sample string 3</Surname>
    <Title>sample string 1</Title>
  </MedicalAidMainMemberDetails>
  <MedicalAidMembershipNumber>sample string 7</MedicalAidMembershipNumber>
  <MedicalAidName>sample string 4</MedicalAidName>
  <MedicalAidOptionCode>sample string 10</MedicalAidOptionCode>
  <MedicalAidPlan>sample string 5</MedicalAidPlan>
  <MedicalAidPlanCode>sample string 12</MedicalAidPlanCode>
  <MedicalAidPlanOption>sample string 6</MedicalAidPlanOption>
  <MedicalAidRoutingCode>sample string 9</MedicalAidRoutingCode>
  <MedicalAidSchemeCode>sample string 11</MedicalAidSchemeCode>
</AccountDetails>