ICCM
API URL
{{url}}/spice-service/assessment/create
Method
POST
Description
Assessment Creation of other symptoms
Input:
Field Name
Type
Mandatory
Example
Authorization (Header)
String
Yes
Bearer 1ba363a1edf54402b51f58060aa52b11d30f99a490295adec900fdabf2b472181c0bfb165be18f4f5c430c7218a244bd29b9300d3471acc08197ccfb996118f6
client
String
Yes
mob
households
String
Yes
Households details
householdMembers
String
Yes
Household Members details
assessments
String
Yes
Assessment details
assessmentDetails
String
Yes
iccm
nutritionalStatusDetails
String
Yes
hasOedemaOfBothFeet: true
fever
String
Yes
rdtTest: +ve, act: NA, hasFever: true, noOfDaysOfFever: 22
diarrhoea
String
Yes
Diarrhoea details
hasDiarrhoea
Boolean
Yes
Has Diarrhoea validation
numberOfDaysDiarrhoea
Bigint
Yes
Number Of Days Diarrhoea
zincDispensedStatus
String
Yes
Zinc Dispensed Status
jellyWaterDispensedStatus
String
Yes
Jelly Water Dispensed Status
sssDispensedStatus
String
Yes
SSS Dispensed Status
orsDispensedStatus
String
Yes
ORS Dispensed Status
isBloodyDiarrhoea
Boolean
Yes
Is Bloody Diarrhoea
diarrhoeaSigns
String
Yes
restlessAndIrritable,
littleOrNoUrine
cough
String
Yes
Cough details
chestInDrawing
Boolean
Yes
Chest In Drawing
hasCough
Boolean
Yes
Has Cough
breathPerMinute
Bigint
Yes
Breath Per Minute
noOfDaysOfCough
Bigint
Yes
Number Of Days Of Cough
generalDangerSigns
String
Yes
General Danger Signs
isBreastfeed
Boolean
Yes
Is Breastfeed
isUnusualSleepy
Boolean
Yes
Is Unusual Sleepy
isVomiting
Boolean
Yes
Is Vomiting
isConvulsionPastFewDays
Boolean
Yes
Is Convulsion Past Few Days
assessmentType
String
Yes
ICCM
encounter
String
Yes
Encounter details like patient details and organization details
endTime
Date
Yes
End Time
householdId
Bigint
Yes
Household Id
latitude
Double
Yes
Location details
longitude
Double
Yes
longitude details
memberId
Bigint
Yes
Household Member Id
patientId
Bigint
Yes
Patient Id
provenance
String
Yes
Provenance details
referred
Boolean
Yes
Patient Referred status
startTime
Date
Yes
Start Time
patientStatus
String
Yes
Patient Status
referenceId
Bigint
Yes
Reference ID for a household member
referredReasons
String
Yes
MUAC, Cough, Malaria, Diarrhoea
summary
String
Yes
diarrheaCondition: Severe Dehydration,
referredSiteId: 1,
feverCondition: Malaria
updatedAt
Date
Yes
Updated At
villageId
Bigint
Yes
Village ID for assessment
Sample Input:
{ "households": [], "householdMembers": [], "assessment": { "assessmentDetail": { "iccm": { "nutritionalStatusDetails": { "hasOedemaOfBothFeet": true }, "fever": { "rdtTest": "+ve", "act": "NA", "hasFever": true, "noOfDaysOfFever": 3 }, "diarrhoea": { "hasDiarrhoea": true, "numberOfDaysDiarrhoea": 3, "zincDispensedStatus": "Dispensed", "jellyWaterDispensedStatus": "Dispensed", "sssDispensedStatus": "Dispensed", "orsDispensedStatus": "Dispensed", "isBloodyDiarrhoea": true, "diarrhoeaSigns": [ "restlessAndIrritable", "littleOrNoUrine" ] }, "cough": { "chestInDrawing": true, "hasCough": true, "breathPerMinute": 3, "noOfDaysOfCough": 3 }, "generalDangerSigns": { "isBreastfeed": false, "isUnusualSleepy": false, "isVomiting": false, "isConvulsionPastFewDays": false } } }, "assessmentType": "ICCM", "encounter": { "endTime": "2025-01-27T06:46:35.356Z", "householdId": "2016852", "latitude": 37.4219983, "longitude": -122.084, "memberId": "1", "patientId": "2", "provenance": {}, "referred": true, "startTime": "2025-01-27T06:46:35.356Z" }, "patientStatus": "Referred", "referenceId": 15, "referredReasons": "MUAC, Cough, Malaria, Diarrhoea", "summary": { "diarrheaCondition": "Severe Dehydration", "referredSiteId": 1, "feverCondition": "Malaria" }, "updatedAt": 1737960391717, "villageId": "1" }, "followUps": [], "householdMemberLinks": [] }
Output:
Field Name
Type
Comments
Message
String
Assessment Created Successfully