Benefit
Defined in: packages/parser/src/profiles/271/types.ts:9
One benefit (an EB segment) and the segments that qualify it. Codes are returned as they appear, without translation.
Properties
| Property | Type | Description |
|---|---|---|
additionalInfo | Segment[] | Additional information (III segments), such as the place of service or nature of injury. |
amount | string | undefined | Monetary amount (EB07). |
authorizationRequired | string | undefined | Whether the service needs authorization or certification (EB11). |
coverageLevel | string | undefined | Who the benefit covers, such as the individual or family (EB02). |
dates | Segment[] | Dates that apply to the benefit (DTP segments). |
eb | Segment | The EB segment itself. |
errors | RequestError[] | Errors the payer reported for this benefit (AAA segments). |
inNetwork | string | undefined | Whether the benefit applies in network (EB12). |
insuranceType | string | undefined | Insurance type, such as an HMO or Medicare Part B (EB04). |
limits | Segment[] | Limits on how often the service can be delivered (HSD segments). |
messages | string[] | Free-form message text (MSG01), one entry per message. |
percent | string | undefined | Percentage, such as coinsurance (EB08). |
planDescription | string | undefined | Plan coverage description (EB05). |
quantity | object | Quantity qualifier (EB09) and quantity (EB10). |
quantity.qualifier | string | undefined | What the quantity counts, such as visits or days (EB09). |
quantity.value | string | undefined | The quantity (EB10). |
references | Segment[] | Reference numbers for the benefit (REF segments). |
relatedEntities | Loop[] | Other parties the benefit refers to, such as a primary care provider or another payer. The first segment of each is the NM1 that names the party, followed by its address, contact and provider segments. |
serviceTypes | string[] | Service type codes (EB03), one per repetition. |
status | string | undefined | Eligibility or benefit information code, such as active coverage or a co-payment (EB01). |
timePeriod | string | undefined | Time period the amount or quantity applies to, such as per visit or per year (EB06). |