SPICE Product Docs
SPICE 1.0 Docs
SPICE 1.0 Docs
  • Overview
    • 📒What is SPICE?
    • ✨SPICE App Workflows
      • Screening
      • Enrollment
      • Assessment
      • My Patients
      • Medical Review
      • 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
  • 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. Engineering
  2. API Documentation
  3. SPICE Services

Patient Details

API URL

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

Method

POST

Description

Patient details

Input:

Field Name

Type

Mandatory

Example

Authorization(Header)

String

Yes

Bearer eyJlbmMiOiJBMTI4R0NNIiwiYWxnIjoiUlNBLU9BRVAtMjU2In0.MCm0mJDfpfjlr10Uok79-kTF7fv9Tn7cI5m2WsRDGUd9VS7iRmfbszjuc1-w5D-PYt9CdVxRMGBQlzYauhnI

Sample Input:

{ "id": 25, "assessmentRequired": true, "assessmentDataRequired": false, "isConfirmDiagnosis": false, "isDiabetesDiagnosis": false, "isGad7": false, "isHtnDiagnosis": false, "lifeStyleRequired": false, "isPhq9": false, "isPregnant": false, "prescriberRequired": false, "redRiskPatient": false }

Output:

Field Name

Type

Comments

id

Integer

Patient ID

nationalId

String

Patient national ID

firstName

String

First name

lastName

String

Last name

dateOfBirth

Timestamp with Timezone

Date of birth

age

Bigint

Patient age

gender

String

Patient gender

phoneNumber

String

Patient Number

phoneNumberCategory

String

Phone number category

height

Double Precision

Patient height

weight

Double Precision

Patient weight

bmi

Double Precision

Patient bmi

isRegularSmoker

Boolean

Regular Smoker status

programId

Bigint

Patient program id

avgSystolic

Integer

Average systolic blood pressure

avgDiastolic

Integer

Average diastolic blood pressure

avgPulse

Integer

Average pulse

glucoseUnit

String

Blood glucose unit

glucoseType

String

Blood glucose type

glucoseValue

Double Precision

Blood glucose value

cvdRiskLevel

String

Cvd risk level

cvdRiskScore

Integer

Cvd risk score

nextMedicalReviewDate

Timestamp without Timezone

Next medical review date

nextBpAssessmentDate

Timestamp without Timezone

Next blood pressure assessment date

nextBgAssessmentDate

Timestamp without Timezone

Next blood glucose assessment date

patientId

Bigint

Patient id

patientStatus

String

Patient status

isObservation

Boolean

Observation status

isScreening

Boolean

Screening status

screeningReferral

Boolean

Screening referral status

enrollmentAt

Timestamp without Timezone

Enrollment date

lastReviewDate

Timestamp without Timezone

Last review date

lastAssessmentDate

Timestamp without Timezone

Last assessment date

isConfirmDiagnosis

Boolean

Confirm diagnosis status

diagnosisComments

String

Diagnosis comments

confirmDiagnosis

String

Confirm diagnosis

phq4Score

Integer

PHQ4 mental health score

phq4RiskLevel

String

PHQ4 risk level

phq4FirstScore

Integer

PHQ4 first score

phq4SecondScore

Integer

PHQ4 second score

phq9Score

Integer

PHQ9 score

phq9RiskLevel

String

PHQ9 risk level

gad7Score

Integer

GAD7 score

gad7RiskLevel

String

GAD7 risk level

riskLevel

String

Risk level

lastMenstrualPeriodDate

Timestamp without Timezone

Last menstrual period date

isHtnDiagnosis

Boolean

HTN diagnosis status

systolic

Integer

Systolic blood pressure

diastolic

Integer

Diastolic blood pressure

pulse

Integer

Pulse

lastMealTime

Timestamp without Timezone

Last meal time

glucoseDateTime

Timestamp without Timezone

Glucose date time

updatedFromEnrollment

Boolean

Updated from enrollment

prescriberDetails

String

Prescriber details

isDiabetesDiagnosis

Boolean

Diabetes diagnosis status

patientLifestyles

String

Patient lifestyle

lastLabtestReferredDate

Timestamp

Lab test referred date

initialReview

Boolean

