POST api/PatientInfo/PatientSearchByFilter

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
HealthCareFacilityId	integer	None.
SurveyId	integer	None.
PatientIdentifyingNo	string	None.
CheckIfPatientIdentifyingNoAlreadyExist	boolean	None.
AuditDateFrom	date	None.
AuditDateTo	date	None.
SpecialtyId	integer	None.
AntifungalId	integer	None.
WardId	integer	None.
GenderCode	character	None.
BirthDateFrom	date	None.
BirthDateTo	date	None.
ShowCompleted	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "HealthCareFacilityId": 1,
  "SurveyId": 1,
  "PatientIdentifyingNo": "sample string 2",
  "CheckIfPatientIdentifyingNoAlreadyExist": true,
  "AuditDateFrom": "2025-04-01T19:02:35.7482735+00:00",
  "AuditDateTo": "2025-04-01T19:02:35.7482735+00:00",
  "SpecialtyId": 1,
  "AntifungalId": 1,
  "WardId": 1,
  "GenderCode": "A",
  "BirthDateFrom": "2025-04-01T19:02:35.7482735+00:00",
  "BirthDateTo": "2025-04-01T19:02:35.7482735+00:00",
  "ShowCompleted": true
}

application/xml, text/xml

Sample:

<PatientSearchFilterDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NAPSWebApi.DTO.DTOModel.AFNAPS.Guidance.PatientDetails">
  <AntifungalId>1</AntifungalId>
  <AuditDateFrom>2025-04-01T19:02:35.7482735+00:00</AuditDateFrom>
  <AuditDateTo>2025-04-01T19:02:35.7482735+00:00</AuditDateTo>
  <BirthDateFrom>2025-04-01T19:02:35.7482735+00:00</BirthDateFrom>
  <BirthDateTo>2025-04-01T19:02:35.7482735+00:00</BirthDateTo>
  <CheckIfPatientIdentifyingNoAlreadyExist>true</CheckIfPatientIdentifyingNoAlreadyExist>
  <GenderCode>65</GenderCode>
  <HealthCareFacilityId>1</HealthCareFacilityId>
  <PatientIdentifyingNo>sample string 2</PatientIdentifyingNo>
  <ShowCompleted>true</ShowCompleted>
  <SpecialtyId>1</SpecialtyId>
  <SurveyId>1</SurveyId>
  <WardId>1</WardId>
</PatientSearchFilterDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of PatientSearchResultDTO

Name	Type	Additional information
SpecialtyId	integer	None.
SpecialtyName	string	None.
WardId	integer	None.
WardName	string	None.
PatientId	integer	None.
PatientIdentifyingNo	string	None.
AuditDate	date	None.
HealthCareFacilityId	integer	None.
HealthCareFacilityName	string	None.
SurveyId	integer	None.
SurveyName	string	None.
IsCompleted	boolean	None.
CreatedDate	date	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "SpecialtyId": 1,
    "SpecialtyName": "sample string 1",
    "WardId": 1,
    "WardName": "sample string 2",
    "PatientId": 3,
    "PatientIdentifyingNo": "sample string 4",
    "AuditDate": "2025-04-01T19:02:35.8107715+00:00",
    "HealthCareFacilityId": 1,
    "HealthCareFacilityName": "sample string 5",
    "SurveyId": 1,
    "SurveyName": "sample string 6",
    "IsCompleted": true,
    "CreatedDate": "2025-04-01T19:02:35.8107715+00:00"
  },
  {
    "SpecialtyId": 1,
    "SpecialtyName": "sample string 1",
    "WardId": 1,
    "WardName": "sample string 2",
    "PatientId": 3,
    "PatientIdentifyingNo": "sample string 4",
    "AuditDate": "2025-04-01T19:02:35.8107715+00:00",
    "HealthCareFacilityId": 1,
    "HealthCareFacilityName": "sample string 5",
    "SurveyId": 1,
    "SurveyName": "sample string 6",
    "IsCompleted": true,
    "CreatedDate": "2025-04-01T19:02:35.8107715+00:00"
  }
]

application/xml, text/xml

Sample:

<ArrayOfPatientSearchResultDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NAPSWebApi.DTO.DTOModel.AFNAPS.Guidance.PatientDetails">
  <PatientSearchResultDTO>
    <AuditDate>2025-04-01T19:02:35.8107715+00:00</AuditDate>
    <CreatedDate>2025-04-01T19:02:35.8107715+00:00</CreatedDate>
    <HealthCareFacilityId>1</HealthCareFacilityId>
    <HealthCareFacilityName>sample string 5</HealthCareFacilityName>
    <IsCompleted>true</IsCompleted>
    <PatientId>3</PatientId>
    <PatientIdentifyingNo>sample string 4</PatientIdentifyingNo>
    <SpecialtyId>1</SpecialtyId>
    <SpecialtyName>sample string 1</SpecialtyName>
    <SurveyId>1</SurveyId>
    <SurveyName>sample string 6</SurveyName>
    <WardId>1</WardId>
    <WardName>sample string 2</WardName>
  </PatientSearchResultDTO>
  <PatientSearchResultDTO>
    <AuditDate>2025-04-01T19:02:35.8107715+00:00</AuditDate>
    <CreatedDate>2025-04-01T19:02:35.8107715+00:00</CreatedDate>
    <HealthCareFacilityId>1</HealthCareFacilityId>
    <HealthCareFacilityName>sample string 5</HealthCareFacilityName>
    <IsCompleted>true</IsCompleted>
    <PatientId>3</PatientId>
    <PatientIdentifyingNo>sample string 4</PatientIdentifyingNo>
    <SpecialtyId>1</SpecialtyId>
    <SpecialtyName>sample string 1</SpecialtyName>
    <SurveyId>1</SurveyId>
    <SurveyName>sample string 6</SurveyName>
    <WardId>1</WardId>
    <WardName>sample string 2</WardName>
  </PatientSearchResultDTO>
</ArrayOfPatientSearchResultDTO>