Table Description
Deduction: A deduction is the means by which an organization can allocate a portion of a clients benefit for a specific purpose.

This purpose can be categorized based on whether the deduction is made to a third party, toward a specific liability or towards the organization itself.

Each category can then be broken down into deduction types containing different configurable parameters. For example a category of Third Party could contain deduction types for Gas deductions, Electricity deductions and Tax deductions.

Relationship Diagram
Click the diagram to manipulate and zoom. Traverse the diagram using Click-and-Drag motions.
Model Details
Location in Model: Logical View::MetaModel::Curam::Core::Reference Model::Service Layer::Deduction::Entity::Deduction
Controlling File: core\model\Packages\Reference Model\Service Layer\Deduction\Entity\Deduction_cat.efx
Table Options
ALLOW_OPTIMISTIC_LOCKINGyes
VALIDATION_EXIT_POINTyes
Attributes (14)
AttributeStereotypeNullableDescriptionDomain DefinitionCodetableDDL Type
deductionIDkeynoUnique reference number assigned by the system to a Deduction record. Generated number.DEDUCTION_ID SVR_INT64
deductionNamedetailsnoCode value to indicate the name of the deduction. Codetable is 'DeductionName'.DEDUCTION_NAME_CODEDeductionNameSVR_STRING<10>
prioritydetailsnoPriority indicating the order in which the specific deductions should be processed.PRIORITY SVR_INT32
maxAmountdetails Amount indicating the maximum fixed amount which can be entered when creating a deduction against a benefit, or the maximum amount a percentage based deduction can be evaluated to.CURAM_AMOUNT SVR_MONEY
maxPercentagedetails Value indicating the maximum percentage which can be entered when creating a deduction against a benefit.RATE SVR_DOUBLE
defaultAmountdetails Amount indicating the default amount which will be inherited when creating a deduction against a benefit.CURAM_AMOUNT SVR_MONEY
defaultPercentagedetails Value indicating the default percentage which will be inherited when creating a deduction against a benefit.RATE SVR_DOUBLE
minAmountdetails Amount indicating the minimum amount which can be deducted for a deduction. This is used for variable deductions. When a variable deduction is created in delivery, the resulting deduction amount cannot be less than the minimum amount. It is also used when creating a deduction. Deductions cannot be created for less than the minimum amount.CURAM_AMOUNT SVR_MONEY
actionTypedetailsnoThis value indicates the action to take when there is an insufficient amount remaining on a benefit to process the deduction amount.DEDUCTION_ACTION_TYPE_CODEDeductionActionTypeSVR_STRING<10>
categorydetailsnoIndicates the category of the deduction i.e. Third Party Deduction, Applied Deduction or Un-applied Deduction.DEDUCTION_CATEGORY_CODEDeductionCategoryCodeSVR_STRING<10>
dateCreateddetailsnoThe date on which a deduction was created.CURAM_DATE SVR_DATE
commentsdetails General comments entered by the user.COMMENTS SVR_STRING<300>
recordStatusdetailsnoIndicates the status of a deduction record. The values are 'Active' or 'Canceled'.RECORD_STATUS_CODERecordStatusSVR_STRING<10>
preventOverlappingInddetailsyesIndicates if overlapping deductions can be applied.CURAM_INDICATOR SVR_BOOLEAN
Foreign Keys (1)
ChildParent
DeductionProductLink.deductionIDDeduction.deductionID
Indices (1)
Index NameAttributes
RecordStatusIndexrecordStatus
Operations (17)
OperationStereotypeOptionsDescriptionSQL
insertinsertAUTO_ID: deductionID
AUTO_ID_KEY: PRODUCTBO
PRE_DATA_ACCESS: yes
Standard Operation 
readread Standard Operation 
modifymodifyOPTIMISTIC_LOCKING: yes
PRE_DATA_ACCESS: yes
Standard Operation 
readActiveDeductionByNamensreadPRE_DATA_ACCESS: yes
Returns the active deduction record based on the deduction name. 
validateModify  Validates deduction details before modifying. 
readStatusnsread Returns the status value. 
cancelnsmodifyOPTIMISTIC_LOCKING: yes
PRE_DATA_ACCESS: yes
Changes the status of the deduction to 'cancelled' 
validateCancel  Validates deduction details before updating to 'canceled'. 
readLowestPrioritynsPRE_DATA_ACCESS: yes
 
