Table Description
Utility: An external organization paid by the human services organization on behalf of a participant.

A utility is a type of participant.

The utility is paid, as instructed by the participant, by deducting money from an active claim entitlement the participant has registered on the system.

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::Concern::Entity Objects::Utility::Utility
Controlling File: core\model\Packages\Concern\Utility_cat.efx
Table Options
ALLOW_OPTIMISTIC_LOCKINGyes
LAST_UPDATED_FIELDyes
Attributes (16)
AttributeStereotypeNullableDescriptionDomain DefinitionCodetableDDL Type
concernRoleIDkeynoUnique reference number assigned by the system to a Concern Role record.CONCERN_ROLE_ID SVR_INT64
namedetails The governing First Name and Surname or label utilized by the Utility in their interaction with the Organization.UTILITY_NAME SVR_STRING<131>
registeredNamedetails The registered name of the utility.REGISTERED_NAME SVR_STRING<131>
utilityTypeCodedetails Code value to denote the Utility type.UTILITY_TYPE_CODEUtilityTypeSVR_STRING<10>
methodOfPmtCodedetailsyesCode to denote the type of Method of Payment to the Utility.METHOD_OF_DELIVERY_CODEMethodOfDeliverySVR_STRING<10>
paymentFrequencydetailsyesCode value to indicate the frequency of payment to the Utility.FREQUENCY_PATTERN SVR_STRING<9>
statusCodedetails Code value to indicate the current statusRECORD_STATUS_CODERecordStatusSVR_STRING<10>
commentsdetails Free text registered by the User.COMMENTS SVR_STRING<300>
primaryAlternateIDdetails The primary alternate reference number of this utility.ALTERNATE_ID SVR_STRING<18>
maximumPaymentRatedetails The maximum payment amount that can be made to a UtilityRATE SVR_DOUBLE
minimumPaymentAmountdetails The minimum payment amount that can be made to a UtilityCURAM_AMOUNT SVR_MONEY
nextPaymentDatedetailsyesThe next payment calculation date for this utilityCURAM_DATE SVR_DATE
currencyTypedetailsyesThe preferred currency for the UtilityCURRENCY_CODECurrencySVR_STRING<10>
upperNamedetails The governing First Name and Surname or label utilized by the Utility in their interaction with the Organization (upper case equivalent).UTILITY_NAME SVR_STRING<131>
upperRegisteredNamedetails The registered name of the utility (upper case equivalent).REGISTERED_NAME SVR_STRING<131>
upperUtilityTypeCodedetails Code value to denote the Utility type (upper case equivalent).UTILITY_TYPE_CODEUtilityTypeSVR_STRING<10>
Foreign Keys (1)
ChildParent
Utility.concernRoleIDConcernRole.concernRoleID
Indices (3)
Index NameAttributes
UtilPmtDateMOPIdxnextPaymentDate, methodOfPmtCode
UtilityIndex1primaryAlternateID
UtilitiesByTypeIndutilityTypeCode
Operations (15)
OperationStereotypeOptionsDescriptionSQL
insertinsertPRE_DATA_ACCESS: yes
Standard Operation 
modifymodifyOPTIMISTIC_LOCKING: yes
POST_DATA_ACCESS: yes
PRE_DATA_ACCESS: yes
Standard Operation 
readread Standard Operation 
readSummaryDetailnsPRE_DATA_ACCESS: yes
 
Called to retrieve a summary details record, including name and address, for a utility.SQL
searchByTypensreadmulti Used to return all utilities with the specified typeCode 
searchByNextPmtDateRangeMOPnsmulti  Operation to retrieve all rows from the Utility entity that match the specified methodOfPmtCode and where the nextPaymentDate is between the specified date range.SQL
searchByNextPmtDateMOPnsmulti Operation to retrieve all rows from the Utility entity that match the specified methodOfPmtCode and where the nextPaymentDate is <= the input date.SQL
modifyNextPmtDatensmodifyOPTIMISTIC_LOCKING: yes
POST_DATA_ACCESS: yes
Operation to update the nextPaymentDate of a specific Utility entry 
searchAllUtilitiesnsmultiPRE_DATA_ACCESS: yes
READMULTI_LIM: 0
 
