GET api/v1/{providerId}/clinical/patientclinicalnotes

Get patient clinical notes details for all patients for a tenant. Admin only endpoint.

Request Information

URI Parameters

Name	Description	Type	Additional information
providerId		globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

Collection of Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.PatientClinicalNotesVo

Name	Type	Additional information
PatientClinicalNotesId	globally unique identifier	None.
Patient	Com.Healthbridge.Hhas.Patient.Interface.ValueObjects.PatientVo	None.
PracticeId	globally unique identifier	None.
Note	string	None.
IsImportant	boolean	None.
Type	string	None.
Format	string	None.
CapturedDate	date	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "PatientClinicalNotesId": "be109b58-daf8-4457-a8bf-f736d14b1261",
    "Patient": {
      "PatientId": "a89817e5-5150-4cd1-88af-006113590700",
      "PatientXRef": "sample string 2",
      "PracticeId": "65c71264-caf6-4625-94ad-7a3805c29b97",
      "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-19T03:53:32Z",
        "IdentityNo": "sample string 5",
        "Gender": "sample string 6",
        "ContactNo": "sample string 7",
        "EmailAddress": "sample string 8"
      },
      "PatientAccountDetails": {
        "AccountId": "afe0bd88-c3ef-4823-bc37-5a90f6f62261",
        "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-19T03:53:32Z",
          "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
    },
    "PracticeId": "fd526db5-b71c-4ea2-a6c5-0c4aebfa4e84",
    "Note": "sample string 3",
    "IsImportant": true,
    "Type": "sample string 5",
    "Format": "sample string 6",
    "CapturedDate": "2025-11-19T03:53:32Z"
  },
  {
    "PatientClinicalNotesId": "be109b58-daf8-4457-a8bf-f736d14b1261",
    "Patient": {
      "PatientId": "a89817e5-5150-4cd1-88af-006113590700",
      "PatientXRef": "sample string 2",
      "PracticeId": "65c71264-caf6-4625-94ad-7a3805c29b97",
      "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-19T03:53:32Z",
        "IdentityNo": "sample string 5",
        "Gender": "sample string 6",
        "ContactNo": "sample string 7",
        "EmailAddress": "sample string 8"
      },
      "PatientAccountDetails": {
        "AccountId": "afe0bd88-c3ef-4823-bc37-5a90f6f62261",
        "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-19T03:53:32Z",
          "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
    },
    "PracticeId": "fd526db5-b71c-4ea2-a6c5-0c4aebfa4e84",
    "Note": "sample string 3",
    "IsImportant": true,
    "Type": "sample string 5",
    "Format": "sample string 6",
    "CapturedDate": "2025-11-19T03:53:32Z"
  }
]

application/xml, text/xml

Sample:

