Purging Claims Data

Oracle Health Insurance applications store a significant amount of information. This page describes the integration point that enables the user to purge data from the operational claims tables. The two primary scenarios for using this integration point are to purge information that is beyond its retention period on a product environment, and to reduce the size of non-production environments.

This integration point removes claims and all related details, taking a number of criteria to control the scope of the purge process. Claims that match on all specified criteria are purged. It is possible to mark specific claims such that they are never purged, even if they meet all criteria.

Request

This integration point is available via the following path:

http://<HOST_ADDRESS>:<HOST_PORT>/<CONTEXT_ROOT>/purgeClaims

This integration point exposes a POST method. The payload for this request contains the selection criteria for the claims to be purged.

The request message has the following structure:

{
  "periodUom" : "",
  "periodLength" : "",
  "includeFinancialData" : "",
  "includeLimitConsumptions" : "",
  "formCode" : "",
  "formTypeCode" : "",
  "brandCode" : "",
  "claimDynUsageName1" : "",
  "claimDynValue1" : "",
  "claimDynUsageName2" : "",
  "claimDynValue2" : "",
  "claimDynUsageName3" : "",
  "claimDynValue3" : "",
  "extClaimDataDynUsageName" : "",
  "extClaimDataDynValue" : "",
  "currentDate" : ""
}

Retention Period

The retention period is derived from the system date. The age of a claim is determined by the last updated date on the claim header.

For example, a retention period of ten years purges all Claims that have not been updated in 10 years as of the day the user calls this integration point.

Dynamic fields as Selection Criteria

It is possible to specify up to three single-value dynamic fields on the claims table as criteria for the purging process. Use the following format for dynamic fields of type date: YYYY-MM-DD.

The following criteria are supported:

Table 1. Dynamic fields as Selection Criteria
Parameter	Description
periodUom	This required parameter specifies, together witch period length, the retention period. Specify the unit of measure as D (days), M (months) or Y (years)
periodLength	Required parameter that specifies the length of the retention period
includeFinancialData	This required parameter controls whether financial data is included in the purge process. Note that the base financial objects that resulted from claims that have been purged earlier are also removed regardless of the retention period if this parameter is `Y`.
includeLimitConsumptions	This required parameter controls whether the adjudication limit consumptions and provider limit consumptions are included in the purge process. Note that the consumptions that resulted from claims that have been purged earlier are also removed if this parameter is `Y`.
formCode	This optional parameter specifies the claims form. Only Claims with the specified form purge.
formTypeCode	This optional parameter specifies the Claim form type. Only Claims with the specified form type purge.
brandCode	This optional parameter specifies the brand. Only Claims with the specified brand (excludes Claims without a specified brand) purge.
claimDynUsageName1	Dynamic Field Usage Name
claimDynValue1	Dynamic Field Value
claimDynUsageName2	Dynamic Field Usage Name
claimDynValue2	Dynamic Field Value
claimDynUsageName3	Dynamic Field Usage Name
claimDynValue3	Dynamic Field Value
extClaimDataDynUsageName	This optional parameter provides the ability to use a dynamic field that is available on the external Claims data table as parameter for the purging process. Only use single-value dynamic fields as parameters. Specifying a dynamic field usage name and value (specify both) purges only Claims that have the specified value for the specified dynamic field on their external claims data record.
extClaimDataDynValue	This optional parameter holds the value for the specified extClaimDataDynUsageName (previous parameter). Use the following format for dynamic fields of type date: `YYYY-MM-DD`.
currentDate	This is an optional parameter. Use it in test environments only. Calculate the retention period as if today is `currentDate` instead of the system date. This enables purging recent records in test situations.

Example

The following example purges all claims with form type code INST and product line (dynamic field on the claims table) HMO that are older than ten years together with their financial data, adjudication limit, and provider limit consumptions.

{
  "periodUom" : "Y",
  "periodLength" : "10",
  "includeFinancialData" : "Y",
  "includeLimitConsumptions" : "Y",
  "formTypeCode : "INST",
  "claimDynUsageName1" : "productLine",
  "claimDynValue1" : "HMO"
}

Response Messages

This service can respond with the following messages:

Table 2. Response Messages
Code	Message
CLA-IP-PUCL-001	Period UoM must be D (days), M (months) or Y (years)
CLA-IP-PUCL-002	Period length must be a positive number without decimals
CLA-IP-PUCL-003	The request must include both Period UoM and Period Length
CLA-IP-PUCL-004	Claim Form Code is unknown
CLA-IP-PUCL-005	Claim Form Type Code is unknown
CLA-IP-PUCL-006	Brand Code is unknown
CLA-IP-PUCL-007	Dynamic Field Usage Name is unknown
CLA-IP-PUCL-007	Dynamic Field Usage Name and Value must both be provided

Authorization

This operation is protected by the access restriction "purgeClaims IP".