SPICE Product Docs
SPICE 2.0 Docs
SPICE 2.0 Docs
  • Overview
    • πŸ“’What is SPICE?
    • ✨SPICE App Workflows
      • Household Registration
      • Assessment
      • Follow-up
      • My Patients
      • Medical Review
      • Pharmacy
    • πŸ‘©β€βš•οΈSPICE Users
    • 🏒Admin Workflows
      • Admin Portal
    • πŸ”Data Privacy & Security
      • Privacy Policy
      • Terms & Conditions of Use
    • ❓Frequently Asked Questions (FAQs)
  • Engineering
    • πŸ–₯️Architecture
      • C4 Diagrams
      • Architecture Diagram
    • πŸ”§Technology Stack
    • πŸ‘¨β€πŸ’»API Documentation
      • Common Services
        • Login
        • Reset Password
        • Logout
        • Verify Set Password
        • User Profile Update
        • Set Password for new User
        • Validate Phone Number
        • Get User Details
        • Change Password for Users
        • Forgot Password
        • Validate User Email
        • Get User Profile
      • Admin Services
        • Lab Test Customization
          • Lab Test Update
          • Lab Test List
          • Lab Test by Name
          • Lab Test Delete
          • Lab Test Create
          • Lab Test Validate
        • Medication
          • Medication List
          • Medication Create
          • Medication Update
          • Medication Remove
          • Medication Validate
        • User
          • User Validate
          • User List
          • User Remove
          • User Create and Update
        • Get Menu
        • Country List
        • Health Facility
          • Health Facility Update
          • Health Facility List
          • Health Facility Create
          • Health Facility Details
        • Region
          • Get Region Detail
          • Region Upload
          • Region Download
      • SPICE Service
        • Patient Search
        • Household Create
        • Patient List
        • Member Create
        • Offline Sync
          • Offline Household Create
          • Offline Member Create
        • Medical Review
          • ANC Pregnancy Create
          • ANC Pregnancy Detail
          • ICCM Under two months Create
          • ICCM Under five years Create
          • ICCM Under two months Details
          • Labour Mother Neonate Create
          • ICCM Under five years Details
          • Labour Mother Neonate Details
          • PNC Create
          • PNC Details
        • Assessment
          • Childhood Visit
          • ICCM
          • ANC
          • PNC
          • Other Symptoms
        • Investigation
          • Create Investigation
          • Investigation Remove
          • Investigation History List
        • Prescription
          • Prescription Remove
          • Prescribed Details
          • Prescription Create
        • App Version
        • Calculate WGS
        • Create Diagnosis
        • Diagnosis Details
        • Get Chiefdoms
        • Get Districts
        • Get Patient Status
        • Get Patient Details
        • Household Update
        • Member Update
  • Deploy
    • πŸš€Deployment Guide
      • πŸ“±Android
      • πŸ–₯️Admin Portal
      • πŸ—„οΈHAPI FHIR Server
      • πŸ—„οΈServer
    • 🌎Customization Guide
      • Multi-Language Translation
        • Support for multiple languages
      • Clinical Workflow Customization
      • WHO Hearts Algorithm
      • Country Level Administrative Divisions
  • PRODUCT
    • πŸ₯˜Releases
    • πŸ›£οΈRoadmap
  • COMMUNITY
    • πŸ§‘β€πŸ’»Engage
    • πŸ“žSupport
    • πŸ“ƒPolicies
  • LINKS
    • Source Code (GitHub)
    • Medtronic LABS
    • Developer Support
  • versions
    • SPICE 1.0
      • OVERVIEW
        • πŸ“’What is SPICE?
        • ✨SPICE App Workflows
          • Screening
          • Enrollment
          • Assessment
          • Medical Review
            • Treatment Plan
            • Prescribe
            • Lab Test
          • My Patients
          • Pharmacy
          • Admin Portal
        • πŸ‘©β€βš•οΈSPICE Users
        • πŸ”Data Privacy & Security
          • Privacy Policy
          • Terms & Conditions of Use
        • ❓Frequently Asked Questions (FAQs)
      • ENGINEERING
        • πŸ–₯️Architecture
          • C4 Diagrams
          • FHIR & Standards
        • πŸ”§Technology Stack
        • πŸ‘¨β€πŸ’»API Documentation
          • Common Services
            • Account Create
            • Change Password for Site Users
            • Country Create
            • Forgot Password
            • Get User Details
            • Get User Profile
            • Locked Users List
            • Login
            • Logout
            • Operating Unit Create
            • Reset Password
            • Set Password for New User
            • Site Create
            • Unlock User
            • User Profile Update
            • Validate User Email
            • Verify Set Password
            • Super Admin
              • Superadmin Details
              • Superadmin List
              • Superadmin Create
              • Superadmin Delete
              • Superadmin Update
          • Admin Services
            • Account
              • Account - Activate
              • Account - Deactivate
              • Account - Deactivated list
              • Account - Details
              • Account - Update
              • Account Admin - Create
              • Account Admin - Delete
              • Account Admin - Update
              • Account Dashboard - Region Admin
              • Account List - Admin
            • Clinical Workflow
              • Create
              • Delete
              • List
              • Update
              • Account Customization - Create
              • Account Customization - Details
              • Account Customization - Update
            • Country Dashboard - Superadmin
            • Lab Test
              • Create
              • Delete
              • Details
              • List
              • Update
              • Lab Test Range - Create
              • Lab Test Range - Delete
              • Lab Test Range - Details
              • Lab Test Range - Update
            • Medication
              • Create
              • Delete
              • Medication Validation
              • List
              • Update
            • Operating Unit
              • Operating Unit - Details
              • Operating Unit - Update
              • Operating Unit Admin - Create
              • Operating Unit Admin - Remove
              • Operating Unit Admin - Update
              • Operating Unit Dashboard - Account Admin
              • Operating Unit List - Admin
            • Program
              • Create
              • List
              • Delete
              • Details
              • Update
            • Region Admin
              • Region Admin - Create
              • Region admin - Delete
              • Region Admin - Details
              • Region admin - Update
            • Site
              • Site - Details
              • Site - Update
              • Site Dashboard - Operating Unit Admin
              • Site List - Admin
              • Site User - Create
              • Site User - Remove
              • Site User - Update
            • Site List - Region Admin
          • SPICE Services
            • Advance-search
            • Advanced search - Site
            • App Version
            • Assessment
            • Assessment Bplog Create
            • Assessment Glucose log Create
            • BPLog List
            • BPLog Create
            • Confirm Diagnosis
            • Device Details
            • Fill Prescription - Update
            • GlucoseLog Create
            • GlucoseLog List
            • Investigation Create
              • Fill Prescription List
            • Investigation List
            • Investigation Search
            • Labtest Result Create
            • Labtest Result Details
            • Labtest Result List
            • Lifestyle Create
            • Lifestyle List
            • Lifestyle remove
            • Lifestyle Update
            • Lifestyle Update view Status
            • Lifestyle view history
            • Medical Review Create - Continuous Medical Review
            • Medical Review Create - Initial Medical Review
            • Medical Review Static Data
            • Medical Review Count
            • Medical review list
            • Medical Review Summary
            • Mental Health Create
            • Mental Health Details
            • Mobile - Forgot Password
            • Mobile - Login
            • Mobile - Logout
            • Nutritionist Lifestyle Create
            • Patient Basic Details
            • Patient Details
            • Patient enrollment
            • Patient-labtest-list
            • Patient Labtest - Remove
            • Patient Labtest - Review
            • Patient-lifestyle-details
            • Patient list
            • Patient Pregnancy Details
            • Patient Pregnancy Details Create
            • Patient Remove
            • Patient Transfer - Create
            • Patient Transfer Count
            • Patient Transfer - Country Site List
            • Patient Transfer - Role user list
            • Patient Transfer List
            • Patient Transfer - Update
            • Patient Transfer - Validate
            • Patient update
            • Patient Visit
            • PatientVisit
            • Pregnancy Create
            • Pregnancy Details
            • Prescription History List
            • Prescription List
            • Prescription Remove
            • Prescription search
            • Pregnancy Update
            • Prescription-history list
            • Prescription Update
            • Refill Prescription History
            • Screening
            • Screening log details
            • Search
            • Transfer Notification Count
            • Treatment Plan Details
            • Treatment Plan Update
            • User Validate API
          • FHIR-Adapter Services
            • Add User
            • Get User By Id
            • Get User By Username
            • Get User List
            • Get User Profile
            • Update User
            • Reset User Password
            • Delete User by ID
            • Forgot Password Validation
            • Options
            • Receive Message
            • Login
            • Site Migration
            • User Migration
            • APIKey Manager API
              • Retrieve API Keys
              • Generate API Keys
              • Delete API Keys
              • Validate API Key
      • DEPLOY
        • πŸš€Deployment Guide
          • πŸ—„οΈServer
          • πŸ“±Android
          • πŸ–₯️Admin Portal
          • πŸ—„οΈFHIR Adapter
        • 🌎Customization Guide
          • Multi-Language Translation
            • Support for multiple languages
          • Clinical Workflow Customization
          • WHO Hearts Algorithm
          • Country Level Administrative Divisions
      • PRODUCT
        • πŸ₯˜Releases
        • πŸ›£οΈRoadmap
      • LINKS
        • Source Code (GitHub)
        • Medtronic LABS
        • Developer Support
