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

Patient Remove

API URL

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

Method

POST

Description

Patient Remove

Input:

Field Name

Type

Mandatory

Example

Authorization(Header)

String

Yes

Bearer eyJlbmMiOiJBMTI4R0NNIiwiYWxnIjoiUlNBLU9BRVAtMjU2In0.MCm0mJDfpfjlr10Uok79-kTF7fv9Tn7cI5m2WsRDGUd9VS7iRmfbszjuc1-w5D-PYt9CdVxRMGBQlzYauhnI

Input:

Field Name

Type

Mandatory

Example

deleteReason

String

Yes

Patient Deceased

Sample Input:

{ "deleteReason": "Patient Deceased", "id": 25, "patientTrackId": 25, "tenantId": 4 }

Output:

Field Name

Type

Comments

id

Integer

Patient Table ID

nationalId

String

National ID

firstName

String

Patient FirstName

middleName

String

Patient MiddleName

lastName

String

Patient LastName

gender

String

Patient Gender

dateOfBirth

Date

Patient date of birth

age

BigInt

Patient Age

isPregnant

Boolean

Is patient pregnant or not

phoneNumber

String

Patient phone number

phoneNumberCategory

String

Patient phone number category

countryId

BigInt

Country ID

countyId

BigInt

County ID

subCountyId

BigInt

SubCounty ID

siteId

BigInt

Patient Site ID

landmark

String

Patient Landmark

occupation

String

Occupation

levelOfEducation

String

Level of Education

insuranceStatus

Boolean

Insurance Status

insuranceType

String

Type of Insurance

insuranceId

String

Insurance ID

otherInsurance

String

Other Insurance

isRegularSmoker

Boolean

Is patient regular smoker

programId

BigInt

Program ID

initial

String

Patient initial

emrNumber

BigInt

Patient EMR number

patientStatus

String

Patient Status

virtualId

BigInt

Patient Virtual Id created after enrollment

Sample Output:

{
    "message": "Patient deleted successfully.",
    "entity": {
        "id": 25,
        "nationalId": "AKSH123",
        "firstName": "AKSHATA",
        "middleName": "S",
        "lastName": "A",
        "gender": "Female",
        "dateOfBirth": "1997-05-26T00:00:00+05:30",
        "age": 26,
        "isPregnant": true,
        "phoneNumber": "149832758",
        "phoneNumberCategory": "Personal",
        "countryId": 1,
        "countyId": 2,
        "subCountyId": 3,
        "siteId": 1,
        "landmark": "US",
        "occupation": "Unemployed",
        "levelOfEducation": "College/University Completed",
        "insuranceStatus": true,
        "insuranceType": "Other",
        "insuranceId": "231",
        "otherInsurance": "LIC",
        "isRegularSmoker": true,
        "programId": 2,
        "initial": "A",
        "emrNumber": 0,
        "patientStatus": "true",
        "virtualId": 24
    },
    "status": true,
    "entityList": null,
    "responseCode": 200,
    "totalCount": null
}
PreviousPatient Pregnancy Details CreateNextPatient Transfer - Create
👨‍💻