Skip to content

Admin Guide

The Admin Guide is intended for system administrators and technical staff responsible for configuring and maintaining RADIS (Radiology Report Archive and Discovery System).

Installation

Clone the repository: git clone https://github.com/openradx/radis.git
cd radis
uv sync
cp ./example.env ./.env  # copy example environment to .env
uv run cli stack-deploy  # builds and starts Docker containers

Updating RADIS

Follow these steps to safely update your RADIS installation:

  1. Verify no active jobs
  2. Enable maintenance mode: In Django Admin, navigate to Common → Project Settings and check the "Maintenance mode" checkbox, then save
  3. Navigate to Production folder
  4. Backup database: Run uv run cli db-backup to create a database backup
  5. Remove stack: Run uv run cli stack-rm to remove all Docker containers and services
  6. Pull latest changes: Run git pull origin main to fetch the latest code updates
  7. Update environment: Compare example.env with your .env file and add any new environment variables or update changed values
  8. Pull Docker images: Run uv run cli compose-pull to download the latest Docker images
  9. Deploy stack: Run uv run cli stack-deploy to rebuild and start all services with the updated code
  10. Disable maintenance mode: In Django Admin, navigate to Common → Project Settings and uncheck the "Maintenance mode" checkbox, then save

User and Group Management

Administrators can create users by navigating to the Django Admin section. Alternatively, users can self-register, after which an administrator must approve and activate their account.

RADIS uses a group-based permission system:

  • Groups define access to specific reports based on organizational structure
  • Users are assigned to one or more groups to inherit their permissions
  • Active Group determines which reports a user can currently access

Creating and Managing Groups

Access Django Admin

  • Log in as a staff user
  • Go to Admin Section → Django Admin (available at /django-admin/ URL path)

Create/Edit Groups

  • Navigate to Authentication and Authorization → Groups
  • Click "Add Group" or edit an existing group
  • Give the group a Name (e.g., "Radiology Department", "Research Team", "Oncology")

Assign Permissions

  • In the group form, you'll see Available permissions and Chosen permissions
  • Select the permissions you want from the available list
  • Move them to Chosen permissions

Add Users to Group

  • In the Users section, select users from Available users
  • Move them to Chosen users
  • Click Save to apply all changes

Active Group

Each user has an active group that determines which reports they can currently access:

  • Only reports associated with the active group are visible in searches and collections
  • This ensures proper data isolation between different departments or projects

Report Management

Report Import and Management

Administrators can import reports programmatically via the RADIS API or using the RADIS Client library. See the RADIS Client section below for details.

Extraction Jobs

Administrators can monitor and manage extraction jobs where AI analyzes reports to extract structured data.

Managing Extractions

  1. Access Django Admin: Navigate to Extractions → Extraction Jobs
  2. Monitor Status: View jobs by status (Preparing, Pending, In Progress, Success, Failure, Canceled)
  3. View Details: Click on a job to see:
  4. Owner and group
  5. Query and filters
  6. Output field
  7. Results data

Granting Urgent Priority Permission

Users with urgent priority permission can skip the queue:

  1. Navigate to Authentication and Authorization → Groups
  2. Edit the desired group
  3. Add permission: extractions | extraction job | Can process urgently
  4. Save

Subscription Management

Administrators can view and manage all user subscriptions through the Django Admin interface.

Managing Subscriptions

  1. Access Django Admin: Navigate to Subscriptions → Subscriptions
  2. View All Subscriptions: Click on a subscription entry to view its full details.
  3. Delete a Subscription: Subscriptions can be removed if necessary using the Delete action

Urgent Priority Permission

  1. Navigate to Authentication and Authorization → Groups
  2. Edit the desired group
  3. Add permission: subscriptions | subscription | Can process urgently
  4. Save

System Announcements

System administrators can inform users about important updates, maintenance schedules, or system changes through the announcement feature.

Creating Announcements

  1. Access Admin Interface: Navigate to the Django admin interface (typically accessible at /django-admin/)
  2. Find Project Settings: Go to the "Common" section and select "Project settings"
  3. Edit Announcement: In the Project Settings form, locate the "Announcement" field
  4. Enter Message: Type your announcement message. HTML formatting is supported for rich text display
  5. Save Changes: Click "Save" to publish the announcement

Announcement Display

  • Announcements appear prominently on the main/home page
  • All logged-in users will see the announcement when they access RADIS

Example Announcements

Maintenance Notice:

<strong>Scheduled Maintenance:</strong> RADIS will be offline for maintenance on
<strong>March 15, 2024 from 2:00 AM to 4:00 AM UTC</strong>. Please plan your
extractions and subscriptions accordingly.

New Feature Announcement:

<strong>New Feature Available:</strong> You can now create custom extraction
jobs with multiple output fields. Check out the user guide for more details.

RADIS Client

RADIS Client is a Python library for programmatic access to RADIS features without using the web interface.

Creating API Tokens

To create an API token for programmatic access:

  1. Navigate to Token Authentication by going to "Profile" --> "Manage API Token"
  2. Description & Expiry Time : Add a description (optional) and expiry time for the token.
  3. Click on "Generate Token".
  4. This token will only be visible once, so make sure to copy it now and store it in a safe place. As you will not be able to see it again, you will have to generate a new token if you lose it.

Revoking Tokens

  • Admins can revoke tokens by navigating to Django Admin --> Token Authentication