Guide JSON format

Stedi’s native format for EDI transactions is called Guide JSON. It closely reflects the structure of an EDI transaction, but uses JSON instead of EDI syntax.

• When you Generate EDI, Stedi accepts Guide JSON as input, and delivers a fully-validated EDI file to your partner.
• Stedi parses inbound EDI into Guide JSON format.

Example

The following example shows an 834 benefit enrollment in X12 EDI and Guide JSON formats. The EDI format is in the first tab, and the Guide JSON is in the second tab.

834 benefit enrollment EDI

ISA*00*          *00*          *ZZ*SENDERNAME     *ZZ*RECEIVERNAME   *041227*1324*^*00501*000000103*0*P*>~
GS*BE*SENDERNAME*RECEIVERNAME*20041227*1324*000000103*X*005010X220A1~
ST*834*12345*005010X220A1~
BGN*00*12456*19980520*1200****2~
REF*38*ABCD012354~
N1*P5**FI*999888777~
N1*IN**FI*654456654~
INS*N*19*024*07*A~
REF*0F*123456789~
REF*1L*123456001~
DTP*357*D8*19960801~
NM1*IL*1*DOE*JAMES*E***34*103229876~
DMG*D8*19770816*M~
SE*12*12345~
GE*1*000000103~
IEA*1*000000103~

What is Guide JSON?

Guides are Stedi’s machine-readable representation of the EDI specifications that your trading partners provide to you (typically in the form of PDF, Excel, or Word files), or that you provide to your trading partners. You can view and import guides from X12 HIPAA transactions and popular logistics and retail trading partners as needed for your integration.

Each guide is backed by a JSON Schema that defines the structure of the EDI transaction. Guide JSON is JSON data that conforms to the guide’s schema.

How Stedi uses Guide JSON

• Inbound files: Stedi uses the inbound transaction settings within the partnership to determine which Stedi guide to use for validation and translation. If validation is successful, Stedi parses the file into one or more transactions, and outputs them in Guide JSON.
• Outbound files: You supply Stedi’s Generate Outbound Transaction endpoint with transaction data in the Guide JSON format. Stedi uses that data to generate an EDI file and deliver it to your trading partner.

Find a guide’s JSON Schema

To find the JSON Schema for a guide:

1. Navigate to the Guides page in your Stedi account.
2. Click the guide you want to view.
3. Open the Actions menu and select View schema.

How Guide JSON formats vary

Guide JSON formats vary in three ways. You must account for these differences when you receive Guide JSON webhooks for inbound transactions, and when you call Stedi APIs to send outbound transactions.

Transaction type

Since a guide can represent any of the 300+ EDI transaction types, the Guide JSON (and corresponding JSON Schema) will differ depending on the transaction type. For example, the Guide JSON for an 834 benefit enrollment will differ from the Guide JSON for an 835 Claim Payment/Advice (also known as an ERA). This means that the payloads you receive from Stedi through webhooks will vary depending on the transaction type, and the payloads you send to Stedi APIs will also vary depending on the transaction type.

Release

X12 has 30+ releases, or versions. There are often breaking changes between X12 releases, which makes it impossible to reliably canonicalize transactions across releases. Since different trading partners use different releases, the Guide JSON you have to accept from and provide to Stedi differ depending on the release. For example, the Guide JSON for an 850 Purchase Order in X12 release 004010 will be different than the Guide JSON for an 850 Purchase Order in X12 release 005010.

Trading partner

Since different trading partners use different EDI specifications, the Guide JSON may differ depending on the trading partner. For example, the Amazon Retail 855 PO Acknowledgment allows you to optionally specify pricing information in the CTP segment, but the Walmart 855 does not.

These differences don’t apply to X12 HIPAA transactions, which are standardized across trading partners. For example, the Guide JSON for an 834 benefit enrollment will be the same regardless of which payer you send it to.