Plan Benefits Details

Output representation details of the insurance policy benefits.

JSON Example 

1{
2  "isSuccess": true,
3  "errors": [],
4  "networks": [
5    {
6      "id": "n1",
7      "network": "FIRST_NETWORK_TIER",
8      "name": "Preferred Network",
9      "sequence": 1
10    },
11    {
12      "id": "n2",
13      "network": "SECOND_NETWORK_TIER",
14      "name": "In Network",
15      "sequence": 2
16    }
17  ],
18  "benefits": [
19    {
20      "benefitId": "bft1",
21      "benefitSequence": 1,
22      "productId": "01tSG0000011yBFYAY",
23      "productName": "Preventive Care",
24      "productCompGrpId": "0y7SG0000000Q8zYAE",
25      "productCompGgpName": "General plan information",
26      "productCompGgpSequence": 1,
27      "network": "First Network Tier",
28      "attributes": [
29        {
30          "attributeDefinitionId": "0tjSG0000001embYAA",
31          "name": "Copay",
32          "value": 400,
33          "sequence": 1,
34          "keyHidden": false,
35          "dataType": "Currency"
36        },
37        {
38          "attributeDefinitionId": "0tjSG00000020yPYAQ",
39          "name": "Deductible waiver",
40          "value": "Deductible waived",
41          "sequence": 2,
42          "keyHidden": true,
43          "dataType": "Text"
44        },
45        {
46          "attributeDefinitionId": "0tjSG0000001YmMYAU",
47          "name": "Notes",
48          "value": "In network limitations apply.",
49          "sequence": 2,
50          "keyHidden": true,
51          "dataType": "Text"
52        }
53      ],
54      "combinedValue": "Copay $400 | Deductible waived | In network limitations apply."
55    }
56  ]
57}

Properties 

NameTypeDescriptionAvailable Version
attributesBenefit AttributesList of attributes.63.0
benefitsBenefitsDetails of the plan benefit.63.0
combinedValueStringCombined value of the Insurance Policy Coverage Benefit Attribute for a benefit.63.0
errorsListList of errors.63.0
isSuccessBooleanBoolean to determine whether it was success or failure.63.0
networkStringThe tier type of the network.63.0
networksNetworksInsurance Policy Coverage Networks for creating plan benefits.63.0
productCompGgpIdStringID of product component group63.0
productIdStringID of the product.63.0
productNameStringName of the product.63.0