Home

Patient

GET api/Patient/{systemID}/Search?lastName={lastName}&firstName={firstName}&medicalRecNum={medicalRecNum}&dateOfBirth={dateOfBirth}

Search and retrieve all patient records matching given filters/parameters (partials allowed)

Request Information

Parameters

NameDescriptionAdditional information
systemID
Unique ID for QS/1 System

Define this parameter in the request URI.

lastName
Last Name of Patient (partials allowed)

Define this parameter in the request URI.

firstName
First Name of Patient (partials allowed)

Define this parameter in the request URI.

medicalRecNum
Third Party Identifier for Patient (e.g. Employee ID)  (partials allowed)

Define this parameter in the request URI.

dateOfBirth
Date of Birth of Patient (YYYYMMDD - partials allowed)

Define this parameter in the request URI.

    

Response Codes

    
  • OK (200)
  • BadRequest (400)
  • NotFound (404)
  • InternalServerError (500)
  •     

Response Information

Patient

Response body formats

application/json, text/json

Sample:
[
  {
    "PatientID": "sample string 1",
    "MedicalRecordNumber": "sample string 2",
    "LastName": "sample string 3",
    "FirstName": "sample string 4",
    "MiddleInitial": "sample string 5",
    "DateOfBirth": "sample string 6",
    "Room": "sample string 7",
    "Facility": "sample string 8",
    "FacilityCode": "sample string 9",
    "RxNumber": "sample string 10",
    "HomePhone": "sample string 11",
    "SSN": "sample string 12",
    "Address": "sample string 13",
    "Address2": "sample string 14",
    "City": "sample string 15",
    "State": "sample string 16",
    "Zip": "sample string 17",
    "WorkPhone": "sample string 18",
    "CellPhone": "sample string 19",
    "EmailAddress": "sample string 20",
    "InCareOf": "sample string 21",
    "Title": "sample string 22",
    "AccountNumber": "sample string 23"
  },
  {
    "PatientID": "sample string 1",
    "MedicalRecordNumber": "sample string 2",
    "LastName": "sample string 3",
    "FirstName": "sample string 4",
    "MiddleInitial": "sample string 5",
    "DateOfBirth": "sample string 6",
    "Room": "sample string 7",
    "Facility": "sample string 8",
    "FacilityCode": "sample string 9",
    "RxNumber": "sample string 10",
    "HomePhone": "sample string 11",
    "SSN": "sample string 12",
    "Address": "sample string 13",
    "Address2": "sample string 14",
    "City": "sample string 15",
    "State": "sample string 16",
    "Zip": "sample string 17",
    "WorkPhone": "sample string 18",
    "CellPhone": "sample string 19",
    "EmailAddress": "sample string 20",
    "InCareOf": "sample string 21",
    "Title": "sample string 22",
    "AccountNumber": "sample string 23"
  },
  {
    "PatientID": "sample string 1",
    "MedicalRecordNumber": "sample string 2",
    "LastName": "sample string 3",
    "FirstName": "sample string 4",
    "MiddleInitial": "sample string 5",
    "DateOfBirth": "sample string 6",
    "Room": "sample string 7",
    "Facility": "sample string 8",
    "FacilityCode": "sample string 9",
    "RxNumber": "sample string 10",
    "HomePhone": "sample string 11",
    "SSN": "sample string 12",
    "Address": "sample string 13",
    "Address2": "sample string 14",
    "City": "sample string 15",
    "State": "sample string 16",
    "Zip": "sample string 17",
    "WorkPhone": "sample string 18",
    "CellPhone": "sample string 19",
    "EmailAddress": "sample string 20",
    "InCareOf": "sample string 21",
    "Title": "sample string 22",
    "AccountNumber": "sample string 23"
  }
]

text/javascript

