KMS RIS Agent User Guide

KMS RIS Agent User Guide

Idea
What is the KMS RIS Agent?

The KMS RIS Agent is an automated system that assists hospitals in managing radiology orders and medical images. It works as a digital assistant that:

  • Automatically fetches new radiology orders from your Hospital Information System (IHS)
  • Processes medical images placed in a special folder
  • Uploads images back to the hospital system for doctors to review
  • Handles failures by renaming files with clear error descriptions and retrying automatically

Info
How It Works

1. Order Management

Every minute, the system checks the hospital IHS for new radiology orders, then sends them to the system automatically.

2. Image Processing

When images (JPG, PNG, JPEG) are added to the Watch folder:

  • The system detects them immediately
  • Compresses the image
  • Reads patient info from the filename (accession number)
  • Uploads the image automatically into the hospital system

3. Smart Error Handling

  • Failed files are renamed with a descriptive error message
  • System retries automatically
  • Error details are written in the filename for easy troubleshooting
C:\Medical_Images
├── Watch ← Place new images here
├── Processed ← Successfully processed
│   ├── failed_uploads ← Cannot upload
│   └── failed_originals ← Cannot process
FolderPurpose
WatchPlace new medical images here
ProcessedImages successfully handled
failed_uploadsFiles that couldn’t upload
failed_originalsFiles that couldn’t process

Alert
Image Naming Requirements

Use only the accession number for the filename:

  • 019966250821014.jpg
  • ACC123456789.png
  • RAD2024001234.jpeg

The accession number must match what exists in the hospital system.


Notes
Common Error Examples

Upload Errors

  • FAILED_0199_AUTH_FAILED_CHECK_CREDENTIALS_123.jpg → Check login credentials with IT Technician
  • FAILED_ACC123_ACCESSION_NOT_FOUND_IN_SYSTEM_123.jpg → Verify accession number
  • FAILED_RAD2024_NETWORK_ISSUE_CHECK_CONNECTION_123.jpg → Check internet or check with the IT Technician

Processing Errors

  • FAILED_img_INVALID_IMAGE_FORMAT_USE_JPG_PNG.jpg → Please convert to the supported image format
  • FAILED_scan_CORRUPTED_IMAGE_FILE.jpg → Rescan/Redownload the image and retry
  • FAILED_big_IMAGE_TOO_LARGE_REDUCE_SIZE.jpg → Compress image and retry
  • FAILED_wrong_FILENAME_FORMAT_INCORRECT.jpg → Rename using accession number only

Info
Monitoring the System

Health Check

Open a browser and go to:

http://localhost:9090/ris-agent/api/ris/health
  • OK” → System working fine
  • Error page → Needs attention

Log Files

Check the /logs folder in the installation directory for details.


Idea
Daily Operations

Morning

  • Check health status
  • Review failed folders
  • Fix any issues from filenames

When Adding Images

  • Use correct accession number as filename
  • Place file in Watch folder
  • Wait 30–60 seconds
  • If failed, check error message in filename

Handling Failed Files

  1. Read the error in the filename
  2. Fix the issue (rename file, check network, etc.)
  3. Move corrected file to Watch
  4. Delete failed file after resolved

Common Issues & Solutions

ErrorMeaningSolution
AUTH_FAILEDInvalid credentialsCheck with IT
ACCESSION_NOT_FOUNDOrder not detectedVerify accession number
NETWORK_ISSUEConnection problemCheck network or retry
INVALID_IMAGE_FORMATUnsupported fileSave as JPG/PNG
IMAGE_TOO_LARGEFile too bigCompress image

Troubleshooting Quick Reference

IssueCheckSolution
Images not movingFilename formatUse accession number only
Health check failsRestartRun start-kms-ris-agent.bat
Upload failuresNetworkWait or contact IT
System won’t startJava installationInstall Java 21
Port conflictCheck other appsChange port or stop app

Info
System Performance

  • Order Fetching: every 1 min
  • Image Processing: within 30 sec
  • Failed Image Retry: every 5 min
  • Failed Upload Retry: every 10 min

Info
Success Indicators

  • Health check returns “OK” consistently
  • Images process within 1 minute
  • Failed folders remain mostly empty
  • Orders reach DICOM system smoothly
  • Images are accessible to hospital staff
  • Minimal manual intervention required

Remember: The system is designed to work automatically. If you find yourself fixing issues frequently, report it to IT to optimize the setup.

    • Related Articles

    • Radiology Diagnostic Flow Integration Guide with RIS Agent and SATUSEHAT

      Summary This article explains the complete workflow of Diagnostic Radiology Integration (X-Ray, CT, MRI, USG) in the Ksatria eHospital, including interaction between eHospital → IHS Service → RIS Agent → DICOM Router → Modality → SATUSEHAT. Overview ...
    • How to Setup and Configure LIS Agent

      Overview Integration with medical laboratory equipment into an Electronic Medical Record (EMR) system is crucial for seamless data exchange, reducing manual input errors, and improving workflow efficiency in healthcare facilities. To address this ...
    • DICOM Forwarding Setup Guide

      Overview This guide explains how to configure a DICOM workflow where K PACS sends images to Orthanc, and Orthanc automatically forwards those images to a DICOM Router. This setup is typically used in clinics or hospitals to centralize image routing ...
    • Petunjuk Penggunaan Antrean KMS / KMS Queue [ID]

      Antrean KMS merupakan aplikasi terpisah dari Ksatria eHospital yang khusus digunakan untuk pengelolaan antrean pasien. Aplikasi ini dapat diakses melalui: URL: https://microservice.ksatria.app/ Username: [Disediakan oleh Tim Ksatria] ...
    • Ringkasan Fitur IHS KMS Satu Sehat Dashboard

      Fitur Satu Sehat Dashboard pada Ksatria Medical System (KMS) adalah fitur yang digunakan untuk memantau aktivitas pengiriman data pasien klinik atau RS ke platform Satu Sehat milik pemerintah. Satu Sehat Dashboard ini dapat memberikan gambaran ...