POST api/ProviderService/SearchPatientsByName?name={name}&DOB={DOB}&practiceID={practiceID}&providerID={providerID}

Search Patients By Name

Request Information

URI Parameters

Name	Type	Additional information
name	string	Required
DOB	date	Required
practiceID	globally unique identifier	Required
providerID	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

Collection of PatientViewModel

Name	Type	Additional information
CanSaveSimilarMatch	boolean	None.
SaveSimilarMatch	boolean	None.
PatientId	globally unique identifier	None.
FullName	string	None.
BloodGroup	string	None.
TitleId	integer	None.
TitleName	string	None.
InterestedIn	string	None.
FirstName	string	None.
MiddleName	string	None.
SurName	string	None.
MRN_Seed	integer	None.
RefferringPhysician	string	None.
Mother_Name	string	None.
Maiden_Name	string	None.
TTPName	string	None.
MRN	string	None.
DOB	date	None.
GenderId	integer	None.
Gender	string	None.
Mobile	string	None.
Phone	string	None.
Email	string	None.
PaperFileNumber	string	None.
Address	string	None.
Note	string	None.
CityId	integer	None.
RegionId	integer	None.
StateId	integer	None.
CountryId	integer	None.
DateCreated	date	None.
CaseNo	string	None.
FacilityCode	string	None.
ImageName	string	None.
OtherReferral	string	None.
ReferralTypeID	globally unique identifier	None.
CampaignID	globally unique identifier	None.
FacilityID	globally unique identifier	None.
RefferringPhyscianID	globally unique identifier	None.
MainPhysicianID	globally unique identifier	None.
MainPhysicianFullName	string	None.
HasUserAccount	boolean	None.
PatientAccountType	PatientAccountType	None.
PatientAccountType_Secondary	PatientAccountType	None.
EmergencyName	string	None.
EmergencyContact	string	None.
EmergencyRelationTypeId	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "CanSaveSimilarMatch": true,
    "SaveSimilarMatch": true,
    "PatientId": "56bd6e2c-f022-470f-9adb-a323a6d11124",
    "FullName": "sample string 3",
    "BloodGroup": "sample string 4",
    "TitleId": 1,
    "TitleName": "sample string 5",
    "InterestedIn": "sample string 6",
    "FirstName": "sample string 7",
    "MiddleName": "sample string 8",
    "SurName": "sample string 9",
    "MRN_Seed": 1,
    "RefferringPhysician": "sample string 10",
    "Mother_Name": "sample string 11",
    "Maiden_Name": "sample string 12",
    "TTPName": "sample string 13",
    "MRN": "sample string 14",
    "DOB": "2025-12-14T08:56:09.5416277+00:00",
    "GenderId": 1,
    "Gender": "sample string 15",
    "Mobile": "samplestring16",
    "Phone": "samplestring17",
    "Email": "sample string 18",
    "PaperFileNumber": "sample string 19",
    "Address": "sample string 20",
    "Note": "sample string 21",
    "CityId": 1,
    "RegionId": 1,
    "StateId": 1,
    "CountryId": 1,
    "DateCreated": "2025-12-14T08:56:09.5416277+00:00",
    "CaseNo": "sample string 22",
    "FacilityCode": "sample string 23",
    "ImageName": "sample string 24",
    "OtherReferral": "sample string 25",
    "ReferralTypeID": "5ebbb041-f5f7-47af-91d5-c9bfb4c1832f",
    "CampaignID": "9c511a53-ce5d-47ed-b407-1d8aa8986598",
    "FacilityID": "a4703671-6a8a-42dc-aff0-b92314167842",
    "RefferringPhyscianID": "d1509691-dcd6-4256-b8f7-34b29e59e178",
    "MainPhysicianID": "aa1dbd84-5e64-45e1-ad11-62e28e79148c",
    "MainPhysicianFullName": "sample string 26",
    "HasUserAccount": true,
    "PatientAccountType": {
      "PatientAccountTypeId": 1,
      "AccountHolder": "sample string 1",
      "MedicareNumber": "sample string 2",
      "MedicareExpiry": "2025-12-14T08:56:09.5416277+00:00",
      "HealthFundId": 1,
      "DVANumber": "sample string 3",
      "DVACardColorId": 1,
      "DVADisability": "sample string 4",
      "IHINo": "sample string 5",
      "HCCPensionNo": "sample string 6",
      "HCCPensionExpiry": "2025-12-14T08:56:09.5416277+00:00",
      "GAPOnly": true
    },
    "PatientAccountType_Secondary": {
      "PatientAccountTypeId": 1,
      "AccountHolder": "sample string 1",
      "MedicareNumber": "sample string 2",
      "MedicareExpiry": "2025-12-14T08:56:09.5416277+00:00",
      "HealthFundId": 1,
      "DVANumber": "sample string 3",
      "DVACardColorId": 1,
      "DVADisability": "sample string 4",
      "IHINo": "sample string 5",
      "HCCPensionNo": "sample string 6",
      "HCCPensionExpiry": "2025-12-14T08:56:09.5416277+00:00",
      "GAPOnly": true
    },
    "EmergencyName": "sample string 27",
    "EmergencyContact": "samplestring28",
    "EmergencyRelationTypeId": 1
  },
  {
    "CanSaveSimilarMatch": true,
    "SaveSimilarMatch": true,
    "PatientId": "56bd6e2c-f022-470f-9adb-a323a6d11124",
    "FullName": "sample string 3",
    "BloodGroup": "sample string 4",
    "TitleId": 1,
    "TitleName": "sample string 5",
    "InterestedIn": "sample string 6",
    "FirstName": "sample string 7",
    "MiddleName": "sample string 8",
    "SurName": "sample string 9",
    "MRN_Seed": 1,
    "RefferringPhysician": "sample string 10",
    "Mother_Name": "sample string 11",
    "Maiden_Name": "sample string 12",
    "TTPName": "sample string 13",
    "MRN": "sample string 14",
    "DOB": "2025-12-14T08:56:09.5416277+00:00",
    "GenderId": 1,
    "Gender": "sample string 15",
    "Mobile": "samplestring16",
    "Phone": "samplestring17",
    "Email": "sample string 18",
    "PaperFileNumber": "sample string 19",
    "Address": "sample string 20",
    "Note": "sample string 21",
    "CityId": 1,
    "RegionId": 1,
    "StateId": 1,
    "CountryId": 1,
    "DateCreated": "2025-12-14T08:56:09.5416277+00:00",
    "CaseNo": "sample string 22",
    "FacilityCode": "sample string 23",
    "ImageName": "sample string 24",
    "OtherReferral": "sample string 25",
    "ReferralTypeID": "5ebbb041-f5f7-47af-91d5-c9bfb4c1832f",
    "CampaignID": "9c511a53-ce5d-47ed-b407-1d8aa8986598",
    "FacilityID": "a4703671-6a8a-42dc-aff0-b92314167842",
    "RefferringPhyscianID": "d1509691-dcd6-4256-b8f7-34b29e59e178",
    "MainPhysicianID": "aa1dbd84-5e64-45e1-ad11-62e28e79148c",
    "MainPhysicianFullName": "sample string 26",
    "HasUserAccount": true,
    "PatientAccountType": {
      "PatientAccountTypeId": 1,
      "AccountHolder": "sample string 1",
      "MedicareNumber": "sample string 2",
      "MedicareExpiry": "2025-12-14T08:56:09.5416277+00:00",
      "HealthFundId": 1,
      "DVANumber": "sample string 3",
      "DVACardColorId": 1,
      "DVADisability": "sample string 4",
      "IHINo": "sample string 5",
      "HCCPensionNo": "sample string 6",
      "HCCPensionExpiry": "2025-12-14T08:56:09.5416277+00:00",
      "GAPOnly": true
    },
    "PatientAccountType_Secondary": {
      "PatientAccountTypeId": 1,
      "AccountHolder": "sample string 1",
      "MedicareNumber": "sample string 2",
      "MedicareExpiry": "2025-12-14T08:56:09.5416277+00:00",
      "HealthFundId": 1,
      "DVANumber": "sample string 3",
      "DVACardColorId": 1,
      "DVADisability": "sample string 4",
      "IHINo": "sample string 5",
      "HCCPensionNo": "sample string 6",
      "HCCPensionExpiry": "2025-12-14T08:56:09.5416277+00:00",
      "GAPOnly": true
    },
    "EmergencyName": "sample string 27",
    "EmergencyContact": "samplestring28",
    "EmergencyRelationTypeId": 1
  }
]

