Payload Configs (Payload Settings)
Understanding Payload Configurations
RADPAIR's Payload Settings feature allows organizations to define custom field validation rules for different study types and modalities. This powerful feature ensures that when reports are signed, they contain all required metadata fields with acceptable values, enabling seamless integration with external systems and webhooks.
Payload configurations are particularly useful for:
Ensuring consistent data structure across different study types
Validating required fields before report signing
Standardizing field values for external system integration
Customizing validation rules by study or modality
Payload Settings provide powerful customization for ensuring data quality and consistency across your radiology workflow. Start with simple configurations and gradually add complexity as your team becomes familiar with the feature.
Accessing Payload Settings
To access Payload Settings:
Navigate to Organization Settings
Click on the Payload Configs tab in the left sidebar
Creating a Payload Configuration
Basic Configuration Setup
To create a new payload configuration:
Click the Add Configuration button
Enter a descriptive Payload Config Name (e.g., "Mammography", "Chest CT")
Choose either Study or Modality as your targeting method:
Study: Select specific studies from your organization or system-wide studies
Modality: Select imaging modalities (CT, MRI, US, etc.)
Defining Field Rules
For each configuration, you can define multiple fields with validation rules:
Field Properties:
Field Name: The metadata field to validate (e.g., "laterality", "contrast", "views")
Allowed Values: Specific acceptable values for the field
Leave empty to let the system auto-determine appropriate values (this is for scenarios where the value is a measurement e.g. 3mm or 1.3mm x 1.5mm)
Add multiple values by typing and pressing Enter
Required: Toggle to make the field mandatory for report signing
Overridable: Allow users to override validation failures (only available for required fields)
Example Configuration:
Configuration Name: Mammography
Study: Mammography
Fields:
- laterality (Required, Overridable) - Values: [bilateral, left, right]
- views (Required) - Values: [CC, MLO, spot compression]
- contrast (Optional) - Values: [with contrast, without contrast]Managing Payload Configurations
Editing Configurations
To modify an existing configuration:
Click the three-dot menu next to the configuration
Select Edit from the dropdown
Make your changes in the dialog
Click Save to apply changes
Disabling/Enabling Configurations
You can temporarily disable configurations without deleting them:
Click the three-dot menu next to the configuration
Select Disable or Enable from the dropdown
Disabled configurations will show as "(Disabled)" and won't be applied during validation
Deleting Configurations
To permanently remove a configuration:
Click the three-dot menu next to the configuration
Select Delete from the dropdown
Confirm the deletion in the dialog
Remember to save: No changes are applied until save button is clicked
How Payload Validation Works
Validation Process
When a report is signed, RADPAIR:
Identifies the applicable payload configuration based on the report's study or modality
Extracts metadata fields from the report
Validates each required field is present and contains acceptable values
Allows signing if validation passes, or blocks signing with override options if validation fails
Validation Failure Handling
If validation fails, users see a detailed notification showing:
Required fields: Missing mandatory fields that must be added
Optional overridable fields: Fields that can be bypassed with override permission
Override option: Button to proceed despite validation failures (for overridable fields only)
Field Value Auto-Determination
When no specific allowed values are defined for a field, RADPAIR's AI system attempts to:
Extract appropriate values from the study description
Use context from the report content
Apply intelligent defaults based on the study type
If a field cannot be filled because of missing data, it will be set to "null". Same is true if you choose to override a field
Integration with Webhooks
Payload configurations work seamlessly with RADPAIR's webhook system:
Validated data is included in webhook payloads when reports are signed
Consistent structure ensures external systems receive predictable data formats
Required fields guarantee critical information is always present in webhook notifications
Best Practices
Configuration Design
Use descriptive names that clearly identify the study type or modality
Start with required fields that are absolutely necessary for your workflow
Be specific with allowed values to ensure data consistency
Test configurations with sample reports before deploying to production
Field Management
Leverage auto-determination for fields with variable but predictable values
Use overridable flags for fields that may occasionally need exceptions
Keep field lists manageable - too many required fields can hinder workflow
Regular review configurations to ensure they remain relevant and accurate
Organizational Workflow
Coordinate with IT teams to align field requirements with downstream systems
Train radiologists on new validation requirements and override procedures
Monitor validation failures to identify common issues and refine configurations
Document field meanings and acceptable values for consistency across users
Troubleshooting
Common Issues
Configuration not applying:
Verify the study/modality selection matches your reports
Check that the configuration is enabled (not disabled)
Validation always failing:
Review allowed values for typos or case sensitivity
Check if field names match the actual metadata field names
Verify required fields are actually extractable from your report format
Override not working:
Confirm the field is marked as both "Required" and "Overridable"
Check user permissions for overriding validation failures
Ensure the organization settings allow payload overrides
Getting Help
If you encounter issues with payload configurations:
Check the browser console for detailed error messages
Review your organization's integration settings
Contact your system administrator for permission-related issues
Reach out to RADPAIR support for technical assistance