<ArrayOfPatientClinicalNotesVo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects">
  <PatientClinicalNotesVo>
    <CapturedDate>2025-11-19T03:53:32.8375672+02:00</CapturedDate>
    <Format>sample string 6</Format>
    <IsImportant>true</IsImportant>
    <Note>sample string 3</Note>
    <Patient xmlns:d3p1="http://mpsapi.healthbridge.com/clinical/patient/v1/patient/">
      <d3p1:Deceased>true</d3p1:Deceased>
      <d3p1:Employer>sample string 7</d3p1:Employer>
      <d3p1:FileNo>sample string 4</d3p1:FileNo>
      <d3p1:KnownAs>sample string 5</d3p1:KnownAs>
      <d3p1:MaritalStatus>sample string 9</d3p1:MaritalStatus>
      <d3p1:Occupation>sample string 6</d3p1:Occupation>
      <d3p1:PatientAccountDetails>
        <d3p1:AccountId>afe0bd88-c3ef-4823-bc37-5a90f6f62261</d3p1:AccountId>
        <d3p1:AccountNo>sample string 2</d3p1:AccountNo>
        <d3p1:IsCashAccount>true</d3p1:IsCashAccount>
        <d3p1:MedicalAidDependentCode>sample string 8</d3p1:MedicalAidDependentCode>
        <d3p1:MedicalAidMainMemberDetails>
          <d3p1:ContactNo>sample string 7</d3p1:ContactNo>
          <d3p1:DateOfBirth>2025-11-19T03:53:32.8375672+02:00</d3p1:DateOfBirth>
          <d3p1:EmailAddress>sample string 8</d3p1:EmailAddress>
          <d3p1:FirstName>sample string 2</d3p1:FirstName>
          <d3p1:Gender>sample string 6</d3p1:Gender>
          <d3p1:IdentityNo>sample string 5</d3p1:IdentityNo>
          <d3p1:Surname>sample string 3</d3p1:Surname>
          <d3p1:Title>sample string 1</d3p1:Title>
        </d3p1:MedicalAidMainMemberDetails>
        <d3p1:MedicalAidMembershipNumber>sample string 7</d3p1:MedicalAidMembershipNumber>
        <d3p1:MedicalAidName>sample string 4</d3p1:MedicalAidName>
        <d3p1:MedicalAidOptionCode>sample string 10</d3p1:MedicalAidOptionCode>
        <d3p1:MedicalAidPlan>sample string 5</d3p1:MedicalAidPlan>
        <d3p1:MedicalAidPlanCode>sample string 12</d3p1:MedicalAidPlanCode>
        <d3p1:MedicalAidPlanOption>sample string 6</d3p1:MedicalAidPlanOption>
        <d3p1:MedicalAidRoutingCode>sample string 9</d3p1:MedicalAidRoutingCode>
        <d3p1:MedicalAidSchemeCode>sample string 11</d3p1:MedicalAidSchemeCode>
      </d3p1:PatientAccountDetails>
      <d3p1:PatientDetails>
        <d3p1:ContactNo>sample string 7</d3p1:ContactNo>
        <d3p1:DateOfBirth>2025-11-19T03:53:32.8375672+02:00</d3p1:DateOfBirth>
        <d3p1:EmailAddress>sample string 8</d3p1:EmailAddress>
        <d3p1:FirstName>sample string 2</d3p1:FirstName>
        <d3p1:Gender>sample string 6</d3p1:Gender>
        <d3p1:IdentityNo>sample string 5</d3p1:IdentityNo>
        <d3p1:Surname>sample string 3</d3p1:Surname>
        <d3p1:Title>sample string 1</d3p1:Title>
      </d3p1:PatientDetails>
      <d3p1:PatientId>a89817e5-5150-4cd1-88af-006113590700</d3p1:PatientId>
      <d3p1:PatientXRef>sample string 2</d3p1:PatientXRef>
      <d3p1:PhysicalAddress>
        <d3p1:Code>sample string 4</d3p1:Code>
        <d3p1:Line1>sample string 1</d3p1:Line1>
        <d3p1:Line2>sample string 2</d3p1:Line2>
        <d3p1:Line3>sample string 3</d3p1:Line3>
      </d3p1:PhysicalAddress>
      <d3p1:PostalAddress>
        <d3p1:Code>sample string 4</d3p1:Code>
        <d3p1:Line1>sample string 1</d3p1:Line1>
        <d3p1:Line2>sample string 2</d3p1:Line2>
        <d3p1:Line3>sample string 3</d3p1:Line3>
      </d3p1:PostalAddress>
      <d3p1:PracticeId>65c71264-caf6-4625-94ad-7a3805c29b97</d3p1:PracticeId>
      <d3p1:PreferredLanguage>sample string 8</d3p1:PreferredLanguage>
    </Patient>
    <PatientClinicalNotesId>be109b58-daf8-4457-a8bf-f736d14b1261</PatientClinicalNotesId>
    <PracticeId>fd526db5-b71c-4ea2-a6c5-0c4aebfa4e84</PracticeId>
    <Type>sample string 5</Type>
  </PatientClinicalNotesVo>
  <PatientClinicalNotesVo>
    <CapturedDate>2025-11-19T03:53:32.8375672+02:00</CapturedDate>
    <Format>sample string 6</Format>
    <IsImportant>true</IsImportant>
    <Note>sample string 3</Note>
    <Patient xmlns:d3p1="http://mpsapi.healthbridge.com/clinical/patient/v1/patient/">
      <d3p1:Deceased>true</d3p1:Deceased>
      <d3p1:Employer>sample string 7</d3p1:Employer>
      <d3p1:FileNo>sample string 4</d3p1:FileNo>
      <d3p1:KnownAs>sample string 5</d3p1:KnownAs>
      <d3p1:MaritalStatus>sample string 9</d3p1:MaritalStatus>
      <d3p1:Occupation>sample string 6</d3p1:Occupation>
      <d3p1:PatientAccountDetails>
        <d3p1:AccountId>afe0bd88-c3ef-4823-bc37-5a90f6f62261</d3p1:AccountId>
        <d3p1:AccountNo>sample string 2</d3p1:AccountNo>
        <d3p1:IsCashAccount>true</d3p1:IsCashAccount>
        <d3p1:MedicalAidDependentCode>sample string 8</d3p1:MedicalAidDependentCode>
        <d3p1:MedicalAidMainMemberDetails>
          <d3p1:ContactNo>sample string 7</d3p1:ContactNo>
          <d3p1:DateOfBirth>2025-11-19T03:53:32.8375672+02:00</d3p1:DateOfBirth>
          <d3p1:EmailAddress>sample string 8</d3p1:EmailAddress>
          <d3p1:FirstName>sample string 2</d3p1:FirstName>
          <d3p1:Gender>sample string 6</d3p1:Gender>
          <d3p1:IdentityNo>sample string 5</d3p1:IdentityNo>
          <d3p1:Surname>sample string 3</d3p1:Surname>
          <d3p1:Title>sample string 1</d3p1:Title>
        </d3p1:MedicalAidMainMemberDetails>
        <d3p1:MedicalAidMembershipNumber>sample string 7</d3p1:MedicalAidMembershipNumber>
        <d3p1:MedicalAidName>sample string 4</d3p1:MedicalAidName>
        <d3p1:MedicalAidOptionCode>sample string 10</d3p1:MedicalAidOptionCode>
        <d3p1:MedicalAidPlan>sample string 5</d3p1:MedicalAidPlan>
        <d3p1:MedicalAidPlanCode>sample string 12</d3p1:MedicalAidPlanCode>
        <d3p1:MedicalAidPlanOption>sample string 6</d3p1:MedicalAidPlanOption>
        <d3p1:MedicalAidRoutingCode>sample string 9</d3p1:MedicalAidRoutingCode>
        <d3p1:MedicalAidSchemeCode>sample string 11</d3p1:MedicalAidSchemeCode>
      </d3p1:PatientAccountDetails>
      <d3p1:PatientDetails>
        <d3p1:ContactNo>sample string 7</d3p1:ContactNo>
        <d3p1:DateOfBirth>2025-11-19T03:53:32.8375672+02:00</d3p1:DateOfBirth>
        <d3p1:EmailAddress>sample string 8</d3p1:EmailAddress>
        <d3p1:FirstName>sample string 2</d3p1:FirstName>
        <d3p1:Gender>sample string 6</d3p1:Gender>
        <d3p1:IdentityNo>sample string 5</d3p1:IdentityNo>
        <d3p1:Surname>sample string 3</d3p1:Surname>
        <d3p1:Title>sample string 1</d3p1:Title>
      </d3p1:PatientDetails>
      <d3p1:PatientId>a89817e5-5150-4cd1-88af-006113590700</d3p1:PatientId>
      <d3p1:PatientXRef>sample string 2</d3p1:PatientXRef>
      <d3p1:PhysicalAddress>
        <d3p1:Code>sample string 4</d3p1:Code>
        <d3p1:Line1>sample string 1</d3p1:Line1>
        <d3p1:Line2>sample string 2</d3p1:Line2>
        <d3p1:Line3>sample string 3</d3p1:Line3>
      </d3p1:PhysicalAddress>
      <d3p1:PostalAddress>
        <d3p1:Code>sample string 4</d3p1:Code>
        <d3p1:Line1>sample string 1</d3p1:Line1>
        <d3p1:Line2>sample string 2</d3p1:Line2>
        <d3p1:Line3>sample string 3</d3p1:Line3>
      </d3p1:PostalAddress>
      <d3p1:PracticeId>65c71264-caf6-4625-94ad-7a3805c29b97</d3p1:PracticeId>
      <d3p1:PreferredLanguage>sample string 8</d3p1:PreferredLanguage>
    </Patient>
    <PatientClinicalNotesId>be109b58-daf8-4457-a8bf-f736d14b1261</PatientClinicalNotesId>
    <PracticeId>fd526db5-b71c-4ea2-a6c5-0c4aebfa4e84</PracticeId>
    <Type>sample string 5</Type>
  </PatientClinicalNotesVo>
</ArrayOfPatientClinicalNotesVo>

URI parameters

Headers | Add header

Body

Status

Headers

Body

GET api/v1/{providerId}/clinical/patientclinicalnotes

Request Information

URI Parameters

Body Parameters

Response Information

Resource Description

Response Formats

application/json, text/json

application/xml, text/xml