Purging Authorization 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 authorization tables. The two primary scenarios for using this integration point are to purge information that is beyond its retention period on a production environment, and to reduce the size of non-production environments.

This integration point removes authorization data and all their details, taking a number of criteria to control the scope of the purge process.

Note that the purging process excludes authorizations with consumption. This means that authorizations that are linked to claim Lines (through consumptions) are not purged. Run the Purging Claims Data process before the authorization purging process for discarding those links. This removes authorization consumptions of claim Lines. Afterward, the authorizations purging process removes the authorizations, including their counters and counter periods.

Request

This integration point is available via the following path:

http://[hostName]:[portNumber]/[api-context-root]/purgeauthorizations

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

The request message has the following structure:

{
  "periodUom" : "",
  "periodLength" : "",
  "formCode" : "",
  "authDynUsageName1" : "",
  "authDynValue1" : "",
  "authDynUsageName2" : "",
  "authDynValue2" : "",
  "authDynUsageName3" : "",
  "authDynValue3" : "",
  "currentDate" : ""
}

Table 1. Explanation of elements in the request

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
formCode	This optional parameter specifies the authorization form. Only Authorizations with the specified form purge.
authDynUsageName1	Dynamic Field Usage Name
authDynValue1	Dynamic Field Value
authDynUsageName2	Dynamic Field Usage Name
authDynValue2	Dynamic Field Value
authDynUsageName3	Dynamic Field Usage Name
authDynValue3	Dynamic Field Value
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.

Retention Period

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

For example, a retention period of ten years purges all authorizations 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 authorization table as criteria for the purging process. Use the following format for dynamic fields of type date: YYYY-MM-DD.

Example

The following example purges only the authorizations with the ONCOLOGY form and product line (dynamic field on the authorization table) HMO that are older than ten years.

{
  "periodUom" : "Y",
  "periodLength" : "10",
  "formCode" : "ONCOLOGY",
  "authDynUsageName1" : "productLine",
  "authDynValue1" : "HMO",
  "authDynUsageName2" : "",
  "authDynValue2" : "",
  "authDynUsageName3" : "",
  "authDynValue3" : "",
  "currentDate" : ""
}

Response Messages

This service can respond with the following messages:

Table 2. Response Messages

Code	Message
CLA-IP-PUAU-001	Period UoM must be D (days), M (months) or Y (years)
CLA-IP-PUAU-002	Period length must be a positive number without decimals
CLA-IP-PUAU-003	The request must include both Period UoM and Period Length
CLA-IP-PUAU-004	Authorization Form Code is unknown
CLA-IP-PUAU-005	Dynamic Field Usage Name is unknown
CLA-IP-PUAU-006	Dynamic Field Usage Name and Value must both be provided

Authorization

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