Powered by GitBook

@2024 Medtronic LABS

On this page

Input:

Sample Input:

{ "households": [ ], "householdMembers": [] "assessment": { "assessmentDetai": { "pncMother": { "dateOfDelivery": "2025-01-15T00:00:00+00:00", "sleepsUnderBedNet": false, "exclusivelyBreastfeeding": false, "pncMotherSigns": [ "convulsionsOrNotConscious" ], "chlorhexidine": false, "noOfNeonates": 1, "fatherPresent": false, "visitNo": 1, "neonatePatientReferenceId": 22 } }, "assessmentType": "PNC_MOTHER", "encounter": {}, "patientStatus": "Referred", "referenceId": 3, "referredReasons": "PNC Mother Signs - PNC Visit 1", "summary": { "nextVisitDate": "2025-01-28T00:00:00+00:00", "referredSiteId": 22, "referredSite": "Swiss Health Centre" }, "updatedAt": 1737960251805, "villageId": "12" }, "children": [ { "assessments": [ { "assessmentDetail": { "pncNeonatal": { "lastMenstrualPeriod": "2025-01-14T00:00:00+00:00", "gestationalAge": 1, "deathOfNewborn": false, "newbornReferredToSBCU": false, "lowBirthWeight": false, "visitNo": 1 } }, "assessmentType": "PNC_NEONATE", "encounter": {}, "patientStatus": "Recovered", "referenceId": 4, "referredReasons": "PNC Visit 1", "updatedAt": 1737960251810, "villageId": "351" }, "createdAt": 1737960251768, "dateOfBirth": "2025-01-15T00:00:00+00:00", "gender": "male", "householdHeadRelationship": "Son / Daughter", "householdId": "2016852", "householdReferenceId": "30", "isActive": true, "isChild": true, "latitude": 37.4219983, "longitude": -122.084, "motherReferenceId": "189", "name": "prem baby", "phoneNumber": "21312312", "phoneNumberCategory": "Personal", "provenance": {}, "referenceId": "190", "updatedAt": 1737960251768, "village": "Clergy", "villageId": 351 }, "createdAt": 1737960108296, "dateOfBirth": "1993-01-27T00:00:00+00:00", "gender": "female", "householdHeadRelationship": "Wife / Husband", "householdId": "2016852", "householdReferenceId": "30", "id": "2016875", "isActive": true, "isChild": false, "isPregnant": true, "lastUpdated": "2025-01-27T06:41:37+00:00", "latitude": 37.4219983, "longitude": -122.084, "name": "lili", "patientId": "314300116400072", "phoneNumber": "21331231", "phoneNumberCategory": "Personal", "provenance": {}, "referenceId": "189", "updatedAt": 1737960108296, "version": "1", "village": "Clergy", "villageId": 351 }, "assessments": [], "followUps": [], "householdMemberLinks": [] }

Output:

Sample Output:

API URL

{{url}}/spice-service/assessment/create

Method

POST

Description

Assessment Creation of PNC in RMNC

Field Name

Type

Mandatory

Example

Authorization (Header)

String

Yes

Bearer 1ba363a1edf54402b51f58060aa52b11d30f99a490295adec900fdabf2b472181c0bfb165be18f4f5c430c7218a244bd29b9300d3471acc08197ccfb996118f6

client

String

Yes

mob

household

String

Yes

Households details

householdMember

String

Yes

Household Members details

dateOfBirth

Date

Yes

DateOfBirth of member

gender

String

Yes

Gender of Household member

householdHeadRelationship

String

Yes

Household Head Relationship

householdReferenceId

Bigint

Yes

Household Reference Id

isActive

Boolean

Yes

Is Active

isChild

Boolean

Yes

Is Child validation

latitude

Double

Yes

Location details

longitude

Double

Yes

longitude details

name

String

Yes

Household name

phoneNumber

Bigint

Yes

Phone Number

phoneNumberCategory

String

Yes

PhoneNumber Category

provenance

String

Yes

Provenance details

referenceId

Bigint

Yes

Reference ID for the household member

village

String

Yes

Village name

villageId

Bigint

Yes

Village ID for household

landmark

String

Yes

Landmark for household

name

string

Yes

Household Name

noOfPeople

Bigint

Yes

Number of People in Household

ownedAnImprovedLatrine

Boolean

Yes

Owned An Improved Latrine

ownedHandWashingFacilityWithSoap

Boolean

Yes

Had owned a HandWashing Facility With Soap

ownedTreatedBedNet

Boolean

Yes

Owned Treated BedNet

assessment

String

Yes

Assessment details pncMother

dateOfDelivery

Date

Yes

Date Of Delivery

sleepsUnderBedNet

Boolean

Yes

Sleeps Under Bed Net

exclusivelyBreastfeeding

Boolean

Yes

Exclusively Breastfeeding

pncMotherSigns

String

Yes

convulsionsOrNotConscious

chlorhexidine

Boolean

Yes

Chlorhexidine

noOfNeonates

Bigint

Yes

No Of Neonates

fatherPresent

Boolean

Yes

Father Present

visitNo

Bigint

Yes

Visit No

neonatePatientReferenceId

Bigint

Yes

Neonate Patient Reference Id

assessmentType

String

Yes

PNC_MOTHER

encounter

String

Yes

Encounter details like patient details and organization details

endTime

Date

Yes

End Time

household

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

PNC Mother Signs - PNC Visit 1

summary

String

Yes

referredSiteId

updatedAt

Date

Yes

Updated At

villageId

Bigint

Yes

Village ID for assessment

children

String

Yes

Children’s details of PNC

assessmentDetails

String

Yes

pncNeonatal

assessmentType

String

Yes

PNC_MOTHER

lastMenstrualPeriod

Date

Yes

Last Menstrual Period

gestationalAge

Bigint

Yes

Gestational Age

deathOfNewborn

Boolean

Yes

Death Of Newborn

newbornReferredToSBCU

Boolean

Yes

Newborn Referred To SBCU

lowBirthWeight

Boolean

Yes

Low Birth Weight

Field Name

Type

Comments

Message

String

Assessment Created Successfully

{
  "message": "Assessment Created Successfully.",
  "entity": null,
  "status": true,
  "entityList": null,
  "responseCode": 201,
  "totalCount": null
}
  1. Engineering
  2. πŸ‘¨β€πŸ’»API Documentation
  3. SPICE Service
  4. Assessment

PNC

PreviousANCNextOther Symptoms