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 Transfer - Country Site List

API URL

{{url}}/admin-service/site/country/site-list

Method

POST

Description

Patient transfer country site list

Input:

Field Name

Type

Mandatory

Example

Authorization(Header)

String

Yes

Bearer eyJlbmMiOiJBMTI4R0NNIiwiYWxnIjoiUlNBLU9BRVAtMjU2In0.MCm0mJDfpfjlr10Uok79-kTF7fv9Tn7cI5m2WsRDGUd9VS7iRmfbszjuc1-w5D-PYt9CdVxRMGBQlzYauhnI

Input:

Field Name

Type

Mandatory

Example

Facility

String

Yes

ze

Sample Input:

{ "countryId": 1, "searchTerm": "ze", "tenantId": 4 }

Output:

Field Name

Type

Comments

name

String

Site name

email

String

Site mail ID

addressType

String

Address type

addressUse

String

Address use

address1

String

Address 1

address2

String

Address 2

latitude

String

Latitude

longitude

String

Longitude

city

String

City

phoneNumber

String

Phone number

siteLevel

String

Site level

siteType

String

Site type

countryId

Bigint

Country Id

countyId

Bigint

County Id

subCountyId

Bigint

Sub county Id

accountId

Bigint

Account Id

operatingUnit

Object

Operating unit details

account

Object

Account details

country

Object

Country details

clinicalWorkflows

Object

Clinical workflows details

culture

Object

Culture details

Sample Output:

