GET api/PatientDashboardCards
Returns the dashboard cards of logged in patient.
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
PatientDashboardCardModelName | 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": "4478caff-593c-4390-adff-93fc8961eafe", "FormLayoutId": "eff6b6c0-09a5-4ae6-880f-348349ba6845", "PatientId": "794ed48c-c4ff-4f03-8f4f-f6c5dd91a366", "ExpirationDate": "sample string 4", "DoctorId": "63d56d78-ebfd-4656-a772-bfa1579d44f9", "Completed": true, "SurveyLayoutName": "sample string 6" }, { "Id": "4478caff-593c-4390-adff-93fc8961eafe", "FormLayoutId": "eff6b6c0-09a5-4ae6-880f-348349ba6845", "PatientId": "794ed48c-c4ff-4f03-8f4f-f6c5dd91a366", "ExpirationDate": "sample string 4", "DoctorId": "63d56d78-ebfd-4656-a772-bfa1579d44f9", "Completed": true, "SurveyLayoutName": "sample string 6" } ], "PatientApplicationAuthorizationCodes": [ { "PatientApplicationAuthorizationCodeId": "50b7b754-322d-48c1-b24e-52f96fe9f6bd", "PatientApplicationInstanceId": "128b51a7-1f86-40a7-9849-fc36283c7c1c", "Code": "sample string 3", "ExpirationDateTime": "sample string 4", "Used": true, "Id": "86d94e79-e0ec-48c5-aab4-d19b3efc702b", "ApplicationInstanceId": "sample string 7", "ApplicationName": "sample string 8", "ApplicationVersion": "sample string 9", "DeviceId": "sample string 10", "EclClientAccountNumber": "sample string 11" }, { "PatientApplicationAuthorizationCodeId": "50b7b754-322d-48c1-b24e-52f96fe9f6bd", "PatientApplicationInstanceId": "128b51a7-1f86-40a7-9849-fc36283c7c1c", "Code": "sample string 3", "ExpirationDateTime": "sample string 4", "Used": true, "Id": "86d94e79-e0ec-48c5-aab4-d19b3efc702b", "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": "61f3d518-b04f-4831-b590-b33d27f11e13", "TextToDisplay": "sample string 2", "Address": "sample string 3" }, { "Id": "61f3d518-b04f-4831-b590-b33d27f11e13", "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>86d94e79-e0ec-48c5-aab4-d19b3efc702b</Id> <PatientApplicationAuthorizationCodeId>50b7b754-322d-48c1-b24e-52f96fe9f6bd</PatientApplicationAuthorizationCodeId> <PatientApplicationInstanceId>128b51a7-1f86-40a7-9849-fc36283c7c1c</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>86d94e79-e0ec-48c5-aab4-d19b3efc702b</Id> <PatientApplicationAuthorizationCodeId>50b7b754-322d-48c1-b24e-52f96fe9f6bd</PatientApplicationAuthorizationCodeId> <PatientApplicationInstanceId>128b51a7-1f86-40a7-9849-fc36283c7c1c</PatientApplicationInstanceId> <Used>true</Used> </PatientApplicationAuthorizationCodesModel> </PatientApplicationAuthorizationCodes> <Surveys> <SurveyRequestInfoModel> <Completed>true</Completed> <DoctorId>63d56d78-ebfd-4656-a772-bfa1579d44f9</DoctorId> <ExpirationDate>sample string 4</ExpirationDate> <FormLayoutId>eff6b6c0-09a5-4ae6-880f-348349ba6845</FormLayoutId> <Id>4478caff-593c-4390-adff-93fc8961eafe</Id> <PatientId>794ed48c-c4ff-4f03-8f4f-f6c5dd91a366</PatientId> <SurveyLayoutName>sample string 6</SurveyLayoutName> </SurveyRequestInfoModel> <SurveyRequestInfoModel> <Completed>true</Completed> <DoctorId>63d56d78-ebfd-4656-a772-bfa1579d44f9</DoctorId> <ExpirationDate>sample string 4</ExpirationDate> <FormLayoutId>eff6b6c0-09a5-4ae6-880f-348349ba6845</FormLayoutId> <Id>4478caff-593c-4390-adff-93fc8961eafe</Id> <PatientId>794ed48c-c4ff-4f03-8f4f-f6c5dd91a366</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>61f3d518-b04f-4831-b590-b33d27f11e13</Id> <TextToDisplay>sample string 2</TextToDisplay> </WebLinkModel> <WebLinkModel> <Address>sample string 3</Address> <Id>61f3d518-b04f-4831-b590-b33d27f11e13</Id> <TextToDisplay>sample string 2</TextToDisplay> </WebLinkModel> </WebLinks> </PatientDashboardCardModel>