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
  1. versions
  2. SPICE 1.0
  3. ENGINEERING
  4. API Documentation
  5. SPICE Services

Assessment

API URL

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

Method

POST

Description

Patient Assessment Creation

Input:

Field Name

Type

Mandatory

Example

Authorization(Header)

String

Yes

Bearer eyJlbmMiOiJBMTI4R0NNIiwiYWxnIjoiUlNBLU9BRVAtMjU2In0.MCm0mJDfpfjlr10Uok79-kTF7fv9Tn7cI5m2WsRDGUd9VS7iRmfbszjuc1-w5D-PYt9CdVxRMGBQlzYauhnI

Input:

Field Name

Type

Mandatory

Example

Symptoms

String

No

Shortness of breath with usual activities

Compliances

String

No

Did not take any medication

Height

Double-precision

Yes

182

Weight

Double-precision

Yes

65

Temperature

Double-precision

No

96

Systolic

Integer

Yes

103

Diastolic

Integer

Yes

102

Pulse

Integer

No

34

glucoseUnit

String

Yes

mmol/L

glucose

Integer

No

20

glucoseDateTime

Timestamp

Yes

2023-05-26T17:01:13+05:30

hba1cUnit

String

No

mmol/L

glucoseType

String

Yes

rbs

glucoseValue

Double-precision

No

20

hba1c

Double-precision

No

22

lastMealTime

Timestamp

Yes

2023-05-26T09:30:00+05:30

Mental Health Questions(PHQ9)

Integer

Yes

3

Sample Input:

{ "lastName": "A", "gender": "Female", "isRegularSmoker": true, "cvdRiskScore": 3, "bpLog": { "avgSystolic": 88, "weight": 77, "avgDiastolic": 88, "avgBloodPressure": "88/88", "height": 188, "bpLogDetails": [ { "diastolic": 88, "pulse": 88, "systolic": 88 }, { "diastolic": 88, "pulse": 88, "systolic": 88 }, { "diastolic": 88, "pulse": 88, "systolic": 88 } ], "bmi": 21.79 }, "phq4": { "phq4Score": 6, "phq4MentalHealth": [ { "answerId": 67, "score": 3, "questionId": 6, "displayOrder": 4 }, { "answerId": 55, "score": 0, "questionId": 13, "displayOrder": 1 }, { "answerId": -1, "score": 2, "questionId": 9, "displayOrder": 3 }, { "answerId": 49, "score": 1, "questionId": 17, "displayOrder": 2 } ], "phq4RiskLevel": "Moderate" }, "compliances": [ { "isChildExist": true, "complianceId": 1, "name": "Did not take any medication" }, { "complianceId": 2, "name": "Could not afford/pay for medication" } ], "symptoms": [ { "name": "Shortness of breath with usual activities", "symptomId": 2, "type": "Hypertension" }, { "name": "Unplanned weight loss", "symptomId": 1, "type": "Diabetes" } ], "firstName": "AKSHATA", "cvdRiskLevel": "Low risk", "nationalId": "AKSH123", "unitMeasurement": "metric", "tenantId": 4, "cvdRiskScoreDisplay": "3% - Low risk", "siteId": 1, "provisionalDiagnosis": [ "DM" ], "patientTrackId": 25, "glucoseLog": { "glucoseUnit": "mmol/L", "glucose": 22, "glucoseDateTime": "2023-05-26T17:07:24+05:30", "hba1cUnit": "mmol/L", "glucoseType": "rbs", "glucoseValue": 22, "hba1c": 22, "lastMealTime": "2023-05-26T09:30:00+05:30" }, "age": 26 }

Output:

Field Name

Type

Comments

id

Integer

Patient Table ID

nationalId

String

National ID

firstName

String

Patient FirstName

lastName

String

Patient LastName

gender

String

Patient Gender

age

BigInt

Patient Age

programId

Integer

Program ID

emrNumber

Integer

Patient EMR Number

patientStatus

String

Patient Status

siteName

String

SiteName

glucoseType

String

Type of Glucose

glucoseValue

Number

Glucose Value

glucoseUnit

String

Glucose unit

avgSystolic

Integer

Average Systolic

avgDiastolic

Integer

Average Diastolic

bmi

Double-precision

Patient BMI

cvdRiskLevel

String

CVD Risk Level

cvdRiskScore

Integer

CVD Risk Score

phq4RiskLevel

String

Phq4 Risk Level

phq4Score

Integer

Phq4 Risk Score

id

Integer

Patient Symptom Table ID

symptomId

Integer

Symptoms ID

name

String

Symptoms Name

type

String

Symptoms Type

otherSymptom

String

Is patient suffering from any other symptoms

id

Integer

Patient Compliance Table ID

name

String

MedicalCompliance Name

complianceId

Integer

MedicalCompliance ID

otherCompliance

String

Is patient having any other medical compliance

riskLevel

String

Risk level

riskMessage

String

Risk Message

Sample Output:

  {
    "message": "Assessment created successfully for a patient.",
    "entity": {
        "patientDetails": {
            "id": 25,
            "nationalId": "AKSH123",
            "firstName": "AKSHATA",
            "lastName": "A",
            "gender": "Female",
            "age": 26,
            "programId": 24,
            "emrNumber": 0,
            "patientStatus": "ENROLLED",
            "siteName": "Medical Care"
        },
        "glucoseLog": {
            "createdBy": 5,
            "updatedBy": 5,
            "glucoseType": "rbs",
            "glucoseValue": 22,
            "glucoseUnit": "mmol/L",
            "updatedFromEnrollment": false,
            "latest": false,
            "deleted": false,
            "oldRecord": false
        },
        "bpLog": {
            "createdBy": 5,
            "updatedBy": 5,
            "avgSystolic": 88,
            "avgDiastolic": 88,
            "bmi": 21.79,
            "cvdRiskLevel": "Low risk",
            "cvdRiskScore": 3,
            "updatedFromEnrollment": false,
            "latest": false,
            "deleted": false,
            "oldRecord": false,
            "redRiskPatient": false
        },
        "phq4": {
            "createdBy": 5,
            "phq4RiskLevel": "Moderate",
            "phq4Score": 6
        },
        "symptoms": [
            {
                "id": 18,
                "symptomId": 2,
                "name": "Shortness of breath with usual activities",
                "type": "Hypertension",
                "otherSymptom": null
            },
            {
                "id": 19,
                "symptomId": 1,
                "name": "Unplanned weight loss",
                "type": "Diabetes",
                "otherSymptom": null
            }
        ],
        "medicalCompliance": [
            {
                "id": 15,
                "name": "Did not take any medication",
                "complianceId": 1,
                "otherCompliance": null
            },
            {
                "id": 16,
                "name": "Could not afford/pay for medication",
                "complianceId": 2,
                "otherCompliance": null
            }
        ],
        "riskLevel": null,
        "riskMessage": "Take your prescribed medication and come back in 3 days for a BP recheck. Your doctor may ask you to come for medical review",
        "confirmDiagnosis": [
            "Gestational Diabetes(GDM)",
            "Anxiety",
            "Pre-Hypertension"
        ]
    },
    "status": true,
    "entityList": null,
    "responseCode": 201,
    "totalCount": null
}
PreviousApp VersionNextAssessment Bplog Create

Last updated 3 months ago

👨‍💻