GET api/patients?searchtext={searchtext}&page={page}&pageSize={pageSize}
Retrieves one or more patients identified by {searchText}. Must have a valid Authorization header.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
searchtext |
The text to search. Leave empty if all patients are to be paged. |
string |
Required |
page |
Page number. If left empty it will be set to 1. |
integer |
Required |
pageSize |
Size of wanted page - Maximum 50. If left empty it vil be set to 50. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
One or more patients that matches the search criteria and total number of patients in the search.
PatientSearchName | Description | Type | Additional information |
---|---|---|---|
Patients |
List of patients from the returned search. |
Collection of Patient |
None. |
Response Formats
application/json, text/json
Sample:
{ "Patients": [ { "ID": 1, "CreateDate": "sample string 1", "PatientGUID": "f799a6ea-0b4c-4290-9e89-ddde13e53cd3", "PatientNo": "sample string 2", "CreatedBy": "sample string 3", "LastModifiedDate": "sample string 4", "ActivePatient": true, "FirstName": "sample string 5", "MiddleName": "sample string 6", "LastName": "sample string 7", "Gender": 1, "BirthDate": "sample string 8", "Salutation": "sample string 9", "Title": "sample string 10", "Address1": "sample string 11", "Address2": "sample string 12", "Address3": "sample string 13", "Province": "sample string 14", "ZipCode": "sample string 15", "City": "sample string 16", "Country": "sample string 17", "HomeTelephone": "sample string 18", "WorkTelephone": "sample string 19", "MobileTelephone": "sample string 20", "EMail": "sample string 21", "SSNumber": "sample string 22", "Physician": "sample string 23", "Referral": "sample string 24", "Insurance1": "sample string 25", "Insurance2": "sample string 26", "Other1": "sample string 27", "Other2": "sample string 28" }, { "ID": 1, "CreateDate": "sample string 1", "PatientGUID": "f799a6ea-0b4c-4290-9e89-ddde13e53cd3", "PatientNo": "sample string 2", "CreatedBy": "sample string 3", "LastModifiedDate": "sample string 4", "ActivePatient": true, "FirstName": "sample string 5", "MiddleName": "sample string 6", "LastName": "sample string 7", "Gender": 1, "BirthDate": "sample string 8", "Salutation": "sample string 9", "Title": "sample string 10", "Address1": "sample string 11", "Address2": "sample string 12", "Address3": "sample string 13", "Province": "sample string 14", "ZipCode": "sample string 15", "City": "sample string 16", "Country": "sample string 17", "HomeTelephone": "sample string 18", "WorkTelephone": "sample string 19", "MobileTelephone": "sample string 20", "EMail": "sample string 21", "SSNumber": "sample string 22", "Physician": "sample string 23", "Referral": "sample string 24", "Insurance1": "sample string 25", "Insurance2": "sample string 26", "Other1": "sample string 27", "Other2": "sample string 28" } ] }
application/xml, text/xml
Sample:
<PatientSearch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Himsa.Noah.Public.Model"> <Patients> <Patient> <ActivePatient>true</ActivePatient> <Address1>sample string 11</Address1> <Address2>sample string 12</Address2> <Address3>sample string 13</Address3> <BirthDate>sample string 8</BirthDate> <City>sample string 16</City> <Country>sample string 17</Country> <CreateDate>sample string 1</CreateDate> <CreatedBy>sample string 3</CreatedBy> <EMail>sample string 21</EMail> <FirstName>sample string 5</FirstName> <Gender>1</Gender> <HomeTelephone>sample string 18</HomeTelephone> <ID>1</ID> <Insurance1>sample string 25</Insurance1> <Insurance2>sample string 26</Insurance2> <LastModifiedDate>sample string 4</LastModifiedDate> <LastName>sample string 7</LastName> <MiddleName>sample string 6</MiddleName> <MobileTelephone>sample string 20</MobileTelephone> <Other1>sample string 27</Other1> <Other2>sample string 28</Other2> <PatientGUID>f799a6ea-0b4c-4290-9e89-ddde13e53cd3</PatientGUID> <PatientNo>sample string 2</PatientNo> <Physician>sample string 23</Physician> <Province>sample string 14</Province> <Referral>sample string 24</Referral> <SSNumber>sample string 22</SSNumber> <Salutation>sample string 9</Salutation> <Title>sample string 10</Title> <WorkTelephone>sample string 19</WorkTelephone> <ZipCode>sample string 15</ZipCode> </Patient> <Patient> <ActivePatient>true</ActivePatient> <Address1>sample string 11</Address1> <Address2>sample string 12</Address2> <Address3>sample string 13</Address3> <BirthDate>sample string 8</BirthDate> <City>sample string 16</City> <Country>sample string 17</Country> <CreateDate>sample string 1</CreateDate> <CreatedBy>sample string 3</CreatedBy> <EMail>sample string 21</EMail> <FirstName>sample string 5</FirstName> <Gender>1</Gender> <HomeTelephone>sample string 18</HomeTelephone> <ID>1</ID> <Insurance1>sample string 25</Insurance1> <Insurance2>sample string 26</Insurance2> <LastModifiedDate>sample string 4</LastModifiedDate> <LastName>sample string 7</LastName> <MiddleName>sample string 6</MiddleName> <MobileTelephone>sample string 20</MobileTelephone> <Other1>sample string 27</Other1> <Other2>sample string 28</Other2> <PatientGUID>f799a6ea-0b4c-4290-9e89-ddde13e53cd3</PatientGUID> <PatientNo>sample string 2</PatientNo> <Physician>sample string 23</Physician> <Province>sample string 14</Province> <Referral>sample string 24</Referral> <SSNumber>sample string 22</SSNumber> <Salutation>sample string 9</Salutation> <Title>sample string 10</Title> <WorkTelephone>sample string 19</WorkTelephone> <ZipCode>sample string 15</ZipCode> </Patient> </Patients> </PatientSearch>