Policy In Patch Integration Point

This web service supports the creation and maintenance of Policies. It accepts either an online request for a single Policy or a data file for a set of Policies. To process a file with Policies, start by uploading the data file using the Data File Set web service.

The processing and request format is the same as for the regular Policy In Integration Point, with the following differences:

  • The Policy In Patch Integration Point (or IP) treats list items in the request differently. Like in Policy In Integration Point, the system updates existing list items and creates new list items. This Integration Point never deletes existing list items.

  • There is no delete by omission. If an existing element is not included in a list, the element is not deleted. If you include an empty list, all items will be removed.

  • This behavior applies to sub-resources, dynamic records, and dynamic fields.

  • The list behavior also applies to Person details.

  • Address matching is on Address Type and Start Date.

Use this Integration Point in situations where the payload does not contain all details of a Policy. Typical use cases are:

  • Details of the same Policy are in separate files. For example, a one-month file that includes only coverage details for the employee. And a second-month file that includes only coverage details for dependents.

  • Only changes to an existing Policy are present in the payload. Examples are new Enrollments (such as newborns) or Address changes.

Online Request Message

The HTTP PUT request to: http://[hostName]:[portNumber]/[api-context-root]/policies enable external systems to create and update Policies. Each request message contains the details of a single Policy.

Set the header parameter patch to true for invoking the Policy In Patch Integration Point. An HTTP request without the header parameter starts the Policy In Integration Point.

Example

Adding Policy Enrollment Product for a single member on an existing policy with two members. Both members already have Policy Enrollment Product CO_HDHP.

PUT http://<host>:<port>/<context-root>/policies/submit

<policy code="POL001">
    <policyEnrollmentList>
        <policyEnrollment>
            <person code="PH001"/>
            <policyEnrollmentProductList>
                <policyEnrollmentProduct startDate="2017-11-01" enrollmentProductCode="CO_PPO"/>
            </policyEnrollmentProductList>
        </policyEnrollment>
    </policyEnrollmentList>
</policy>

Content-Type: application/xml
Accept: */*
patch: true

The request adds a new Policy Enrollment Product CO_PPO to member PH001 without removing the existing Policy Enrollment Product CO_HDHP.

File Request

Like the Policy In Integration Point, the Policy In Patch supports file-based requests. This request enables the handling of multiple Policies in one go. Because this service supports requests with significant volume, it relies on the Data File Set web service to import the Policy payload into the application before it reads and processes the data. Refer to Data File Set Integration Point for more information about how to create a Data File Set.

The patch body parameter in the request body controls whether the Policy In Patch Integration Point or the Policy In Integration Point is started. Set the patch to true to start the Policy In Patch Integration Point. The default value for the flag is false.

Each of the data files has <policies> as its root element. This data file has the following structure:

<policies>
   <policy
     code=""
     policyIdentifierTypeCode=""
     elementId=""
   >
</policies>

Example

Adding Policy Enrollment Product to a single member with an existing policy with two members.

  1. Upload the file containing the update transaction as a Data File Set. Refer to the Data File Set Integration Point for details. In this example, the Data File Set has a code 2042. The file contains the following data:

    <policies>
   <policy code="POL001">
      <policyEnrollmentList>
         <policyEnrollment>
            <person code="PH001" />
            <policyEnrollmentProductList>
               <policyEnrollmentProduct startDate="2017-11-01" enrollmentProductCode="CO_PPO" />
            </policyEnrollmentProductList>
         </policyEnrollment>
      </policyEnrollmentList>
   </policy>
</policies>

  2. Perform the file-based request:

POST http://<host>:<port>/<context-root>/writepolicies

{
"dataFileSetCode": "2042",
"submit": "true",
"patch": "true"
}

Content-Type: application/json
Accept: */*

The request adds the Policy Enrollment Product CO_PPO to member PH001 without removing the existing Policy Enrollment Product CO_HDHP.

Authorization

This Integration Point requires a grant for access restriction Policy In IP.