GET api/PatientAccessHealthSummaries/search?enteredOperator={enteredOperator}&entered1={entered1}&entered2={entered2}&doctorId[0]={doctorId[0]}&doctorId[1]={doctorId[1]}&type[0]={type[0]}&type[1]={type[1]}&page={page}&itemsPerPage={itemsPerPage}
Returns a list of health summary of a patient.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
enteredOperator |
Entered date operator an outgoing secure messages's comparison operators. Possible values: NotCompare (equals to empty string ""), Equals, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual, Between, DifferentThan, Contains, StartsWith |
string |
Default value is |
entered1 |
Date when health summary was entered. |
date |
None. |
entered2 |
Second date when health summary was entered. |
date |
None. |
doctorId |
Unique IDs of doctor. |
Collection of globally unique identifier |
None. |
type |
Types of health summary. |
Collection of CdaType |
None. |
page |
Page number requested (search results are paginated). |
integer |
Default value is 1 |
itemsPerPage |
Items to return on each page. See page parameter above. |
integer |
Default value is 10 |
Body Parameters
None.
Response Information
Resource Description
ListModelOfHealthSummaryModelName | Description | Type | Additional information |
---|---|---|---|
TotalItems | integer |
None. |
|
ItemsPerPage | integer |
None. |
|
CurrentPage | integer |
None. |
|
TotalPages | integer |
None. |
|
FirstRowOnPage | integer |
None. |
|
LastRowOnPage | integer |
None. |
|
Rows | Collection of HealthSummaryModel |
None. |
Response Formats
application/json, text/json
Sample:
{ "TotalItems": 1, "ItemsPerPage": 2, "CurrentPage": 3, "TotalPages": 4, "FirstRowOnPage": 5, "LastRowOnPage": 6, "Rows": [ { "Id": "d00b8699-7975-4fc0-9e6e-435548da45c9", "CDAContent": "sample string 2", "PatientExternalId": "sample string 3", "PatientFirstName": "sample string 4", "PatientMiddleName": "sample string 5", "PatientLastName": "sample string 6", "LocationExternalId": "sample string 7", "LocationName": "sample string 8", "LocationTimeZoneId": "sample string 9", "DoctorExternalId": "sample string 10", "DoctorName": "sample string 11", "EnteredUTC": "sample string 12", "Type": "sample string 13" }, { "Id": "d00b8699-7975-4fc0-9e6e-435548da45c9", "CDAContent": "sample string 2", "PatientExternalId": "sample string 3", "PatientFirstName": "sample string 4", "PatientMiddleName": "sample string 5", "PatientLastName": "sample string 6", "LocationExternalId": "sample string 7", "LocationName": "sample string 8", "LocationTimeZoneId": "sample string 9", "DoctorExternalId": "sample string 10", "DoctorName": "sample string 11", "EnteredUTC": "sample string 12", "Type": "sample string 13" } ] }
application/xml, text/xml
Sample:
<ListModelOfHealthSummaryModelBfZ6j0wR xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models"> <CurrentPage>3</CurrentPage> <FirstRowOnPage>5</FirstRowOnPage> <ItemsPerPage>2</ItemsPerPage> <LastRowOnPage>6</LastRowOnPage> <Rows xmlns:d2p1="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models.HealthSummaries"> <d2p1:HealthSummaryModel> <d2p1:CDAContent>sample string 2</d2p1:CDAContent> <d2p1:DoctorExternalId>sample string 10</d2p1:DoctorExternalId> <d2p1:DoctorName>sample string 11</d2p1:DoctorName> <d2p1:EnteredUTC>sample string 12</d2p1:EnteredUTC> <d2p1:Id>d00b8699-7975-4fc0-9e6e-435548da45c9</d2p1:Id> <d2p1:LocationExternalId>sample string 7</d2p1:LocationExternalId> <d2p1:LocationName>sample string 8</d2p1:LocationName> <d2p1:LocationTimeZoneId>sample string 9</d2p1:LocationTimeZoneId> <d2p1:PatientExternalId>sample string 3</d2p1:PatientExternalId> <d2p1:PatientFirstName>sample string 4</d2p1:PatientFirstName> <d2p1:PatientLastName>sample string 6</d2p1:PatientLastName> <d2p1:PatientMiddleName>sample string 5</d2p1:PatientMiddleName> <d2p1:Type>sample string 13</d2p1:Type> </d2p1:HealthSummaryModel> <d2p1:HealthSummaryModel> <d2p1:CDAContent>sample string 2</d2p1:CDAContent> <d2p1:DoctorExternalId>sample string 10</d2p1:DoctorExternalId> <d2p1:DoctorName>sample string 11</d2p1:DoctorName> <d2p1:EnteredUTC>sample string 12</d2p1:EnteredUTC> <d2p1:Id>d00b8699-7975-4fc0-9e6e-435548da45c9</d2p1:Id> <d2p1:LocationExternalId>sample string 7</d2p1:LocationExternalId> <d2p1:LocationName>sample string 8</d2p1:LocationName> <d2p1:LocationTimeZoneId>sample string 9</d2p1:LocationTimeZoneId> <d2p1:PatientExternalId>sample string 3</d2p1:PatientExternalId> <d2p1:PatientFirstName>sample string 4</d2p1:PatientFirstName> <d2p1:PatientLastName>sample string 6</d2p1:PatientLastName> <d2p1:PatientMiddleName>sample string 5</d2p1:PatientMiddleName> <d2p1:Type>sample string 13</d2p1:Type> </d2p1:HealthSummaryModel> </Rows> <TotalItems>1</TotalItems> <TotalPages>4</TotalPages> </ListModelOfHealthSummaryModelBfZ6j0wR>