Table Description
Plan Template Plan Item: An activity which is part of a predefined service plan.

This table provides the link between plan templates and plan items. This entity is focused solely on the administration of template plan items within the Service Planning Administration component.

Example

A case worker creates a Return to Work service plan for participant Linda Smith as she has recently become unemployed. He chooses to use a predefined template which consists of a Sustainable Employment goal, Transportation and Childcare sub-goals and Mileage Reimbursement and Childcare Provision plan items. The following was performed in the administration component to achieve this:

  • An administrator creates a Return to Work Template with a Sustainable Employment goal .
  • Transportation and Childcare sub-goals are linked to the goal, and Mileage Reimbursement and Childcare Provision plan items to these sub-goals
    • .
  • This template is then associated with a Return to Work service plan.
This entity enables the sharing and reuse of plan items across multiple templates.

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::ServicePlans::Templates::PlanTemplatePlanItem::Entity::PlanTemplatePlanItem
Controlling File: ServicePlans\model\Packages\Service Layer\Templates\PlanTemplatePlanItem\Entity\Entity_cat.efx
Table Options
ALLOW_OPTIMISTIC_LOCKINGyes
LAST_UPDATED_FIELDyes
Attributes (13)
AttributeStereotypeNullableDescriptionDomain DefinitionCodetableDDL Type
planTemplatePlanItemIDkeynoUnique reference number assigned by the system to a plan template plan item record.PLAN_TEMPLATE_PLAN_ITEM_ID SVR_INT64
planItemIDdetailsnoUnique reference of the plan item which has been added to the plan template. Links the plan template to the related plan item.PLAN_ITEM_ID SVR_INT64
planTemplateSubGoalIDdetailsnoUnique reference number of the associated sub-goal to which this plan item has been added. Links the plan template plan item to the related sub-goal.PLAN_TEMPLATE_SUBGOAL_ID SVR_INT64
outcomeRequiredInddetails Indicates whether this template sub goal requires and outcome to be set or not.CURAM_INDICATOR SVR_BOOLEAN
durationdetails Number of days from the service plan start date that it should take to complete this plan item.TEMPLATE_PLAN_ITEM_DURATION SVR_INT32
startDaydetails Number of days after the commenced start date of the service plan that this plan item should start.NUMBER_OF_DAYS SVR_INT32
expectedOutcomeIDdetails Unique reference number of the outcome associated with this plan item. Links the plan item to the related outcome.EXPECTED_OUTCOME_ID SVR_INT64
authorizedUnitsdetails Indicates the authorized number of units for the plan item e.g. 6 physiotherapy visits.AUTHORIZED_UNITS SVR_INT32
maximumUnitsdetails Indicates the maximum number of units allowed for the plan item e.g. 9 physiotherapy visits.MAXIMUM_UNITS SVR_INT32
descriptiondetailsyesA description of the plan item.COMMENTS SVR_STRING<300>
approvalReqInddetailsyesIndicator to check if the plan item requires approval.PLAN_ITEM_REQUIRES_APPROVAL_IND SVR_BOOLEAN
isMandatoryInddetailsyesIndicator to see if the plan item is mandatory.PLANITEM_MANDATORY_INDICATOR SVR_BOOLEAN
descriptionTextIDdetailsyesUnique Identifier corresponding to localized description of PlanTemplatePlanItem description.LOCALIZABLE_TEXT_ID SVR_INT64
Foreign Keys (4)
ChildParent
PlanTemplatePlanItem.descriptionTextIDLocalizableText.localizableTextID
PlanTemplatePlanItem.planItemIDPlanItem.planItemID
PlanTemplatePlanItem.planTemplateSubGoalIDPlanTemplateSubGoal.planTemplateSubGoalID
PlanTemplatePlanItemApprCrit.planTemplatePlanItemIDPlanTemplatePlanItem.planTemplatePlanItemID
Indices (2)
Index NameAttributes
PTASubGoalPlanItemIndexplanTemplateSubGoalID, planItemID
PTPlanItemDescTextIDIndexdescriptionTextID
Operations (26)
OperationStereotypeOptionsDescriptionSQL
removeremovePRE_DATA_ACCESS: yes
Removes plan template plan item from plan template sub goal. 
countForPlanItemIDAndTemplateIDns Counts template planItems for specified template ID and plan item ID.SQL
insertinsertAUTO_ID: planTemplatePlanItemID
AUTO_ID_KEY: SERCPLANBO
PRE_DATA_ACCESS: yes
Creates a plan template plan item record. 
modifyDetailsnsmodifyOPTIMISTIC_LOCKING: yes
PRE_DATA_ACCESS: yes
@deprecated since Curam v6,replaced with {@link modifyPlanTemplateAndPlanItemDetails}This method along with the existing functionality of modifyDetails , modifies approval and mandatory information as well. See release note <CR00226905> 
readDetailsns @deprecated sicne Curam v6, replaced with {@link readPlanTemplateAndPlanItemDetails}.The new method reads the plan template plan item details along with approval and mandatory indicators.SQL
validateInsert  Validates details for insert. 
validateModify  @deprecated sicne Curam v6, replaced with {@link validatePlanTemplateAndPlanItemModify}.The new method along with the existing functionality of vaildateDetails , validates approval and mandatory information as well. See release note <CR00228989> 
readPlanItemNamens Reads service plan template plan item name.SQL
countForPlanTemplateSubGoalIDns Counts all planItems assigned to the specified sub goal.SQL
searchByPlanTemplateIDnsmulti Lists all plan template planItems assigned to a plan template.SQL
searchByPlanTemplateSubGoalIDnsmulti Lists all plan template planItems assigned to a plan template sub goal.SQL
validateCancel  Validates plan template plan item cancellation. 
searchPlanItemDetailsByPlanTemplateSubGoalIDnsmulti @deprecated since Curam v6, replaced with {@link searchPlanItemByPlanTemplateSubGoalID}.The new method reads plan template plan item and plan item details for all PlanTemplateAndPlanItem records created for the PlanTemplateSubGoal along with mandatory and approval indicators..SQL
searchTemplatePlanItemsForModifynsmulti Lists the plan items available for modification for a specified sub-goal.SQL
readPlanTemplateSubGoalIDnsread Reads the planTemplateSubGoalID of the PlanTemplatePlanItem record. 
searchUnassociatedTemplateApprovalCriteriansmulti Lists all plan template approval criteria not assigned to a plan template plan item.SQL
readread Reads a row of data from plan template plan item table. 
modifymodifyOPTIMISTIC_LOCKING: yes
Modifies a row of data from plan template plan item table. 
searchByPlanItemIDreadmulti Returns all columns of plan template plan item for the given plan item ID. 
insertPlanTemplatePlanIteminsert <p class="MsoNormal"> <span style="COLOR: #002060">Inserts plan template plan item record. This method expects the planTemplatePlanItemID to be set. It is preferred to call <font color="#000000">insertPlanTemplatePlanItem</font> method only in scenarios where calling method wants to set the value of primary key by itself.</span> </p> 
readPlanTemplateAndPlanItemDetailsns Reads plan template planItem.SQL
searchPlanItemByPlanTemplateSubGoalIDnsmulti Reads plan template plan item and plan item details for all PlanTemplatePlanItem records created for the PlanTemplateSubGoal.SQL
modifyPlanTemplateAndPlanItemDetailsnsmodifyOPTIMISTIC_LOCKING: yes
PRE_DATA_ACCESS: yes
Modifies plan template planItem. 
validatePlanTemplateAndPlanItemModify  Validates PlanTemplateAndPlanItem details along with approval and mandatory informations as well. 
modifyDescriptionTextIDnsmodifyOPTIMISTIC_LOCKING: yes
<p class="MsoNormal" style="MARGIN: 0in 0in 0pt"> <font size="3"><font face="Calibri">Modifies descriptionTextID.</font></font> </p> 
readLastWrittenns Reads the last updated time of the template plan item.SQL
Related Pages (16)