GET api/PatientDashboardCards

Returns the dashboard cards of logged in patient.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

PatientDashboardCardModel

Name	Description	Type	Additional 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": "14694dda-f5b3-4acf-922b-7d15be526f17",
      "FormLayoutId": "a8d2adf1-63f3-40e0-982c-b6d40e601cba",
      "PatientId": "6f6efe8a-9864-4507-868b-81b9ad6b7efe",
      "ExpirationDate": "sample string 4",
      "DoctorId": "b40e452a-49a6-4e39-aa0e-a2e954955bbf",
      "Completed": true,
      "SurveyLayoutName": "sample string 6"
    },
    {
      "Id": "14694dda-f5b3-4acf-922b-7d15be526f17",
      "FormLayoutId": "a8d2adf1-63f3-40e0-982c-b6d40e601cba",
      "PatientId": "6f6efe8a-9864-4507-868b-81b9ad6b7efe",
      "ExpirationDate": "sample string 4",
      "DoctorId": "b40e452a-49a6-4e39-aa0e-a2e954955bbf",
      "Completed": true,
      "SurveyLayoutName": "sample string 6"
    }
  ],
  "PatientApplicationAuthorizationCodes": [
    {
      "PatientApplicationAuthorizationCodeId": "02ae1206-07a1-4e73-85f8-5cbb539e8c42",
      "PatientApplicationInstanceId": "6d8565e4-3fda-4ffd-a86c-c9bf48c28dba",
      "Code": "sample string 3",
      "ExpirationDateTime": "sample string 4",
      "Used": true,
      "Id": "9c983ddb-ddfe-415a-b6b7-0df3e8b4d86d",
      "ApplicationInstanceId": "sample string 7",
      "ApplicationName": "sample string 8",
      "ApplicationVersion": "sample string 9",
      "DeviceId": "sample string 10",
      "EclClientAccountNumber": "sample string 11"
    },
    {
      "PatientApplicationAuthorizationCodeId": "02ae1206-07a1-4e73-85f8-5cbb539e8c42",
      "PatientApplicationInstanceId": "6d8565e4-3fda-4ffd-a86c-c9bf48c28dba",
      "Code": "sample string 3",
      "ExpirationDateTime": "sample string 4",
      "Used": true,
      "Id": "9c983ddb-ddfe-415a-b6b7-0df3e8b4d86d",
      "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": "4fab2436-79d4-4fd5-8e6a-d4549c3ab935",
      "TextToDisplay": "sample string 2",
      "Address": "sample string 3"
    },
    {
      "Id": "4fab2436-79d4-4fd5-8e6a-d4549c3ab935",
      "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>9c983ddb-ddfe-415a-b6b7-0df3e8b4d86d</Id>
      <PatientApplicationAuthorizationCodeId>02ae1206-07a1-4e73-85f8-5cbb539e8c42</PatientApplicationAuthorizationCodeId>
      <PatientApplicationInstanceId>6d8565e4-3fda-4ffd-a86c-c9bf48c28dba</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>9c983ddb-ddfe-415a-b6b7-0df3e8b4d86d</Id>
      <PatientApplicationAuthorizationCodeId>02ae1206-07a1-4e73-85f8-5cbb539e8c42</PatientApplicationAuthorizationCodeId>
      <PatientApplicationInstanceId>6d8565e4-3fda-4ffd-a86c-c9bf48c28dba</PatientApplicationInstanceId>
      <Used>true</Used>
    </PatientApplicationAuthorizationCodesModel>
  </PatientApplicationAuthorizationCodes>
  <Surveys>
    <SurveyRequestInfoModel>
      <Completed>true</Completed>
      <DoctorId>b40e452a-49a6-4e39-aa0e-a2e954955bbf</DoctorId>
      <ExpirationDate>sample string 4</ExpirationDate>
      <FormLayoutId>a8d2adf1-63f3-40e0-982c-b6d40e601cba</FormLayoutId>
      <Id>14694dda-f5b3-4acf-922b-7d15be526f17</Id>
      <PatientId>6f6efe8a-9864-4507-868b-81b9ad6b7efe</PatientId>
      <SurveyLayoutName>sample string 6</SurveyLayoutName>
    </SurveyRequestInfoModel>
    <SurveyRequestInfoModel>
      <Completed>true</Completed>
      <DoctorId>b40e452a-49a6-4e39-aa0e-a2e954955bbf</DoctorId>
      <ExpirationDate>sample string 4</ExpirationDate>
      <FormLayoutId>a8d2adf1-63f3-40e0-982c-b6d40e601cba</FormLayoutId>
      <Id>14694dda-f5b3-4acf-922b-7d15be526f17</Id>
      <PatientId>6f6efe8a-9864-4507-868b-81b9ad6b7efe</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>4fab2436-79d4-4fd5-8e6a-d4549c3ab935</Id>
      <TextToDisplay>sample string 2</TextToDisplay>
    </WebLinkModel>
    <WebLinkModel>
      <Address>sample string 3</Address>
      <Id>4fab2436-79d4-4fd5-8e6a-d4549c3ab935</Id>
      <TextToDisplay>sample string 2</TextToDisplay>
    </WebLinkModel>
  </WebLinks>
</PatientDashboardCardModel>