Patient List

API URL	{{url}}/spice-service/patient/list
Method	POST
Description	Patient List

Input:

Field Name	Type	Mandatory	Example
Authorization (Header)	String	Yes	Bearer 1ba363a1edf54402b51f58060aa52b11d30f99a490295adec900fdabf2b472181c0bfb165be18f4f5c430c7218a244bd29b9300d3471acc08197ccfb996118f6
client	String	Yes	mob
countryId	Integer	Yes	Country Id
limit	Integer	Yes	Limit of data to fetch
referencePatientId	Integer	Yes	Reference Patient Id
siteId	Integer	Yes	Site id
sort	String	Yes	Sort the data
isRedRisk	Boolean	Yes	Red risk indication
tenantId	Integer	Yes	Tenant if of user
type	String	Yes	Type
villageIds	Integer	Yes	Village id

Sample Input:

{ "countryId": 1, "limit": 15, "referencePatientId": "12", "siteId": "9", "skip": 30, "tenantId": 1405, "type": "my_patients", "villageIds": [ 728 ] }

Output:

Field Name	Type	Comments
message	String	Patient List fetched successfully
id	Integer	Patient id
name	String	Patient Name
birthDate	Date	Data of birth of patient
patientId	BigInt	Patinet reference id
gender	String	Patient gender
village	String	Village details
villageId	BigInt	Village id
phoneNumber	Bigint	Patient Phone number
phoneNumberCategory	String	Category of patient
isPregnant	Boolean	Pregnant status of patient
isActive	Boolean	Patient status
status	Boolean	Response status

Sample Output:

{
  "message": "Patient List fetched successfully.",
  "entity": {
    "patientList": [
      {
        "requestFrom": null,
        "id": "1",
        "name": "Leon wife",
        "nationalId": null,
        "birthDate": "1997-11-15T00:00:00+00:00",
        "patientId": "2211",
        "gender": "FEMALE",
        "village": "Leon Sl Village",
        "villageId": "1",
        "phoneNumber": "8665XX55",
        "phoneNumberCategory": "personal",
        "age": null,
        "memberReference": null,
        "memberId": null,
        "fhirUrl": null,
        "motherPatientId": null,
        "householdId": null,
        "isPregnant": true,
        "isActive": true,
        "diagnosisType": null,
        "identityType": null,
        "identityValue": null,
        "patientStatus": null,
        "dateOfBirth": null,
        "chw": null,
        "type": null,
        "performer": null,
        "hhid": null
      }
    ],
    "referencePatientId": null,
    "totalCount": 1
  },
  "status": true,
  "entityList": null,
  "responseCode": 200,
  "totalCount": null
}