-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathpayers.json
More file actions
2046 lines (2046 loc) · 94.9 KB
/
payers.json
File metadata and controls
2046 lines (2046 loc) · 94.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"components": {
"schemas": {
"ClaimPaymentEnrollmentProcess": {
"description": "Details about the enrollment process for Electronic Remittance Advice (ERAs).",
"properties": {
"requestedEffectiveDate": {
"$ref": "#/components/schemas/RequestedEffectiveDate",
"description": "Whether this payer supports specifying a requested effective date for transaction enrollments.\n - If set to `SUPPORTED`, Stedi will process [transaction enrollment requests](https://www.stedi.com/docs/healthcare/api-reference/post-enrollment-create-enrollment) for this payer according to their specified `requestedEffectiveDate`.\n - This property is only returned when Stedi can determine whether the payer supports requested effective dates."
},
"supportedAggregationPreferences": {
"description": "Aggregation types this payer supports for 835 Electronic Remittance Advice (ERA) transactions. Payers can aggregate by the provider's NPI, tax ID (TIN), or both.\n - You can use this information to specify an `aggregationPreference` when submitting ERA enrollment requests.\n - This property is only returned when Stedi can determine the payer's supported aggregation types.",
"items": {
"$ref": "#/components/schemas/SupportedAggregationType"
},
"type": "array"
},
"timeframe": {
"$ref": "#/components/schemas/EnrollmentProcessTimeframe"
},
"type": {
"$ref": "#/components/schemas/EnrollmentProcessType"
}
},
"type": "object"
},
"ClaimStatusInquiryEnrollmentProcess": {
"description": "Details about the enrollment process for real-time claim status requests.",
"properties": {
"requestedEffectiveDate": {
"$ref": "#/components/schemas/RequestedEffectiveDate",
"description": "Whether this payer supports specifying a requested effective date for transaction enrollments.\n - If set to `SUPPORTED`, Stedi will process [transaction enrollment requests](https://www.stedi.com/docs/healthcare/api-reference/post-enrollment-create-enrollment) for this payer according to their specified `requestedEffectiveDate`.\n - This property is only returned when Stedi can determine whether the payer supports requested effective dates."
},
"timeframe": {
"$ref": "#/components/schemas/EnrollmentProcessTimeframe"
},
"type": {
"$ref": "#/components/schemas/EnrollmentProcessType"
}
},
"type": "object"
},
"CoordinationOfBenefitsEnrollmentProcess": {
"description": "Details about the enrollment process for coordination of benefits (COB) checks.",
"properties": {
"requestedEffectiveDate": {
"$ref": "#/components/schemas/RequestedEffectiveDate",
"description": "Whether this payer supports specifying a requested effective date for transaction enrollments.\n - If set to `SUPPORTED`, Stedi will process [transaction enrollment requests](https://www.stedi.com/docs/healthcare/api-reference/post-enrollment-create-enrollment) for this payer according to their specified `requestedEffectiveDate`.\n - This property is only returned when Stedi can determine whether the payer supports requested effective dates."
},
"timeframe": {
"$ref": "#/components/schemas/EnrollmentProcessTimeframe"
},
"type": {
"$ref": "#/components/schemas/EnrollmentProcessType"
}
},
"type": "object"
},
"CoverageType": {
"description": "The types of insurance coverage that a payer can provide. Used to indicate whether a payer supports transactions for medical coverage, dental coverage, vision coverage, or a combination of these.",
"enum": [
"medical",
"dental",
"vision"
],
"type": "string"
},
"DentalClaimEnrollmentProcess": {
"description": "Details about the enrollment process for dental claim submission.",
"properties": {
"requestedEffectiveDate": {
"$ref": "#/components/schemas/RequestedEffectiveDate",
"description": "Whether this payer supports specifying a requested effective date for transaction enrollments.\n - If set to `SUPPORTED`, Stedi will process [transaction enrollment requests](https://www.stedi.com/docs/healthcare/api-reference/post-enrollment-create-enrollment) for this payer according to their specified `requestedEffectiveDate`.\n - This property is only returned when Stedi can determine whether the payer supports requested effective dates."
},
"timeframe": {
"$ref": "#/components/schemas/EnrollmentProcessTimeframe"
},
"type": {
"$ref": "#/components/schemas/EnrollmentProcessType"
}
},
"type": "object"
},
"EligibilityInquiryEnrollmentProcess": {
"description": "Details about the enrollment process for eligibility checks.",
"properties": {
"requestedEffectiveDate": {
"$ref": "#/components/schemas/RequestedEffectiveDate",
"description": "Whether this payer supports specifying a requested effective date for transaction enrollments.\n - If set to `SUPPORTED`, Stedi will process [transaction enrollment requests](https://www.stedi.com/docs/healthcare/api-reference/post-enrollment-create-enrollment) for this payer according to their specified `requestedEffectiveDate`.\n - This property is only returned when Stedi can determine whether the payer supports requested effective dates."
},
"timeframe": {
"$ref": "#/components/schemas/EnrollmentProcessTimeframe"
},
"type": {
"$ref": "#/components/schemas/EnrollmentProcessType"
}
},
"type": "object"
},
"EnrollmentInfo": {
"description": "Information about enrollment requirements for the payer",
"properties": {
"ptanRequired": {
"description": "Whether a PTAN (Provider Transaction Access Number) is required for transaction enrollment.\n\nThe Provider Transaction Access Number (PTAN) is a Medicare-issued number given to providers upon enrollment with Medicare. This number is usually six digits and is assigned based on the type of service and the location of the provider. Upon enrollment, Medicare Administrating Contracting (MAC) providers should receive their assigned PTAN number in their approval letter.",
"type": "boolean"
},
"transactionEnrollmentProcesses": {
"$ref": "#/components/schemas/TransactionEnrollmentProcesses",
"description": "Enrollment details for specific transaction types.\n\nStedi only returns this object when information about the enrollment process is available for one or more transaction types. When this object isn't included in the response, it **doesn't** mean no transaction types require enrollment. Refer to the `transactionSupport` object for details about which transaction types require enrollment."
}
},
"type": "object"
},
"EnrollmentProcessTimeframe": {
"description": "Stedi's expected timeframe for completing the transaction enrollment process. `INSTANT` indicates that the enrollment will be in `LIVE` status within minutes of submitting the request.",
"enum": [
"INSTANT",
"HOURS",
"DAYS",
"WEEKS"
],
"type": "string"
},
"EnrollmentProcessType": {
"description": "Whether transaction enrollment is single or multi-step.\n - `ONE_CLICK` indicates that once you submit the transaction enrollment request, Stedi can complete the rest of the enrollment process without any further action from you.\n - `MULTI_STEP` indicates that you must complete additional steps to finish the enrollment process. Customer support will reach out with clear instructions explaining how to complete any remaining steps.",
"enum": [
"ONE_CLICK",
"MULTI_STEP"
],
"type": "string"
},
"GetPayerRecordResponseContent": {
"properties": {
"payer": {
"$ref": "#/components/schemas/PayerRecord",
"description": "The payer record matching the provided Stedi payer ID. The record includes the payer's display name and aliases as well as supported transaction types and details about the payer's [transaction enrollment](https://www.stedi.com/docs/healthcare/transaction-enrollment) process."
}
},
"required": [
"payer"
],
"type": "object"
},
"InstitutionalClaimEnrollmentProcess": {
"description": "Details about the enrollment process for institutional claim submission.",
"properties": {
"requestedEffectiveDate": {
"$ref": "#/components/schemas/RequestedEffectiveDate",
"description": "Whether this payer supports specifying a requested effective date for transaction enrollments.\n - If set to `SUPPORTED`, Stedi will process [transaction enrollment requests](https://www.stedi.com/docs/healthcare/api-reference/post-enrollment-create-enrollment) for this payer according to their specified `requestedEffectiveDate`.\n - This property is only returned when Stedi can determine whether the payer supports requested effective dates."
},
"timeframe": {
"$ref": "#/components/schemas/EnrollmentProcessTimeframe"
},
"type": {
"$ref": "#/components/schemas/EnrollmentProcessType"
}
},
"type": "object"
},
"InternalFailureExceptionResponseContent": {
"description": "The server response when an unexpected error occurred while processing request.",
"properties": {
"code": {
"description": "Error classification code",
"type": "string"
},
"message": {
"description": "Human-readable error message",
"type": "string"
}
},
"required": [
"message"
],
"type": "object"
},
"ListPayerRecordsCsvOutputPayload": {
"description": "All supported payer records in CSV format. The first row contains the header with field names, and subsequent rows contain the payer data.\n\nTo render this data as a CSV file, you must save it to a file with a `.csv` extension.",
"type": "string"
},
"ListPayerRecordsResponseContent": {
"description": "Common output structure for list operations with pagination support.",
"properties": {
"items": {
"description": "Payers that Stedi supports for each transaction type. Results are returned in alphabetical order of the Stedi ID.",
"items": {
"$ref": "#/components/schemas/PayerRecord"
},
"type": "array"
},
"nextPageToken": {
"description": "Token that you can supply in subsequent requests to retrieve the next page of results. If not returned, there are no more results.",
"maxLength": 1024,
"minLength": 1,
"type": "string"
}
},
"required": [
"items"
],
"type": "object"
},
"Matches": {
"description": "Shows which properties in the payer record match the search query. This information helps you understand why Stedi returned this payer and which parts of the payer record matched the search terms. It's also especially useful for debugging search queries and building user interfaces that display matching text.\n- Matching text is wrapped in `<b>` HTML tags for highlighting.\n- This object only contains properties with matching text. For example, if none of the payer's aliases matched the search query, this object will not include the `aliases` property.",
"properties": {
"aliases": {
"description": "The parts of the payer's aliases that match the search query. Each alias that contains matching text is included as a separate entry, with matching portions wrapped in `<b>` tags. For example, searching for `XYZ` might return: [`<b>XYZ</b>123`, `ABC<b>XYZ</b>`].",
"items": {
"type": "string"
},
"type": "array"
},
"displayName": {
"description": "The part of the payer's display name that matched the search query. For example, searching for `Blue` might return: `Blue Cross <b>Blue</b> Shield`.",
"type": "string"
},
"names": {
"description": "The parts of the payer's other names that match the search query. Each name that contains matching text is included as a separate entry, with matching portions wrapped in `<b>` tags. For example, searching for `Health` might return: [`Community <b>Health</b> Plan`, `<b>Health</b> Partners`].",
"items": {
"type": "string"
},
"type": "array"
},
"primaryPayerId": {
"description": "The part of the primary payer ID that matched the search query. For example, if you search for '12345', the results for a payer with primary payer ID `12345ABC` would return: `<b>12345</b>ABC`.",
"type": "string"
},
"stediId": {
"description": "The part of the payer's Stedi payer ID that matched the search query. Stedi payer IDs only support exact substring matching (no prefix or fuzzy matching). For example, if you search for `KRP`, the results for a payer with Stedi payer ID 'KRPCH' would be: `<b>KRP</b>CH`.",
"type": "string"
}
},
"type": "object"
},
"NotSupportedBreakdown": {
"properties": {
"total": {
"description": "Total number of matching payers that don't support this transaction type.",
"minimum": 0,
"type": "integer"
}
},
"required": [
"total"
],
"type": "object"
},
"OperatingStateCode": {
"description": "US state codes, territories, or `NATIONAL` indicating the geographic regions where a payer operates. When set to `NATIONAL`, the payer operates throughout the entire United States.",
"enum": [
"AL",
"AK",
"AZ",
"AR",
"CA",
"CO",
"CT",
"DE",
"FL",
"GA",
"HI",
"ID",
"IL",
"IN",
"IA",
"KS",
"KY",
"LA",
"ME",
"MD",
"MA",
"MI",
"MN",
"MS",
"MO",
"MT",
"NE",
"NV",
"NH",
"NJ",
"NM",
"NY",
"NC",
"ND",
"OH",
"OK",
"OR",
"PA",
"RI",
"SC",
"SD",
"TN",
"TX",
"UT",
"VT",
"VA",
"WA",
"WV",
"WI",
"WY",
"DC",
"PR",
"VI",
"GU",
"AS",
"MP",
"NATIONAL"
],
"type": "string"
},
"PayerRecord": {
"properties": {
"aliases": {
"description": "Alternative IDs associated with a payer. If a payer changes their `primaryPayerId`, aliases allow you to continue sending transactions to the payer using the old ID uninterrupted.",
"items": {
"type": "string"
},
"type": "array"
},
"avatarUrl": {
"description": "A URL pointing to an image file (`.png`, `.jpeg`, or `.jpg`) with the payer's logo. This is the same logo Stedi displays in the [Payer Network](https://www.stedi.com/healthcare/network). You can use this property to display payer logos in your system or application.\n\nThis property is only returned when a payer logo is available.",
"type": "string"
},
"coverageTypes": {
"description": "A list of insurance coverage types that indicates whether this payer supports transactions for medical coverage, dental coverage, vision coverage, or a combination of these. For example: `[\"medical\"]` or `[\"medical\", \"dental\"]`.\n\nWhen this array isn't in the response, it means Stedi hasn't classified the payer's coverage types yet, **not** that the payer doesn't support any coverage types.",
"items": {
"$ref": "#/components/schemas/CoverageType"
},
"type": "array"
},
"displayName": {
"description": "The payer's business name, such as Cigna or Aetna. This is the name most commonly used to identify the payer.",
"type": "string"
},
"employerIdentificationNumbers": {
"description": "Employer Identification Numbers (EINs) associated with this payer.",
"items": {
"description": "A valid Employer Identification Number (EIN) in the format XX-XXXXXXX",
"pattern": "^[0-9]{2}-[0-9]{7}$",
"type": "string"
},
"type": "array"
},
"enrollment": {
"$ref": "#/components/schemas/EnrollmentInfo",
"description": "Details about the [transaction enrollment process](https://www.stedi.com/docs/healthcare/transaction-enrollment) for this payer, if available. This object may not be returned for some payers."
},
"names": {
"description": "Alternative names associated with a payer. These additional names help you search for and identify payers using the name most familiar to your organization.",
"items": {
"type": "string"
},
"type": "array"
},
"operatingStates": {
"description": "A list of US state codes, territories, or `NATIONAL` that indicates the geographic regions where this payer operates. For example: `[\"CA\", \"OR\"]` for a regional payer, or `[\"NATIONAL\"]` for a payer that operates throughout the entire United States.\n\nWhen this array isn't in the response, it means Stedi hasn't classified the payer's operating states yet.",
"items": {
"$ref": "#/components/schemas/OperatingStateCode"
},
"type": "array"
},
"parentPayerGroupId": {
"description": "The payer's parent payer group entity. This is metadata Stedi uses internally. It doesn't necessarily relate to the payer's enrollment process or other capabilities.",
"type": "string"
},
"primaryPayerId": {
"description": "The most commonly used ID for a payer. This value often corresponds to the name the payer uses internally and provides to patients on member ID cards.",
"type": "string"
},
"stediId": {
"description": "A unique ID that Stedi assigned to this payer and uses internally for routing requests. This ID will not change even if the `primaryPayerId` is updated.",
"type": "string"
},
"transactionSupport": {
"$ref": "#/components/schemas/TransactionSupport"
},
"urls": {
"$ref": "#/components/schemas/PayerUrls",
"description": "URLs associated with this payer, such as their website. This object is only returned when URL information is available for the payer."
}
},
"required": [
"aliases",
"displayName",
"names",
"primaryPayerId",
"stediId",
"transactionSupport"
],
"type": "object"
},
"PayerUrls": {
"description": "URLs associated with a payer.",
"properties": {
"website": {
"description": "The payer's website URL.",
"type": "string"
}
},
"type": "object"
},
"ProfessionalClaimEnrollmentProcess": {
"description": "Details about the enrollment process for professional claim submission.",
"properties": {
"requestedEffectiveDate": {
"$ref": "#/components/schemas/RequestedEffectiveDate",
"description": "Whether this payer supports specifying a requested effective date for transaction enrollments.\n - If set to `SUPPORTED`, Stedi will process [transaction enrollment requests](https://www.stedi.com/docs/healthcare/api-reference/post-enrollment-create-enrollment) for this payer according to their specified `requestedEffectiveDate`.\n - This property is only returned when Stedi can determine whether the payer supports requested effective dates."
},
"timeframe": {
"$ref": "#/components/schemas/EnrollmentProcessTimeframe"
},
"type": {
"$ref": "#/components/schemas/EnrollmentProcessType"
}
},
"type": "object"
},
"RequestedEffectiveDate": {
"description": "Whether a payer supports specifying a requested effective date for transaction enrollments.",
"enum": [
"SUPPORTED",
"NOT_SUPPORTED"
],
"type": "string"
},
"ResourceNotFoundExceptionResponseContent": {
"description": "The server response when the specified resource cannot be found after an API request passes authentication and authorization.",
"properties": {
"code": {
"description": "Error classification code",
"type": "string"
},
"message": {
"description": "Human-readable error message",
"type": "string"
}
},
"required": [
"message"
],
"type": "object"
},
"SearchPayerRecord": {
"properties": {
"aliases": {
"description": "Alternative IDs associated with a payer. If a payer changes their `primaryPayerId`, aliases allow you to continue sending transactions to the payer using the old ID uninterrupted.",
"items": {
"type": "string"
},
"type": "array"
},
"avatarUrl": {
"description": "A URL pointing to an image file (`.png`, `.jpeg`, or `.jpg`) with the payer's logo. This is the same logo Stedi displays in the [Payer Network](https://www.stedi.com/healthcare/network). You can use this property to display payer logos in your system or application.\n\nThis property is only returned when a payer logo is available.",
"type": "string"
},
"coverageTypes": {
"description": "A list of insurance coverage types that indicates whether this payer supports transactions for medical coverage, dental coverage, vision coverage, or a combination of these. For example: `[\"medical\"]` or `[\"medical\", \"dental\", \"vision\"]`.\n\nWhen this array isn't in the response, it means Stedi hasn't classified the payer's coverage types yet, **not** that the payer doesn't support any coverage types.",
"items": {
"$ref": "#/components/schemas/CoverageType"
},
"type": "array"
},
"displayName": {
"description": "The payer's business name, such as Cigna or Aetna. This is the name most commonly used to identify the payer.",
"type": "string"
},
"employerIdentificationNumbers": {
"description": "Employer Identification Numbers (EINs) associated with this payer.",
"items": {
"description": "A valid Employer Identification Number (EIN) in the format XX-XXXXXXX",
"pattern": "^[0-9]{2}-[0-9]{7}$",
"type": "string"
},
"type": "array"
},
"enrollment": {
"$ref": "#/components/schemas/EnrollmentInfo",
"description": "Information about the [transaction enrollment process](https://www.stedi.com/docs/healthcare/transaction-enrollment) for this payer."
},
"names": {
"description": "Alternative names associated with a payer. These additional names help you search for and identify payers using the name most familiar to your organization.",
"items": {
"type": "string"
},
"type": "array"
},
"operatingStates": {
"description": "A list of US state codes, territories, or `NATIONAL` that indicates the geographic regions where this payer operates. For example: `[\"CA\", \"OR\"]` for a regional payer, or `[\"NATIONAL\"]` for a payer that operates throughout the entire United States.\n\nWhen this array isn't in the response, it means Stedi hasn't classified the payer's operating states yet.",
"items": {
"$ref": "#/components/schemas/OperatingStateCode"
},
"type": "array"
},
"parentPayerGroupId": {
"description": "The parent payer group entity this payer belongs to. This is for metadata purposes and doesn't necessarily relate to the payer's enrollment process or other capabilities.",
"type": "string"
},
"primaryPayerId": {
"description": "The most commonly used ID for a payer. This value often corresponds to the name the payer uses internally and provides to patients on member ID cards.",
"type": "string"
},
"stediId": {
"description": "A unique ID that Stedi assigned to this payer and uses internally for routing requests. This ID will not change even if the `primaryPayerId` is updated.",
"type": "string"
},
"transactionSupport": {
"$ref": "#/components/schemas/SearchPayerTransactionSupport"
},
"urls": {
"$ref": "#/components/schemas/PayerUrls",
"description": "URLs associated with this payer, such as their website. This object is only returned when URL information is available for the payer."
}
},
"required": [
"aliases",
"displayName",
"names",
"primaryPayerId",
"stediId",
"transactionSupport"
],
"type": "object"
},
"SearchPayerTransactionSupport": {
"description": "Whether the following transaction types are supported: 270 eligibility checks, 276/277 claim status requests, 837 claims (professional, dental, institutional), 835 ERAs (claim payments), 275 unsolicited claim attachments, and coordination of benefits checks.\n\nIf the value is `ENROLLMENT_REQUIRED`, Stedi supports the transaction type, but you must [enroll with the payer](https://www.stedi.com/docs/healthcare/supported-payers#enrollment) first.",
"properties": {
"claimPayment": {
"$ref": "#/components/schemas/TransactionSupportValue",
"description": "Whether you can receive 835 Electronic Remittance Advice (ERA) transactions from this payer."
},
"claimStatus": {
"$ref": "#/components/schemas/TransactionSupportValue",
"description": "Whether you can send 276 claim status requests to this payer."
},
"coordinationOfBenefits": {
"$ref": "#/components/schemas/TransactionSupportValue",
"description": "Coordination of Benefits (COB) support."
},
"dentalClaimSubmission": {
"$ref": "#/components/schemas/TransactionSupportValue",
"description": "Whether you can send 837D dental claims to this payer."
},
"eligibilityCheck": {
"$ref": "#/components/schemas/TransactionSupportValue",
"description": "Whether you can send 270 eligibility checks to this payer."
},
"institutionalClaimSubmission": {
"$ref": "#/components/schemas/TransactionSupportValue",
"description": "Whether you can send 837I institutional claims to this payer."
},
"professionalClaimSubmission": {
"$ref": "#/components/schemas/TransactionSupportValue",
"description": "Whether you can send 837P professional claims to this payer."
},
"unsolicitedClaimAttachment": {
"$ref": "#/components/schemas/TransactionSupportValue",
"description": "Whether you can send unsolicited claim attachments to this payer."
}
},
"required": [
"claimPayment",
"claimStatus",
"coordinationOfBenefits",
"dentalClaimSubmission",
"eligibilityCheck",
"institutionalClaimSubmission",
"professionalClaimSubmission",
"unsolicitedClaimAttachment"
],
"type": "object"
},
"SearchPayersResponseContent": {
"description": "Common output structure for list operations with pagination support.",
"properties": {
"items": {
"description": "Matching payers sorted by relevance, with the most relevant matches listed first.",
"items": {
"$ref": "#/components/schemas/SearchResult"
},
"type": "array"
},
"nextPageToken": {
"description": "Token that you can supply in subsequent requests to retrieve the next page of results. If not returned, there are no more results.",
"maxLength": 1024,
"minLength": 1,
"type": "string"
},
"stats": {
"$ref": "#/components/schemas/SearchResultsStats",
"description": "Statistics about the search results, including the total number of payers matching the search query and the number of payers supported per transaction type."
}
},
"required": [
"items",
"stats"
],
"type": "object"
},
"SearchResult": {
"properties": {
"matches": {
"$ref": "#/components/schemas/Matches",
"description": "Shows which properties in the payer record match the search query. This information helps you understand why Stedi returned this payer and which parts of the payer record matched the search terms. It's also especially useful for debugging search queries and building user interfaces that display matching text.\n- Matching text is wrapped in `<b>` HTML tags for highlighting.\n- This object only contains properties with matching text. For example, if none of the payer's aliases matched the search query, this object will not include the `aliases` property."
},
"payer": {
"$ref": "#/components/schemas/SearchPayerRecord",
"description": "A payer record matching the search query."
},
"score": {
"deprecated": true,
"description": "A relevance score indicating how well this payer matched the search query. Higher scores are better matches. The minimum score is 0.",
"format": "double",
"type": "number"
}
},
"required": [
"payer",
"score"
],
"type": "object"
},
"SearchResultsStats": {
"properties": {
"total": {
"description": "Total number of payers matching the search query.",
"minimum": 0,
"type": "integer"
},
"transactionSupport": {
"$ref": "#/components/schemas/TransactionSupportStats",
"deprecated": true,
"description": "Number of matching payers supported per transaction type.\n\nThe categories for each transaction type are mutually exclusive. For example, to calculate the total number of payers that support eligibility checks, regardless of whether enrollment is required, you must add the `supported` and `enrollmentRequired` counts together.\n\n**DEPRECATED**\nThis shape is deprecated since 2025-06-24: Use the `transactionSupportCounts` property instead."
},
"transactionSupportCounts": {
"$ref": "#/components/schemas/TransactionSupportCounts",
"description": "Number of matching payers for each supported transaction type.\n\nTo get the total number of payers that support each transaction type, with additional detail on whether enrollment is required, use `supported.total` instead."
}
},
"required": [
"total",
"transactionSupport",
"transactionSupportCounts"
],
"type": "object"
},
"SupportedAggregationType": {
"description": "Aggregation types a payer supports for 835 Electronic Remittance Advice (ERA) transactions. Payers can aggregate by the provider's NPI, tax ID (TIN), or both.\n\nYou can use this information to specify an `aggregationPreference` when submitting ERA enrollment requests.",
"enum": [
"NPI",
"TIN"
],
"type": "string"
},
"SupportedBreakdown": {
"properties": {
"enrollmentNotRequired": {
"description": "Number of matching payers that support this transaction type and don't require transaction enrollment.",
"minimum": 0,
"type": "integer"
},
"enrollmentRequired": {
"description": "Number of matching payers that support this transaction type and require [transaction enrollment](https://www.stedi.com/docs/healthcare/transaction-enrollment).",
"minimum": 0,
"type": "integer"
},
"total": {
"description": "Total number of matching payers that support this transaction type (`enrollmentRequired` + `enrollmentNotRequired`).",
"minimum": 0,
"type": "integer"
}
},
"required": [
"enrollmentNotRequired",
"enrollmentRequired",
"total"
],
"type": "object"
},
"TransactionEnrollmentProcesses": {
"description": "Information about the transaction enrollment requirements and expected timeframes for each transaction type.",
"properties": {
"claimPayment": {
"$ref": "#/components/schemas/ClaimPaymentEnrollmentProcess",
"description": "Details about the enrollment process for Electronic Remittance Advice (ERAs) with this payer."
},
"claimStatusInquiry": {
"$ref": "#/components/schemas/ClaimStatusInquiryEnrollmentProcess",
"description": "Details about the enrollment process for real-time claim status requests with this payer."
},
"coordinationOfBenefits": {
"$ref": "#/components/schemas/CoordinationOfBenefitsEnrollmentProcess",
"description": "Details about the enrollment process for coordination of benefits (COB) checks with this payer."
},
"dentalClaim": {
"$ref": "#/components/schemas/DentalClaimEnrollmentProcess",
"description": "Details about the enrollment process for dental claim submission with this payer."
},
"eligibilityInquiry": {
"$ref": "#/components/schemas/EligibilityInquiryEnrollmentProcess",
"description": "Details about the enrollment process for eligibility checks with this payer."
},
"institutionalClaim": {
"$ref": "#/components/schemas/InstitutionalClaimEnrollmentProcess",
"description": "Details about the enrollment process for institutional claim submission with this payer."
},
"professionalClaim": {
"$ref": "#/components/schemas/ProfessionalClaimEnrollmentProcess",
"description": "Details about the enrollment process for professional claim submission with this payer."
},
"unsolicitedClaimAttachment": {
"$ref": "#/components/schemas/UnsolicitedClaimAttachmentEnrollmentProcess",
"description": "Details about the enrollment process for unsolicited claim attachments with this payer."
}
},
"type": "object"
},
"TransactionFilterValue": {
"description": "Transaction support filter values. When multiple transaction filters are specified, they are combined with AND logic (payers must satisfy **all** criteria).",
"enum": [
"SUPPORTED",
"NOT_SUPPORTED",
"ENROLLMENT_REQUIRED",
"EITHER"
],
"type": "string"
},
"TransactionSupport": {
"description": "Whether the following transaction types are supported: 270 eligibility checks, 276 claim status requests, 837 professional claims, and 835 ERAs (claim payments). If the value is `ENROLLMENT_REQUIRED`, Stedi supports the transaction type, but you must [enroll with the payer](https://www.stedi.com/docs/healthcare/supported-payers#enrollment) first.",
"properties": {
"claimPayment": {
"$ref": "#/components/schemas/TransactionSupportValue",
"description": "Whether you can receive 835 Electronic Remittance Advice (ERA) transactions from this payer."
},
"claimStatus": {
"$ref": "#/components/schemas/TransactionSupportValue",
"description": "Whether you can send 276 claim status requests to this payer."
},
"claimSubmission": {
"$ref": "#/components/schemas/TransactionSupportValue",
"deprecated": true,
"description": "Whether you can send 837 professional claims to this payer.\nThis shape is deprecated since 2024-11-13: This `claimSubmission` property is deprecated and will be removed in a future release. Instead, use the `professionalClaimSubmission` property."
},
"coordinationOfBenefits": {
"$ref": "#/components/schemas/TransactionSupportValue",
"description": "Coordination of Benefits (COB) support."
},
"dentalClaimSubmission": {
"$ref": "#/components/schemas/TransactionSupportValue",
"description": "Whether you can send 837p dental claims to this payer."
},
"eligibilityCheck": {
"$ref": "#/components/schemas/TransactionSupportValue",
"description": "Whether you can send 270 eligibility checks to this payer."
},
"institutionalClaimSubmission": {
"$ref": "#/components/schemas/TransactionSupportValue",
"description": "Whether you can send 837i institutional claims to this payer."
},
"professionalClaimSubmission": {
"$ref": "#/components/schemas/TransactionSupportValue",
"description": "Whether you can send 837p professional claims to this payer."
},
"unsolicitedClaimAttachment": {
"$ref": "#/components/schemas/TransactionSupportValue",
"description": "Whether you can send unsolicited claim attachments to this payer."
}
},
"required": [
"claimPayment",
"claimStatus",
"claimSubmission",
"coordinationOfBenefits",
"dentalClaimSubmission",
"eligibilityCheck",
"institutionalClaimSubmission",
"professionalClaimSubmission",
"unsolicitedClaimAttachment"
],
"type": "object"
},
"TransactionSupportCounts": {
"properties": {
"claimPayment": {
"$ref": "#/components/schemas/TransactionSupportCountsItem",
"description": "Number of matching payers that support 835 Electronic Remittance Advices (ERAs)."
},
"claimStatus": {
"$ref": "#/components/schemas/TransactionSupportCountsItem",
"description": "Number of matching payers that support 276/277 real-time claim status."
},
"coordinationOfBenefits": {
"$ref": "#/components/schemas/TransactionSupportCountsItem",
"description": "Number of matching payers that support 270/271 coordination of benefits (COB) checks."
},
"dentalClaimSubmission": {
"$ref": "#/components/schemas/TransactionSupportCountsItem",
"description": "Number of matching payers that support 837D dental claims."
},
"eligibilityCheck": {
"$ref": "#/components/schemas/TransactionSupportCountsItem",
"description": "Number of matching payers that support 270/271 eligibility checks."
},
"institutionalClaimSubmission": {
"$ref": "#/components/schemas/TransactionSupportCountsItem",
"description": "Number of matching payers that support 837I institutional claims."
},
"professionalClaimSubmission": {
"$ref": "#/components/schemas/TransactionSupportCountsItem",
"description": "Number of matching payers that support 837P professional claims."
},
"unsolicitedClaimAttachment": {
"$ref": "#/components/schemas/TransactionSupportCountsItem",
"description": "Number of matching payers that support 275 unsolicited claim attachments."
}
},
"required": [
"claimPayment",
"claimStatus",
"coordinationOfBenefits",
"dentalClaimSubmission",
"eligibilityCheck",
"institutionalClaimSubmission",
"professionalClaimSubmission",
"unsolicitedClaimAttachment"
],
"type": "object"
},
"TransactionSupportCountsItem": {
"properties": {
"notSupported": {
"$ref": "#/components/schemas/NotSupportedBreakdown",
"description": "Number of matching payers that don't support this transaction type."
},
"supported": {
"$ref": "#/components/schemas/SupportedBreakdown",
"description": "Number of matching payers that support this transaction type, broken down by enrollment requirements."
}
},
"required": [
"notSupported",
"supported"
],
"type": "object"
},
"TransactionSupportStats": {
"properties": {
"claimPayment": {
"$ref": "#/components/schemas/TransactionSupportStatsItem",
"description": "Number of matching payers that support 835 Electronic Remittance Advices (ERAs)."
},
"claimStatus": {
"$ref": "#/components/schemas/TransactionSupportStatsItem",
"description": "Number of matching payers that support 276/277 real-time claim status."
},
"coordinationOfBenefits": {
"$ref": "#/components/schemas/TransactionSupportStatsItem",
"description": "Number of matching payers that support 270/271 coordination of benefits (COB) checks."
},
"dentalClaimSubmission": {
"$ref": "#/components/schemas/TransactionSupportStatsItem",
"description": "Number of matching payers that support 837D dental claims."
},
"eligibilityCheck": {
"$ref": "#/components/schemas/TransactionSupportStatsItem",
"description": "Number of matching payers that support 270/271 eligibility checks."
},
"institutionalClaimSubmission": {
"$ref": "#/components/schemas/TransactionSupportStatsItem",
"description": "Number of matching payers that support 837I institutional claims."
},
"professionalClaimSubmission": {
"$ref": "#/components/schemas/TransactionSupportStatsItem",
"description": "Number of matching payers that support 837P professional claims."
},
"unsolicitedClaimAttachment": {
"$ref": "#/components/schemas/TransactionSupportStatsItem",
"description": "Number of matching payers that support 275 unsolicited claim attachments."
}
},
"required": [
"claimPayment",
"claimStatus",
"coordinationOfBenefits",
"dentalClaimSubmission",
"eligibilityCheck",
"institutionalClaimSubmission",
"professionalClaimSubmission",
"unsolicitedClaimAttachment"
],
"type": "object"
},
"TransactionSupportStatsItem": {
"properties": {
"enrollmentRequired": {
"description": "Number of matching payers that require [transaction enrollment](https://www.stedi.com/docs/healthcare/transaction-enrollment) for this transaction type.",
"minimum": 0,
"type": "integer"
},
"notSupported": {
"description": "Number of matching payers that don't support this transaction type.",
"minimum": 0,
"type": "integer"
},
"supported": {
"description": "Number of matching payers that support this transaction type.",
"minimum": 0,
"type": "integer"
}
},
"required": [
"enrollmentRequired",
"notSupported",
"supported"
],
"type": "object"
},
"TransactionSupportValue": {
"enum": [
"SUPPORTED",
"NOT_SUPPORTED",
"ENROLLMENT_REQUIRED"
],
"type": "string"
},
"UnauthorizedExceptionResponseContent": {
"description": "The server response when the authorizer failed to authenticate the caller.",
"properties": {
"code": {
"description": "Error classification code",
"type": "string"
},
"message": {
"description": "Human-readable error message",
"type": "string"
}
},
"required": [
"message"
],
"type": "object"
},
"UnsolicitedClaimAttachmentEnrollmentProcess": {
"description": "Details about the enrollment process for unsolicited claim attachments.",
"properties": {
"requestedEffectiveDate": {
"$ref": "#/components/schemas/RequestedEffectiveDate",
"description": "Whether this payer supports specifying a requested effective date for transaction enrollments.\n - If set to `SUPPORTED`, Stedi will process [transaction enrollment requests](https://www.stedi.com/docs/healthcare/api-reference/post-enrollment-create-enrollment) for this payer according to their specified `requestedEffectiveDate`.\n - This property is only returned when Stedi can determine whether the payer supports requested effective dates."
},
"timeframe": {
"$ref": "#/components/schemas/EnrollmentProcessTimeframe"
},
"type": {
"$ref": "#/components/schemas/EnrollmentProcessType"
}
},
"type": "object"
},
"ValidationExceptionField": {
"description": "Describes one specific validation failure for an input member.",
"properties": {
"message": {
"description": "A detailed description of the validation failure.",
"type": "string"
},
"path": {
"description": "A JSONPointer expression to the structure member whose value failed to satisfy the modeled constraints.",
"type": "string"
}
},
"required": [
"message",
"path"
],
"type": "object"
},
"ValidationExceptionResponseContent": {
"description": "A standard error for input validation failures.\nThis should be thrown by services when a member of the input structure\nfalls outside of the modeled or documented constraints.",
"properties": {
"fieldList": {
"description": "A list of specific failures encountered while validating the input.\nA member can appear in this list more than once if it failed to satisfy multiple constraints.",
"items": {
"$ref": "#/components/schemas/ValidationExceptionField"
},
"type": "array"
},
"message": {
"description": "A summary of the validation failure.",
"type": "string"
}
},
"required": [
"message"
],
"type": "object"
}
},
"securitySchemes": {
"httpApiKeyAuth": {
"description": "A [Stedi API Key](https://portal.stedi.com/app/settings/api-keys) for authentication.",
"in": "header",