Returns the lowest Deduction priority. The lowest priority returned will be the highest numerical value i.e. in a list of deductions with priorities 1, 2, 3, 4, 5, the lowest priority would be 5.SQL
searchActiveDeductionIDPrioritynsmultiPRE_DATA_ACCESS: yes
 
Returns a list of active deduction id's and priorities.SQL
readPrioritynsread Returns the priority value for a deduction record. 
readActiveDeductionByPrioritynsreadPRE_DATA_ACCESS: yes
Returns deduction details for an active deduction based on the priority value. 
searchAllnkreadmultiORDER_BY: recordStatus, priority
Returns a list of deductions sorted by record status and priority. 
validateInsert  Validates deduction details before inserting a deduction record. 
modifyPrioritynsmodify Modifies the priority of a deduction record. 
insertDeductioninsert <p> <span style="COLOR: #002060">Inserts deduction record. This method expects the deductionID to be set. It is preferred to call <font color="#000000">insertDeduction</font> method only in scenarios where calling method wants to set the value of primary key by itself.</span> </p> 
modifyDeductionmodifyOPTIMISTIC_LOCKING: yes
This modify operation will be called while re-applying a change set in the target system. Entity level validations that will happen during a standard modify operation will not be applicable in this case. This modify operation will update all the attributes defined for this entity. 
Related Pages (159)
- (CHIPDecision_context)
- (DefaultICProduct_tabDetails)
DefaultICProduct_tabDetailsPreview
- (EmergencyMedicaidDecision_context)
- (ESIDecision_context)
- (ExemptionDecision_context)
Cancel Payment (Financial_cancelPayment)
Cancel Payment (Financial_cancelPayment1)
Cancel Issued Payment (Financial_cancelPaymentInstrument)
Reissue with Applied Deduction (Financial_createAppliedFixedDeductionWizard)
Reverse Instruction (Financial_createInstructionReversal)
Reverse Details (Financial_createLineItemReversal)
Reissue with Un-applied Deduction (Financial_createUnappliedDeductionWizard)
Invalidate Payment (Financial_invalidatePayment)
Confirm & Reissue (Financial_regenerateAppliedFixedDeduction)
Reissue with Un-applied Deduction (Financial_regenerateUnappliedDeduction)
Simulate Payment (Financial_simulatePayment1)
Check Retroactive Medicaid Eligibility (HCRRetroactiveMedicaid_confirmCheckEligibilty)
- (InsuranceAssistanceDecision_context)
Cancel Sanction (ISP_cancelSanctionEvidence)
Cancel Disregard (ISP_cancelSanctionOverride)
New Sanction (ISP_createSanctionEvidence)
New Disregard (ISP_createSanctionOverride)
Edit Sanction (ISP_modifySanctionEvidence_fromList)
Edit Sanction (ISP_modifySanctionEvidence_fromView)
Edit Disregard (ISP_modifySanctionOverride_fromList)
Modify Sanction Override Details: (ISP_modifySanctionOverride_fromView)
Reverse Line Item (Participant_createLineItemReversal)
End Deduction (Participant_endDeduction)
Add Existing Deduction (Product_addDeduction)
New Deduction (Product_createDeduction)
Product_deductionHome
New Fixed Deduction (ProductDelivery_createAppliedFixedDeduction)
New Applied Fixed Deduction (ProductDelivery_createAppliedFixedDeduction1)
New Applied Fixed Deduction (ProductDelivery_createAppliedFixedDeductionWizard)
New Variable Deduction (ProductDelivery_createAppliedVariableDeduction)
New Applied Variable Deduction (ProductDelivery_createAppliedVariableDeduction1)
New Applied Variable Deduction (ProductDelivery_createAppliedVariableDeductionWizard)
New Third Party Fixed Deduction (ProductDelivery_createThirdPartyFixedDeduction)
New Third Party Fixed Deduction (ProductDelivery_createThirdPartyFixedDeduction1)
New Third Party Variable Deduction (ProductDelivery_createThirdPartyVariableDeduction)
New Third Party Variable Deduction (ProductDelivery_createThirdPartyVariableDeduction1)
New Fixed Deduction (ProductDelivery_createUnappliedFixedDeduction)
New Un-applied Fixed Deduction (ProductDelivery_createUnappliedFixedDeduction1)
New Variable Deduction (ProductDelivery_createUnappliedVariableDeduction)
New Un-applied Variable Deduction (ProductDelivery_createUnappliedVariableDeduction1)
Edit Applied Deduction (ProductDelivery_modifyAppliedDeductionDetailsFromList)
Edit Applied Deduction (ProductDelivery_modifyAppliedDeductionDetailsFromView)
Edit Deduction Details (ProductDelivery_modifyDeductionDetailsFromList)
Edit Deduction Details (ProductDelivery_modifyDeductionDetailsFromView)
Edit Third Party Deduction Details (ProductDelivery_modifyThirdPartyDeductionFromList)
Edit Third Party Deduction Details (ProductDelivery_modifyThirdPartyDeductionFromList1)
Edit Third Party Deduction Details (ProductDelivery_modifyThirdPartyDeductionFromView)
Edit Third Party Deduction Details (ProductDelivery_modifyThirdPartyDeductionFromView1)
Edit Un-applied Deduction Details (ProductDelivery_modifyUnappliedDeductionDetailsFromList)
Edit Un-applied Deduction Details (ProductDelivery_modifyUnappliedDeductionDetailsFromView)
Save Simulation (ProductDelivery_saveSimulation)
Simulate Payment (ProductDelivery_simulatePayment)
- (ProductDelivery_tabDetails)
ProductDelivery_tabDetailsPreview
Activate Contract (ProviderManagement_activateContract)
New Text Translation (ProviderManagement_addDescriptionTranslationToServiceOffering)
New Text Translation (ProviderManagement_addNameTranslationToServiceOffering)
Add Service Authorization Line Item: (ProviderManagement_addSampleServiceAuthorizationLineItem)
New Service (ProviderManagement_addServicesToProviderContract)
Add Services to Contract (ProviderManagement_addServicesToProviderGroupContract)
New Service (ProviderManagement_addServicesToProviderGroupContract_fromView)
Update to Training (ProviderManagement_addTrainingForServiceOffering)
Submit Service Invoice Line Item for Processing (ProviderManagement_allowSILIForProcessingAsDuplicate)
Amend Utilization Contract (ProviderManagement_amendProviderGroupUtilizationContract)
Amend Contract (ProviderManagement_amendUtilizationContract)
Approve Line Item (ProviderManagement_approveLineItemCorrections)
Approve Line Item (ProviderManagement_approvePendingSILI)
Approve Line Item (ProviderManagement_approvePendingSILICorrections)
Approve Line Item (ProviderManagement_approveServiceInvoiceLineItem)
Approve Service Invoice Line Items (ProviderManagement_approveServiceInvoiceLineItems)
Approve Line Item (ProviderManagement_approveSILI)
Approve Service Invoice Line Item as Duplicate (ProviderManagement_approveSILIAsDuplicate)
Approve Line Item (ProviderManagement_approveSILICorrections)
Approve Line Items (ProviderManagement_approveSubmittedSILI)
Approve Line Items (ProviderManagement_confirmApproveServiceInvoiceLineItems)
Confirm cancel overlapping reservations (ProviderManagement_confirmCancelOverlappingActiveResForAnyClient)
Confirm Modify Overlapping Placements (ProviderManagement_confirmModifyOverlappingPlacementPrd)
Confirm modify overlapping placements (ProviderManagement_confirmModifyPlacementPrdForWL)
Submit Line Items (ProviderManagement_confirmSubmitServiceInvoiceLineItems)
New Applied Deduction (ProviderManagement_createAppliedVariableDeduction)
New Service (ProviderManagement_createNewServiceOffering)
New Service (ProviderManagement_createNewTrainingServiceOffering)
New Service Rate (ProviderManagement_createProviderGroupUtilizationContractProviderOfferingRate)
New Payment Options (ProviderManagement_createProviderPaymentOption)
New Rate (ProviderManagement_createProviderServiceOfferingRate)
Create Emergency Placement (ProviderManagement_createSampleEmergencyPlacement)
Create Service Authorization Line Items (ProviderManagement_createSampleSAWithSALI)
New Service (ProviderManagement_createServiceOffering)
New Payment Options (ProviderManagement_createServicePaymentOption)
New Service Rate (ProviderManagement_createServiceRate)
New Third Party Deduction (ProviderManagement_createThirdPartyVariableDeduction)
New Training Service (ProviderManagement_createTrainingServiceOffering)
New Un-Applied Deduction (ProviderManagement_createUnappliedVariableDeduction)
New Utilization Contract (ProviderManagement_createUtilizationContractForProvider)
New Rate (ProviderManagement_createUtilizationContractProviderOfferingRate)
Edit Payment Option (ProviderManagement_editProviderPaymentOption)
Edit Service (ProviderManagement_editServiceOffering)
Edit Service (ProviderManagement_editServiceOfferingFrmView)
Edit Payment Options (ProviderManagement_editServicePaymentOption)
Edit Service Rate (ProviderManagement_editServiceRate)
Edit Training Service (ProviderManagement_editTrainingServiceOffering)
Edit Training Service (ProviderManagement_editTrainingServiceOfferingFrmView)
Edit Applied Deduction (ProviderManagement_modifyAppliedDeductionDetails)
Edit Text Translation (ProviderManagement_modifyLocalizableSODescriptionTextTranslation)
Edit Text Translation (ProviderManagement_modifyLocalizableSONameTextTranslation)
Select Provider Payment Type (ProviderManagement_modifyPaymentType)
Confirm Placement (ProviderManagement_modifyPlaceDuringConfirmation)
Edit Placement (ProviderManagement_modifyPlacementDetails)
Modify Placement Information (ProviderManagement_modifyPlacementInformation)
Confirm Cancel Reservation (ProviderManagement_modifyPlacementInformationConfirmCancelReservation)
Allocate Place (ProviderManagement_modifyPlaceProviderOfferingAllocate)
Edit Service Rate (ProviderManagement_modifyProviderGroupUtilizationContractProviderOfferingRate)
Edit Rate (ProviderManagement_modifyProviderServiceOfferingRate)
Confirm Placement: (ProviderManagement_modifySamplePlaceDuringConfirmation)
Modify Service Authorization Line Item: (ProviderManagement_modifySampleServiceAuthorizationLineItem)
Edit Delivery Configuration (ProviderManagement_modifySecurityRightsAndServiceDeliveryConfiguration)
Edit Third Party Deduction (ProviderManagement_modifyThirdPartyDeduction)
Edit Un-Applied Deduction (ProviderManagement_modifyUnappliedDeductionDetails)
Edit Utilization Contract (ProviderManagement_modifyUtilizationContractForProviderGroup)
Edit Rate (ProviderManagement_modifyUtilizationContractProviderOfferingRate)
Place Client (ProviderManagement_placeSampleClient)
Renew Contract (ProviderManagement_renewContract)
Renew Contract (ProviderManagement_renewProviderGroupContract)
Submit Line Item (ProviderManagement_submitOpenSILIForProcessing)
Submit Line Item (ProviderManagement_submitServiceInvoiceLineItemForProcessing)
Submit Line Items (ProviderManagement_submitServiceInvoiceLineItems)
Submit Line Item (ProviderManagement_submitSILI)
Submit Service Invoice Line Item for Processing (ProviderManagement_submitSILIForProcessingFromTask)
Submit Service Invoice (ProviderManagement_submittServiceInvoiceForProcessing)
Transfer Client (ProviderManagement_transferClient)
Transfer Placement to Another Case (ProviderManagement_transferSamplePlacementToAnotherCase)
Reassessment Details (ProviderManagement_triggerReassessment)
Update Placement Period (ProviderManagement_updateSamplePlacementPeriod)
Delete Deduction (Resource_cancelDeduction)
New Deduction (Resource_createDeduction)
New Deduction (Resource_createDeduction1)
View Deduction Details: (Resource_deductionHome)
Resource_listDeductions
Edit Deduction (Resource_modifyDeductionFromList)
Edit Deduction (Resource_modifyDeductionFromView)
New Disregard (SanctionAssessment_createDisregard_CREOLE)
New Sanction (SanctionAssessment_createSanction_CREOLE)
Edit Sanction (SanctionAssessment_modifySanction)
Edit Recommendation Disregard (SanctionAssessment_modifySanctionOverride)
Add Plan Item (ServicePlanDelivery_addCustomServicePlanItem)
Add Plan Item (ServicePlanDelivery_addServicePlanItem)
Edit Plan Item (ServicePlanDelivery_modifyCustomServicePlanItemProviderEditable)
Edit Plan Item (ServicePlanDelivery_modifyCustomServicePlanItemProviderNonEditable)
Edit Plan Item (ServicePlanDelivery_modifyServicePlanItemProviderEditable)
Edit Plan Item (ServicePlanDelivery_modifyServicePlanItemProviderNonEditable)
- (StateBasicPlanDecision_context)
- (StreamlineMedicaidDecision_context)
- (UQHPDecision_context)