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

Get filtered patients in the practice

Request Information

URI Parameters

Name	Description	Type	Additional 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

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

Name	Type	Additional 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": "a8334ccf-7fcc-4263-880e-fc414963f601",
      "PatientXRef": "sample string 2",
      "PracticeId": "afbbd553-9907-4535-906c-74396df16e88",
      "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-10T19:47:13Z",
        "IdentityNo": "sample string 5",
        "Gender": "sample string 6",
        "ContactNo": "sample string 7",
        "EmailAddress": "sample string 8"
      },
      "PatientAccountDetails": {
        "AccountId": "0f0d45ff-70a0-4391-9599-90523f90eab4",
        "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-10T19:47:13Z",
          "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": "a8334ccf-7fcc-4263-880e-fc414963f601",
      "PatientXRef": "sample string 2",
      "PracticeId": "afbbd553-9907-4535-906c-74396df16e88",
      "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-10T19:47:13Z",
        "IdentityNo": "sample string 5",
        "Gender": "sample string 6",
        "ContactNo": "sample string 7",
        "EmailAddress": "sample string 8"
      },
      "PatientAccountDetails": {
        "AccountId": "0f0d45ff-70a0-4391-9599-90523f90eab4",
        "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-10T19:47:13Z",
          "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>0f0d45ff-70a0-4391-9599-90523f90eab4</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-04-10T19:47:13.9174739+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-04-10T19:47:13.9174739+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>a8334ccf-7fcc-4263-880e-fc414963f601</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>afbbd553-9907-4535-906c-74396df16e88</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>0f0d45ff-70a0-4391-9599-90523f90eab4</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-04-10T19:47:13.9174739+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-04-10T19:47:13.9174739+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>a8334ccf-7fcc-4263-880e-fc414963f601</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>afbbd553-9907-4535-906c-74396df16e88</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>

URI parameters

Headers | Add header

Body

Status

Headers

Body

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

Request Information

URI Parameters

Body Parameters

Response Information

Resource Description

Response Formats

application/json, text/json

application/xml, text/xml