Patient enrollment
API URL | {{url}}/spice-service/patient/enrollment |
Method | POST |
Description | Patient enrollment |
Input:
Field Name | Type | Mandatory | Example |
Authorization(Header) | String | Yes | Bearer eyJlbmMiOiJBMTI4R0NNIiwiYWxnIjoiUlNBLU9BRVAtMjU2In0.MCm0mJDfpfjlr10Uok79-kTF7fv9Tn7cI5m2WsRDGUd9VS7iRmfbszjuc1-w5D-PYt9CdVxRMGBQlzYauhnI |
Input:
Field Name | Type | Mandatory | Example |
NationalId | String | Yes | PARTE65432 |
FirstName | String | Yes | Partha |
LastName | String | Yes | E |
MobileNumber | String | Yes | 198765432 |
MobileNumberCategory | String | Yes | Personal |
county | String | Yes | Kwale |
SubCounty | String | Yes | Matuga |
Occupation | String | Yes | Employed |
LevelOfEducation | String | Yes | A-level Completed |
gender | String | Yes | Male |
DateOfBirth | Date | No | 26/05/2000 |
Age | Bigint | Yes | 23 |
IsRegularSmoker | Boolean | Yes | No |
Diabetes | String | Yes | N/A |
Hypertension | String | Yes | N/A |
Height | Double-precision | Yes | 182 |
Weight | Double-precision | Yes | 77 |
Systolic | Integer | Yes | 88 |
Diastolic | Integer | Yes | 88 |
Pulse | Integer | No | 88 |
Blood Glucose | Double-precision | No | 23 |
lastMealTime | TimeStamp | No | 2023-05-26T17:01:13+05:30 |
MentalHealthQuestions(PHQ4) | Integer | Yes | 4 |
Sample Input:
{ "gender": "Male", "isRegularSmoker": false, "cvdRiskScore": 2, "dateOfBirth": "2000-05-26T00:00:00+05:30", "bpLog": { "avgSystolic": 88, "bpLogId": 47, "weight": 77, "avgDiastolic": 88, "avgBloodPressure": "88/88", "height": 182, "bpLogDetails": [ { "diastolic": 88, "pulse": 88, "systolic": 88 }, { "diastolic": 88, "pulse": 88, "systolic": 88 }, { "diastolic": 88, "pulse": 88, "systolic": 88 } ], "bmi": 23.25 }, "phq4": { "phq4Score": 7, "phq4MentalHealth": [ { "answerId": 67, "score": 3, "questionId": 6, "displayOrder": 4 }, { "answerId": 23, "score": 1, "questionId": 13, "displayOrder": 1 }, { "answerId": -1, "score": 2, "questionId": 9, "displayOrder": 3 }, { "answerId": 49, "score": 1, "questionId": 17, "displayOrder": 2 } ], "phq4RiskLevel": "Moderate" }, "cvdRiskLevel": "Low risk", "unitMeasurement": "metric", "bpLogId": 47, "cvdRiskScoreDisplay": "2% - Low risk", "bioMetrics": { "gender": "Male", "isRegularSmoker": false, "age": 23 }, "siteId": 1, "patientTrackId": 12, "glucoseLog": { "glucoseUnit": "mmol/L", "hba1cUnit": "mmol/L" }, "age": 23, "bioData": { "firstName": "Partha", "lastName": "E", "country": 1, "levelOfEducation": "A-level Completed", "phoneNumber": "198765432", "occupation": "Employed", "nationalId": "PARTE65432", "initial": "E", "county": 2, "subCounty": 3, "insuranceStatus": false, "phoneNumberCategory": "Personal" }, "patientStatus": { "htnPatientType": "N/A", "diabetesPatientType": "N/A", "isHtnDiagnosis": false, "isDiabetesDiagnosis": false } }
Output:
Field Name | Type | Comments |
| Integer | User ID |
| String | Patient national ID |
| String | Patient first name |
| String | Patient last name |
| String | Patient gender |
| Bigint | Patient age |
| String | Site name |
| Time Stamp | Enrollment date |
| Bigint | Virtual id |
| Integer | Average systolic |
| Integer | Average diastolic |
| Double-precision | BMI |
| String | CVD risk level |
| Integer | CVD risk score |
| Boolean | Is updated from enrollment |
| Boolean | Is latest |
| Boolean | Is deleted |
| Boolean | Is old record |
| Boolean | Is red risk patient |
| String | Provisional treatment plan |
| Boolean | Confirm diagnosis |
| String | Phq4 risk level |
| Integer | phq4 score |