Table Description
Referral: A referral of one or more clients to a provider who may provide a service to a client for which the referring agency does not pay or monitor.

A referral can be added to any type of case.

Example

A case worker assesses James Smith's strengths and needs and identifies that he has mental health issues. To address these issues the case worker creates an outcome plan to address these issues. A referral is created to refer James for a Psychiatric Assessment.
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::CPM::Service Layer::Referral::Entity::Referral
Controlling File: CPM\model\Packages\Service Layer\Referral\Referral.efx
Table Options
ALLOW_OPTIMISTIC_LOCKINGyes
Attributes (17)
AttributeStereotypeNullableDescriptionDomain DefinitionCodetableDDL Type
referralIDkeynoUnique identifier for a referral.INTERNAL_ID SVR_INT64
creationDatedetailsnoThe creation date of the referral.CURAM_DATE SVR_DATE
reasondetailsnoThe textual description of the reason for the referral.REASON_TEXT_SMALL SVR_STRING<2000>
clientContactedProviderInddetails Indicates whether the client has contacted the referral provider.CONTACTED_PROVIDER_INDContactedProviderIndSVR_STRING<10>
notifyClientAutomaticallydetails Indicates whether or not a referral letter should be sent automatically to the client.CURAM_INDICATOR SVR_BOOLEAN
followUpRequiredInddetails Indicates whether the referral should be followed up to ensure the client contacted the referral provider.CURAM_INDICATOR SVR_BOOLEAN
clientNotificationTextdetails General text relating to the referral.REASON_TEXT_SMALL SVR_STRING<2000>
recordStatusdetailsnoStatus of the referral record. Values include 'Active' or 'Canceled'.RECORD_STATUS_CODERecordStatusSVR_STRING<10>
sensitivitydetails Sensitivity level associated with the referral. A user must have at least an equivalent sensitivity level to view, add, modify or delete the referral.SENSITIVITY_CODESensitivitySVR_STRING<10>
referralDatedetails The date the referral is scheduled for.CURAM_DATE SVR_DATE
followUpWarningDaysdetails The number of days after a referral has been scheduled or created that an alert should be invoked to the caseworker. REFERRAL_WARNING_DAYS SVR_STRING<10>
referredBydetailsnoThe name of the user who referred the client(s). This can be the user who created the referral or another user.USER_NAME SVR_STRING<64>
providerNotificationTextdetails General text relating to the referral that is to be included in the notification document that is produced for the provider.REASON_TEXT_SMALL SVR_STRING<2000>
notifyProviderAutomaticallydetails Indicates whether or not a referral letter should be sent automatically to the provider.CURAM_INDICATOR SVR_BOOLEAN
relatedObjectIDdetailsnoUnique reference number of the object with which the referral is associated. For example, a case, incident, person, etc. This id is used in conjunction with the relatedObjectLinkType for lookup.INTERNAL_ID SVR_INT64
relatedObjectTypedetailsnoType of object the referral is related to. This is used for lookup in conjunction with relatedObjectID.REFERRAL_OBJECT_LINK_TYPEReferralRelatedLinkTypeSVR_STRING<10>
createdBydetailsnoUser name of the user who created the referral.USER_NAME SVR_STRING<64>
Foreign Keys (2)
ChildParent
Referral.referredByUsers.userName
ReferralRole.referralIDReferral.referralID
Indices (2)
Index NameAttributes
ReferralRelatedObjectIDIdxrelatedObjectID
IND_1535832586referredBy
Operations (5)
OperationStereotypeOptionsDescriptionSQL
insertinsertAUTO_ID: referralID
Standard Operation 
readread Standard Operation 
modifymodifyOPTIMISTIC_LOCKING: yes
Standard Operation 
searchByRelatedObjectIDTypeAndStatusreadmulti Retrieves all referral records related to a referral based on the related object identifier, related object type and record status. 
searchByRelatedObjectAndDateRangereadmultiWHERE: relatedObjectID=:relatedObjectID AND ((referralDate >=:startDate AND referralDate <=:endDate AND referralDate is not null ) OR (creationDate>=:startDate AND creationDate <=:endDate AND referralDate is null))
Retrieves all referral records with passed relatedObjectId and where referral date lies within the date range or where referral date is null. 
Related Pages (42)
New Agreement (AddAgreementWizard_activities)
Activities (OutcomePlan_listReferrals)
Referral Details (OutcomePlan_viewReferralDetails)
OutcomePlan_viewReferralDetailsPreviewPanel
New Referral (OutcomePlanCollaborationPreselectedReferralWizard_details)
New Referral: (OutcomePlanCollaborationPreselectedReferralWizard_factors)
New Referral (OutcomePlanCollaborationPreselectedReferralWizard_notification)
OutcomePlanCollaborationPreselectedReferralWizard_provider
OutcomePlanCollaborationPreselectedReferralWizard_sharing
New Referral (OutcomePlanCollaborationReferralWizard_details)
New Referral (OutcomePlanCollaborationReferralWizard_factors)
New Referral (OutcomePlanCollaborationReferralWizard_notification)
OutcomePlanCollaborationReferralWizard_provider
New Referral (OutcomePlanCollaborationReferralWizard_service)
OutcomePlanCollaborationReferralWizard_sharing
New Referral (OutcomePlanPreselectedReferralWizard_details)
New Referral: (OutcomePlanPreselectedReferralWizard_factors)
New Referral (OutcomePlanPreselectedReferralWizard_notification)
OutcomePlanPreselectedReferralWizard_provider
) (OutcomePlanReferral_viewContextPanel)
Home (OutcomePlanReferral_viewReferral)
New Referral (OutcomePlanReferralWizard_details)
New Referral (OutcomePlanReferralWizard_factors)
New Referral (OutcomePlanReferralWizard_notification)
OutcomePlanReferralWizard_provider
New Referral (OutcomePlanReferralWizard_service)
Delete Referral (ProviderManagement_cancelReferral)
New Attachment (ProviderManagement_createReferralAttachment)
Edit Referral (ProviderManagement_editReferralNotificationsNotSent)
Edit Referral (ProviderManagement_editReferralNotificationsSent)
ProviderManagement_listReferralNotifications
Referrals (ProviderManagement_listReferrals)
New Referral (ProviderManagement_referralWizardAddDetails)
New Referral (ProviderManagement_referralWizardAddNotification)
ProviderManagement_referralWizardAddProvider
New Referral (ProviderManagement_referralWizardAddService)
ProviderManagement_referralWizardLinkAddProvider
ProviderManagement_specifyReferralProviderCPMService
ProviderManagement_specifyReferralProviderCPMServiceLink
Specify Provider (ProviderManagement_specifyReferralProviderUnregisteredService)
Home (ProviderManagement_viewReferral)
) (ProviderManagement_viewReferralSummaryDetails)