Skip to main content

Apteryx User Roles and Privileges

Josh Grabia
Updated

Roles

  • Admin Account
    The admin account is the first user created for an Apteryx site. It is configured with all privileges. Any privilege can be removed from this role, save the Admin privilege. This user cannot be removed. This user cannot be view restricted to any modality, patient, or study.
  • Standard User
    The Standard user is a permanent account that may have any combination of privileges.
  • Temporary User
    Not available on AD FS sites. Temporary users can be created when sharing patients or studies. These user accounts are created with an expiration date. During this creation step, enabling the ability to download images gives the temporary user the Export privilege. By default, temporary users get Query privileges.

Privileges

Admin

  • Create and modify enhancements
  • Create and modify layouts
  • Place images in layouts
  • Modify site settings
    • Default to always show hidden images (view ghosted)
    • Default to always show enhanced images
    • Set Brightness, Contrast and Gamma deltas
    • Set Zoom increment
  • Manage users
    • Create New Users (for AD FS, must use external tools)
    • Remove Users (for AD FS, must use external tools)
    • Initiate password reset (for AD FS, must use external tools)
    • Modify user privileges (for AD FS, must use external tools)
    • Modify user restrictions (NOT available for AD FS)
      • Patient
      • Study
      • Modality
  • (AD FS Claim type: ApteryxAdmins)

Query

  • User should be able to search Apteryx for patients
  • User should be able to search using the software APIs
  • (AD FS Claim type: ApteryxQuery)

Share (NOT available for AD FS)

  • Share patients and studies with other users
  • (with Admin only) can create and share to a temporary user
  • (AD FS Claim type: ApteryxShare, –reserved for future development)

Export

NOTE: In addition to the below Claim type being added, The Export > Email function in Apteryx requires AD users to have an associated email address specified in the Email field within their AD profile in order to function. 

  • Download instances in series currently in the viewer (including retakes) as JPEG, PNG, DICOM in ISO or zip container
  • Download instances in one or more selected series as JPEG, PNG or DICOM in ISO or zip container
  • Download one or more selected instances as JPEG, PNG or DICOM in ISO or zip container
  • Save current view as JPEG or PNG
  • Save selected instances as JPEG or PNG
  • Email download link of instances in series currently in view (including retakes) as JPEG, PNG or DICOM in a password-protected ISO or ZIP container
  • Email download link of instances in selected series (including retakes) as JPEG, PNG or DICOM in a password-protected ISO or ZIP container
  • Email download link of selected instances as JPEG, PNG or DICOM in a password-protected ISO or ZIP container
  • (AD FS Claim type: ApteryxExport)

Print

  • Print the current series in the viewer
  • Print one or more selected instances
  • (AD FS Claim type: ApteryxPrint)

Capture/Import

  • Apteryx will display the Capture button and External Applications
  • Import images into a new patient
  • Import images into an existing patient
  • (AD FS Claim type: Apteryx Online Capture)

Edit

  • A User should be able to make changes through Patient- Study- Series- and Instance Advanced Edit.
  • A User should be able to make changes to the DICOM database using APIs.
  • (AD FS Claim type: ApteryxEdit)

Displaying User Privileges

The privileges are always visible in the Help & About menu for the currently logged in user. Click the user’s name on the header menu then click Help & About. All of the assigned privileges are displayed on this panel.

 

Article Version 1.2 2025.03.18

Related articles