Sample:
[{"PatientID":"sample string 1","MedicalRecordNumber":"sample string 2","LastName":"sample string 3","FirstName":"sample string 4","MiddleInitial":"sample string 5","DateOfBirth":"sample string 6","Room":"sample string 7","Facility":"sample string 8","FacilityCode":"sample string 9","RxNumber":"sample string 10","HomePhone":"sample string 11","SSN":"sample string 12","Address":"sample string 13","Address2":"sample string 14","City":"sample string 15","State":"sample string 16","Zip":"sample string 17","WorkPhone":"sample string 18","CellPhone":"sample string 19","EmailAddress":"sample string 20","InCareOf":"sample string 21","Title":"sample string 22","AccountNumber":"sample string 23"},{"PatientID":"sample string 1","MedicalRecordNumber":"sample string 2","LastName":"sample string 3","FirstName":"sample string 4","MiddleInitial":"sample string 5","DateOfBirth":"sample string 6","Room":"sample string 7","Facility":"sample string 8","FacilityCode":"sample string 9","RxNumber":"sample string 10","HomePhone":"sample string 11","SSN":"sample string 12","Address":"sample string 13","Address2":"sample string 14","City":"sample string 15","State":"sample string 16","Zip":"sample string 17","WorkPhone":"sample string 18","CellPhone":"sample string 19","EmailAddress":"sample string 20","InCareOf":"sample string 21","Title":"sample string 22","AccountNumber":"sample string 23"},{"PatientID":"sample string 1","MedicalRecordNumber":"sample string 2","LastName":"sample string 3","FirstName":"sample string 4","MiddleInitial":"sample string 5","DateOfBirth":"sample string 6","Room":"sample string 7","Facility":"sample string 8","FacilityCode":"sample string 9","RxNumber":"sample string 10","HomePhone":"sample string 11","SSN":"sample string 12","Address":"sample string 13","Address2":"sample string 14","City":"sample string 15","State":"sample string 16","Zip":"sample string 17","WorkPhone":"sample string 18","CellPhone":"sample string 19","EmailAddress":"sample string 20","InCareOf":"sample string 21","Title":"sample string 22","AccountNumber":"sample string 23"}]

application/xml, text/xml

Sample:
<ArrayOfPatient xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QCFWebAPI.Models">
  <Patient>
    <AccountNumber>sample string 23</AccountNumber>
    <Address>sample string 13</Address>
    <Address2>sample string 14</Address2>
    <CellPhone>sample string 19</CellPhone>
    <City>sample string 15</City>
    <DateOfBirth>sample string 6</DateOfBirth>
    <EmailAddress>sample string 20</EmailAddress>
    <Facility>sample string 8</Facility>
    <FacilityCode>sample string 9</FacilityCode>
    <FirstName>sample string 4</FirstName>
    <HomePhone>sample string 11</HomePhone>
    <InCareOf>sample string 21</InCareOf>
    <LastName>sample string 3</LastName>
    <MedicalRecordNumber>sample string 2</MedicalRecordNumber>
    <MiddleInitial>sample string 5</MiddleInitial>
    <PatientID>sample string 1</PatientID>
    <Room>sample string 7</Room>
    <RxNumber>sample string 10</RxNumber>
    <SSN>sample string 12</SSN>
    <State>sample string 16</State>
    <Title>sample string 22</Title>
    <WorkPhone>sample string 18</WorkPhone>
    <Zip>sample string 17</Zip>
  </Patient>
  <Patient>
    <AccountNumber>sample string 23</AccountNumber>
    <Address>sample string 13</Address>
    <Address2>sample string 14</Address2>
    <CellPhone>sample string 19</CellPhone>
    <City>sample string 15</City>
    <DateOfBirth>sample string 6</DateOfBirth>
    <EmailAddress>sample string 20</EmailAddress>
    <Facility>sample string 8</Facility>
    <FacilityCode>sample string 9</FacilityCode>
    <FirstName>sample string 4</FirstName>
    <HomePhone>sample string 11</HomePhone>
    <InCareOf>sample string 21</InCareOf>
    <LastName>sample string 3</LastName>
    <MedicalRecordNumber>sample string 2</MedicalRecordNumber>
    <MiddleInitial>sample string 5</MiddleInitial>
    <PatientID>sample string 1</PatientID>
    <Room>sample string 7</Room>
    <RxNumber>sample string 10</RxNumber>
    <SSN>sample string 12</SSN>
    <State>sample string 16</State>
    <Title>sample string 22</Title>
    <WorkPhone>sample string 18</WorkPhone>
    <Zip>sample string 17</Zip>
  </Patient>
  <Patient>
    <AccountNumber>sample string 23</AccountNumber>
    <Address>sample string 13</Address>
    <Address2>sample string 14</Address2>
    <CellPhone>sample string 19</CellPhone>
    <City>sample string 15</City>
    <DateOfBirth>sample string 6</DateOfBirth>
    <EmailAddress>sample string 20</EmailAddress>
    <Facility>sample string 8</Facility>
    <FacilityCode>sample string 9</FacilityCode>
    <FirstName>sample string 4</FirstName>
    <HomePhone>sample string 11</HomePhone>
    <InCareOf>sample string 21</InCareOf>
    <LastName>sample string 3</LastName>
    <MedicalRecordNumber>sample string 2</MedicalRecordNumber>
    <MiddleInitial>sample string 5</MiddleInitial>
    <PatientID>sample string 1</PatientID>
    <Room>sample string 7</Room>
    <RxNumber>sample string 10</RxNumber>
    <SSN>sample string 12</SSN>
    <State>sample string 16</State>
    <Title>sample string 22</Title>
    <WorkPhone>sample string 18</WorkPhone>
    <Zip>sample string 17</Zip>
  </Patient>
</ArrayOfPatient>