GET Patient/Search?AccountId={AccountId}&ProgramId={ProgramId}&SearchTerm={SearchTerm}&page={page}&recordCount={recordCount}

Get Donors

Request Information

URI Parameters

NameDescriptionTypeAdditional information
AccountId

Account Id

 integer

Required
ProgramId

Program Id

 integer

Required
SearchTerm

Search Term

 string

Required
page

Pager information

 integer

Default value is 0
recordCount

Pager information

 integer

Default value is 100

Body Parameters

None.

Response Information

Resource Description

PatientSearchResult
NameDescriptionTypeAdditional information
Patients

Collection of Patient

None.
CanAddPatient

boolean

None.
TotalRecordCount

integer

None.

Response Formats

application/json, text/json

Sample: 
{
  "Patients": [
    {
      "Id": 1,
      "First": "sample string 2",
      "Last": "sample string 3",
      "Middle": "sample string 4",
      "ProgramId": 1,
      "AccountId": 1,
      "DonorId1": "sample string 5",
      "Birthdate": "2024-11-14T14:56:49.0090218+00:00",
      "Gender": "sample string 6",
      "Ethnicity": "sample string 7",
      "Status": true,
      "ProgramsGroupId": 1,
      "ProgramsPanelsGroupsId": 1,
      "ManagerId1": 1,
      "ManagerId2": 1,
      "Picture": "sample string 9",
      "AvailableFrequencyGroups": [
        {
          "Id": 1,
          "Name": "sample string 1",
          "IsDefault": true
        },
        {
          "Id": 1,
          "Name": "sample string 1",
          "IsDefault": true
        }
      ],
      "AvailableGenders": [
        "sample string 1",
        "sample string 2"
      ],
      "AvailableEthnicities": [
        "sample string 1",
        "sample string 2"
      ],
      "AvailablePanelGroups": [
        {
          "Id": 1,
          "Name": "sample string 1"
        },
        {
          "Id": 1,
          "Name": "sample string 1"
        }
      ],
      "AvailableCaseManagers": [
        {
          "Id": 1,
          "Name": "sample string 1"
        },
        {
          "Id": 1,
          "Name": "sample string 1"
        }
      ],
      "DonorInfo_Active": true,
      "DonorInfo_ContactAndOther_Edit": true,
      "DonorInfo_ContactAndOther_View": true,
      "DonorInfo_PanelGroupEdit": true,
      "DonorInfo_NameAndOther_Edit": true,
      "IsLocked_CaseManager1": true,
      "IsRequired_CaseManager1": true,
      "CanCreateNewOrder": true,
      "PatientId2": "sample string 16",
      "PatientId3": "sample string 17",
      "PatientId2InstructionalText": "sample string 18",
      "PatientId3InstructionalText": "sample string 19",
      "RequiredId2": true,
      "RequiredId3": true
    },
    {
      "Id": 1,
      "First": "sample string 2",
      "Last": "sample string 3",
      "Middle": "sample string 4",
      "ProgramId": 1,
      "AccountId": 1,
      "DonorId1": "sample string 5",
      "Birthdate": "2024-11-14T14:56:49.0090218+00:00",
      "Gender": "sample string 6",
      "Ethnicity": "sample string 7",
      "Status": true,
      "ProgramsGroupId": 1,
      "ProgramsPanelsGroupsId": 1,
      "ManagerId1": 1,
      "ManagerId2": 1,
      "Picture": "sample string 9",
      "AvailableFrequencyGroups": [
        {
          "Id": 1,
          "Name": "sample string 1",
          "IsDefault": true
        },
        {
          "Id": 1,
          "Name": "sample string 1",
          "IsDefault": true
        }
      ],
      "AvailableGenders": [
        "sample string 1",
        "sample string 2"
      ],
      "AvailableEthnicities": [
        "sample string 1",
        "sample string 2"
      ],
      "AvailablePanelGroups": [
        {
          "Id": 1,
          "Name": "sample string 1"
        },
        {
          "Id": 1,
          "Name": "sample string 1"
        }
      ],
      "AvailableCaseManagers": [
        {
          "Id": 1,
          "Name": "sample string 1"
        },
        {
          "Id": 1,
          "Name": "sample string 1"
        }
      ],
      "DonorInfo_Active": true,
      "DonorInfo_ContactAndOther_Edit": true,
      "DonorInfo_ContactAndOther_View": true,
      "DonorInfo_PanelGroupEdit": true,
      "DonorInfo_NameAndOther_Edit": true,
      "IsLocked_CaseManager1": true,
      "IsRequired_CaseManager1": true,
      "CanCreateNewOrder": true,
      "PatientId2": "sample string 16",
      "PatientId3": "sample string 17",
      "PatientId2InstructionalText": "sample string 18",
      "PatientId3InstructionalText": "sample string 19",
      "RequiredId2": true,
      "RequiredId3": true
    }
  ],
  "CanAddPatient": true,
  "TotalRecordCount": 2
}

application/xml, text/xml