Initial review status

deleteReason

String

Deleted reason

deleteOtherReason

String

Deleted reason

labtestReferred

Boolean

Lab test referred

medicationPrescribed

Boolean

Medication referred

redRiskPatient

Boolean

Red risk patient status

Sample Output:

{
    "message": "Patient fetched successfully.",
    "entity": {
        "id": 25,
        "tenantId": 4,
        "createdBy": 5,
        "updatedBy": 5,
        "createdAt": "2023-05-26T16:33:22+05:30",
        "updatedAt": "2023-05-26T16:36:53+05:30",
        "nationalId": "AXXX123",
        "firstName": "AKSHATA",
        "lastName": "A",
        "dateOfBirth": "1997-05-26T00:00:00+05:30",
        "age": 26,
        "gender": "Female",
        "phoneNumber": "149XXX758",
        "phoneNumberCategory": "Personal",
        "height": 188,
        "weight": 77,
        "bmi": 21.79,
        "isRegularSmoker": true,
        "countryId": 1,
        "siteId": 1,
        "operatingUnitId": 1,
        "accountId": 1,
        "programId": 24,
        "avgSystolic": 88,
        "avgDiastolic": 88,
        "avgPulse": null,
        "glucoseUnit": "mmol/L",
        "glucoseType": "rbs",
        "glucoseValue": 25,
        "cvdRiskLevel": "Low risk",
        "cvdRiskScore": 3,
        "screeningLogId": 14,
        "nextMedicalReviewDate": "2023-06-26T16:35:47+05:30",
        "nextBpAssessmentDate": "2023-08-26T16:36:53+05:30",
        "nextBgAssessmentDate": null,
        "patientId": 25,
        "patientStatus": "ENROLLED",
        "isObservation": null,
        "isScreening": true,
        "screeningReferral": true,
        "enrollmentAt": "2023-05-26T16:35:47+05:30",
        "lastReviewDate": null,
        "lastAssessmentDate": "2023-05-26T16:36:53+05:30",
        "isConfirmDiagnosis": true,
        "diagnosisComments": null,
        "confirmDiagnosis": [
            "Gestational Diabetes(GDM)",
            "Pre-Hypertension"
        ],
        "provisionalDiagnosis": [
            "DM"
        ],
        "phq4Score": 6,
        "phq4RiskLevel": "Moderate",
        "phq4FirstScore": 3,
        "phq4SecondScore": 3,
        "phq9Score": null,
        "phq9RiskLevel": null,
        "gad7Score": null,
        "gad7RiskLevel": null,
        "riskLevel": null,
        "lastMenstrualPeriodDate": null,
        "isPregnant": true,
        "estimatedDeliveryDate": null,
        "isPhq9": true,
        "isGad7": true,
        "lastMedicationPrescribedDate": null,
        "isHtnDiagnosis": true,
        "bpLogDetails": [
            {
                "systolic": 88,
                "diastolic": 88,
                "pulse": 88
            },
            {
                "systolic": 88,
                "diastolic": 88,
                "pulse": 88
            },
            {
                "systolic": 88,
                "diastolic": 88,
                "pulse": 88
            }
        ],
        "glucoseLogDetails": {
            "createdBy": 5,
            "updatedBy": 5,
            "glucoseType": "rbs",
            "glucoseValue": 25,
            "lastMealTime": "2023-05-26T13:00:00+05:30",
            "glucoseDateTime": "2023-05-26T16:36:50+05:30",
            "glucoseUnit": "mmol/L",
            "updatedFromEnrollment": false,
            "latest": false,
            "deleted": false,
            "oldRecord": false
        },
        "prescriberDetails": null,
        "isDiabetesDiagnosis": true,
        "patientLifestyles": null,
        "lastLabtestReferredDate": null,
        "totalCount": 0,
        "deleteReason": null,
        "deleteOtherReason": null,
        "active": true,
        "initialReview": false,
        "medicationPrescribed": false,
        "deleted": false,
        "labtestReferred": false,
        "redRiskPatient": false
    },
    "status": true,
    "entityList": null,
    "responseCode": 200,
    "totalCount": null
}
PreviousPatient Basic DetailsNextPatient enrollment
👨‍💻