application/xml, text/xml

Sample:

<ArrayOfPatientViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CSP.EMRContexts.Common.ViewModels">
  <PatientViewModel>
    <Address>sample string 20</Address>
    <BloodGroup>sample string 4</BloodGroup>
    <CampaignID>9c511a53-ce5d-47ed-b407-1d8aa8986598</CampaignID>
    <CanSaveSimilarMatch>true</CanSaveSimilarMatch>
    <CaseNo>sample string 22</CaseNo>
    <CityId>1</CityId>
    <CountryId>1</CountryId>
    <DOB>2025-12-14T08:56:09.5416277+00:00</DOB>
    <DateCreated>2025-12-14T08:56:09.5416277+00:00</DateCreated>
    <Email>sample string 18</Email>
    <EmergencyContact>samplestring28</EmergencyContact>
    <EmergencyName>sample string 27</EmergencyName>
    <EmergencyRelationTypeId>1</EmergencyRelationTypeId>
    <FacilityCode>sample string 23</FacilityCode>
    <FacilityID>a4703671-6a8a-42dc-aff0-b92314167842</FacilityID>
    <FirstName>sample string 7</FirstName>
    <FullName>sample string 3</FullName>
    <Gender>sample string 15</Gender>
    <GenderId>1</GenderId>
    <HasUserAccount>true</HasUserAccount>
    <ImageName>sample string 24</ImageName>
    <InterestedIn>sample string 6</InterestedIn>
    <MRN>sample string 14</MRN>
    <MRN_Seed>1</MRN_Seed>
    <Maiden_Name>sample string 12</Maiden_Name>
    <MainPhysicianFullName>sample string 26</MainPhysicianFullName>
    <MainPhysicianID>aa1dbd84-5e64-45e1-ad11-62e28e79148c</MainPhysicianID>
    <MiddleName>sample string 8</MiddleName>
    <Mobile>samplestring16</Mobile>
    <Mother_Name>sample string 11</Mother_Name>
    <Note>sample string 21</Note>
    <OtherReferral>sample string 25</OtherReferral>
    <PaperFileNumber>sample string 19</PaperFileNumber>
    <PatientAccountType>
      <AccountHolder>sample string 1</AccountHolder>
      <DVACardColorId>1</DVACardColorId>
      <DVADisability>sample string 4</DVADisability>
      <DVANumber>sample string 3</DVANumber>
      <GAPOnly>true</GAPOnly>
      <HCCPensionExpiry>2025-12-14T08:56:09.5416277+00:00</HCCPensionExpiry>
      <HCCPensionNo>sample string 6</HCCPensionNo>
      <HealthFundId>1</HealthFundId>
      <IHINo>sample string 5</IHINo>
      <MedicareExpiry>2025-12-14T08:56:09.5416277+00:00</MedicareExpiry>
      <MedicareNumber>sample string 2</MedicareNumber>
      <PatientAccountTypeId>1</PatientAccountTypeId>
    </PatientAccountType>
    <PatientAccountType_Secondary>
      <AccountHolder>sample string 1</AccountHolder>
      <DVACardColorId>1</DVACardColorId>
      <DVADisability>sample string 4</DVADisability>
      <DVANumber>sample string 3</DVANumber>
      <GAPOnly>true</GAPOnly>
      <HCCPensionExpiry>2025-12-14T08:56:09.5416277+00:00</HCCPensionExpiry>
      <HCCPensionNo>sample string 6</HCCPensionNo>
      <HealthFundId>1</HealthFundId>
      <IHINo>sample string 5</IHINo>
      <MedicareExpiry>2025-12-14T08:56:09.5416277+00:00</MedicareExpiry>
      <MedicareNumber>sample string 2</MedicareNumber>
      <PatientAccountTypeId>1</PatientAccountTypeId>
    </PatientAccountType_Secondary>
    <PatientId>56bd6e2c-f022-470f-9adb-a323a6d11124</PatientId>
    <Phone>samplestring17</Phone>
    <ReferralTypeID>5ebbb041-f5f7-47af-91d5-c9bfb4c1832f</ReferralTypeID>
    <RefferringPhyscianID>d1509691-dcd6-4256-b8f7-34b29e59e178</RefferringPhyscianID>
    <RefferringPhysician>sample string 10</RefferringPhysician>
    <RegionId>1</RegionId>
    <SaveSimilarMatch>true</SaveSimilarMatch>
    <StateId>1</StateId>
    <SurName>sample string 9</SurName>
    <TTPName>sample string 13</TTPName>
    <TitleId>1</TitleId>
    <TitleName>sample string 5</TitleName>
  </PatientViewModel>
  <PatientViewModel>
    <Address>sample string 20</Address>
    <BloodGroup>sample string 4</BloodGroup>
    <CampaignID>9c511a53-ce5d-47ed-b407-1d8aa8986598</CampaignID>
    <CanSaveSimilarMatch>true</CanSaveSimilarMatch>
    <CaseNo>sample string 22</CaseNo>
    <CityId>1</CityId>
    <CountryId>1</CountryId>
    <DOB>2025-12-14T08:56:09.5416277+00:00</DOB>
    <DateCreated>2025-12-14T08:56:09.5416277+00:00</DateCreated>
    <Email>sample string 18</Email>
    <EmergencyContact>samplestring28</EmergencyContact>
    <EmergencyName>sample string 27</EmergencyName>
    <EmergencyRelationTypeId>1</EmergencyRelationTypeId>
    <FacilityCode>sample string 23</FacilityCode>
    <FacilityID>a4703671-6a8a-42dc-aff0-b92314167842</FacilityID>
    <FirstName>sample string 7</FirstName>
    <FullName>sample string 3</FullName>
    <Gender>sample string 15</Gender>
    <GenderId>1</GenderId>
    <HasUserAccount>true</HasUserAccount>
    <ImageName>sample string 24</ImageName>
    <InterestedIn>sample string 6</InterestedIn>
    <MRN>sample string 14</MRN>
    <MRN_Seed>1</MRN_Seed>
    <Maiden_Name>sample string 12</Maiden_Name>
    <MainPhysicianFullName>sample string 26</MainPhysicianFullName>
    <MainPhysicianID>aa1dbd84-5e64-45e1-ad11-62e28e79148c</MainPhysicianID>
    <MiddleName>sample string 8</MiddleName>
    <Mobile>samplestring16</Mobile>
    <Mother_Name>sample string 11</Mother_Name>
    <Note>sample string 21</Note>
    <OtherReferral>sample string 25</OtherReferral>
    <PaperFileNumber>sample string 19</PaperFileNumber>
    <PatientAccountType>
      <AccountHolder>sample string 1</AccountHolder>
      <DVACardColorId>1</DVACardColorId>
      <DVADisability>sample string 4</DVADisability>
      <DVANumber>sample string 3</DVANumber>
      <GAPOnly>true</GAPOnly>
      <HCCPensionExpiry>2025-12-14T08:56:09.5416277+00:00</HCCPensionExpiry>
      <HCCPensionNo>sample string 6</HCCPensionNo>
      <HealthFundId>1</HealthFundId>
      <IHINo>sample string 5</IHINo>
      <MedicareExpiry>2025-12-14T08:56:09.5416277+00:00</MedicareExpiry>
      <MedicareNumber>sample string 2</MedicareNumber>
      <PatientAccountTypeId>1</PatientAccountTypeId>
    </PatientAccountType>
    <PatientAccountType_Secondary>
      <AccountHolder>sample string 1</AccountHolder>
      <DVACardColorId>1</DVACardColorId>
      <DVADisability>sample string 4</DVADisability>
      <DVANumber>sample string 3</DVANumber>
      <GAPOnly>true</GAPOnly>
      <HCCPensionExpiry>2025-12-14T08:56:09.5416277+00:00</HCCPensionExpiry>
      <HCCPensionNo>sample string 6</HCCPensionNo>
      <HealthFundId>1</HealthFundId>
      <IHINo>sample string 5</IHINo>
      <MedicareExpiry>2025-12-14T08:56:09.5416277+00:00</MedicareExpiry>
      <MedicareNumber>sample string 2</MedicareNumber>
      <PatientAccountTypeId>1</PatientAccountTypeId>
    </PatientAccountType_Secondary>
    <PatientId>56bd6e2c-f022-470f-9adb-a323a6d11124</PatientId>
    <Phone>samplestring17</Phone>
    <ReferralTypeID>5ebbb041-f5f7-47af-91d5-c9bfb4c1832f</ReferralTypeID>
    <RefferringPhyscianID>d1509691-dcd6-4256-b8f7-34b29e59e178</RefferringPhyscianID>
    <RefferringPhysician>sample string 10</RefferringPhysician>
    <RegionId>1</RegionId>
    <SaveSimilarMatch>true</SaveSimilarMatch>
    <StateId>1</StateId>
    <SurName>sample string 9</SurName>
    <TTPName>sample string 13</TTPName>
    <TitleId>1</TitleId>
    <TitleName>sample string 5</TitleName>
  </PatientViewModel>
</ArrayOfPatientViewModel>