GET api/PatientDashboardCards

Returns the dashboard cards of logged in patient.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

PatientDashboardCardModel
NameDescriptionTypeAdditional information
FullName

Full name of patient

string

None.

DateOfBirth

DOB of patient

string

None.

LastVisitDate

Last visit date of patient.

string

None.

LastLoginDate

Last login date of patient.

string

None.

UpcomingAppointmentDate

Patient upcoming appointment date

string

None.

UpcomingAppointmentLocationName

Patient upcoming appointment location

string

None.

Surveys

List of patient survey information

Collection of SurveyRequestInfoModel

None.

PatientApplicationAuthorizationCodes

List of patient application and authrization code information

Collection of PatientApplicationAuthorizationCodesModel

None.

HealthSummaryLastUpdateDate

Date of last updated health summary for patient

string

None.

WebLinks

List of web links of the patient.

Collection of WebLinkModel

None.

NewEducationResourcesQuantity

Quantity of new education resources for patient

integer

None.

NewSecureMessagesQuantity

Quantity of new secure messages for patient

integer

None.

AcceptedCommunicationTypes

Communication types accepted by patients

string

None.

Response Formats

application/json, text/json

Sample:
{
  "FullName": "sample string 1",
  "DateOfBirth": "sample string 2",
  "LastVisitDate": "sample string 3",
  "LastLoginDate": "sample string 4",
  "UpcomingAppointmentDate": "sample string 5",
  "UpcomingAppointmentLocationName": "sample string 6",
  "Surveys": [
    {
      "Id": "ce5c70c1-6fe7-4632-8b2b-c44caf72189b",
      "FormLayoutId": "b65df687-db69-4693-add0-aecb1e22a5d3",
      "PatientId": "54a2db5e-a5f6-44a0-93fe-8e560476bf9e",
      "ExpirationDate": "sample string 4",
      "DoctorId": "72c616c4-2fec-4003-b2df-3be590d300ff",
      "Completed": true,
      "SurveyLayoutName": "sample string 6"
    },
    {
      "Id": "ce5c70c1-6fe7-4632-8b2b-c44caf72189b",
      "FormLayoutId": "b65df687-db69-4693-add0-aecb1e22a5d3",
      "PatientId": "54a2db5e-a5f6-44a0-93fe-8e560476bf9e",
      "ExpirationDate": "sample string 4",
      "DoctorId": "72c616c4-2fec-4003-b2df-3be590d300ff",
      "Completed": true,
      "SurveyLayoutName": "sample string 6"
    }
  ],
  "PatientApplicationAuthorizationCodes": [
    {
      "PatientApplicationAuthorizationCodeId": "8085ab4a-3007-49f5-ade4-d5f668647343",
      "PatientApplicationInstanceId": "656b27fb-da73-4aa0-a410-9a27ba03d008",
      "Code": "sample string 3",
      "ExpirationDateTime": "sample string 4",
      "Used": true,
      "Id": "ba71b917-5313-4362-b4af-d0ed4f500c25",
      "ApplicationInstanceId": "sample string 7",
      "ApplicationName": "sample string 8",
      "ApplicationVersion": "sample string 9",
      "DeviceId": "sample string 10",
      "EclClientAccountNumber": "sample string 11"
    },
    {
      "PatientApplicationAuthorizationCodeId": "8085ab4a-3007-49f5-ade4-d5f668647343",
      "PatientApplicationInstanceId": "656b27fb-da73-4aa0-a410-9a27ba03d008",
      "Code": "sample string 3",
      "ExpirationDateTime": "sample string 4",
      "Used": true,
      "Id": "ba71b917-5313-4362-b4af-d0ed4f500c25",
      "ApplicationInstanceId": "sample string 7",
      "ApplicationName": "sample string 8",
      "ApplicationVersion": "sample string 9",
      "DeviceId": "sample string 10",
      "EclClientAccountNumber": "sample string 11"
    }
  ],
  "HealthSummaryLastUpdateDate": "sample string 7",
  "WebLinks": [
    {
      "Id": "6a362e9e-1866-4b2b-bbe1-720686e67e1e",
      "TextToDisplay": "sample string 2",
      "Address": "sample string 3"
    },
    {
      "Id": "6a362e9e-1866-4b2b-bbe1-720686e67e1e",
      "TextToDisplay": "sample string 2",
      "Address": "sample string 3"
    }
  ],
  "NewEducationResourcesQuantity": 8,
  "NewSecureMessagesQuantity": 9,
  "AcceptedCommunicationTypes": "sample string 10"
}

application/xml, text/xml

