POST api/v1/{providerId}/clinical/patient/{patientId}/lookup

Find all patient similar to provided one 1. find by IdentityNo if presented 2. find by firstName(3)+surname+dob

Request Information

URI Parameters

NameDescriptionTypeAdditional information
providerId

globally unique identifier

Required
patientId

globally unique identifier

Required

Body Parameters

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.

Request Formats

application/json, text/json

Sample: 
{
  "PatientId": "81ca79c9-5e9d-45c9-84d6-b3a5948dfd4e",
  "PatientXRef": "sample string 2",
  "PracticeId": "cbec3905-407b-4d66-8073-b52386238de4",
  "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-19T10:00:21Z",
    "IdentityNo": "sample string 5",
    "Gender": "sample string 6",
    "ContactNo": "sample string 7",
    "EmailAddress": "sample string 8"
  },
  "PatientAccountDetails": {
    "AccountId": "80e9bcc5-390f-4a64-a8cc-6dd51c4645fc",
    "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-19T10:00: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
}

application/xml, text/xml

Sample: 
<Patient xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://mpsapi.healthbridge.com/clinical/patient/v1/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>80e9bcc5-390f-4a64-a8cc-6dd51c4645fc</AccountId>
    <AccountNo>sample string 2</AccountNo>
    <IsCashAccount>true</IsCashAccount>
    <MedicalAidDependentCode>sample string 8</MedicalAidDependentCode>
    <MedicalAidMainMemberDetails>
      <ContactNo>sample string 7</ContactNo>
      <DateOfBirth>2025-11-19T10:00:21.8742039+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-11-19T10:00:21.8742039+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>81ca79c9-5e9d-45c9-84d6-b3a5948dfd4e</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>cbec3905-407b-4d66-8073-b52386238de4</PracticeId>
  <PreferredLanguage>sample string 8</PreferredLanguage>
</Patient>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'System.Web.Http.ModelBinding.JQueryMvcFormUrlEncodedFormatter' to write type 'PatientVo'.

Response Information

Resource Description

Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects.RestApiResultOfCom.Healthbridge.Hhas.Patient.Interface.ValueObjects.PatientVo[]
NameDescriptionTypeAdditional information
Sucess

boolean

None.
ResponseCode

integer

None.
ResponseMessage

string

None.
Data

Collection of Com.Healthbridge.Hhas.Patient.Interface.ValueObjects.PatientVo

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": [
    {
      "PatientId": "9e854d44-b749-413d-8564-b57bbe608255",
      "PatientXRef": "sample string 2",
      "PracticeId": "a32a4ddd-a134-4552-b51c-c0b040024e74",
      "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-19T10:00:21Z",
        "IdentityNo": "sample string 5",
        "Gender": "sample string 6",
        "ContactNo": "sample string 7",
        "EmailAddress": "sample string 8"
      },
      "PatientAccountDetails": {
        "AccountId": "51c18156-5d66-4029-96b4-bc5de97426b5",
        "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-19T10:00: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
    },
    {
      "PatientId": "9e854d44-b749-413d-8564-b57bbe608255",
      "PatientXRef": "sample string 2",
      "PracticeId": "a32a4ddd-a134-4552-b51c-c0b040024e74",
      "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-19T10:00:21Z",
        "IdentityNo": "sample string 5",
        "Gender": "sample string 6",
        "ContactNo": "sample string 7",
        "EmailAddress": "sample string 8"
      },
      "PatientAccountDetails": {
        "AccountId": "51c18156-5d66-4029-96b4-bc5de97426b5",
        "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-19T10:00: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
    }
  ],
  "Links": [
    {
      "Rel": "sample string 1",
      "HRef": "sample string 2"
    },
    {
      "Rel": "sample string 1",
      "HRef": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample: 
<RestApiResultOfArrayOfPatientAN1HZlnr 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/patient/v1/patient/">
    <d2p1: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>51c18156-5d66-4029-96b4-bc5de97426b5</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-19T10:00:21.8742039+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-19T10:00:21.8742039+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>9e854d44-b749-413d-8564-b57bbe608255</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>a32a4ddd-a134-4552-b51c-c0b040024e74</d2p1:PracticeId>
      <d2p1:PreferredLanguage>sample string 8</d2p1:PreferredLanguage>
    </d2p1:Patient>
    <d2p1: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>51c18156-5d66-4029-96b4-bc5de97426b5</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-19T10:00:21.8742039+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-19T10:00:21.8742039+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>9e854d44-b749-413d-8564-b57bbe608255</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>a32a4ddd-a134-4552-b51c-c0b040024e74</d2p1:PracticeId>
      <d2p1:PreferredLanguage>sample string 8</d2p1:PreferredLanguage>
    </d2p1:Patient>
  </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>
</RestApiResultOfArrayOfPatientAN1HZlnr>