Product Export (HTTP)

This section describes the generation of the outbound data file set PRODUCTS HTTP. The user initiates this process by selecting an available data set and clicking the "Build" button in the Outbound Data Sets page. The payload can only be built if all products in the set have the status Test or Approved.

The generated data file set contains up to four data files.

Products

The first data file t hat is created holds all of the selected products and product details. The created data file has the type PRODUCTS. The XML payload has the following structure:

<products>
  <product
    elementId
    uuid
    code
    description
    aggregationLevel
    priorityCode
    productLineCode
    productFamilyCode
    fundingArrangementCode
    brandCode
    currencyCode
    buildNumber
  >
    <productProviderGroupList/>
    <productBenefitSpecificationList/>
    <productLimitList/>
  </product>
</products>

The product provider grouplist are written to the export file as follows:

<productProviderGroupList>
  <productProviderGroup
    providerGroupCode
    assignmentLabel
    startDate
    endDate
  />
</productProviderGroupList>

The product limits are written to the export file as follows:

<productLimitList>
  <productLimit
    limitCode
    renewalReference
    renewalPeriodLength
    renewalPeriodUnitOfMeasure
    carryOverPeriodLength
    carryOverPeriodUnitOfMeasure
    otherProductsCarryOverPeriodLength
    otherProductsCarryOverPeriodUnitOfMeasure
    startDate
    endDate
  />
</productLimitList>

The product benefit specifications are written to the export file as follows:

<productBenefitSpecificationList>
      <productBenefitSpecification
        uuid
        benefitSpecificationCode
        startDate
        endDate
      >
        <productBenefitSpecificationLimitList>
          <productBenefitSpecificationLimit
            limitCode
            aliasCode
            displayName
            maximumNumber
            maxumumServiceDays
            coverWithholdCategoryCode
            reachedAction
            startDate
            endDate
          >
            <maximumAmount
              currency
              value
            />
          </productBenefitSpecificationLimit>
        </productBenefitSpecificationLimitList>
        <productBenefitSpecificationValueList>
          <productBenefitSpecificationValue
            coverWithholdCategoryCode
            aliasCode
            displayName
            percentage
            startDate
            endDate
          >
            <coverWithholdAmount
              currency
              value
            />
          </productBenefitSpecificationValue>
        </productBenefitSpecificationValueList>
        <productBenefitSpecificationReinsuranceList>
          <productBenefitSpecificationReinsurance
             aliasCode
             displayName
             startDate
             endDate
          />
        </productBenefitSpecificationReinsuranceList>
      </productBenefitSpecification>
</productBenefitSpecificationList>

The payload also includes dynamic fields. Although these are not show in the example above, they appear in the same way as the native fields.

Benefit Specifications

The second data file that is created holds all of benefit specifications used by the products in the first data file. The created data file has the type BENEFIT SPECIFICATIONS. The XML payload has the following structure:

<benefitSpecifications>
  <benefitSpecification
    elementId
    uuid // UUID of the benefit specification
    code
    description
    serviceOptionServiceCode
    active
    subType
    claimFormTypeCode
    procedureGroup1Usage
    procedureGroup1Code
    procedureGroup2Usage
    procedureGroup2Code
    procedureGroup3Usage
    procedureGroup3Code
    procedureConditionUsage
    procedureConditionCode
    diagnosisGroupCode
    diagnosisGroupUsage
    diagnosisConditionCode
    diagnosisTypeCode
    employerCountryRegionUsage
    employerCountryRegionGroupCode
    employerCountryRegionCode
    employerCountryRegionCountryCode
    providerCountryRegionUsage
    providerCountryRegionGroupCode
    providerCountryRegionCode
    providerCountryRegionCountryCode
    personCountryRegionUsage
    personCountryRegionGroupCode
    personCountryRegionCode
    personCountryRegionCountryCode
    productProviderGroupScope
    specificProviderGroupScope
    regimeCode
    caseDefinitionCode
    gender
    ageFrom
    ageTo
    authorizationMissing
    consumeAuthorization
    priorityCode
    locationTypeUsage
    modifierUsage
    specialtyUsage
  >
    <benefitSpecificationDynamicLogicList>
      <benefitSpecificationDynamicLogic
         code
      />
    <benefitSpecificationDynamicLogicList>
    <benefitSpecificationProviderGroupList>
      <benefitSpecificationProviderGroup
         code
         assignmentLabel
      />
    </benefitSpecificationProviderGroupList>
    <benefitSpecificationLocationTypeList>
      <benefitSpecificationLocationType
        <locationType
          code
          claimFormTypeCode
        />
      />
    </benefitSpecificationLocationTypeList>
    <benefitSpecificationModifierList>
      <benefitSpecificationModifier
        code
      />
    </benefitSpecificationModifierList>
    <benefitSpecificationSpecialtyList>
      <benefitSpecificationSpecialty
       code
      />
    </benefitSpecificationSpecialtyList>
  </benefitSpecification>
</benefitSpecifications>

The payload also includes dynamic fields. Although these are not show in the example above, they appear in the same way as the native fields.

Product Setup

The additional data files that are created hold the benefit priorities and country region groups used by the benefit specifications in the second data file.

For each of the following root elements, an additional data file is added to the data file set:

• <countryRegionGroups>

• <benefitPriorities>

Each of the created data files have the type PRODUCT SETUP. The XML payloads in these data files have the following structure:

<countryRegionGroups>
  <countryRegionGroup
    elementId
    uuid
    code
    description
  >
    <countryRegionGroupDetailList>
      <countryRegionGroupDetail
        countryRegionCode
        countryCode
      />
    </countryRegionGroupDetailList>
  </countryRegionGroup>
</countryRegionGroups>

The data file that holds country region groups only includes country region groups that are used by a benefit specification in the second data file.

<benefitPriorities>
  <benefitPriority
    elementId
    uuid // UUID of the benefit priority
    code
    displayName
    priority
  />
</benefitPriorities>

The data file that holds benefit priorities only includes benefit priorities that are used by a benefit specification in the second data file. Benefit priorities that link to a service definition priority that is reference only are not included.