Retrieves a summary record for each utility. May return a very large number of records.SQL
searchByNameTypeOrAddressnsmultiPRE_DATA_ACCESS: yes
 
 SQL
readMaxPaymentRatensread Reads the maximum payment rate for a utility. 
search  @superseded - replaced by searchByNameTypeOrAddress 
readMethodOfPmtCurrencynsread Reads the methodOfPmtCode and currencyType for a Utility. 
readSummaryDetailsByReferenceNumbernsmultiPRE_DATA_ACCESS: yes
READMULTI_LIM: 0
 
Searches for Utilities based on reference numberSQL
convertDetailsToUpper  Method to convert the utility details to upper. 
Related Pages (225)
Register Prospect (AddProspectPerson_registerForPDCWizard)
Register Prospect (AddProspectPerson_registerWizard)
Match Client (Application_matchClientConfirmation)
Add Client (Application_registerPersonAndAddAsClient)
Register Person (Application_registerProspectPersonAsPerson)
Utility Payments (BenefitSample_listUtilityPayment)
Register Person (BenefitSample_registerPerson)
Select Delivery Pattern (BenefitSample_selectDeliveryPattern)
Register Person and Create Case (Case_registerPersonAndCreateIntegratedCase)
Register Person and Create Case (Case_registerPersonAndCreateIntegratedCasePDC)
Register Prospect Person and Create a Case (Case_registerProspectPersonAndCreateIntegratedCase)
Register Prospect Person and Create an Integrated Case (Case_registerProspectPersonAndCreateIntegratedCasePDC)
Reception Contact (ClientContactWizard_issueDetails)
Add Client (CommonIntake_addClient)
Register Client (CommonIntake_registerClient)
Create Client Contact (Contact_register)
Create Client Contact (Contact_registerFromPersonSearch)
New Product Delivery (DefaultIC_createProductDelivery)
Select Delivery Pattern (DefaultICMember_selectDeliveryPattern)
Integrated Case Utility Home (DefaultICUtility_home)
New Absent Parent Evidence (EVD_addToCaseAbsentParentEvidence_sa)
New Household Member Evidence (EVD_createHouseholdMemberEvidence_sa)
Edit Absent Parent Evidence (EVD_incomingModifyAbsentParentEvidence)
Edit Absent Parent Evidence (EVD_modifyAbsentParentEvidence)
Edit Alternative Identifier (ExternalParty_modifyAlternateIDFromList)
Edit Alternative Identifier (ExternalParty_modifyAlternateIDFromView)
Regenerate Payment (ExternalParty_regeneratePayment)
Cancel Payment (Financial_cancelPayment)
Cancel Payment (Financial_cancelPayment1)
Cancel Issued Payment (Financial_cancelPaymentInstrument)
Reverse Instruction (Financial_createInstructionReversal)
Reverse Details (Financial_createLineItemReversal)
Refund Payment (Financial_createRefund)
Invalidate Payment (Financial_invalidatePayment)
Refund Payments (Financial_refundPayments)
Confirm & Reissue (Financial_regenerateAppliedFixedDeduction)
Regenerate Payment For New Nominee: (Financial_regenerateForNewNominee)
Regenerate Payment (Financial_regeneratePayment)
Reissue Payment (Financial_regeneratePayment1)
Reissue Payment Instrument (Financial_regeneratePaymentInstrument)
Reissue with Un-applied Deduction (Financial_regenerateUnappliedDeduction)
Add Member (HCRAddMemberWizard_summary)
Check Retroactive Medicaid Eligibility (HCRRetroactiveMedicaid_confirmCheckEligibilty)
Utility Payments (ICBenefitUnderPayment_listUtilityPayment)
Select Delivery Pattern (ICMember_selectDeliveryPattern)
Utility Payments (ICProductSample_listUtilityPayment)
Create Delivery (ICSample_createProductDelivery)
Register Person (ICSample_registerPerson)
Select Delivery Pattern (ICSample_selectDeliveryPattern)
Integrated Case Utility Home (ICSample_utilityHome)
Utility Payments (ICSportingGrantSample_listUtilityPayment)
Register Person (IncomeScreening_registerHouseholdMember)
Register Prospect Person (IncomeScreening_registerHouseholdProspect)
Register Person (IncomeScreening_registerPerson)
Register Prospect Person (IncomeScreening_registerProspect)
Register Person (IncomeSupportScreening_registerPerson)
Register Person (IncomeSupportScreening_registerPersonForHouseholdEvidence)
Register Prospect (IncomeSupportScreening_registerProspect)
Register Prospect (IncomeSupportScreening_registerProspectForHouseholdEvidence)
Register Prospect Person as Person (Individual_registerProspectAsPerson)
Related Persons (Intake_listRelatedPerson)
Register Person (Intake_personFullRegistration)
Person Search Results (Intake_personSearchResult)
Register Prospect Person as Person (Intake_registerProspectAsPerson)
Register Client for Intake (Intake_registerProspectPerson)
Register Prospect Person as Person (Intake_registerProspectPersonAsPerson)
Register Prospect Person (Intake_registerProspectPersons)
Register Prospect Person (Intake_registerProspectPersons_Reset)
Register Prospect Person (Intake_registerProspectPersons_Reset1)
Register Prospect Person (Intake_registerProspectPersons1)
Register Person (IntakeShortCuts_registerPerson)
Add Prospect Person (IntakeShortCuts_registerProspectPerson)
Register Person (InvestigationSample_registerPerson)
Register Person (InvestigationSample_registerPersonForPDC)
Add Household Member (ISAddMemberWizard_summaryDetails)
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)
Register Person (ISP_registerPerson)
Integrated Case Utility Home (ISP_utilityHome)
Basic Intake Information (ISPIntakeInformation_createFromScreening)
Utility Payments (ISPProduct_listUtilityPayment)
Re-add a Member (ISReAddMemberWizard_submit)
Register Person (LiabilitySample_registerPerson)
Select Delivery Pattern (LiabilitySample_selectBillingPattern)
New Alternative Identifier (Participant_createAlternateID)
Reverse Line Item (Participant_createLineItemReversal)
Merge Duplicate (Participant_mergeAlternativeIDs)
Edit Alternative Identifier (Participant_modifyAlternateID)
Edit Alternative Identifier (Participant_modifyAlternateIDFromList)
Edit Alternative Identifier (Participant_modifyAlternateIDFromView)
- (Participant_regeneratePaymentInstrument)
Utility Payments (PDBenefitUnderPayment_listUtilityPayment)
Utility Payments (Person_listUtilityPayment)
Edit Utility Payment (Person_modifyUtilityPaymentFromList)
Edit Utility Payment (Person_modifyUtilityPaymentFromView)
Register Person (Person_register)
Register Person (Person_registerForPDC)
View Utility Payment (Person_viewUtilityPayment)
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)
New Utility Payment (ProductDelivery_createUtilityPayment)
Existing Utility Payments (ProductDelivery_listExistingUtilityPayment)
Register Prospect (Prospect_register)
Confirm Registration (Prospect_registerPersonFromProspect)
Register Employer (ProspectEmployer_duplicateCheckWizard)
Register Prospect Person (ProspectPerson_register)
Register Prospect Person as Person (ProspectPerson_registerAsPerson)
Register Prospect Person as Person (ProspectPerson_registerAsPersonForPDCWizard)
Register Prospect Person as Person (ProspectPerson_registerAsPersonWizard)
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)
Step 5: Register Person (ProviderManagement_duplicateRegisterPersonAsProvider)
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 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 Utilization Contract (ProviderManagement_modifyUtilizationContractForProviderGroup)
Edit Rate (ProviderManagement_modifyUtilizationContractProviderOfferingRate)
Place Client (ProviderManagement_placeSampleClient)
Step 5: Register Person (ProviderManagement_registerPersonAsProvider)
Register As Person (ProviderManagement_registerProviderAsPersonFrmProviderHome)
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)
Quick Registration (Quick_register)
Register Person (RegisterPerson_registerForPDCWizard)
Register Person (RegisterPerson_registerWizard)
Register Utility (RegisterUtility_registerWizard)
Application (RightsAndResponsibilitiesForCase)
Application (RightsAndResponsibilitiesForCaseSubmit)
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)
Home (Utility_home)
Edit Utility (Utility_modifyUtility)
Register Utility (Utility_register)