Sample:
<PatientDashboardCardModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models.PatientDashboardCards">
  <AcceptedCommunicationTypes>sample string 10</AcceptedCommunicationTypes>
  <DateOfBirth>sample string 2</DateOfBirth>
  <FullName>sample string 1</FullName>
  <HealthSummaryLastUpdateDate>sample string 7</HealthSummaryLastUpdateDate>
  <LastLoginDate>sample string 4</LastLoginDate>
  <LastVisitDate>sample string 3</LastVisitDate>
  <NewEducationResourcesQuantity>8</NewEducationResourcesQuantity>
  <NewSecureMessagesQuantity>9</NewSecureMessagesQuantity>
  <PatientApplicationAuthorizationCodes>
    <PatientApplicationAuthorizationCodesModel>
      <ApplicationInstanceId>sample string 7</ApplicationInstanceId>
      <ApplicationName>sample string 8</ApplicationName>
      <ApplicationVersion>sample string 9</ApplicationVersion>
      <Code>sample string 3</Code>
      <DeviceId>sample string 10</DeviceId>
      <EclClientAccountNumber>sample string 11</EclClientAccountNumber>
      <ExpirationDateTime>sample string 4</ExpirationDateTime>
      <Id>ba71b917-5313-4362-b4af-d0ed4f500c25</Id>
      <PatientApplicationAuthorizationCodeId>8085ab4a-3007-49f5-ade4-d5f668647343</PatientApplicationAuthorizationCodeId>
      <PatientApplicationInstanceId>656b27fb-da73-4aa0-a410-9a27ba03d008</PatientApplicationInstanceId>
      <Used>true</Used>
    </PatientApplicationAuthorizationCodesModel>
    <PatientApplicationAuthorizationCodesModel>
      <ApplicationInstanceId>sample string 7</ApplicationInstanceId>
      <ApplicationName>sample string 8</ApplicationName>
      <ApplicationVersion>sample string 9</ApplicationVersion>
      <Code>sample string 3</Code>
      <DeviceId>sample string 10</DeviceId>
      <EclClientAccountNumber>sample string 11</EclClientAccountNumber>
      <ExpirationDateTime>sample string 4</ExpirationDateTime>
      <Id>ba71b917-5313-4362-b4af-d0ed4f500c25</Id>
      <PatientApplicationAuthorizationCodeId>8085ab4a-3007-49f5-ade4-d5f668647343</PatientApplicationAuthorizationCodeId>
      <PatientApplicationInstanceId>656b27fb-da73-4aa0-a410-9a27ba03d008</PatientApplicationInstanceId>
      <Used>true</Used>
    </PatientApplicationAuthorizationCodesModel>
  </PatientApplicationAuthorizationCodes>
  <Surveys>
    <SurveyRequestInfoModel>
      <Completed>true</Completed>
      <DoctorId>72c616c4-2fec-4003-b2df-3be590d300ff</DoctorId>
      <ExpirationDate>sample string 4</ExpirationDate>
      <FormLayoutId>b65df687-db69-4693-add0-aecb1e22a5d3</FormLayoutId>
      <Id>ce5c70c1-6fe7-4632-8b2b-c44caf72189b</Id>
      <PatientId>54a2db5e-a5f6-44a0-93fe-8e560476bf9e</PatientId>
      <SurveyLayoutName>sample string 6</SurveyLayoutName>
    </SurveyRequestInfoModel>
    <SurveyRequestInfoModel>
      <Completed>true</Completed>
      <DoctorId>72c616c4-2fec-4003-b2df-3be590d300ff</DoctorId>
      <ExpirationDate>sample string 4</ExpirationDate>
      <FormLayoutId>b65df687-db69-4693-add0-aecb1e22a5d3</FormLayoutId>
      <Id>ce5c70c1-6fe7-4632-8b2b-c44caf72189b</Id>
      <PatientId>54a2db5e-a5f6-44a0-93fe-8e560476bf9e</PatientId>
      <SurveyLayoutName>sample string 6</SurveyLayoutName>
    </SurveyRequestInfoModel>
  </Surveys>
  <UpcomingAppointmentDate>sample string 5</UpcomingAppointmentDate>
  <UpcomingAppointmentLocationName>sample string 6</UpcomingAppointmentLocationName>
  <WebLinks>
    <WebLinkModel>
      <Address>sample string 3</Address>
      <Id>6a362e9e-1866-4b2b-bbe1-720686e67e1e</Id>
      <TextToDisplay>sample string 2</TextToDisplay>
    </WebLinkModel>
    <WebLinkModel>
      <Address>sample string 3</Address>
      <Id>6a362e9e-1866-4b2b-bbe1-720686e67e1e</Id>
      <TextToDisplay>sample string 2</TextToDisplay>
    </WebLinkModel>
  </WebLinks>
</PatientDashboardCardModel>