GET api/v1/{practiceId}/clinical/pathologyreports/{pathologyReportId}/linkedpatients

Get linked patients list for specific pathology report

Request Information

URI Parameters

Name	Description	Type	Additional information
practiceId		globally unique identifier	Required
pathologyReportId	pathology report id	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

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

Name	Type	Additional information
PracticeId	globally unique identifier	None.
PatientId	globally unique identifier	None.
FirstName	string	None.
Surname	string	None.
MedicalAidName	string	None.
IdentityNo	string	None.
DateOfBirth	date	None.
LastVisitDate	date	None.
Age	integer	None.
Created	boolean	None.
Allergies	Collection of string	None.
AllergiesNote	string	None.
NoAllergies	boolean	None.
ClinicalNotes	string	None.
ChronicConditions	Collection of string	None.
PatientDashboardEventsCount	integer	None.
PatientDashboardEvents	Collection of Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.PatientDashboardHistoryEventDto	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "PracticeId": "2e8e4fad-a0cd-439c-9e20-328a7f45a7ca",
    "PatientId": "60ecf74c-4e96-4d44-8944-dc8e89f1eac4",
    "FirstName": "sample string 3",
    "Surname": "sample string 4",
    "MedicalAidName": "sample string 5",
    "IdentityNo": "sample string 6",
    "DateOfBirth": "2025-08-06T16:54:57Z",
    "LastVisitDate": "2025-08-06T16:54:57Z",
    "Age": 8,
    "Created": true,
    "Allergies": [
      "sample string 1",
      "sample string 2"
    ],
    "AllergiesNote": "sample string 10",
    "NoAllergies": true,
    "ClinicalNotes": "sample string 12",
    "ChronicConditions": [
      "sample string 1",
      "sample string 2"
    ],
    "PatientDashboardEventsCount": 13,
    "PatientDashboardEvents": [
      {
        "DateTime": "2025-08-06T16:54:57Z",
        "PatientId": "9ce60405-59f6-471d-b063-5751e5cfc5a9",
        "PathologyReportId": "5276166a-5634-4978-be20-a497b7c09bfa",
        "ParentReferenceId": "c317fa3c-6921-4a1d-870d-707004bf3167",
        "ParentDescription": "sample string 4",
        "NotMatched": true,
        "Type": "sample string 6",
        "ParentLineNum": 7,
        "Code": "sample string 8",
        "Description": "sample string 9",
        "Value": "sample string 10",
        "ValueUnits": "sample string 11",
        "ValueFlag": "sample string 12",
        "Narrative": "sample string 13",
        "Thumbnail": "sample string 14"
      },
      {
        "DateTime": "2025-08-06T16:54:57Z",
        "PatientId": "9ce60405-59f6-471d-b063-5751e5cfc5a9",
        "PathologyReportId": "5276166a-5634-4978-be20-a497b7c09bfa",
        "ParentReferenceId": "c317fa3c-6921-4a1d-870d-707004bf3167",
        "ParentDescription": "sample string 4",
        "NotMatched": true,
        "Type": "sample string 6",
        "ParentLineNum": 7,
        "Code": "sample string 8",
        "Description": "sample string 9",
        "Value": "sample string 10",
        "ValueUnits": "sample string 11",
        "ValueFlag": "sample string 12",
        "Narrative": "sample string 13",
        "Thumbnail": "sample string 14"
      }
    ]
  },
  {
    "PracticeId": "2e8e4fad-a0cd-439c-9e20-328a7f45a7ca",
    "PatientId": "60ecf74c-4e96-4d44-8944-dc8e89f1eac4",
    "FirstName": "sample string 3",
    "Surname": "sample string 4",
    "MedicalAidName": "sample string 5",
    "IdentityNo": "sample string 6",
    "DateOfBirth": "2025-08-06T16:54:57Z",
    "LastVisitDate": "2025-08-06T16:54:57Z",
    "Age": 8,
    "Created": true,
    "Allergies": [
      "sample string 1",
      "sample string 2"
    ],
    "AllergiesNote": "sample string 10",
    "NoAllergies": true,
    "ClinicalNotes": "sample string 12",
    "ChronicConditions": [
      "sample string 1",
      "sample string 2"
    ],
    "PatientDashboardEventsCount": 13,
    "PatientDashboardEvents": [
      {
        "DateTime": "2025-08-06T16:54:57Z",
        "PatientId": "9ce60405-59f6-471d-b063-5751e5cfc5a9",
        "PathologyReportId": "5276166a-5634-4978-be20-a497b7c09bfa",
        "ParentReferenceId": "c317fa3c-6921-4a1d-870d-707004bf3167",
        "ParentDescription": "sample string 4",
        "NotMatched": true,
        "Type": "sample string 6",
        "ParentLineNum": 7,
        "Code": "sample string 8",
        "Description": "sample string 9",
        "Value": "sample string 10",
        "ValueUnits": "sample string 11",
        "ValueFlag": "sample string 12",
        "Narrative": "sample string 13",
        "Thumbnail": "sample string 14"
      },
      {
        "DateTime": "2025-08-06T16:54:57Z",
        "PatientId": "9ce60405-59f6-471d-b063-5751e5cfc5a9",
        "PathologyReportId": "5276166a-5634-4978-be20-a497b7c09bfa",
        "ParentReferenceId": "c317fa3c-6921-4a1d-870d-707004bf3167",
        "ParentDescription": "sample string 4",
        "NotMatched": true,
        "Type": "sample string 6",
        "ParentLineNum": 7,
        "Code": "sample string 8",
        "Description": "sample string 9",
        "Value": "sample string 10",
        "ValueUnits": "sample string 11",
        "ValueFlag": "sample string 12",
        "Narrative": "sample string 13",
        "Thumbnail": "sample string 14"
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfPatientDashboardVo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects">
  <PatientDashboardVo>
    <Age>8</Age>
    <Allergies xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Allergies>
    <AllergiesNote>sample string 10</AllergiesNote>
    <ChronicConditions xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </ChronicConditions>
    <ClinicalNotes>sample string 12</ClinicalNotes>
    <Created>true</Created>
    <DateOfBirth>2025-08-06T16:54:57.3631125+02:00</DateOfBirth>
    <FirstName>sample string 3</FirstName>
    <IdentityNo>sample string 6</IdentityNo>
    <LastVisitDate>2025-08-06T16:54:57.3631125+02:00</LastVisitDate>
    <MedicalAidName>sample string 5</MedicalAidName>
    <NoAllergies>true</NoAllergies>
    <PatientDashboardEvents>
      <PatientDashboardHistoryEventDto>
        <Code>sample string 8</Code>
        <DateTime>2025-08-06T16:54:57.3631125+02:00</DateTime>
        <Description>sample string 9</Description>
        <Narrative>sample string 13</Narrative>
        <NotMatched>true</NotMatched>
        <ParentDescription>sample string 4</ParentDescription>
        <ParentLineNum>7</ParentLineNum>
        <ParentReferenceId>c317fa3c-6921-4a1d-870d-707004bf3167</ParentReferenceId>
        <PathologyReportId>5276166a-5634-4978-be20-a497b7c09bfa</PathologyReportId>
        <PatientId>9ce60405-59f6-471d-b063-5751e5cfc5a9</PatientId>
        <Thumbnail>sample string 14</Thumbnail>
        <Type>sample string 6</Type>
        <Value>sample string 10</Value>
        <ValueFlag>sample string 12</ValueFlag>
        <ValueUnits>sample string 11</ValueUnits>
      </PatientDashboardHistoryEventDto>
      <PatientDashboardHistoryEventDto>
        <Code>sample string 8</Code>
        <DateTime>2025-08-06T16:54:57.3631125+02:00</DateTime>
        <Description>sample string 9</Description>
        <Narrative>sample string 13</Narrative>
        <NotMatched>true</NotMatched>
        <ParentDescription>sample string 4</ParentDescription>
        <ParentLineNum>7</ParentLineNum>
        <ParentReferenceId>c317fa3c-6921-4a1d-870d-707004bf3167</ParentReferenceId>
        <PathologyReportId>5276166a-5634-4978-be20-a497b7c09bfa</PathologyReportId>
        <PatientId>9ce60405-59f6-471d-b063-5751e5cfc5a9</PatientId>
        <Thumbnail>sample string 14</Thumbnail>
        <Type>sample string 6</Type>
        <Value>sample string 10</Value>
        <ValueFlag>sample string 12</ValueFlag>
        <ValueUnits>sample string 11</ValueUnits>
      </PatientDashboardHistoryEventDto>
    </PatientDashboardEvents>
    <PatientDashboardEventsCount>13</PatientDashboardEventsCount>
    <PatientId>60ecf74c-4e96-4d44-8944-dc8e89f1eac4</PatientId>
    <PracticeId>2e8e4fad-a0cd-439c-9e20-328a7f45a7ca</PracticeId>
    <Surname>sample string 4</Surname>
  </PatientDashboardVo>
  <PatientDashboardVo>
    <Age>8</Age>
    <Allergies xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Allergies>
    <AllergiesNote>sample string 10</AllergiesNote>
    <ChronicConditions xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </ChronicConditions>
    <ClinicalNotes>sample string 12</ClinicalNotes>
    <Created>true</Created>
    <DateOfBirth>2025-08-06T16:54:57.3631125+02:00</DateOfBirth>
    <FirstName>sample string 3</FirstName>
    <IdentityNo>sample string 6</IdentityNo>
    <LastVisitDate>2025-08-06T16:54:57.3631125+02:00</LastVisitDate>
    <MedicalAidName>sample string 5</MedicalAidName>
    <NoAllergies>true</NoAllergies>
    <PatientDashboardEvents>
      <PatientDashboardHistoryEventDto>
        <Code>sample string 8</Code>
        <DateTime>2025-08-06T16:54:57.3631125+02:00</DateTime>
        <Description>sample string 9</Description>
        <Narrative>sample string 13</Narrative>
        <NotMatched>true</NotMatched>
        <ParentDescription>sample string 4</ParentDescription>
        <ParentLineNum>7</ParentLineNum>
        <ParentReferenceId>c317fa3c-6921-4a1d-870d-707004bf3167</ParentReferenceId>
        <PathologyReportId>5276166a-5634-4978-be20-a497b7c09bfa</PathologyReportId>
        <PatientId>9ce60405-59f6-471d-b063-5751e5cfc5a9</PatientId>
        <Thumbnail>sample string 14</Thumbnail>
        <Type>sample string 6</Type>
        <Value>sample string 10</Value>
        <ValueFlag>sample string 12</ValueFlag>
        <ValueUnits>sample string 11</ValueUnits>
      </PatientDashboardHistoryEventDto>
      <PatientDashboardHistoryEventDto>
        <Code>sample string 8</Code>
        <DateTime>2025-08-06T16:54:57.3631125+02:00</DateTime>
        <Description>sample string 9</Description>
        <Narrative>sample string 13</Narrative>
        <NotMatched>true</NotMatched>
        <ParentDescription>sample string 4</ParentDescription>
        <ParentLineNum>7</ParentLineNum>
        <ParentReferenceId>c317fa3c-6921-4a1d-870d-707004bf3167</ParentReferenceId>
        <PathologyReportId>5276166a-5634-4978-be20-a497b7c09bfa</PathologyReportId>
        <PatientId>9ce60405-59f6-471d-b063-5751e5cfc5a9</PatientId>
        <Thumbnail>sample string 14</Thumbnail>
        <Type>sample string 6</Type>
        <Value>sample string 10</Value>
        <ValueFlag>sample string 12</ValueFlag>
        <ValueUnits>sample string 11</ValueUnits>
      </PatientDashboardHistoryEventDto>
    </PatientDashboardEvents>
    <PatientDashboardEventsCount>13</PatientDashboardEventsCount>
    <PatientId>60ecf74c-4e96-4d44-8944-dc8e89f1eac4</PatientId>
    <PracticeId>2e8e4fad-a0cd-439c-9e20-328a7f45a7ca</PracticeId>
    <Surname>sample string 4</Surname>
  </PatientDashboardVo>
</ArrayOfPatientDashboardVo>

URI parameters

Headers | Add header

Body

Status

Headers

Body

GET api/v1/{practiceId}/clinical/pathologyreports/{pathologyReportId}/linkedpatients

Request Information

URI Parameters

Body Parameters

Response Information

Resource Description

Response Formats

application/json, text/json

application/xml, text/xml