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": "efbaaf69-3b49-4e4d-a524-66169dee420d", "FormLayoutId": "5738df82-d920-489a-9dc8-fccb257cd2a9", "PatientId": "c3431ea4-5e53-4587-8c49-bc9741158fbe", "ExpirationDate": "sample string 4", "DoctorId": "d31482b3-b57b-473d-8f3d-e8ce49c1f178", "Completed": true, "SurveyLayoutName": "sample string 6" }, { "Id": "efbaaf69-3b49-4e4d-a524-66169dee420d", "FormLayoutId": "5738df82-d920-489a-9dc8-fccb257cd2a9", "PatientId": "c3431ea4-5e53-4587-8c49-bc9741158fbe", "ExpirationDate": "sample string 4", "DoctorId": "d31482b3-b57b-473d-8f3d-e8ce49c1f178", "Completed": true, "SurveyLayoutName": "sample string 6" } ], "PatientApplicationAuthorizationCodes": [ { "PatientApplicationAuthorizationCodeId": "75960e2c-06ca-4d9b-b58a-d5171ec30558", "PatientApplicationInstanceId": "84197556-2a8a-4863-bb71-3867ee685a2a", "Code": "sample string 3", "ExpirationDateTime": "sample string 4", "Used": true, "Id": "c5c4898c-73f6-4dd7-8004-5d5b926c5da0", "ApplicationInstanceId": "sample string 7", "ApplicationName": "sample string 8", "ApplicationVersion": "sample string 9", "DeviceId": "sample string 10", "EclClientAccountNumber": "sample string 11" }, { "PatientApplicationAuthorizationCodeId": "75960e2c-06ca-4d9b-b58a-d5171ec30558", "PatientApplicationInstanceId": "84197556-2a8a-4863-bb71-3867ee685a2a", "Code": "sample string 3", "ExpirationDateTime": "sample string 4", "Used": true, "Id": "c5c4898c-73f6-4dd7-8004-5d5b926c5da0", "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": "200431c1-f492-4eb0-8b93-7ea058e5b262", "TextToDisplay": "sample string 2", "Address": "sample string 3" }, { "Id": "200431c1-f492-4eb0-8b93-7ea058e5b262", "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>c5c4898c-73f6-4dd7-8004-5d5b926c5da0</Id> <PatientApplicationAuthorizationCodeId>75960e2c-06ca-4d9b-b58a-d5171ec30558</PatientApplicationAuthorizationCodeId> <PatientApplicationInstanceId>84197556-2a8a-4863-bb71-3867ee685a2a</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>c5c4898c-73f6-4dd7-8004-5d5b926c5da0</Id> <PatientApplicationAuthorizationCodeId>75960e2c-06ca-4d9b-b58a-d5171ec30558</PatientApplicationAuthorizationCodeId> <PatientApplicationInstanceId>84197556-2a8a-4863-bb71-3867ee685a2a</PatientApplicationInstanceId> <Used>true</Used> </PatientApplicationAuthorizationCodesModel> </PatientApplicationAuthorizationCodes> <Surveys> <SurveyRequestInfoModel> <Completed>true</Completed> <DoctorId>d31482b3-b57b-473d-8f3d-e8ce49c1f178</DoctorId> <ExpirationDate>sample string 4</ExpirationDate> <FormLayoutId>5738df82-d920-489a-9dc8-fccb257cd2a9</FormLayoutId> <Id>efbaaf69-3b49-4e4d-a524-66169dee420d</Id> <PatientId>c3431ea4-5e53-4587-8c49-bc9741158fbe</PatientId> <SurveyLayoutName>sample string 6</SurveyLayoutName> </SurveyRequestInfoModel> <SurveyRequestInfoModel> <Completed>true</Completed> <DoctorId>d31482b3-b57b-473d-8f3d-e8ce49c1f178</DoctorId> <ExpirationDate>sample string 4</ExpirationDate> <FormLayoutId>5738df82-d920-489a-9dc8-fccb257cd2a9</FormLayoutId> <Id>efbaaf69-3b49-4e4d-a524-66169dee420d</Id> <PatientId>c3431ea4-5e53-4587-8c49-bc9741158fbe</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>200431c1-f492-4eb0-8b93-7ea058e5b262</Id> <TextToDisplay>sample string 2</TextToDisplay> </WebLinkModel> <WebLinkModel> <Address>sample string 3</Address> <Id>200431c1-f492-4eb0-8b93-7ea058e5b262</Id> <TextToDisplay>sample string 2</TextToDisplay> </WebLinkModel> </WebLinks> </PatientDashboardCardModel>