IPPOAD Insurance policy administration message (D10B)
This is the standard EDIFACT D10B spec, with 20 loops and 216 segment positions, as OpenEDI JSON, an ediFabric C# template and an ediFabric Native model. To change it for a trading partner, customize it in the EDI Spec Builder.
Use the IPPOAD spec in your code
ediFabric .NET
Add the C# template and its common files to your project, or reference the template NuGet package, and read IPPOAD files into TSIPPOAD objects. See ediFabric .NET.
ediFabric Native
Native supports X12 today, and EDIFACT is coming. When it's available, map version D10B to this Native model with set_map to parse IPPOAD files to JSON from Python, Java, C or C#. See ediFabric Native.
OpenEDI
Select Customize in Spec Builder to copy the spec under your own name, change it for your partner, and parse files against it in EdiNation, ediFabric Native or ediFabric Cloud. Read about OpenEDI.
Generate IPPOAD classes in Python, Java, Node.js, Go, Rust or C
The OpenEDI file describes each IPPOAD as JSON. To work with IPPOAD data as typed objects, generate classes from the OpenEDI file in your language; the root class is TSIPPOAD. The classes keep the loops, segments, lengths and code lists, but not the EDI data formats. Read more in Generate a class from OpenEDI.
Python: datamodel-code-generator. Node.js: openapi-typescript. Java, Go, Rust and C: OpenAPI Generator.
IPPOAD structure
Loops and segments of the standard IPPOAD, with their usage and maximum repeats.
| ID | Name | Usage | Max use |
|---|---|---|---|
| UNH | Message Header | Optional | 1 |
| BGM | BEGINNING OF MESSAGE | Mandatory | 1 |
| ATT | ATTRIBUTE | Optional | 9 |
| RFF | REFERENCE | Optional | 9 |
| DTM | DATE/TIME/PERIOD | Optional | 9 |
| QTY | QUANTITY | Optional | 9 |
| SEQ | SEQUENCE DETAILS | Optional | 1 |
| Loop PNA | PARTY IDENTIFICATION | Optional | 9 |
| PNA | PARTY IDENTIFICATION | Mandatory | 1 |
| Loop RFF | REFERENCE | Optional | 9 |
| RFF | REFERENCE | Mandatory | 1 |
| DTM | DATE/TIME/PERIOD | Optional | 9 |
| Loop ICD | INSURANCE COVER DESCRIPTION | Mandatory | 999 |
| ICD | INSURANCE COVER DESCRIPTION | Mandatory | 1 |
| IDE | IDENTITY | Mandatory | 9 |
| GEI | PROCESSING INFORMATION | Optional | 1 |
| ATT | ATTRIBUTE | Optional | 99 |
| CUX | CURRENCIES | Optional | 1 |
| DTM | DATE/TIME/PERIOD | Optional | 99 |
| MOA | MONETARY AMOUNT | Optional | 9 |
| PCD | PERCENTAGE DETAILS | Optional | 9 |
| QTY | QUANTITY | Optional | 9 |
| QRS | QUERY AND RESPONSE | Optional | 99 |
| RFF | REFERENCE | Optional | 9 |
| FTX | FREE TEXT | Optional | 99 |
| Loop COD | COMPONENT DETAILS | Optional | 999 |
| COD | COMPONENT DETAILS | Mandatory | 1 |
| IDE | IDENTITY | Optional | 99 |
| GEI | PROCESSING INFORMATION | Optional | 1 |
| ATT | ATTRIBUTE | Optional | 99 |
| COM | COMMUNICATION CONTACT | Optional | 9 |
| DTM | DATE/TIME/PERIOD | Optional | 99 |
| EFI | EXTERNAL FILE LINK IDENTIFICATION | Optional | 1 |
| MOA | MONETARY AMOUNT | Optional | 9 |
| PCD | PERCENTAGE DETAILS | Optional | 9 |
| QRS | QUERY AND RESPONSE | Optional | 99 |
| QTY | QUANTITY | Optional | 9 |
| RFF | REFERENCE | Optional | 9 |
| FTX | FREE TEXT | Optional | 9 |
| Loop PCC | PREMIUM CALCULATION COMPONENT DETAILS | Optional | 99 |
| PCC | PREMIUM CALCULATION COMPONENT DETAILS | Mandatory | 1 |
| IDE | IDENTITY | Optional | 9 |
| ADR | ADDRESS | Optional | 99 |
| ATT | ATTRIBUTE | Optional | 9 |
| DTM | DATE/TIME/PERIOD | Optional | 9 |
| MOA | MONETARY AMOUNT | Optional | 9 |
| PCD | PERCENTAGE DETAILS | Optional | 9 |
| QRS | QUERY AND RESPONSE | Optional | 9 |
| QTY | QUANTITY | Optional | 9 |
| FTX | FREE TEXT | Optional | 9 |
| Loop PNA | PARTY IDENTIFICATION | Optional | 9999 |
| PNA | PARTY IDENTIFICATION | Mandatory | 1 |
| IDE | IDENTITY | Optional | 99 |
| GEI | PROCESSING INFORMATION | Optional | 1 |
| ATT | ATTRIBUTE | Optional | 99 |
| COM | COMMUNICATION CONTACT | Optional | 9 |
| DTM | DATE/TIME/PERIOD | Optional | 9 |
| LOC | PLACE/LOCATION IDENTIFICATION | Optional | 9 |
| MOA | MONETARY AMOUNT | Optional | 9 |
| PCD | PERCENTAGE DETAILS | Optional | 9 |
| QRS | QUERY AND RESPONSE | Optional | 99 |
| QTY | QUANTITY | Optional | 9 |
| RFF | REFERENCE | Optional | 9 |
| FTX | FREE TEXT | Optional | 99 |
| Loop CTA | CONTACT INFORMATION | Optional | 9 |
| CTA | CONTACT INFORMATION | Mandatory | 1 |
| COM | COMMUNICATION CONTACT | Optional | 9 |
| Loop COD | COMPONENT DETAILS | Optional | 999 |
| COD | COMPONENT DETAILS | Mandatory | 1 |
| IDE | IDENTITY | Optional | 9 |
| GEI | PROCESSING INFORMATION | Optional | 1 |
| ADR | ADDRESS | Optional | 9 |
| ATT | ATTRIBUTE | Optional | 9 |
| COM | COMMUNICATION CONTACT | Optional | 9 |
| DTM | DATE/TIME/PERIOD | Optional | 9 |
| EFI | EXTERNAL FILE LINK IDENTIFICATION | Optional | 1 |
| EMP | EMPLOYMENT DETAILS | Optional | 1 |
| FII | FINANCIAL INSTITUTION INFORMATION | Optional | 1 |
| IMD | ITEM DESCRIPTION | Optional | 9 |
| MOA | MONETARY AMOUNT | Optional | 9 |
| PCD | PERCENTAGE DETAILS | Optional | 9 |
| QRS | QUERY AND RESPONSE | Optional | 99 |
| QTY | QUANTITY | Optional | 9 |
| RFF | REFERENCE | Optional | 9 |
| FTX | FREE TEXT | Optional | 9 |
| Loop PCC | PREMIUM CALCULATION COMPONENT DETAILS | Optional | 99 |
| PCC | PREMIUM CALCULATION COMPONENT DETAILS | Mandatory | 1 |
| IDE | IDENTITY | Optional | 9 |
| ADR | ADDRESS | Optional | 99 |
| ATT | ATTRIBUTE | Optional | 9 |
| DTM | DATE/TIME/PERIOD | Optional | 9 |
| MOA | MONETARY AMOUNT | Optional | 9 |
| PCD | PERCENTAGE DETAILS | Optional | 9 |
| QRS | QUERY AND RESPONSE | Optional | 9 |
| QTY | QUANTITY | Optional | 9 |
| FTX | FREE TEXT | Optional | 9 |
| Loop ROD | RISK OBJECT TYPE | Optional | 9999 |
| ROD | RISK OBJECT TYPE | Mandatory | 1 |
| IDE | IDENTITY | Optional | 99 |
| GEI | PROCESSING INFORMATION | Optional | 1 |
| ATT | ATTRIBUTE | Optional | 99 |
| COM | COMMUNICATION CONTACT | Optional | 9 |
| DTM | DATE/TIME/PERIOD | Optional | 99 |
| MEA | MEASUREMENTS | Optional | 99 |
| MOA | MONETARY AMOUNT | Optional | 9 |
| PCD | PERCENTAGE DETAILS | Optional | 9 |
| QRS | QUERY AND RESPONSE | Optional | 99 |
| QTY | QUANTITY | Optional | 99 |
| RFF | REFERENCE | Optional | 9 |
| FTX | FREE TEXT | Optional | 99 |
| Loop COD | COMPONENT DETAILS | Optional | 999 |
| COD | COMPONENT DETAILS | Mandatory | 1 |
| IDE | IDENTITY | Optional | 9 |
| GEI | PROCESSING INFORMATION | Optional | 1 |
| ADR | ADDRESS | Optional | 9 |
| ATT | ATTRIBUTE | Optional | 99 |
| COM | COMMUNICATION CONTACT | Optional | 9 |
| DTM | DATE/TIME/PERIOD | Optional | 9 |
| EFI | EXTERNAL FILE LINK IDENTIFICATION | Optional | 1 |
| EMP | EMPLOYMENT DETAILS | Optional | 9 |
| IMD | ITEM DESCRIPTION | Optional | 9 |
| MOA | MONETARY AMOUNT | Optional | 9 |
| MEA | MEASUREMENTS | Optional | 9 |
| PCD | PERCENTAGE DETAILS | Optional | 9 |
| QRS | QUERY AND RESPONSE | Optional | 99 |
| QTY | QUANTITY | Optional | 9 |
| RFF | REFERENCE | Optional | 9 |
| FTX | FREE TEXT | Optional | 99 |
| Loop PCC | PREMIUM CALCULATION COMPONENT DETAILS | Optional | 99 |
| PCC | PREMIUM CALCULATION COMPONENT DETAILS | Mandatory | 1 |
| IDE | IDENTITY | Optional | 9 |
| ADR | ADDRESS | Optional | 99 |
| ATT | ATTRIBUTE | Optional | 9 |
| DTM | DATE/TIME/PERIOD | Optional | 9 |
| MOA | MONETARY AMOUNT | Optional | 9 |
| PCD | PERCENTAGE DETAILS | Optional | 9 |
| QRS | QUERY AND RESPONSE | Optional | 9 |
| QTY | QUANTITY | Optional | 9 |
| FTX | FREE TEXT | Optional | 9 |
| Loop EVE | EVENT | Optional | 9999 |
| EVE | EVENT | Mandatory | 1 |
| IDE | IDENTITY | Optional | 99 |
| GEI | PROCESSING INFORMATION | Optional | 1 |
| ATT | ATTRIBUTE | Optional | 99 |
| DTM | DATE/TIME/PERIOD | Optional | 9 |
| MEA | MEASUREMENTS | Optional | 9 |
| MOA | MONETARY AMOUNT | Optional | 9 |
| PCD | PERCENTAGE DETAILS | Optional | 9 |
| QRS | QUERY AND RESPONSE | Optional | 99 |
| QTY | QUANTITY | Optional | 99 |
| RFF | REFERENCE | Optional | 9 |
| FTX | FREE TEXT | Optional | 99 |
| Loop COD | COMPONENT DETAILS | Optional | 999 |
| COD | COMPONENT DETAILS | Mandatory | 1 |
| IDE | IDENTITY | Optional | 99 |
| GEI | PROCESSING INFORMATION | Optional | 1 |
| ADR | ADDRESS | Optional | 9 |
| ATT | ATTRIBUTE | Optional | 99 |
| COM | COMMUNICATION CONTACT | Optional | 9 |
| DTM | DATE/TIME/PERIOD | Optional | 9 |
| EFI | EXTERNAL FILE LINK IDENTIFICATION | Optional | 1 |
| EMP | EMPLOYMENT DETAILS | Optional | 9 |
| MOA | MONETARY AMOUNT | Optional | 9 |
| PCD | PERCENTAGE DETAILS | Optional | 9 |
| QRS | QUERY AND RESPONSE | Optional | 99 |
| QTY | QUANTITY | Optional | 9 |
| RFF | REFERENCE | Optional | 9 |
| FTX | FREE TEXT | Optional | 99 |
| Loop PCC | PREMIUM CALCULATION COMPONENT DETAILS | Optional | 99 |
| PCC | PREMIUM CALCULATION COMPONENT DETAILS | Mandatory | 1 |
| IDE | IDENTITY | Optional | 9 |
| ADR | ADDRESS | Optional | 99 |
| ATT | ATTRIBUTE | Optional | 9 |
| DTM | DATE/TIME/PERIOD | Optional | 9 |
| MOA | MONETARY AMOUNT | Optional | 9 |
| PCD | PERCENTAGE DETAILS | Optional | 9 |
| QRS | QUERY AND RESPONSE | Optional | 9 |
| QTY | QUANTITY | Optional | 9 |
| FTX | FREE TEXT | Optional | 9 |
| Loop SEQ | SEQUENCE DETAILS | Optional | 99 |
| SEQ | SEQUENCE DETAILS | Mandatory | 1 |
| IDE | IDENTITY | Optional | 9 |
| GEI | PROCESSING INFORMATION | Optional | 9 |
| ATT | ATTRIBUTE | Optional | 9 |
| DTM | DATE/TIME/PERIOD | Optional | 9 |
| MOA | MONETARY AMOUNT | Optional | 9 |
| PCD | PERCENTAGE DETAILS | Optional | 9 |
| PNA | PARTY IDENTIFICATION | Optional | 9 |
| QRS | QUERY AND RESPONSE | Optional | 9 |
| QTY | QUANTITY | Optional | 9 |
| RFF | REFERENCE | Optional | 9 |
| FTX | FREE TEXT | Optional | 9 |
| Loop COD | COMPONENT DETAILS | Optional | 99 |
| COD | COMPONENT DETAILS | Mandatory | 1 |
| IDE | IDENTITY | Optional | 99 |
| GEI | PROCESSING INFORMATION | Optional | 9 |
| ATT | ATTRIBUTE | Optional | 9 |
| DTM | DATE/TIME/PERIOD | Optional | 9 |
| MOA | MONETARY AMOUNT | Optional | 9 |
| PCD | PERCENTAGE DETAILS | Optional | 9 |
| PNA | PARTY IDENTIFICATION | Optional | 9 |
| QRS | QUERY AND RESPONSE | Optional | 9 |
| QTY | QUANTITY | Optional | 9 |
| RFF | REFERENCE | Optional | 9 |
| FTX | FREE TEXT | Optional | 9 |
| Loop IMD | ITEM DESCRIPTION | Optional | 9 |
| IMD | ITEM DESCRIPTION | Mandatory | 1 |
| IDE | IDENTITY | Optional | 9 |
| DTM | DATE/TIME/PERIOD | Optional | 9 |
| PNA | PARTY IDENTIFICATION | Optional | 9 |
| QRS | QUERY AND RESPONSE | Optional | 9 |
| RFF | REFERENCE | Optional | 9 |
| Loop PYT | PAYMENT TERMS | Optional | 9 |
| PYT | PAYMENT TERMS | Mandatory | 1 |
| IDE | IDENTITY | Optional | 9 |
| GEI | PROCESSING INFORMATION | Optional | 1 |
| ATT | ATTRIBUTE | Optional | 9 |
| DTM | DATE/TIME/PERIOD | Optional | 9 |
| MOA | MONETARY AMOUNT | Optional | 9 |
| PCD | PERCENTAGE DETAILS | Optional | 9 |
| QRS | QUERY AND RESPONSE | Optional | 9 |
| QTY | QUANTITY | Optional | 9 |
| RFF | REFERENCE | Optional | 9 |
| FTX | FREE TEXT | Optional | 9 |
| Loop PCC | PREMIUM CALCULATION COMPONENT DETAILS | Optional | 99 |
| PCC | PREMIUM CALCULATION COMPONENT DETAILS | Mandatory | 1 |
| IDE | IDENTITY | Optional | 9 |
| ADR | ADDRESS | Optional | 1 |
| ATT | ATTRIBUTE | Optional | 9 |
| DTM | DATE/TIME/PERIOD | Optional | 9 |
| MOA | MONETARY AMOUNT | Mandatory | 9 |
| PCD | PERCENTAGE DETAILS | Optional | 9 |
| QRS | QUERY AND RESPONSE | Optional | 9 |
| QTY | QUANTITY | Optional | 9 |
| FTX | FREE TEXT | Optional | 9 |
| UNT | Message Trailer | Optional | 1 |