Creating Purge Rules (Study & HL7)

Purge rules are the tool by which studies and HL7 can be automatically deleted based on chosen conditions.

Rules can be added, edited, and removed either through the User Interface or the web API. This guide provides the steps for both approaches. 

Though the UI is quicker to use for creating basic rules, the API offers further configuration options for more granular control.  HL7 cannot be targeted by UI-made rules.

Remember, purge rules will  permanently delete information from the CIMAR cloud. Before creating/running a rule make sure you are aware of what will be effected. If you are unsure please contact your CIMAR representative or email support@cimar.co.uk.

This guide is split into the following sections:

1. Purge Rules via the User Interface
2. Purge Rules via the API purge/add (creating a new rule)
3. Purge Rules via the API purge/set (editing an existing rule)

Required Permissions

To be able to work with Purge Rules, the following permissions must be enabled in a role applied to the user for  all the namespaces targeted by the rule. If you are unable to access role permissions please contact your local administrator.

Purge rules run nightly automatically. However, if you want to force execution users will also require:

To enable the above permissions, navigate via the UI:

Administration > Roles > Edit > select relevant role > Tick permissions & Save

1. Purge Rules via the User Interface

Through the UI, only studies can be targeted. See API section to target HL7.

What you  can do:

• Delete studies or delete imaging from studies
• Specify date, namespace, and modality conditions

To navigate to the Purge Rules interface:

• Sign-in to CIMAR
• Click ‘Administration’
• Select ‘Purge Rules’ from the ‘more’ dropdown menu.

Click ‘New Purge Rule’.

• Name the rule
• Decide how many days can elapse before a study is purged.
• Rules can be set to run after last update, CIMAR creation date, or exam date.

Creating a new rule…

Click Save and your rule will run nightly or can be run manually using the "Run" button. A dry run will test the process without actually deleting any information.

Additional configuration is available through the API purge/add. Link below will provide guidance to configure Purge Rules via the API.

https://cloud.cimar.co.uk/api/v3/api.html#purge_add

Please contact CIMAR Support if additional guidance is required.