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 eyJlbmMiOiJBMTI4R0NNIiwiYWxnIjoiUlNBLU9BRVAtMjU2In0.MCm0mJDfpfjlr10Uok79-kTF7fv9Tn7cI5m2WsRDGUd9VS7iRmfbszjuc1-w5D-PYt9CdVxRMGBQlzYauhnI |
Sample Input:
{ "limit": 15, "patientFilter": { "screeningReferral": true }, "patientSort": { "isRedRisk": true }, "skip": 0, "tenantId": 4 }
Output:
Field Name | Type | Comments |
| Integer | Patient Table ID |
| String | National ID |
| BigInt | Program ID |
| String | Patient FirstName |
| String | Patient LastName |
| String | Patient Gender |
| BigInt | Patient Age |
| String | Patient Status |
| Timestamp | Patient Enrolled Date |
| BigInt | Patient Id |
| BigInt | ScreeningLog ID |
| Boolean | Patient Initial Review Completed or Not |
| Boolean | Is Patient RedRisk |
Sample Output:
{
"message": "Patient List fetched Successfully.",
"entity": null,
"status": true,
"entityList": [
{
"id": 1,
"nationalId": "ANUANBU15425",
"programId": 2,
"firstName": "ANU",
"lastName": "ANBU",
"gender": "Female",
"age": 26,
"patientStatus": "ENROLLED",
"enrollmentAt": "2023-05-24T13:52:12+05:30",
"patientId": 2,
"screeningLogId": 1,
"createdAt": "2023-05-23T19:11:29+05:30",
"initialReview": true,
"redRiskPatient": true
},
{
"id": 25,
"nationalId": "AKSH123",
"programId": 24,
"firstName": "AKSHATA",
"lastName": "A",
"gender": "Female",
"age": 26,
"patientStatus": "ENROLLED",
"enrollmentAt": "2023-05-26T16:35:47+05:30",
"patientId": 25,
"screeningLogId": 14,
"createdAt": "2023-05-26T16:33:22+05:30",
"initialReview": false,
"redRiskPatient": false
},
{
"id": 24,
"nationalId": "NKSK54585",
"programId": 22,
"firstName": "NK",
"lastName": "SK",
"gender": "Female",
"age": 28,
"patientStatus": "ENROLLED",
"enrollmentAt": "2023-05-26T15:13:21+05:30",
"patientId": 21,
"screeningLogId": 13,
"createdAt": "2023-05-26T15:12:14+05:30",
"initialReview": false,
"redRiskPatient": false
},
{
"id": 23,
"nationalId": "VARUNITHYA",
"programId": 21,
"firstName": "NITHYA",
"lastName": "VARUN",
"gender": "Female",
"age": 26,
"patientStatus": "ENROLLED",
"enrollmentAt": "2023-05-26T15:05:53+05:30",
"patientId": 20,
"screeningLogId": null,
"createdAt": "2023-05-26T15:05:53+05:30",
"initialReview": true,
"redRiskPatient": false
},
{
"id": 22,
"nationalId": "JOHNENID654",
"programId": 20,
"firstName": "JOHNNN",
"lastName": "ENIDDDD",
"gender": "Female",
"age": 26,
"patientStatus": "ENROLLED",
"enrollmentAt": "2023-05-26T11:56:40+05:30",
"patientId": 19,
"screeningLogId": null,
"createdAt": "2023-05-26T11:56:40+05:30",
"initialReview": false,
"redRiskPatient": false
},
{
"id": 21,
"nationalId": "AJEESHAA",
"programId": 19,
"firstName": "AJEE",
"lastName": "SHAA",
"gender": "Female",
"age": 26,
"patientStatus": "ENROLLED",
"enrollmentAt": "2023-05-25T18:48:46+05:30",
"patientId": 18,
"screeningLogId": null,
"createdAt": "2023-05-25T18:48:46+05:30",
"initialReview": true,
"redRiskPatient": false
},
{
"id": 20,
"nationalId": "ASHEEESHAA",
"programId": 18,
"firstName": "ASHEE",
"lastName": "SHAA",
"gender": "Female",
"age": 25,
"patientStatus": "ENROLLED",
"enrollmentAt": "2023-05-25T18:42:22+05:30",
"patientId": 17,
"screeningLogId": null,
"createdAt": "2023-05-25T18:42:22+05:30",
"initialReview": true,
"redRiskPatient": false
},
{
"id": 19,
"nationalId": "ANUDIYA45885",
"programId": 17,
"firstName": "ANU",
"lastName": "DIYA",
"gender": "Female",
"age": 25,
"patientStatus": "ENROLLED",
"enrollmentAt": "2023-05-25T18:35:34+05:30",
"patientId": 16,
"screeningLogId": 12,
"createdAt": "2023-05-25T18:24:51+05:30",
"initialReview": true,
"redRiskPatient": false
},
{
"id": 18,
"nationalId": "XYZ456",
"programId": 16,
"firstName": "DEEPU",
"lastName": "KAVIN",
"gender": "Female",
"age": 35,
"patientStatus": "ENROLLED",
"enrollmentAt": "2023-05-25T18:22:55+05:30",
"patientId": 15,
"screeningLogId": null,
"createdAt": "2023-05-25T18:22:55+05:30",
"initialReview": false,
"redRiskPatient": false
},
{
"id": 16,
"nationalId": "JOHNHENR45884",
"programId": null,
"firstName": "JOHN",
"lastName": "HENRY",
"gender": "Female",
"age": 23,
"patientStatus": "SCREENED",
"enrollmentAt": null,
"patientId": null,
"screeningLogId": 9,
"createdAt": "2023-05-25T14:52:23+05:30",
"initialReview": false,
"redRiskPatient": false
},
{
"id": 14,
"nationalId": "JOHNENID",
"programId": 13,
"firstName": "JOHN",
"lastName": "ENID",
"gender": "Female",
"age": 5,
"patientStatus": "ENROLLED",
"enrollmentAt": "2023-05-25T12:48:40+05:30",
"patientId": 12,
"screeningLogId": null,
"createdAt": "2023-05-25T12:48:40+05:30",
"initialReview": false,
"redRiskPatient": false
},
{
"id": 13,
"nationalId": "VIJISHAA25868",
"programId": 12,
"firstName": "VIJI",
"lastName": "SHAA",
"gender": "Female",
"age": 10,
"patientStatus": "ENROLLED",
"enrollmentAt": "2023-05-25T12:27:41+05:30",
"patientId": 11,
"screeningLogId": 7,
"createdAt": "2023-05-25T12:25:45+05:30",
"initialReview": false,
"redRiskPatient": false
},
{
"id": 11,
"nationalId": "KAVISHREE",
"programId": 10,
"firstName": "KAVYA",
"lastName": "SHREE",
"gender": "Female",
"age": 32,
"patientStatus": "ENROLLED",
"enrollmentAt": "2023-05-24T15:52:47+05:30",
"patientId": 10,
"screeningLogId": null,
"createdAt": "2023-05-24T15:52:47+05:30",
"initialReview": true,
"redRiskPatient": false
},
{
"id": 10,
"nationalId": "OVIYASHREE",
"programId": 9,
"firstName": "OVIII",
"lastName": "SHREE",
"gender": "Female",
"age": 25,
"patientStatus": "ENROLLED",
"enrollmentAt": "2023-05-24T15:37:18+05:30",
"patientId": 9,
"screeningLogId": null,
"createdAt": "2023-05-24T15:37:18+05:30",
"initialReview": true,
"redRiskPatient": false
},
{
"id": 9,
"nationalId": "AVEESHAA21585",
"programId": 8,
"firstName": "AVEE",
"lastName": "SHAA",
"gender": "Female",
"age": 26,
"patientStatus": "ENROLLED",
"enrollmentAt": "2023-05-24T15:05:13+05:30",
"patientId": 8,
"screeningLogId": 5,
"createdAt": "2023-05-24T15:03:52+05:30",
"initialReview": true,
"redRiskPatient": false
}
],
"responseCode": 200,
"totalCount": 20
}