GET api/patients

OBSOLETE: Retrieves the first 50 patients. Must have a valid Authorization header. This method is deprecated, for similar functionality please use the Patients resource that takes a 'searchtext' parameter to perform the query instead and pass a null value for the 'searchtext' parameter.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Patient collection

Collection of Patient
NameDescriptionTypeAdditional information
ID

Gets the ID. The ID is a unique identification of the object/record in the database. Controlled by Noah. Must be set to null or 0 when adding a new patient record but when updating the ID must be set.

 integer

None.
CreateDate

Gets Create Date. Controlled by Noah. When adding or updating Noah ignore this.

 string

None.
PatientGUID

Gets patient GUID. Controlled by Noah. When adding or updating Noah ignore this.

 globally unique identifier

None.
PatientNo

Gets or sets the patient no. Max length is 20 characters. Controlled by Noah. When adding or updating Noah ignore this.

 string

None.
CreatedBy

Gets the created by. Max length is 3 characters (User Initials). Controlled by Noah. Can be omitted by App when adding or updating.

 string

None.
LastModifiedDate

Gets the last modified date. Controlled by Noah. When adding or updating Noah ignore this.

 string

None.
ActivePatient

Gets or sets the active patient. If set to null it will be set to true.

 boolean

None.
FirstName

Gets or sets the first name. Max length is 30 characters.

 string

None.
MiddleName

Gets or sets the name of the middle. Max length is 30 characters.

 string

None.
LastName

Gets or sets the last name. Max length is 30 characters.

 string

None.
Gender

Gets or sets the gender.

 integer

None.
BirthDate

Gets or sets the birth date.

 string

None.
Salutation

Gets or sets the salutation. Max length is 30 characters.

 string

None.
Title

Gets or sets the title. Max length is 30 characters.

 string

None.
Address1

Gets or sets the address1. Max length is 30 characters.

 string

None.
Address2

Gets or sets the address2. Max length is 30 characters.

 string

None.
Address3

Gets or sets the address3. Max length is 30 characters.

 string

None.
Province

Gets or sets the province. Max length is 30 characters.

 string

None.
ZipCode

Gets or sets the zip. Max length is 20 characters.

 string

None.
City

Gets or sets the city. Max length is 30 characters.

 string

None.
Country

Gets or sets the country. Max length is 30 characters.

 string

None.
HomeTelephone

Gets or sets the home phone. Max length is 30 characters.

 string

None.
WorkTelephone

Gets or sets the work phone. Max length is 30 characters.

 string

None.
MobileTelephone

Gets or sets the mobile phone. Max length is 30 characters.

 string

None.
EMail

Gets or sets the E mail. Max length is 50 characters.

 string

None.
SSNumber

Gets or sets the SS number. Max length is 20 characters.

 string

None.
Physician

Gets or sets the physician. Max length is 30 characters.

 string

None.
Referral

Gets or sets the referral. Max length is 30 characters.

 string

None.
Insurance1

Gets or sets the insurance1. Max length is 30 characters.

 string

None.
Insurance2

Gets or sets the insurance2. Max length is 30 characters.

 string

None.
Other1

Gets or sets the Other1. Max length is 30 characters.

 string

None.
Other2

Gets or sets the Other2. Max length is 30 characters.

 string

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "ID": 1,
    "CreateDate": "sample string 1",
    "PatientGUID": "3293636d-7b48-4877-90a7-30828b937efc",
    "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": "3293636d-7b48-4877-90a7-30828b937efc",
    "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: 
<ArrayOfPatient xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Himsa.Noah.Public.Model">
  <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>3293636d-7b48-4877-90a7-30828b937efc</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>3293636d-7b48-4877-90a7-30828b937efc</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>
</ArrayOfPatient>