Sample: 
<PatientSearchResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Avertest.Aversys.DataLayer.Patients">
  <CanAddPatient>true</CanAddPatient>
  <Patients>
    <Patient>
      <AccountId>1</AccountId>
      <AvailableCaseManagers>
        <CaseManager>
          <Id>1</Id>
          <Name>sample string 1</Name>
        </CaseManager>
        <CaseManager>
          <Id>1</Id>
          <Name>sample string 1</Name>
        </CaseManager>
      </AvailableCaseManagers>
      <AvailableEthnicities xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </AvailableEthnicities>
      <AvailableFrequencyGroups>
        <FrequencyGroup>
          <Id>1</Id>
          <Name>sample string 1</Name>
        </FrequencyGroup>
        <FrequencyGroup>
          <Id>1</Id>
          <Name>sample string 1</Name>
        </FrequencyGroup>
      </AvailableFrequencyGroups>
      <AvailableGenders xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </AvailableGenders>
      <AvailablePanelGroups>
        <PanelGroup>
          <Id>1</Id>
          <Name>sample string 1</Name>
        </PanelGroup>
        <PanelGroup>
          <Id>1</Id>
          <Name>sample string 1</Name>
        </PanelGroup>
      </AvailablePanelGroups>
      <Birthdate>2024-11-14T14:56:49.0090218+00:00</Birthdate>
      <CanCreateNewOrder>true</CanCreateNewOrder>
      <DonorId1>sample string 5</DonorId1>
      <DonorInfo_Active>true</DonorInfo_Active>
      <DonorInfo_ContactAndOther_Edit>true</DonorInfo_ContactAndOther_Edit>
      <DonorInfo_ContactAndOther_View>true</DonorInfo_ContactAndOther_View>
      <DonorInfo_NameAndOther_Edit>true</DonorInfo_NameAndOther_Edit>
      <DonorInfo_PanelGroupEdit>true</DonorInfo_PanelGroupEdit>
      <Ethnicity>sample string 7</Ethnicity>
      <First>sample string 2</First>
      <Gender>sample string 6</Gender>
      <Id>1</Id>
      <IsLocked_CaseManager1>true</IsLocked_CaseManager1>
      <IsRequired_CaseManager1>true</IsRequired_CaseManager1>
      <Last>sample string 3</Last>
      <ManagerId1>1</ManagerId1>
      <ManagerId2>1</ManagerId2>
      <Middle>sample string 4</Middle>
      <PatientId2>sample string 16</PatientId2>
      <PatientId2InstructionalText>sample string 18</PatientId2InstructionalText>
      <PatientId3>sample string 17</PatientId3>
      <PatientId3InstructionalText>sample string 19</PatientId3InstructionalText>
      <Picture>sample string 9</Picture>
      <ProgramId>1</ProgramId>
      <ProgramsGroupId>1</ProgramsGroupId>
      <ProgramsPanelsGroupsId>1</ProgramsPanelsGroupsId>
      <Status>true</Status>
    </Patient>
    <Patient>
      <AccountId>1</AccountId>
      <AvailableCaseManagers>
        <CaseManager>
          <Id>1</Id>
          <Name>sample string 1</Name>
        </CaseManager>
        <CaseManager>
          <Id>1</Id>
          <Name>sample string 1</Name>
        </CaseManager>
      </AvailableCaseManagers>
      <AvailableEthnicities xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </AvailableEthnicities>
      <AvailableFrequencyGroups>
        <FrequencyGroup>
          <Id>1</Id>
          <Name>sample string 1</Name>
        </FrequencyGroup>
        <FrequencyGroup>
          <Id>1</Id>
          <Name>sample string 1</Name>
        </FrequencyGroup>
      </AvailableFrequencyGroups>
      <AvailableGenders xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </AvailableGenders>
      <AvailablePanelGroups>
        <PanelGroup>
          <Id>1</Id>
          <Name>sample string 1</Name>
        </PanelGroup>
        <PanelGroup>
          <Id>1</Id>
          <Name>sample string 1</Name>
        </PanelGroup>
      </AvailablePanelGroups>
      <Birthdate>2024-11-14T14:56:49.0090218+00:00</Birthdate>
      <CanCreateNewOrder>true</CanCreateNewOrder>
      <DonorId1>sample string 5</DonorId1>
      <DonorInfo_Active>true</DonorInfo_Active>
      <DonorInfo_ContactAndOther_Edit>true</DonorInfo_ContactAndOther_Edit>
      <DonorInfo_ContactAndOther_View>true</DonorInfo_ContactAndOther_View>
      <DonorInfo_NameAndOther_Edit>true</DonorInfo_NameAndOther_Edit>
      <DonorInfo_PanelGroupEdit>true</DonorInfo_PanelGroupEdit>
      <Ethnicity>sample string 7</Ethnicity>
      <First>sample string 2</First>
      <Gender>sample string 6</Gender>
      <Id>1</Id>
      <IsLocked_CaseManager1>true</IsLocked_CaseManager1>
      <IsRequired_CaseManager1>true</IsRequired_CaseManager1>
      <Last>sample string 3</Last>
      <ManagerId1>1</ManagerId1>
      <ManagerId2>1</ManagerId2>
      <Middle>sample string 4</Middle>
      <PatientId2>sample string 16</PatientId2>
      <PatientId2InstructionalText>sample string 18</PatientId2InstructionalText>
      <PatientId3>sample string 17</PatientId3>
      <PatientId3InstructionalText>sample string 19</PatientId3InstructionalText>
      <Picture>sample string 9</Picture>
      <ProgramId>1</ProgramId>
      <ProgramsGroupId>1</ProgramsGroupId>
      <ProgramsPanelsGroupsId>1</ProgramsPanelsGroupsId>
      <Status>true</Status>
    </Patient>
  </Patients>
  <TotalRecordCount>2</TotalRecordCount>
</PatientSearchResult>