{
  "message": "Site fetched successfully.",
  "entity": null,
  "status": true,
  "entityList": [
    {
      "createdBy": 1,
      "id": 2,
      "updatedBy": 1,
      "createdAt": "2023-05-23T13:04:17+00:00",
      "updatedAt": "2023-05-23T13:04:17+00:00",
      "tenantId": 5,
      "name": "Zen care",
      "email": null,
      "addressType": "Physical",
      "addressUse": "Home",
      "address1": "jhytf",
      "address2": null,
      "latitude": "13.08377",
      "longitude": "80.28257",
      "city": "India, Chennai, Chennai",
      "phoneNumber": "9876654436",
      "workingHours": 0,
      "postalCode": "9886675532",
      "siteLevel": "Level 2",
      "siteType": "Clinic",
      "countryId": 1,
      "countyId": 1,
      "subCountyId": 2,
      "accountId": 1,
      "operatingUnit": {
        "createdBy": 1,
        "id": 1,
        "updatedBy": 1,
        "createdAt": "2023-05-23T12:25:02+00:00",
        "updatedAt": "2023-05-23T12:25:02+00:00",
        "name": "Medical care",
        "account": {
          "createdBy": 1,
          "id": 1,
          "updatedBy": 1,
          "createdAt": "2023-05-23T12:24:13+00:00",
          "updatedAt": "2023-05-23T12:24:13+00:00",
          "tenantId": 2,
          "name": "Medical care",
          "maxNoOfUsers": 1,
          "country": {
            "createdBy": 1,
            "id": 1,
            "updatedBy": 23,
            "createdAt": "2023-05-23T12:15:19+00:00",
            "updatedAt": "2023-05-26T09:44:25+00:00",
            "tenantId": 1,
            "name": "Kenya",
            "countryCode": "254",
            "unitMeasurement": "metric",
            "active": true,
            "deleted": false
          },
          "clinicalWorkflows": [
            {
              "createdBy": 1,
              "id": 1,
              "updatedBy": 1,
              "createdAt": "2023-05-23T12:15:19+00:00",
              "updatedAt": "2023-05-23T12:15:19+00:00",
              "tenantId": null,
              "name": "mental health",
              "viewScreens": null,
              "workflow": "phq4",
              "moduleType": "clinical",
              "countryId": null,
              "default": false,
              "active": true,
              "deleted": false
            },
            {
              "createdBy": 1,
              "id": 2,
              "updatedBy": 1,
              "createdAt": "2023-05-23T12:15:19+00:00",
              "updatedAt": "2023-05-23T12:15:19+00:00",
              "tenantId": null,
              "name": "pregnancy",
              "viewScreens": null,
              "workflow": "pregnancy",
              "moduleType": "clinical",
              "countryId": null,
              "default": false,
              "active": true,
              "deleted": false
            },
            {
              "createdBy": 1,
              "id": 3,
              "updatedBy": 1,
              "createdAt": "2023-05-23T12:15:19+00:00",
              "updatedAt": "2023-05-23T12:15:19+00:00",
              "tenantId": null,
              "name": "hypertension",
              "viewScreens": null,
              "workflow": "bp_log",
              "moduleType": "clinical",
              "countryId": null,
              "default": true,
              "active": true,
              "deleted": false
            },
            {
              "createdBy": 1,
              "id": 4,
              "updatedBy": 1,
              "createdAt": "2023-05-23T12:15:19+00:00",
              "updatedAt": "2023-05-23T12:15:19+00:00",
              "tenantId": null,
              "name": "diabetics",
              "viewScreens": null,
              "workflow": "glucose_log",
              "moduleType": "clinical",
              "countryId": null,
              "default": true,
              "active": true,
              "deleted": false
            }
          ],
          "customizedWorkflows": [],
          "reason": null,
          "status": null,
          "usersRestricted": false,
          "active": true,
          "deleted": false
        },
        "countryId": 1,
        "tenantId": 3,
        "active": true,
        "deleted": false
      },
      "culture": {
        "createdBy": 1,
        "id": 1,
        "updatedBy": 1,
        "createdAt": "2023-05-23T12:15:19+00:00",
        "updatedAt": "2023-05-23T12:15:19+00:00",
        "name": "English - India",
        "code": "en_IN",
        "active": true,
        "deleted": false,
        "hibernateLazyInitializer": {}
      },
      "active": true,
      "deleted": false
    },
    {
      "createdBy": 1,
      "id": 3,
      "updatedBy": 1,
      "createdAt": "2023-05-23T13:19:08+00:00",
      "updatedAt": "2023-05-23T13:19:41+00:00",
      "tenantId": 8,
      "name": "Zen                 care",
      "email": null,
      "addressType": "Physical",
      "addressUse": "Home",
      "address1": "jhyyd",
      "address2": null,
      "latitude": "13.08377",
      "longitude": "80.28257",
      "city": "India, Chennai, Chennai",
      "phoneNumber": "9887676643",
      "workingHours": 0,
      "postalCode": "0865531234",
      "siteLevel": "Level 2",
      "siteType": "Clinic",
      "countryId": 1,
      "countyId": 1,
      "subCountyId": 2,
      "accountId": 1,
      "operatingUnit": {
        "createdBy": 1,
        "id": 1,
        "updatedBy": 1,
        "createdAt": "2023-05-23T12:25:02+00:00",
        "updatedAt": "2023-05-23T12:25:02+00:00",
        "name": "Medical care",
        "account": {
          "createdBy": 1,
          "id": 1,
          "updatedBy": 1,
          "createdAt": "2023-05-23T12:24:13+00:00",
          "updatedAt": "2023-05-23T12:24:13+00:00",
          "tenantId": 2,
          "name": "Medical care",
          "maxNoOfUsers": 1,
          "country": {
            "createdBy": 1,
            "id": 1,
            "updatedBy": 23,
            "createdAt": "2023-05-23T12:15:19+00:00",
            "updatedAt": "2023-05-26T09:44:25+00:00",
            "tenantId": 1,
            "name": "Kenya",
            "countryCode": "254",
            "unitMeasurement": "metric",
            "active": true,
            "deleted": false
          },
          "clinicalWorkflows": [
            {
              "createdBy": 1,
              "id": 1,
              "updatedBy": 1,
              "createdAt": "2023-05-23T12:15:19+00:00",
              "updatedAt": "2023-05-23T12:15:19+00:00",
              "tenantId": null,
              "name": "mental health",
              "viewScreens": null,
              "workflow": "phq4",
              "moduleType": "clinical",
              "countryId": null,
              "default": false,
              "active": true,
              "deleted": false
            },
            {
              "createdBy": 1,
              "id": 2,
              "updatedBy": 1,
              "createdAt": "2023-05-23T12:15:19+00:00",
              "updatedAt": "2023-05-23T12:15:19+00:00",
              "tenantId": null,
              "name": "pregnancy",
              "viewScreens": null,
              "workflow": "pregnancy",
              "moduleType": "clinical",
              "countryId": null,
              "default": false,
              "active": true,
              "deleted": false
            },
            {
              "createdBy": 1,
              "id": 3,
              "updatedBy": 1,
              "createdAt": "2023-05-23T12:15:19+00:00",
              "updatedAt": "2023-05-23T12:15:19+00:00",
              "tenantId": null,
              "name": "hypertension",
              "viewScreens": null,
              "workflow": "bp_log",
              "moduleType": "clinical",
              "countryId": null,
              "default": true,
              "active": true,
              "deleted": false
            },
            {
              "createdBy": 1,
              "id": 4,
              "updatedBy": 1,
              "createdAt": "2023-05-23T12:15:19+00:00",
              "updatedAt": "2023-05-23T12:15:19+00:00",
              "tenantId": null,
              "name": "diabetics",
              "viewScreens": null,
              "workflow": "glucose_log",
              "moduleType": "clinical",
              "countryId": null,
              "default": true,
              "active": true,
              "deleted": false
            }
          ],
          "customizedWorkflows": [],
          "reason": null,
          "status": null,
          "usersRestricted": false,
          "active": true,
          "deleted": false
        },
        "countryId": 1,
        "tenantId": 3,
        "active": true,
        "deleted": false
      },
      "culture": {
        "createdBy": 1,
        "id": 1,
        "updatedBy": 1,
        "createdAt": "2023-05-23T12:15:19+00:00",
        "updatedAt": "2023-05-23T12:15:19+00:00",
        "name": "English - India",
        "code": "en_IN",
        "active": true,
        "deleted": false,
        "hibernateLazyInitializer": {}
      },
      "active": true,
      "deleted": false
    }
  ],
  "responseCode": 200,
  "totalCount": 2
}
PreviousPatient Transfer CountNextPatient Transfer - Role user list
👨‍💻