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

Screening log details

API URL

{{url}}/spice-service/screeninglog/details

Method

POST

Description

Screening log details

Input:

Field Name

Type

Mandatory

Example

Authorization(Header)

String

Yes

Bearer eyJlbmMiOiJBMTI4R0NNIiwiYWxnIjoiUlNBLU9BRVAtMjU2In0.MCm0mJDfpfjlr10Uok79-kTF7fv9Tn7cI5m2WsRDGUd9VS7iRmfbszjuc1-w5D-PYt9CdVxRMGBQlzYauhnI

Sample Input:

{ "isAssessmentDataRequired": true, "patientTrackId": 12, "screeningId": 15 }

Output:

Field Name

Type

Comments

FirstName

String

tenant Id

LastName

String

Patient first name

tenantId

Bigint

Patient tenant id

PhoneNumber

String

Patient middle name

NationalId

String

Patient last name

PhoneNumberCategory

String

Patient national ID

Gender

String

Patient phone number

DateOfBirth

Time stamp

phone number category

Age

BigInt

Patient age

Height

Double precision

Patient height

Weight

Double precision

Patient weight

isRegularSmoker

Boolean

Is regular smoker

isBeforeHtnDiagnosis

Boolean

Is before Htn diagnosis

Systolic

Integer

Systolic

Diastolic

Integer

Diastolic

Pulse

Integer

Pulse

isBeforeDiabetesDiagnosis

Boolean

Is before diabetes diagnosis

glucoseUnit

String

Glucose unit

glucose

Integer

Glucose value

lastMealTime

Timestamp

last meal time

Mental Health Questions(PHQ4)

Integer

Mental health questions

cvdRiskLevel

String

CVD risk level

cvdRiskScore

Integer

CVD risk score

isReferAssessment

Boolean

Is referred for assessment

isLatest

Boolean

Is latest

siteId

Bigint

Site id

operatingUnitId

Bigint

Operating unit id

accountId

Bigint

Account id

deviceInfoId

Bigint

Device information id

bpLogId

Bigint

Bp log id

updatedFromEnrollment

Boolean

Updated from enrollment

type

String

Patient screening type

Sample Output:

{
    "entity": {
        "tenantId": 8,
        "latitude": "0.0",
        "longitude": "0.0",
        "firstName": "PARTHA",
        "middleName": null,
        "lastName": "E",
        "nationalId": "PARTE65432",
        "phoneNumber": "198765432",
        "phoneNumberCategory": "Personal",
        "landmark": null,
        "gender": "Male",
        "dateOfBirth": "2000-05-26T00:00:00+05:30",
        "age": 23,
        "height": 182,
        "weight": 77,
        "bmi": 23.25,
        "isRegularSmoker": false,
        "countryId": 1,
        "countyId": 1,
        "subCountyId": 2,
        "category": "Facility",
        "avgSystolic": 88,
        "avgDiastolic": 88,
        "avgPulse": null,
        "glucoseType": null,
        "glucoseValue": null,
        "glucoseUnit": null,
        "lastMealTime": null,
        "glucoseDateTime": null,
        "isBeforeDiabeticDiagnosis": null,
        "phq4score": 8,
        "phq4RiskLevel": "Moderate",
        "cvdRiskLevel": "Low risk",
        "cvdRiskScore": 2,
        "isReferAssessment": true,
        "isLatest": true,
        "isBeforeHtnDiagnosis": false,
        "siteId": 3,
        "operatingUnitId": 1,
        "accountId": 1,
        "bpArm": null,
        "bpPosition": null,
        "physicallyActive": null,
        "type": "Outpatient",
        "deviceInfoId": 14,
        "phq4MentalHealth": [
            {
                "questionId": 6,
                "answerId": 67,
                "displayOrder": 4,
                "score": 3
            },
            {
                "questionId": 13,
                "answerId": 23,
                "displayOrder": 1,
                "score": 1
            },
            {
                "questionId": 9,
                "answerId": -1,
                "displayOrder": 3,
                "score": 2
            },
            {
                "questionId": 17,
                "answerId": 63,
                "displayOrder": 2,
                "score": 2
            }
        ],
        "idType": null,
        "insuranceStatus": null,
        "covidVaccStatus": null,
        "cvdRiskScoreDisplay": null,
        "preferredName": null,
        "bpLogDetails": [
            {
                "systolic": 88,
                "diastolic": 88,
                "pulse": 88
            },
            {
                "systolic": 88,
                "diastolic": 88,
                "pulse": 88
            }
        ],
        "glucoseLog": null,
        "bpLogId": 47,
        "diagnosis": null,
        "beforeGestationalDiabetes": false,
        "updatedFromEnrollment": false,
        "familyDiabetesHistory": false
    },
    "status": true,
    "entityList": null,
    "responseCode": 200,
    "totalCount": null
}
PreviousScreeningNextSearch

Last updated 3 months ago

👨‍💻