GET api/v1/{practiceId}/clinical/patientdashboards/{patientId}/header

Get patient dashboard header details - summary care record (allergies, notes, chronic condtions, etc)

Request Information

URI Parameters

NameDescriptionTypeAdditional information
practiceId

globally unique identifier

Required
patientId

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.PatientDashboardVo
NameDescriptionTypeAdditional 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": "1b771582-4ea5-4c13-b36e-dcc3555b38bd",
  "PatientId": "87b54ecb-69b7-4c3d-9b28-954fd76c5e7a",
  "FirstName": "sample string 3",
  "Surname": "sample string 4",
  "MedicalAidName": "sample string 5",
  "IdentityNo": "sample string 6",
  "DateOfBirth": "2025-11-19T05:01:21Z",
  "LastVisitDate": "2025-11-19T05:01:21Z",
  "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-11-19T05:01:21Z",
      "PatientId": "d6c53666-d186-43bb-b2a6-878964162ebe",
      "PathologyReportId": "2078c19c-7eba-4d83-8570-f4971f309543",
      "ParentReferenceId": "e69ce1d6-1724-415d-87ef-42103669a68f",
      "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-11-19T05:01:21Z",
      "PatientId": "d6c53666-d186-43bb-b2a6-878964162ebe",
      "PathologyReportId": "2078c19c-7eba-4d83-8570-f4971f309543",
      "ParentReferenceId": "e69ce1d6-1724-415d-87ef-42103669a68f",
      "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: 
<PatientDashboardVo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects">
  <Age>8</Age>
  <Allergies xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Allergies>
  <AllergiesNote>sample string 10</AllergiesNote>
  <ChronicConditions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ChronicConditions>
  <ClinicalNotes>sample string 12</ClinicalNotes>
  <Created>true</Created>
  <DateOfBirth>2025-11-19T05:01:21.1302446+02:00</DateOfBirth>
  <FirstName>sample string 3</FirstName>
  <IdentityNo>sample string 6</IdentityNo>
  <LastVisitDate>2025-11-19T05:01:21.1302446+02:00</LastVisitDate>
  <MedicalAidName>sample string 5</MedicalAidName>
  <NoAllergies>true</NoAllergies>
  <PatientDashboardEvents>
    <PatientDashboardHistoryEventDto>
      <Code>sample string 8</Code>
      <DateTime>2025-11-19T05:01:21.1302446+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>e69ce1d6-1724-415d-87ef-42103669a68f</ParentReferenceId>
      <PathologyReportId>2078c19c-7eba-4d83-8570-f4971f309543</PathologyReportId>
      <PatientId>d6c53666-d186-43bb-b2a6-878964162ebe</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-11-19T05:01:21.1302446+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>e69ce1d6-1724-415d-87ef-42103669a68f</ParentReferenceId>
      <PathologyReportId>2078c19c-7eba-4d83-8570-f4971f309543</PathologyReportId>
      <PatientId>d6c53666-d186-43bb-b2a6-878964162ebe</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>87b54ecb-69b7-4c3d-9b28-954fd76c5e7a</PatientId>
  <PracticeId>1b771582-4ea5-4c13-b36e-dcc3555b38bd</PracticeId>
  <Surname>sample string 4</Surname>
</PatientDashboardVo>