GET api/v1/{practiceid}/patient/patients/{lookupfilter}

Get filtered patients in the practice

Request Information

URI Parameters

NameDescriptionTypeAdditional information
practiceid

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

 globally unique identifier

Required
lookupfilter

chars for filtering by patient information

 string

Required

Body Parameters

None.

Response Information

Resource Description

Array of filtered patients

Collection of Com.Healthbridge.Hhas.Patient.Interface.ValueObjects.PatientVo
NameDescriptionTypeAdditional information
PatientId

The unique identifier of the patient

 globally unique identifier

None.
PatientXRef

The external unique identifier of the patient

 string

None.
PracticeId

The unique identifier of the practice with whom the patient was registered with.

 globally unique identifier

None.
FileNo

Optional, an identifier of the patient file (typically a physical yellow folder held in a cabinet at the practice) The system does not use this information besides storing and displaying it. It is provided as a convenience should the practice employs a specific processes around handling paper files outside the scope of the system.

 string

None.
KnownAs

string

None.
Occupation

string

None.
Employer

string

None.
PreferredLanguage

string

None.
MaritalStatus

string

None.
PatientDetails

Personal details of the person to be treated (the patient)

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

None.
PatientAccountDetails

Represents the billing arrangements for the patient (how the patient will be billed by the provider for the services provided)

 Com.Healthbridge.Hhas.Patient.Interface.ValueObjects.AccountDetailsVo

None.
PhysicalAddress

Physical Address

 Com.Healthbridge.Hhas.Patient.Interface.ValueObjects.AddressVo

None.
PostalAddress

Postal Address

 Com.Healthbridge.Hhas.Patient.Interface.ValueObjects.AddressVo

None.
Deceased

boolean

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "PatientId": "c2d079c8-e1a2-429a-9527-9c2b9fa5adbd",
    "PatientXRef": "sample string 2",
    "PracticeId": "193aa978-b3f7-4cbd-8a77-c7334c7eebc1",
    "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-21T13:09:26Z",
      "IdentityNo": "sample string 5",
      "Gender": "sample string 6",
      "ContactNo": "sample string 7",
      "EmailAddress": "sample string 8"
    },
    "PatientAccountDetails": {
      "AccountId": "889c72bc-b4dc-4a80-a2b2-b59ae414c81c",
      "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-21T13:09:26Z",
        "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
  },
  {
    "PatientId": "c2d079c8-e1a2-429a-9527-9c2b9fa5adbd",
    "PatientXRef": "sample string 2",
    "PracticeId": "193aa978-b3f7-4cbd-8a77-c7334c7eebc1",
    "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-21T13:09:26Z",
      "IdentityNo": "sample string 5",
      "Gender": "sample string 6",
      "ContactNo": "sample string 7",
      "EmailAddress": "sample string 8"
    },
    "PatientAccountDetails": {
      "AccountId": "889c72bc-b4dc-4a80-a2b2-b59ae414c81c",
      "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-21T13:09:26Z",
        "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
  }
]

application/xml, text/xml

Sample: 
<ArrayOfPatient xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://mpsapi.healthbridge.com/clinical/patient/v1/patient/">
  <Patient>
    <Deceased>true</Deceased>
    <Employer>sample string 7</Employer>
    <FileNo>sample string 4</FileNo>
    <KnownAs>sample string 5</KnownAs>
    <MaritalStatus>sample string 9</MaritalStatus>
    <Occupation>sample string 6</Occupation>
    <PatientAccountDetails>
      <AccountId>889c72bc-b4dc-4a80-a2b2-b59ae414c81c</AccountId>
      <AccountNo>sample string 2</AccountNo>
      <IsCashAccount>true</IsCashAccount>
      <MedicalAidDependentCode>sample string 8</MedicalAidDependentCode>
      <MedicalAidMainMemberDetails>
        <ContactNo>sample string 7</ContactNo>
        <DateOfBirth>2025-04-21T13:09:26.1215936+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>
    </PatientAccountDetails>
    <PatientDetails>
      <ContactNo>sample string 7</ContactNo>
      <DateOfBirth>2025-04-21T13:09:26.1215936+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>
    </PatientDetails>
    <PatientId>c2d079c8-e1a2-429a-9527-9c2b9fa5adbd</PatientId>
    <PatientXRef>sample string 2</PatientXRef>
    <PhysicalAddress>
      <Code>sample string 4</Code>
      <Line1>sample string 1</Line1>
      <Line2>sample string 2</Line2>
      <Line3>sample string 3</Line3>
    </PhysicalAddress>
    <PostalAddress>
      <Code>sample string 4</Code>
      <Line1>sample string 1</Line1>
      <Line2>sample string 2</Line2>
      <Line3>sample string 3</Line3>
    </PostalAddress>
    <PracticeId>193aa978-b3f7-4cbd-8a77-c7334c7eebc1</PracticeId>
    <PreferredLanguage>sample string 8</PreferredLanguage>
  </Patient>
  <Patient>
    <Deceased>true</Deceased>
    <Employer>sample string 7</Employer>
    <FileNo>sample string 4</FileNo>
    <KnownAs>sample string 5</KnownAs>
    <MaritalStatus>sample string 9</MaritalStatus>
    <Occupation>sample string 6</Occupation>
    <PatientAccountDetails>
      <AccountId>889c72bc-b4dc-4a80-a2b2-b59ae414c81c</AccountId>
      <AccountNo>sample string 2</AccountNo>
      <IsCashAccount>true</IsCashAccount>
      <MedicalAidDependentCode>sample string 8</MedicalAidDependentCode>
      <MedicalAidMainMemberDetails>
        <ContactNo>sample string 7</ContactNo>
        <DateOfBirth>2025-04-21T13:09:26.1215936+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>
    </PatientAccountDetails>
    <PatientDetails>
      <ContactNo>sample string 7</ContactNo>
      <DateOfBirth>2025-04-21T13:09:26.1215936+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>
    </PatientDetails>
    <PatientId>c2d079c8-e1a2-429a-9527-9c2b9fa5adbd</PatientId>
    <PatientXRef>sample string 2</PatientXRef>
    <PhysicalAddress>
      <Code>sample string 4</Code>
      <Line1>sample string 1</Line1>
      <Line2>sample string 2</Line2>
      <Line3>sample string 3</Line3>
    </PhysicalAddress>
    <PostalAddress>
      <Code>sample string 4</Code>
      <Line1>sample string 1</Line1>
      <Line2>sample string 2</Line2>
      <Line3>sample string 3</Line3>
    </PostalAddress>
    <PracticeId>193aa978-b3f7-4cbd-8a77-c7334c7eebc1</PracticeId>
    <PreferredLanguage>sample string 8</PreferredLanguage>
  </Patient>
</ArrayOfPatient>