samplehc 0.16.0__py3-none-any.whl → 0.18.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (150) hide show
  1. samplehc/_client.py +1 -38
  2. samplehc/_version.py +1 -1
  3. samplehc/resources/__init__.py +0 -14
  4. samplehc/resources/v2/__init__.py +0 -98
  5. samplehc/resources/v2/async_results.py +0 -79
  6. samplehc/resources/v2/documents/__init__.py +0 -14
  7. samplehc/resources/v2/documents/documents.py +0 -194
  8. samplehc/resources/v2/v2.py +0 -224
  9. samplehc/types/__init__.py +0 -5
  10. samplehc/types/v2/__init__.py +0 -53
  11. samplehc/types/v2/documents/__init__.py +0 -3
  12. {samplehc-0.16.0.dist-info → samplehc-0.18.0.dist-info}/METADATA +22 -27
  13. samplehc-0.18.0.dist-info/RECORD +92 -0
  14. samplehc/resources/v1/__init__.py +0 -19
  15. samplehc/resources/v1/v1.py +0 -298
  16. samplehc/resources/v2/clearinghouse/__init__.py +0 -47
  17. samplehc/resources/v2/clearinghouse/claim.py +0 -407
  18. samplehc/resources/v2/clearinghouse/clearinghouse.py +0 -844
  19. samplehc/resources/v2/clearinghouse/payers.py +0 -224
  20. samplehc/resources/v2/documents/pdf_template.py +0 -165
  21. samplehc/resources/v2/hie/__init__.py +0 -47
  22. samplehc/resources/v2/hie/adt.py +0 -249
  23. samplehc/resources/v2/hie/documents.py +0 -390
  24. samplehc/resources/v2/hie/hie.py +0 -134
  25. samplehc/resources/v2/integrations/__init__.py +0 -131
  26. samplehc/resources/v2/integrations/bank/__init__.py +0 -33
  27. samplehc/resources/v2/integrations/bank/bank.py +0 -102
  28. samplehc/resources/v2/integrations/bank/transactions.py +0 -185
  29. samplehc/resources/v2/integrations/careviso.py +0 -372
  30. samplehc/resources/v2/integrations/glidian/__init__.py +0 -33
  31. samplehc/resources/v2/integrations/glidian/glidian.py +0 -425
  32. samplehc/resources/v2/integrations/glidian/prior_authorizations/__init__.py +0 -33
  33. samplehc/resources/v2/integrations/glidian/prior_authorizations/clinical_questions.py +0 -276
  34. samplehc/resources/v2/integrations/glidian/prior_authorizations/prior_authorizations.py +0 -527
  35. samplehc/resources/v2/integrations/integrations.py +0 -326
  36. samplehc/resources/v2/integrations/kno2/__init__.py +0 -33
  37. samplehc/resources/v2/integrations/kno2/kno2.py +0 -102
  38. samplehc/resources/v2/integrations/kno2/messages.py +0 -260
  39. samplehc/resources/v2/integrations/salesforce.py +0 -277
  40. samplehc/resources/v2/integrations/snowflake.py +0 -173
  41. samplehc/resources/v2/integrations/wellsky/__init__.py +0 -33
  42. samplehc/resources/v2/integrations/wellsky/patients.py +0 -324
  43. samplehc/resources/v2/integrations/wellsky/wellsky.py +0 -102
  44. samplehc/resources/v2/integrations/xcures.py +0 -197
  45. samplehc/resources/v2/policies.py +0 -655
  46. samplehc/resources/v2/tasks/__init__.py +0 -33
  47. samplehc/resources/v2/tasks/state.py +0 -266
  48. samplehc/resources/v2/tasks/tasks.py +0 -754
  49. samplehc/resources/v2/workflow_runs/__init__.py +0 -33
  50. samplehc/resources/v2/workflow_runs/step.py +0 -169
  51. samplehc/resources/v2/workflow_runs/workflow_runs.py +0 -479
  52. samplehc/resources/v2/workflows.py +0 -365
  53. samplehc/types/v1/__init__.py +0 -3
  54. samplehc/types/v1_query_audit_logs_params.py +0 -12
  55. samplehc/types/v1_query_audit_logs_response.py +0 -16
  56. samplehc/types/v1_sql_execute_params.py +0 -27
  57. samplehc/types/v1_sql_execute_response.py +0 -27
  58. samplehc/types/v2/async_result_retrieve_response.py +0 -18
  59. samplehc/types/v2/clearinghouse/__init__.py +0 -9
  60. samplehc/types/v2/clearinghouse/claim_submit_params.py +0 -2693
  61. samplehc/types/v2/clearinghouse/claim_submit_response.py +0 -23
  62. samplehc/types/v2/clearinghouse/payer_list_response.py +0 -27
  63. samplehc/types/v2/clearinghouse/payer_search_params.py +0 -12
  64. samplehc/types/v2/clearinghouse/payer_search_response.py +0 -33
  65. samplehc/types/v2/clearinghouse_calculate_patient_cost_params.py +0 -3129
  66. samplehc/types/v2/clearinghouse_check_claim_status_params.py +0 -41
  67. samplehc/types/v2/clearinghouse_check_eligibility_params.py +0 -36
  68. samplehc/types/v2/clearinghouse_check_eligibility_response.py +0 -15
  69. samplehc/types/v2/clearinghouse_coordination_of_benefits_params.py +0 -35
  70. samplehc/types/v2/clearinghouse_run_discovery_params.py +0 -59
  71. samplehc/types/v2/clearinghouse_run_discovery_response.py +0 -13
  72. samplehc/types/v2/document_unzip_async_response.py +0 -12
  73. samplehc/types/v2/document_unzip_response.py +0 -20
  74. samplehc/types/v2/documents/pdf_template_retrieve_metadata_response.py +0 -17
  75. samplehc/types/v2/hie/__init__.py +0 -8
  76. samplehc/types/v2/hie/adt_subscribe_params.py +0 -92
  77. samplehc/types/v2/hie/document_query_params.py +0 -92
  78. samplehc/types/v2/hie/document_query_response.py +0 -16
  79. samplehc/types/v2/hie/document_upload_params.py +0 -54
  80. samplehc/types/v2/integrations/__init__.py +0 -23
  81. samplehc/types/v2/integrations/bank/__init__.py +0 -6
  82. samplehc/types/v2/integrations/bank/transaction_sync_params.py +0 -15
  83. samplehc/types/v2/integrations/bank/transaction_sync_response.py +0 -26
  84. samplehc/types/v2/integrations/careviso_get_payers_response.py +0 -19
  85. samplehc/types/v2/integrations/careviso_submit_prior_authorization_params.py +0 -90
  86. samplehc/types/v2/integrations/glidian/__init__.py +0 -20
  87. samplehc/types/v2/integrations/glidian/prior_authorization_create_draft_params.py +0 -32
  88. samplehc/types/v2/integrations/glidian/prior_authorization_create_draft_response.py +0 -24
  89. samplehc/types/v2/integrations/glidian/prior_authorization_retrieve_record_response.py +0 -13
  90. samplehc/types/v2/integrations/glidian/prior_authorization_submit_response.py +0 -16
  91. samplehc/types/v2/integrations/glidian/prior_authorization_update_record_params.py +0 -20
  92. samplehc/types/v2/integrations/glidian/prior_authorization_update_record_response.py +0 -16
  93. samplehc/types/v2/integrations/glidian/prior_authorizations/__init__.py +0 -7
  94. samplehc/types/v2/integrations/glidian/prior_authorizations/clinical_question_list_response.py +0 -42
  95. samplehc/types/v2/integrations/glidian/prior_authorizations/clinical_question_update_params.py +0 -23
  96. samplehc/types/v2/integrations/glidian/prior_authorizations/clinical_question_update_response.py +0 -19
  97. samplehc/types/v2/integrations/glidian_get_submission_requirements_params.py +0 -17
  98. samplehc/types/v2/integrations/glidian_get_submission_requirements_response.py +0 -31
  99. samplehc/types/v2/integrations/glidian_list_payers_params.py +0 -11
  100. samplehc/types/v2/integrations/glidian_list_payers_response.py +0 -17
  101. samplehc/types/v2/integrations/glidian_list_services_params.py +0 -13
  102. samplehc/types/v2/integrations/glidian_list_services_response.py +0 -19
  103. samplehc/types/v2/integrations/kno2/__init__.py +0 -6
  104. samplehc/types/v2/integrations/kno2/message_get_attachment_response.py +0 -15
  105. samplehc/types/v2/integrations/kno2/message_retrieve_response.py +0 -13
  106. samplehc/types/v2/integrations/salesforce_run_crud_action_params.py +0 -22
  107. samplehc/types/v2/integrations/salesforce_run_soql_query_params.py +0 -11
  108. samplehc/types/v2/integrations/snowflake_query_params.py +0 -12
  109. samplehc/types/v2/integrations/snowflake_query_response.py +0 -8
  110. samplehc/types/v2/integrations/wellsky/__init__.py +0 -6
  111. samplehc/types/v2/integrations/wellsky/patient_add_params.py +0 -13
  112. samplehc/types/v2/integrations/wellsky/patient_search_params.py +0 -32
  113. samplehc/types/v2/integrations/xcure_make_request_params.py +0 -18
  114. samplehc/types/v2/ledger/__init__.py +0 -3
  115. samplehc/types/v2/policy_list_companies_params.py +0 -18
  116. samplehc/types/v2/policy_list_companies_response.py +0 -24
  117. samplehc/types/v2/policy_list_params.py +0 -47
  118. samplehc/types/v2/policy_list_plans_params.py +0 -18
  119. samplehc/types/v2/policy_list_plans_response.py +0 -30
  120. samplehc/types/v2/policy_list_response.py +0 -67
  121. samplehc/types/v2/policy_retrieve_presigned_url_response.py +0 -17
  122. samplehc/types/v2/policy_retrieve_text_response.py +0 -12
  123. samplehc/types/v2/task_cancel_response.py +0 -12
  124. samplehc/types/v2/task_complete_params.py +0 -12
  125. samplehc/types/v2/task_complete_response.py +0 -16
  126. samplehc/types/v2/task_get_suspended_payload_response.py +0 -8
  127. samplehc/types/v2/task_retrieve_response.py +0 -22
  128. samplehc/types/v2/task_retry_response.py +0 -10
  129. samplehc/types/v2/task_update_column_params.py +0 -19
  130. samplehc/types/v2/task_update_column_response.py +0 -9
  131. samplehc/types/v2/task_update_screen_time_params.py +0 -14
  132. samplehc/types/v2/task_update_screen_time_response.py +0 -8
  133. samplehc/types/v2/tasks/__init__.py +0 -7
  134. samplehc/types/v2/tasks/state_get_response.py +0 -8
  135. samplehc/types/v2/tasks/state_update_params.py +0 -13
  136. samplehc/types/v2/tasks/state_update_response.py +0 -9
  137. samplehc/types/v2/workflow_deploy_response.py +0 -12
  138. samplehc/types/v2/workflow_query_params.py +0 -12
  139. samplehc/types/v2/workflow_query_response.py +0 -8
  140. samplehc/types/v2/workflow_run_get_start_data_response.py +0 -14
  141. samplehc/types/v2/workflow_run_resume_when_complete_params.py +0 -14
  142. samplehc/types/v2/workflow_run_resume_when_complete_response.py +0 -12
  143. samplehc/types/v2/workflow_run_retrieve_response.py +0 -16
  144. samplehc/types/v2/workflow_runs/__init__.py +0 -5
  145. samplehc/types/v2/workflow_runs/step_get_output_response.py +0 -14
  146. samplehc/types/v2/workflow_start_params.py +0 -17
  147. samplehc/types/v2/workflow_start_response.py +0 -25
  148. samplehc-0.16.0.dist-info/RECORD +0 -226
  149. {samplehc-0.16.0.dist-info → samplehc-0.18.0.dist-info}/WHEEL +0 -0
  150. {samplehc-0.16.0.dist-info → samplehc-0.18.0.dist-info}/licenses/LICENSE +0 -0
@@ -1,3129 +0,0 @@
1
- # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
-
3
- from __future__ import annotations
4
-
5
- from typing import List, Iterable
6
- from typing_extensions import Literal, Required, Annotated, TypedDict
7
-
8
- from ..._types import SequenceNotStr
9
- from ..._utils import PropertyInfo
10
-
11
- __all__ = [
12
- "ClearinghouseCalculatePatientCostParams",
13
- "EligibilityResponse",
14
- "EligibilityResponseBenefitsInformation",
15
- "EligibilityResponseBenefitsInformationAdditionalInformation",
16
- "EligibilityResponseBenefitsInformationBenefitsAdditionalInformation",
17
- "EligibilityResponseBenefitsInformationBenefitsDateInformation",
18
- "EligibilityResponseBenefitsInformationBenefitsDateInformationAdmission",
19
- "EligibilityResponseBenefitsInformationBenefitsDateInformationDischarge",
20
- "EligibilityResponseBenefitsInformationBenefitsRelatedEntity",
21
- "EligibilityResponseBenefitsInformationBenefitsRelatedEntityAddress",
22
- "EligibilityResponseBenefitsInformationBenefitsRelatedEntityContactInformation",
23
- "EligibilityResponseBenefitsInformationBenefitsRelatedEntityContactInformationContact",
24
- "EligibilityResponseBenefitsInformationBenefitsRelatedEntityProviderInformation",
25
- "EligibilityResponseBenefitsInformationBenefitsServiceDelivery",
26
- "EligibilityResponseBenefitsInformationCompositeMedicalProcedureIdentifier",
27
- "EligibilityResponseBenefitsInformationEligibilityAdditionalInformation",
28
- "EligibilityResponseBenefitsInformationEligibilityAdditionalInformationList",
29
- "EligibilityResponseDependent",
30
- "EligibilityResponseDependentAaaError",
31
- "EligibilityResponseDependentAddress",
32
- "EligibilityResponseDependentHealthCareDiagnosisCode",
33
- "EligibilityResponseDependentResponseProvider",
34
- "EligibilityResponseDependentResponseProviderAaaError",
35
- "EligibilityResponseDependentResponseProviderAddress",
36
- "EligibilityResponseError",
37
- "EligibilityResponseMeta",
38
- "EligibilityResponsePayer",
39
- "EligibilityResponsePayerAaaError",
40
- "EligibilityResponsePayerContactInformation",
41
- "EligibilityResponsePayerContactInformationContact",
42
- "EligibilityResponsePlanDateInformation",
43
- "EligibilityResponsePlanInformation",
44
- "EligibilityResponsePlanStatus",
45
- "EligibilityResponseProvider",
46
- "EligibilityResponseProviderAaaError",
47
- "EligibilityResponseProviderAddress",
48
- "EligibilityResponseSubscriber",
49
- "EligibilityResponseSubscriberAaaError",
50
- "EligibilityResponseSubscriberAddress",
51
- "EligibilityResponseSubscriberHealthCareDiagnosisCode",
52
- "EligibilityResponseSubscriberResponseProvider",
53
- "EligibilityResponseSubscriberResponseProviderAaaError",
54
- "EligibilityResponseSubscriberResponseProviderAddress",
55
- "EligibilityResponseSubscriberTraceNumber",
56
- "EligibilityResponseWarning",
57
- "LineItem",
58
- ]
59
-
60
-
61
- class ClearinghouseCalculatePatientCostParams(TypedDict, total=False):
62
- eligibility_responses: Required[
63
- Annotated[Iterable[EligibilityResponse], PropertyInfo(alias="eligibilityResponses")]
64
- ]
65
- """
66
- The eligibility responses that the patient has in order of preference (primary,
67
- secondary, etc.).
68
- """
69
-
70
- line_items: Required[Annotated[Iterable[LineItem], PropertyInfo(alias="lineItems")]]
71
- """The line items you are estimating the patient cost for"""
72
-
73
-
74
- class EligibilityResponseBenefitsInformationAdditionalInformation(TypedDict, total=False):
75
- description: str
76
-
77
-
78
- class EligibilityResponseBenefitsInformationBenefitsAdditionalInformation(TypedDict, total=False):
79
- alternative_list_id: Annotated[str, PropertyInfo(alias="alternativeListId")]
80
-
81
- coverage_list_id: Annotated[str, PropertyInfo(alias="coverageListId")]
82
-
83
- drug_formulary_number: Annotated[str, PropertyInfo(alias="drugFormularyNumber")]
84
-
85
- family_unit_number: Annotated[str, PropertyInfo(alias="familyUnitNumber")]
86
-
87
- group_description: Annotated[str, PropertyInfo(alias="groupDescription")]
88
-
89
- group_number: Annotated[str, PropertyInfo(alias="groupNumber")]
90
-
91
- hic_number: Annotated[str, PropertyInfo(alias="hicNumber")]
92
-
93
- insurance_policy_number: Annotated[str, PropertyInfo(alias="insurancePolicyNumber")]
94
-
95
- medicaid_recepient_id_number: Annotated[str, PropertyInfo(alias="medicaidRecepientIdNumber")]
96
-
97
- medical_assistance_category: Annotated[str, PropertyInfo(alias="medicalAssistanceCategory")]
98
-
99
- member_id: Annotated[str, PropertyInfo(alias="memberId")]
100
-
101
- plan_description: Annotated[str, PropertyInfo(alias="planDescription")]
102
-
103
- plan_network_description: Annotated[str, PropertyInfo(alias="planNetworkDescription")]
104
-
105
- plan_network_id_number: Annotated[str, PropertyInfo(alias="planNetworkIdNumber")]
106
-
107
- plan_number: Annotated[str, PropertyInfo(alias="planNumber")]
108
-
109
- policy_number: Annotated[str, PropertyInfo(alias="policyNumber")]
110
-
111
- prior_authorization_number: Annotated[str, PropertyInfo(alias="priorAuthorizationNumber")]
112
-
113
- referral_number: Annotated[str, PropertyInfo(alias="referralNumber")]
114
-
115
-
116
- class EligibilityResponseBenefitsInformationBenefitsDateInformationAdmission(TypedDict, total=False):
117
- date: str
118
-
119
- end_date: Annotated[str, PropertyInfo(alias="endDate")]
120
-
121
- start_date: Annotated[str, PropertyInfo(alias="startDate")]
122
-
123
-
124
- class EligibilityResponseBenefitsInformationBenefitsDateInformationDischarge(TypedDict, total=False):
125
- date: str
126
-
127
- end_date: Annotated[str, PropertyInfo(alias="endDate")]
128
-
129
- start_date: Annotated[str, PropertyInfo(alias="startDate")]
130
-
131
-
132
- class EligibilityResponseBenefitsInformationBenefitsDateInformation(TypedDict, total=False):
133
- added: str
134
-
135
- admission: str
136
-
137
- admissions: Iterable[EligibilityResponseBenefitsInformationBenefitsDateInformationAdmission]
138
-
139
- benefit: str
140
-
141
- benefit_begin: Annotated[str, PropertyInfo(alias="benefitBegin")]
142
-
143
- benefit_end: Annotated[str, PropertyInfo(alias="benefitEnd")]
144
-
145
- certification: str
146
-
147
- cobra_begin: Annotated[str, PropertyInfo(alias="cobraBegin")]
148
-
149
- cobra_end: Annotated[str, PropertyInfo(alias="cobraEnd")]
150
-
151
- completion: str
152
-
153
- coordination_of_benefits: Annotated[str, PropertyInfo(alias="coordinationOfBenefits")]
154
-
155
- date_of_death: Annotated[str, PropertyInfo(alias="dateOfDeath")]
156
-
157
- date_of_last_update: Annotated[str, PropertyInfo(alias="dateOfLastUpdate")]
158
-
159
- discharge: str
160
-
161
- discharges: Iterable[EligibilityResponseBenefitsInformationBenefitsDateInformationDischarge]
162
-
163
- effective_date_of_change: Annotated[str, PropertyInfo(alias="effectiveDateOfChange")]
164
-
165
- eligibility: str
166
-
167
- eligibility_begin: Annotated[str, PropertyInfo(alias="eligibilityBegin")]
168
-
169
- eligibility_end: Annotated[str, PropertyInfo(alias="eligibilityEnd")]
170
-
171
- enrollment: str
172
-
173
- issue: str
174
-
175
- latest_visit_or_consultation: Annotated[str, PropertyInfo(alias="latestVisitOrConsultation")]
176
-
177
- period_end: Annotated[str, PropertyInfo(alias="periodEnd")]
178
-
179
- period_start: Annotated[str, PropertyInfo(alias="periodStart")]
180
-
181
- plan: str
182
-
183
- plan_begin: Annotated[str, PropertyInfo(alias="planBegin")]
184
-
185
- plan_end: Annotated[str, PropertyInfo(alias="planEnd")]
186
-
187
- policy_effective: Annotated[str, PropertyInfo(alias="policyEffective")]
188
-
189
- policy_expiration: Annotated[str, PropertyInfo(alias="policyExpiration")]
190
-
191
- premium_paidto_date_begin: Annotated[str, PropertyInfo(alias="premiumPaidtoDateBegin")]
192
-
193
- premium_paid_to_date_end: Annotated[str, PropertyInfo(alias="premiumPaidToDateEnd")]
194
-
195
- primary_care_provider: Annotated[str, PropertyInfo(alias="primaryCareProvider")]
196
-
197
- service: str
198
-
199
- status: str
200
-
201
-
202
- class EligibilityResponseBenefitsInformationBenefitsRelatedEntityAddress(TypedDict, total=False):
203
- address1: str
204
-
205
- address2: str
206
-
207
- city: str
208
-
209
- country_code: Annotated[str, PropertyInfo(alias="countryCode")]
210
-
211
- country_sub_division_code: Annotated[str, PropertyInfo(alias="countrySubDivisionCode")]
212
-
213
- postal_code: Annotated[str, PropertyInfo(alias="postalCode")]
214
-
215
- state: Literal[
216
- "NL",
217
- "PE",
218
- "NS",
219
- "NB",
220
- "QC",
221
- "ON",
222
- "MB",
223
- "SK",
224
- "AB",
225
- "BC",
226
- "YT",
227
- "NT",
228
- "NU",
229
- "DC",
230
- "AS",
231
- "GU",
232
- "MP",
233
- "PR",
234
- "UM",
235
- "VI",
236
- "AK",
237
- "AL",
238
- "AR",
239
- "AZ",
240
- "CA",
241
- "CO",
242
- "CT",
243
- "DE",
244
- "FL",
245
- "GA",
246
- "HI",
247
- "IA",
248
- "ID",
249
- "IL",
250
- "IN",
251
- "KS",
252
- "KY",
253
- "LA",
254
- "MA",
255
- "MD",
256
- "ME",
257
- "MI",
258
- "MN",
259
- "MO",
260
- "MS",
261
- "MT",
262
- "NC",
263
- "ND",
264
- "NE",
265
- "NH",
266
- "NJ",
267
- "NM",
268
- "NV",
269
- "NY",
270
- "OH",
271
- "OK",
272
- "OR",
273
- "PA",
274
- "RI",
275
- "SC",
276
- "SD",
277
- "TN",
278
- "TX",
279
- "UT",
280
- "VA",
281
- "VT",
282
- "WA",
283
- "WI",
284
- "WV",
285
- "WY",
286
- ]
287
-
288
-
289
- class EligibilityResponseBenefitsInformationBenefitsRelatedEntityContactInformationContact(TypedDict, total=False):
290
- communication_mode: Annotated[
291
- Literal[
292
- "Electronic Data Interchange Access Number",
293
- "Electronic Mail",
294
- "Facsimile",
295
- "Telephone",
296
- "Uniform Resource Locator (URL)",
297
- ],
298
- PropertyInfo(alias="communicationMode"),
299
- ]
300
-
301
- communication_number: Annotated[str, PropertyInfo(alias="communicationNumber")]
302
-
303
-
304
- class EligibilityResponseBenefitsInformationBenefitsRelatedEntityContactInformation(TypedDict, total=False):
305
- contacts: Iterable[EligibilityResponseBenefitsInformationBenefitsRelatedEntityContactInformationContact]
306
-
307
- name: str
308
-
309
-
310
- class EligibilityResponseBenefitsInformationBenefitsRelatedEntityProviderInformation(TypedDict, total=False):
311
- provider_code: Annotated[
312
- Literal[
313
- "AD", "AT", "BI", "CO", "CV", "H", "HH", "LA", "OT", "P1", "P2", "PC", "PE", "R", "RF", "SB", "SK", "SU"
314
- ],
315
- PropertyInfo(alias="providerCode"),
316
- ]
317
-
318
- reference_identification: Annotated[str, PropertyInfo(alias="referenceIdentification")]
319
-
320
-
321
- class EligibilityResponseBenefitsInformationBenefitsRelatedEntity(TypedDict, total=False):
322
- address: EligibilityResponseBenefitsInformationBenefitsRelatedEntityAddress
323
-
324
- contact_information: Annotated[
325
- EligibilityResponseBenefitsInformationBenefitsRelatedEntityContactInformation,
326
- PropertyInfo(alias="contactInformation"),
327
- ]
328
-
329
- entity_firstname: Annotated[str, PropertyInfo(alias="entityFirstname")]
330
-
331
- entity_identification: Annotated[
332
- Literal["24", "34", "46", "FA", "FI", "II", "MI", "NI", "PI", "PP", "SV", "XV", "XX"],
333
- PropertyInfo(alias="entityIdentification"),
334
- ]
335
-
336
- entity_identification_value: Annotated[str, PropertyInfo(alias="entityIdentificationValue")]
337
-
338
- entity_identifier: Annotated[
339
- Literal[
340
- "Contracted Service Provider",
341
- "Preferred Provider Organization (PPO)",
342
- "Provider",
343
- "Third-Party Administrator",
344
- "Employer",
345
- "Other Physician",
346
- "Facility",
347
- "Gateway Provider",
348
- "Group",
349
- "Independent Physicians Association (IPA)",
350
- "Insured or Subscriber",
351
- "Legal Representative",
352
- "Origin Carrier",
353
- "Primary Care Provider",
354
- "Prior Insurance Carrier",
355
- "Plan Sponsor",
356
- "Payer",
357
- "Primary Payer",
358
- "Secondary Payer",
359
- "Tertiary Payer",
360
- "Party Performing Verification",
361
- "Vendor",
362
- "Organization Completing Configuration Change",
363
- "Utilization Management Organization",
364
- "Managed Care Organization",
365
- ],
366
- PropertyInfo(alias="entityIdentifier"),
367
- ]
368
-
369
- entity_middlename: Annotated[str, PropertyInfo(alias="entityMiddlename")]
370
-
371
- entity_name: Annotated[str, PropertyInfo(alias="entityName")]
372
-
373
- entity_relationship: Annotated[
374
- Literal["01", "02", "27", "41", "48", "65", "72"], PropertyInfo(alias="entityRelationship")
375
- ]
376
-
377
- entity_suffix: Annotated[str, PropertyInfo(alias="entitySuffix")]
378
-
379
- entity_type: Annotated[Literal["Person", "Non-Person Entity"], PropertyInfo(alias="entityType")]
380
-
381
- provider_information: Annotated[
382
- EligibilityResponseBenefitsInformationBenefitsRelatedEntityProviderInformation,
383
- PropertyInfo(alias="providerInformation"),
384
- ]
385
-
386
-
387
- class EligibilityResponseBenefitsInformationBenefitsServiceDelivery(TypedDict, total=False):
388
- delivery_or_calendar_pattern_code: Annotated[
389
- Literal[
390
- "1st Week of the Month",
391
- "2nd Week of the Month",
392
- "3rd Week of the Month",
393
- "4th Week of the Month",
394
- "5th Week of the Month",
395
- "1st & 3rd Week of the Month",
396
- "2nd & 4th Week of the Month",
397
- "1st Working Day of Period",
398
- "Last Working Day of Period",
399
- "Monday through Friday",
400
- "Monday through Saturday",
401
- "Monday through Sunday",
402
- "Monday",
403
- "Tuesday",
404
- "Wednesday",
405
- "Thursday",
406
- "Friday",
407
- "Saturday",
408
- "Sunday",
409
- "Monday through Thursday",
410
- "Immediately",
411
- "As Directed",
412
- "Daily Mon. Through Fri.",
413
- "1/2 Mon. & 1/2 Tues.",
414
- "1/2 Tues. & 1/2 Thurs.",
415
- "1/2 Wed. & 1/2 Fri.",
416
- "Once Anytime Mon. through Fri.",
417
- "Tuesday through Friday",
418
- "Monday, Tuesday and Thursday",
419
- "Monday, Tuesday and Friday",
420
- "Wednesday and Thursday",
421
- "Monday, Wednesday and Thursday",
422
- "Tuesday, Thursday and Friday",
423
- "1/2 Tues. & 1/2 Fri.",
424
- "1/2 Mon. & 1/2 Wed.",
425
- "1/3 Mon., 1/3 Wed., 1/3 Fri.",
426
- "Whenever Necessary",
427
- "1/2 By Wed. Bal. By Fri.",
428
- "None (Also Used to Cancel or Override a Previous Pattern)",
429
- ],
430
- PropertyInfo(alias="deliveryOrCalendarPatternCode"),
431
- ]
432
-
433
- delivery_or_calendar_pattern_qualifier: Annotated[
434
- Literal[
435
- "1st Week of the Month",
436
- "2nd Week of the Month",
437
- "3rd Week of the Month",
438
- "4th Week of the Month",
439
- "5th Week of the Month",
440
- "1st & 3rd Week of the Month",
441
- "2nd & 4th Week of the Month",
442
- "1st Working Day of Period",
443
- "Last Working Day of Period",
444
- "Monday through Friday",
445
- "Monday through Saturday",
446
- "Monday through Sunday",
447
- "Monday",
448
- "Tuesday",
449
- "Wednesday",
450
- "Thursday",
451
- "Friday",
452
- "Saturday",
453
- "Sunday",
454
- "Monday through Thursday",
455
- "Immediately",
456
- "As Directed",
457
- "Daily Mon. Through Fri.",
458
- "1/2 Mon. & 1/2 Tues.",
459
- "1/2 Tues. & 1/2 Thurs.",
460
- "1/2 Wed. & 1/2 Fri.",
461
- "Once Anytime Mon. through Fri.",
462
- "Tuesday through Friday",
463
- "Monday, Tuesday and Thursday",
464
- "Monday, Tuesday and Friday",
465
- "Wednesday and Thursday",
466
- "Monday, Wednesday and Thursday",
467
- "Tuesday, Thursday and Friday",
468
- "1/2 Tues. & 1/2 Fri.",
469
- "1/2 Mon. & 1/2 Wed.",
470
- "1/3 Mon., 1/3 Wed., 1/3 Fri.",
471
- "Whenever Necessary",
472
- "1/2 By Wed. Bal. By Fri.",
473
- "None (Also Used to Cancel or Override a Previous Pattern)",
474
- ],
475
- PropertyInfo(alias="deliveryOrCalendarPatternQualifier"),
476
- ]
477
-
478
- delivery_or_calendar_pattern_qualifier_code: Annotated[
479
- Literal[
480
- "1",
481
- "2",
482
- "3",
483
- "4",
484
- "5",
485
- "6",
486
- "7",
487
- "8",
488
- "9",
489
- "A",
490
- "B",
491
- "C",
492
- "D",
493
- "E",
494
- "F",
495
- "G",
496
- "H",
497
- "J",
498
- "K",
499
- "L",
500
- "M",
501
- "N",
502
- "O",
503
- "P",
504
- "Q",
505
- "R",
506
- "S",
507
- "SG",
508
- "SL",
509
- "SP",
510
- "SX",
511
- "SY",
512
- "SZ",
513
- "T",
514
- "U",
515
- "V",
516
- "W",
517
- "X",
518
- "Y",
519
- ],
520
- PropertyInfo(alias="deliveryOrCalendarPatternQualifierCode"),
521
- ]
522
-
523
- delivery_pattern_time_code: Annotated[
524
- Literal[
525
- "1st Shift (Normal Working Hours)",
526
- "2nd Shift",
527
- "3rd Shift",
528
- "A.M.",
529
- "P.M.",
530
- "As Directed",
531
- "Any Shift",
532
- "None (Also Used to Cancel or Override a Previous Pattern)",
533
- ],
534
- PropertyInfo(alias="deliveryPatternTimeCode"),
535
- ]
536
-
537
- delivery_pattern_time_qualifier: Annotated[
538
- Literal[
539
- "1st Shift (Normal Working Hours)",
540
- "2nd Shift",
541
- "3rd Shift",
542
- "A.M.",
543
- "P.M.",
544
- "As Directed",
545
- "Any Shift",
546
- "None (Also Used to Cancel or Override a Previous Pattern)",
547
- ],
548
- PropertyInfo(alias="deliveryPatternTimeQualifier"),
549
- ]
550
-
551
- delivery_pattern_time_qualifier_code: Annotated[
552
- Literal["A", "B", "C", "D", "E", "F", "G", "Y"], PropertyInfo(alias="deliveryPatternTimeQualifierCode")
553
- ]
554
-
555
- num_of_periods: Annotated[str, PropertyInfo(alias="numOfPeriods")]
556
-
557
- quantity: str
558
-
559
- quantity_qualifier: Annotated[
560
- Literal["Days", "Units", "Hours", "Month", "Visits"], PropertyInfo(alias="quantityQualifier")
561
- ]
562
-
563
- quantity_qualifier_code: Annotated[
564
- Literal["DY", "FL", "HS", "MN", "VS"], PropertyInfo(alias="quantityQualifierCode")
565
- ]
566
-
567
- sample_selection_modulus: Annotated[str, PropertyInfo(alias="sampleSelectionModulus")]
568
-
569
- time_period_qualifier: Annotated[
570
- Literal[
571
- "Hour",
572
- "Day",
573
- "Years",
574
- "Service Year",
575
- "Calendar Year",
576
- "Year to Date",
577
- "Contract",
578
- "Episode",
579
- "Visit",
580
- "Outlier",
581
- "Remaining",
582
- "Exceeded",
583
- "Not Exceeded",
584
- "Lifetime",
585
- "Lifetime Remaining",
586
- "Month",
587
- "Week",
588
- ],
589
- PropertyInfo(alias="timePeriodQualifier"),
590
- ]
591
-
592
- time_period_qualifier_code: Annotated[
593
- Literal["6", "7", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30", "31", "32", "33", "34", "35"],
594
- PropertyInfo(alias="timePeriodQualifierCode"),
595
- ]
596
-
597
- unit_for_measurement_code: Annotated[
598
- Literal["Days", "Months", "Visits", "Week", "Years"], PropertyInfo(alias="unitForMeasurementCode")
599
- ]
600
-
601
- unit_for_measurement_qualifier: Annotated[
602
- Literal["Days", "Months", "Visits", "Week", "Years"], PropertyInfo(alias="unitForMeasurementQualifier")
603
- ]
604
-
605
- unit_for_measurement_qualifier_code: Annotated[
606
- Literal["DA", "MO", "VS", "WK", "YR"], PropertyInfo(alias="unitForMeasurementQualifierCode")
607
- ]
608
-
609
-
610
- class EligibilityResponseBenefitsInformationCompositeMedicalProcedureIdentifier(TypedDict, total=False):
611
- diagnosis_code_pointer: Annotated[SequenceNotStr[str], PropertyInfo(alias="diagnosisCodePointer")]
612
-
613
- procedure_code: Annotated[str, PropertyInfo(alias="procedureCode")]
614
-
615
- procedure_modifiers: Annotated[SequenceNotStr[str], PropertyInfo(alias="procedureModifiers")]
616
-
617
- product_or_service_id: Annotated[str, PropertyInfo(alias="productOrServiceID")]
618
-
619
- product_or_service_id_qualifier: Annotated[str, PropertyInfo(alias="productOrServiceIdQualifier")]
620
-
621
- product_or_service_id_qualifier_code: Annotated[str, PropertyInfo(alias="productOrServiceIdQualifierCode")]
622
-
623
-
624
- class EligibilityResponseBenefitsInformationEligibilityAdditionalInformation(TypedDict, total=False):
625
- code_category: Annotated[Literal["44"], PropertyInfo(alias="codeCategory")]
626
-
627
- code_list_qualifier: Annotated[str, PropertyInfo(alias="codeListQualifier")]
628
-
629
- code_list_qualifier_code: Annotated[Literal["GR", "NI", "ZZ"], PropertyInfo(alias="codeListQualifierCode")]
630
-
631
- industry: str
632
-
633
- industry_code: Annotated[str, PropertyInfo(alias="industryCode")]
634
-
635
- injured_body_part_name: Annotated[str, PropertyInfo(alias="injuredBodyPartName")]
636
-
637
-
638
- class EligibilityResponseBenefitsInformationEligibilityAdditionalInformationList(TypedDict, total=False):
639
- code_category: Annotated[Literal["44"], PropertyInfo(alias="codeCategory")]
640
-
641
- code_list_qualifier: Annotated[str, PropertyInfo(alias="codeListQualifier")]
642
-
643
- code_list_qualifier_code: Annotated[Literal["GR", "NI", "ZZ"], PropertyInfo(alias="codeListQualifierCode")]
644
-
645
- industry: str
646
-
647
- industry_code: Annotated[str, PropertyInfo(alias="industryCode")]
648
-
649
- injured_body_part_name: Annotated[str, PropertyInfo(alias="injuredBodyPartName")]
650
-
651
-
652
- class EligibilityResponseBenefitsInformation(TypedDict, total=False):
653
- additional_information: Annotated[
654
- Iterable[EligibilityResponseBenefitsInformationAdditionalInformation],
655
- PropertyInfo(alias="additionalInformation"),
656
- ]
657
-
658
- auth_or_cert_indicator: Annotated[Literal["N", "U", "Y"], PropertyInfo(alias="authOrCertIndicator")]
659
-
660
- benefit_amount: Annotated[str, PropertyInfo(alias="benefitAmount")]
661
-
662
- benefit_percent: Annotated[str, PropertyInfo(alias="benefitPercent")]
663
-
664
- benefit_quantity: Annotated[str, PropertyInfo(alias="benefitQuantity")]
665
-
666
- benefits_additional_information: Annotated[
667
- EligibilityResponseBenefitsInformationBenefitsAdditionalInformation,
668
- PropertyInfo(alias="benefitsAdditionalInformation"),
669
- ]
670
-
671
- benefits_date_information: Annotated[
672
- EligibilityResponseBenefitsInformationBenefitsDateInformation, PropertyInfo(alias="benefitsDateInformation")
673
- ]
674
-
675
- benefits_related_entities: Annotated[
676
- Iterable[EligibilityResponseBenefitsInformationBenefitsRelatedEntity],
677
- PropertyInfo(alias="benefitsRelatedEntities"),
678
- ]
679
-
680
- benefits_related_entity: Annotated[
681
- EligibilityResponseBenefitsInformationBenefitsRelatedEntity, PropertyInfo(alias="benefitsRelatedEntity")
682
- ]
683
-
684
- benefits_service_delivery: Annotated[
685
- Iterable[EligibilityResponseBenefitsInformationBenefitsServiceDelivery],
686
- PropertyInfo(alias="benefitsServiceDelivery"),
687
- ]
688
-
689
- code: Literal[
690
- "1",
691
- "2",
692
- "3",
693
- "4",
694
- "5",
695
- "6",
696
- "7",
697
- "8",
698
- "A",
699
- "B",
700
- "C",
701
- "CB",
702
- "D",
703
- "E",
704
- "F",
705
- "G",
706
- "H",
707
- "I",
708
- "J",
709
- "K",
710
- "L",
711
- "M",
712
- "MC",
713
- "N",
714
- "O",
715
- "P",
716
- "Q",
717
- "R",
718
- "S",
719
- "T",
720
- "U",
721
- "V",
722
- "W",
723
- "X",
724
- "Y",
725
- ]
726
-
727
- composite_medical_procedure_identifier: Annotated[
728
- EligibilityResponseBenefitsInformationCompositeMedicalProcedureIdentifier,
729
- PropertyInfo(alias="compositeMedicalProcedureIdentifier"),
730
- ]
731
-
732
- coverage_level: Annotated[
733
- Literal[
734
- "Children Only",
735
- "Dependents Only",
736
- "Employee and Children",
737
- "Employee Only",
738
- "Employee and Spouse",
739
- "Family",
740
- "Individual",
741
- "Spouse and Children",
742
- "Spouse Only",
743
- ],
744
- PropertyInfo(alias="coverageLevel"),
745
- ]
746
-
747
- coverage_level_code: Annotated[
748
- Literal["CHD", "DEP", "ECH", "EMP", "ESP", "FAM", "IND", "SPC", "SPO"], PropertyInfo(alias="coverageLevelCode")
749
- ]
750
-
751
- eligibility_additional_information: Annotated[
752
- EligibilityResponseBenefitsInformationEligibilityAdditionalInformation,
753
- PropertyInfo(alias="eligibilityAdditionalInformation"),
754
- ]
755
-
756
- eligibility_additional_information_list: Annotated[
757
- Iterable[EligibilityResponseBenefitsInformationEligibilityAdditionalInformationList],
758
- PropertyInfo(alias="eligibilityAdditionalInformationList"),
759
- ]
760
-
761
- header_loop_identifier_code: Annotated[str, PropertyInfo(alias="headerLoopIdentifierCode")]
762
-
763
- in_plan_network_indicator: Annotated[
764
- Literal["Yes", "No", "Unknown", "Not Applicable"], PropertyInfo(alias="inPlanNetworkIndicator")
765
- ]
766
-
767
- in_plan_network_indicator_code: Annotated[
768
- Literal["Y", "N", "U", "W"], PropertyInfo(alias="inPlanNetworkIndicatorCode")
769
- ]
770
-
771
- insurance_type: Annotated[
772
- Literal[
773
- "Medicare Secondary Working Aged Beneficiary or Spouse with Employer Group Health Plan",
774
- "Medicare Secondary End-Stage Renal Disease Beneficiary in the Mandated Coordination Period with an Employer's Group Health Plan",
775
- "Medicare Secondary, No-fault Insurance including Auto is Primary",
776
- "Medicare Secondary Worker's Compensation",
777
- "Medicare Secondary Public Health Service (PHS)or Other Federal Agency",
778
- "Medicare Secondary Black Lung",
779
- "Medicare Secondary Veteran's Administration",
780
- "Medicare Secondary Disabled Beneficiary Under Age 65 with Large Group Health Plan (LGHP)",
781
- "Medicare Secondary, Other Liability Insurance is Primary",
782
- "Auto Insurance Policy",
783
- "Commercial",
784
- "Consolidated Omnibus Budget Reconciliation Act (COBRA)",
785
- "Medicare Conditionally Primary",
786
- "Disability",
787
- "Disability Benefits",
788
- "Exclusive Provider Organization",
789
- "Family or Friends",
790
- "Group Policy",
791
- "Health Maintenance Organization (HMO)",
792
- "Health Maintenance Organization (HMO) - Medicare Risk",
793
- "Special Low Income Medicare Beneficiary",
794
- "Indemnity",
795
- "Individual Policy",
796
- "Long Term Care",
797
- "Long Term Policy",
798
- "Life Insurance",
799
- "Litigation",
800
- "Medicare Part A",
801
- "Medicare Part B",
802
- "Medicaid",
803
- "Medigap Part A",
804
- "Medigap Part B",
805
- "Medicare Primary",
806
- "Other",
807
- "Property Insurance - Personal",
808
- "Personal",
809
- "Personal Payment (Cash - No Insurance)",
810
- "Preferred Provider Organization (PPO)",
811
- "Point of Service (POS)",
812
- "Qualified Medicare Beneficiary",
813
- "Property Insurance - Real",
814
- "Supplemental Policy",
815
- "Tax Equity Fiscal Responsibility Act (TEFRA)",
816
- "Workers Compensation",
817
- "Wrap Up Policy",
818
- ],
819
- PropertyInfo(alias="insuranceType"),
820
- ]
821
-
822
- insurance_type_code: Annotated[
823
- Literal[
824
- "12",
825
- "13",
826
- "14",
827
- "15",
828
- "16",
829
- "41",
830
- "42",
831
- "43",
832
- "47",
833
- "AP",
834
- "C1",
835
- "CO",
836
- "CP",
837
- "D",
838
- "DB",
839
- "EP",
840
- "FF",
841
- "GP",
842
- "HM",
843
- "HN",
844
- "HS",
845
- "IN",
846
- "IP",
847
- "LC",
848
- "LD",
849
- "LI",
850
- "LT",
851
- "MA",
852
- "MB",
853
- "MC",
854
- "MH",
855
- "MI",
856
- "MP",
857
- "OT",
858
- "PE",
859
- "PL",
860
- "PP",
861
- "PR",
862
- "PS",
863
- "QM",
864
- "RP",
865
- "SP",
866
- "TF",
867
- "WC",
868
- "WU",
869
- ],
870
- PropertyInfo(alias="insuranceTypeCode"),
871
- ]
872
-
873
- name: Literal[
874
- "Active Coverage",
875
- "Active - Full Risk Capitation",
876
- "Active - Services Capitated",
877
- "Active - Services Capitated to Primary Care Physician",
878
- "Active - Pending Investigation",
879
- "Inactive",
880
- "Inactive - Pending Eligibility Update",
881
- "Inactive - Pending Investigation",
882
- "Co-Insurance",
883
- "Co-Payment",
884
- "Deductible",
885
- "Coverage Basis",
886
- "Benefit Description",
887
- "Exclusions",
888
- "Limitations",
889
- "Out of Pocket (Stop Loss)",
890
- "Unlimited",
891
- "Non-Covered",
892
- "Cost Containment",
893
- "Reserve",
894
- "Primary Care Provider",
895
- "Pre-existing Condition",
896
- "Managed Care Coordinator",
897
- "Services Restricted to Following Provider",
898
- "Not Deemed a Medical Necessity",
899
- "Benefit Disclaimer",
900
- "Second Surgical Opinion Required",
901
- "Other or Additional Payor",
902
- "Prior Year(s) History",
903
- "Card(s) Reported Lost/Stolen",
904
- "Contact Following Entity for Eligibility or Benefit Information",
905
- "Cannot Process",
906
- "Other Source of Data",
907
- "Health Care Facility",
908
- "Spend Down",
909
- ]
910
-
911
- plan_coverage: Annotated[str, PropertyInfo(alias="planCoverage")]
912
-
913
- quantity_qualifier: Annotated[
914
- Literal[
915
- "Minimum",
916
- "Quantity Used",
917
- "Covered - Actual",
918
- "Covered - Estimated",
919
- "Number of Co-insurance Days",
920
- "Deductible Blood Units",
921
- "Days",
922
- "Hours",
923
- "Life-time Reserve - Actual",
924
- "Life-time Reserve - Estimated",
925
- "Maximum",
926
- "Month",
927
- "Number of Services or Procedures",
928
- "Quantity Approved",
929
- "Age, High Value",
930
- "Age, Low Value",
931
- "Visits",
932
- "Years",
933
- ],
934
- PropertyInfo(alias="quantityQualifier"),
935
- ]
936
-
937
- quantity_qualifier_code: Annotated[
938
- Literal[
939
- "8H", "99", "CA", "CE", "D3", "DB", "DY", "HS", "LA", "LE", "M2", "MN", "P6", "QA", "S7", "S8", "VS", "YY"
940
- ],
941
- PropertyInfo(alias="quantityQualifierCode"),
942
- ]
943
-
944
- service_type_codes: Annotated[
945
- List[
946
- Literal[
947
- "1",
948
- "2",
949
- "3",
950
- "4",
951
- "5",
952
- "6",
953
- "7",
954
- "8",
955
- "9",
956
- "10",
957
- "11",
958
- "12",
959
- "13",
960
- "14",
961
- "15",
962
- "16",
963
- "17",
964
- "18",
965
- "19",
966
- "20",
967
- "21",
968
- "22",
969
- "23",
970
- "24",
971
- "25",
972
- "26",
973
- "27",
974
- "28",
975
- "30",
976
- "32",
977
- "33",
978
- "34",
979
- "35",
980
- "36",
981
- "37",
982
- "38",
983
- "39",
984
- "40",
985
- "41",
986
- "42",
987
- "43",
988
- "44",
989
- "45",
990
- "46",
991
- "47",
992
- "48",
993
- "49",
994
- "50",
995
- "51",
996
- "52",
997
- "53",
998
- "54",
999
- "55",
1000
- "56",
1001
- "57",
1002
- "58",
1003
- "59",
1004
- "60",
1005
- "61",
1006
- "62",
1007
- "63",
1008
- "64",
1009
- "65",
1010
- "66",
1011
- "67",
1012
- "68",
1013
- "69",
1014
- "70",
1015
- "71",
1016
- "72",
1017
- "73",
1018
- "74",
1019
- "75",
1020
- "76",
1021
- "77",
1022
- "78",
1023
- "79",
1024
- "80",
1025
- "81",
1026
- "82",
1027
- "83",
1028
- "84",
1029
- "85",
1030
- "86",
1031
- "87",
1032
- "88",
1033
- "89",
1034
- "90",
1035
- "91",
1036
- "92",
1037
- "93",
1038
- "94",
1039
- "95",
1040
- "96",
1041
- "97",
1042
- "98",
1043
- "99",
1044
- "A0",
1045
- "A1",
1046
- "A2",
1047
- "A3",
1048
- "A4",
1049
- "A5",
1050
- "A6",
1051
- "A7",
1052
- "A8",
1053
- "A9",
1054
- "AA",
1055
- "AB",
1056
- "AC",
1057
- "AD",
1058
- "AE",
1059
- "AF",
1060
- "AG",
1061
- "AH",
1062
- "AI",
1063
- "AJ",
1064
- "AK",
1065
- "AL",
1066
- "AM",
1067
- "AN",
1068
- "AO",
1069
- "AQ",
1070
- "AR",
1071
- "B1",
1072
- "B2",
1073
- "B3",
1074
- "BA",
1075
- "BB",
1076
- "BC",
1077
- "BD",
1078
- "BE",
1079
- "BF",
1080
- "BG",
1081
- "BH",
1082
- "BI",
1083
- "BJ",
1084
- "BK",
1085
- "BL",
1086
- "BM",
1087
- "BN",
1088
- "BP",
1089
- "BQ",
1090
- "BR",
1091
- "BS",
1092
- "BT",
1093
- "BU",
1094
- "BV",
1095
- "BW",
1096
- "BX",
1097
- "BY",
1098
- "BZ",
1099
- "C1",
1100
- "CA",
1101
- "CB",
1102
- "CC",
1103
- "CD",
1104
- "CE",
1105
- "CF",
1106
- "CG",
1107
- "CH",
1108
- "CI",
1109
- "CJ",
1110
- "CK",
1111
- "CL",
1112
- "CM",
1113
- "CN",
1114
- "CO",
1115
- "CP",
1116
- "CQ",
1117
- "DG",
1118
- "DM",
1119
- "DS",
1120
- "GF",
1121
- "GN",
1122
- "GY",
1123
- "IC",
1124
- "MH",
1125
- "NI",
1126
- "ON",
1127
- "PT",
1128
- "PU",
1129
- "RN",
1130
- "RT",
1131
- "TC",
1132
- "TN",
1133
- "UC",
1134
- ]
1135
- ],
1136
- PropertyInfo(alias="serviceTypeCodes"),
1137
- ]
1138
-
1139
- service_types: Annotated[
1140
- List[
1141
- Literal[
1142
- "Medical Care",
1143
- "Surgical",
1144
- "Consultation",
1145
- "Diagnostic X-Ray",
1146
- "Diagnostic Lab",
1147
- "Radiation Therapy",
1148
- "Anesthesia",
1149
- "Surgical Assistance",
1150
- "Other Medical",
1151
- "Blood Charges",
1152
- "Used Durable Medical Equipment",
1153
- "Durable Medical Equipment Purchase",
1154
- "Ambulatory Service Center Facility",
1155
- "Renal Supplies in the Home",
1156
- "Alternate Method Dialysis",
1157
- "Chronic Renal Disease (CRD) Equipment",
1158
- "Pre-Admission Testing",
1159
- "Durable Medical Equipment Rental",
1160
- "Pneumonia Vaccine",
1161
- "Second Surgical Opinion",
1162
- "Third Surgical Opinion",
1163
- "Social Work",
1164
- "Diagnostic Dental",
1165
- "Periodontics",
1166
- "Restorative",
1167
- "Endodontics",
1168
- "Maxillofacial Prosthetics",
1169
- "Adjunctive Dental Services",
1170
- "Health Benefit Plan Coverage",
1171
- "Plan Waiting Period",
1172
- "Chiropractic",
1173
- "Chiropractic Office Visits",
1174
- "Dental Care",
1175
- "Dental Crowns",
1176
- "Dental Accident",
1177
- "Orthodontics",
1178
- "Prosthodontics",
1179
- "Oral Surgery",
1180
- "Routine (Preventive) Dental",
1181
- "Home Health Care",
1182
- "Home Health Prescriptions",
1183
- "Home Health Visits",
1184
- "Hospice",
1185
- "Respite Care",
1186
- "Hospital",
1187
- "Hospital - Inpatient",
1188
- "Hospital - Room and Board",
1189
- "Hospital - Outpatient",
1190
- "Hospital - Emergency Accident",
1191
- "Hospital - Emergency Medical",
1192
- "Hospital - Ambulatory Surgical",
1193
- "Long Term Care",
1194
- "Major Medical",
1195
- "Medically Related Transportation",
1196
- "Air Transportation",
1197
- "Cabulance",
1198
- "Licensed Ambulance",
1199
- "General Benefits",
1200
- "In-vitro Fertilization",
1201
- "MRI/CAT Scan",
1202
- "Donor Procedures",
1203
- "Acupuncture",
1204
- "Newborn Care",
1205
- "Pathology",
1206
- "Smoking Cessation",
1207
- "Well Baby Care",
1208
- "Maternity",
1209
- "Transplants",
1210
- "Audiology Exam",
1211
- "Inhalation Therapy",
1212
- "Diagnostic Medical",
1213
- "Private Duty Nursing",
1214
- "Prosthetic Device",
1215
- "Dialysis",
1216
- "Otological Exam",
1217
- "Chemotherapy",
1218
- "Allergy Testing",
1219
- "Immunizations",
1220
- "Routine Physical",
1221
- "Family Planning",
1222
- "Infertility",
1223
- "Abortion",
1224
- "AIDS",
1225
- "Emergency Services",
1226
- "Cancer",
1227
- "Pharmacy",
1228
- "Free Standing Prescription Drug",
1229
- "Mail Order Prescription Drug",
1230
- "Brand Name Prescription Drug",
1231
- "Generic Prescription Drug",
1232
- "Podiatry",
1233
- "Podiatry - Office Visits",
1234
- "Podiatry - Nursing Home Visits",
1235
- "Professional (Physician)",
1236
- "Anesthesiologist",
1237
- "Professional (Physician) Visit - Office",
1238
- "Professional (Physician) Visit - Inpatient",
1239
- "Professional (Physician) Visit - Outpatient",
1240
- "Professional (Physician) Visit - Nursing Home",
1241
- "Professional (Physician) Visit - Skilled Nursing Facility",
1242
- "Professional (Physician) Visit - Home",
1243
- "Psychiatric",
1244
- "Psychiatric - Room and Board",
1245
- "Psychotherapy",
1246
- "Psychiatric - Inpatient",
1247
- "Psychiatric - Outpatient",
1248
- "Rehabilitation",
1249
- "Rehabilitation - Room and Board",
1250
- "Rehabilitation - Inpatient",
1251
- "Rehabilitation - Outpatient",
1252
- "Occupational Therapy",
1253
- "Physical Medicine",
1254
- "Speech Therapy",
1255
- "Skilled Nursing Care",
1256
- "Skilled Nursing Care - Room and Board",
1257
- "Substance Abuse",
1258
- "Alcoholism",
1259
- "Drug Addiction",
1260
- "Vision (Optometry)",
1261
- "Frames",
1262
- "Routine Exam",
1263
- "Lenses",
1264
- "Nonmedically Necessary Physical",
1265
- "Experimental Drug Therapy",
1266
- "Burn Care",
1267
- "Brand Name Prescription Drug - Formulary",
1268
- "Brand Name Prescription Drug - Non-Formulary",
1269
- "Independent Medical Evaluation",
1270
- "Partial Hospitalization (Psychiatric)",
1271
- "Day Care (Psychiatric)",
1272
- "Cognitive Therapy",
1273
- "Massage Therapy",
1274
- "Pulmonary Rehabilitation",
1275
- "Cardiac Rehabilitation",
1276
- "Pediatric",
1277
- "Nursery",
1278
- "Skin",
1279
- "Orthopedic",
1280
- "Cardiac",
1281
- "Lymphatic",
1282
- "Gastrointestinal",
1283
- "Endocrine",
1284
- "Neurology",
1285
- "Eye",
1286
- "Invasive Procedures",
1287
- "Gynecological",
1288
- "Obstetrical",
1289
- "Obstetrical/Gynecological",
1290
- "Mail Order Prescription Drug - Formulary",
1291
- "Mail Order Prescription Drug - Non-Formulary",
1292
- "Physician Visit - Office: Sick",
1293
- "Physician Visit - Office: Well",
1294
- "Coronary Care",
1295
- "Private Duty Nursing - Inpatient",
1296
- "Private Duty Nursing - Home",
1297
- "Surgical Benefits - Professional (Physician)",
1298
- "Surgical Benefits - Facility",
1299
- "Mental Health Provider- Inpatient",
1300
- "Mental Health Provider - Outpatient",
1301
- "Mental Health Facility - Inpatient",
1302
- "Mental Health Facility - Outpatient",
1303
- "Substance Abuse Facility - Inpatient",
1304
- "Substance Abuse Facility - Outpatient",
1305
- "Screening X-ray",
1306
- "Screening laboratory",
1307
- "Mammogram, High Risk Patient",
1308
- "Mammogram, Low Risk Patient",
1309
- "Flu Vaccination",
1310
- "Eyewear and Eyewear Accessories",
1311
- "Case Management",
1312
- "Dermatology",
1313
- "Durable Medical Equipment",
1314
- "Diabetic Supplies",
1315
- "Generic Prescription Drug - Formulary",
1316
- "Generic Prescription Drug - Non-Formulary",
1317
- "Allergy",
1318
- "Intensive Care",
1319
- "Mental Health",
1320
- "Neonatol Intensive Care",
1321
- "Oncology",
1322
- "Physical Therapy",
1323
- "Pulmonary",
1324
- "Renal",
1325
- "Residential Psychiatric Treatment",
1326
- "Transitional Care",
1327
- "Transitional Nursery Care",
1328
- "Urgent Care",
1329
- ]
1330
- ],
1331
- PropertyInfo(alias="serviceTypes"),
1332
- ]
1333
-
1334
- time_qualifier: Annotated[
1335
- Literal[
1336
- "Hour",
1337
- "Day",
1338
- "24 Hours",
1339
- "Years",
1340
- "Service Year",
1341
- "Calendar Year",
1342
- "Year to Date",
1343
- "Contract",
1344
- "Episode",
1345
- "Visit",
1346
- "Outlier",
1347
- "Remaining",
1348
- "Exceeded",
1349
- "Not Exceeded",
1350
- "Lifetime",
1351
- "Lifetime Remaining",
1352
- "Month",
1353
- "Week",
1354
- "Admission",
1355
- ],
1356
- PropertyInfo(alias="timeQualifier"),
1357
- ]
1358
-
1359
- time_qualifier_code: Annotated[
1360
- Literal[
1361
- "6",
1362
- "7",
1363
- "13",
1364
- "21",
1365
- "22",
1366
- "23",
1367
- "24",
1368
- "25",
1369
- "26",
1370
- "27",
1371
- "28",
1372
- "29",
1373
- "30",
1374
- "31",
1375
- "32",
1376
- "33",
1377
- "34",
1378
- "35",
1379
- "36",
1380
- ],
1381
- PropertyInfo(alias="timeQualifierCode"),
1382
- ]
1383
-
1384
- trailer_loop_identifier_code: Annotated[str, PropertyInfo(alias="trailerLoopIdentifierCode")]
1385
-
1386
-
1387
- class EligibilityResponseDependentAaaError(TypedDict, total=False):
1388
- code: Literal[
1389
- "15",
1390
- "33",
1391
- "35",
1392
- "42",
1393
- "43",
1394
- "45",
1395
- "47",
1396
- "48",
1397
- "49",
1398
- "51",
1399
- "52",
1400
- "53",
1401
- "54",
1402
- "55",
1403
- "56",
1404
- "57",
1405
- "58",
1406
- "60",
1407
- "61",
1408
- "62",
1409
- "63",
1410
- "64",
1411
- "65",
1412
- "66",
1413
- "67",
1414
- "68",
1415
- "69",
1416
- "70",
1417
- "71",
1418
- "77",
1419
- "98",
1420
- "AA",
1421
- "AE",
1422
- "AF",
1423
- "AG",
1424
- "AO",
1425
- "CI",
1426
- "E8",
1427
- "IA",
1428
- "MA",
1429
- ]
1430
-
1431
- description: str
1432
-
1433
- field: str
1434
-
1435
- followup_action: Annotated[
1436
- Literal[
1437
- "Please Correct and Resubmit",
1438
- "Resubmission Not Allowed",
1439
- "Resubmission Allowed",
1440
- "Do Not Resubmit; Inquiry Initiated to a Third Party",
1441
- "Please Wait 30 Days and Resubmit",
1442
- "Please Wait 10 Days and Resubmit",
1443
- "Do Not Resubmit; We Will Hold Your Request and Respond Again Shortly",
1444
- ],
1445
- PropertyInfo(alias="followupAction"),
1446
- ]
1447
-
1448
- location: str
1449
-
1450
- possible_resolutions: Annotated[str, PropertyInfo(alias="possibleResolutions")]
1451
-
1452
-
1453
- class EligibilityResponseDependentAddress(TypedDict, total=False):
1454
- address1: str
1455
-
1456
- address2: str
1457
-
1458
- city: str
1459
-
1460
- country_code: Annotated[str, PropertyInfo(alias="countryCode")]
1461
-
1462
- country_sub_division_code: Annotated[str, PropertyInfo(alias="countrySubDivisionCode")]
1463
-
1464
- postal_code: Annotated[str, PropertyInfo(alias="postalCode")]
1465
-
1466
- state: Literal[
1467
- "NL",
1468
- "PE",
1469
- "NS",
1470
- "NB",
1471
- "QC",
1472
- "ON",
1473
- "MB",
1474
- "SK",
1475
- "AB",
1476
- "BC",
1477
- "YT",
1478
- "NT",
1479
- "NU",
1480
- "DC",
1481
- "AS",
1482
- "GU",
1483
- "MP",
1484
- "PR",
1485
- "UM",
1486
- "VI",
1487
- "AK",
1488
- "AL",
1489
- "AR",
1490
- "AZ",
1491
- "CA",
1492
- "CO",
1493
- "CT",
1494
- "DE",
1495
- "FL",
1496
- "GA",
1497
- "HI",
1498
- "IA",
1499
- "ID",
1500
- "IL",
1501
- "IN",
1502
- "KS",
1503
- "KY",
1504
- "LA",
1505
- "MA",
1506
- "MD",
1507
- "ME",
1508
- "MI",
1509
- "MN",
1510
- "MO",
1511
- "MS",
1512
- "MT",
1513
- "NC",
1514
- "ND",
1515
- "NE",
1516
- "NH",
1517
- "NJ",
1518
- "NM",
1519
- "NV",
1520
- "NY",
1521
- "OH",
1522
- "OK",
1523
- "OR",
1524
- "PA",
1525
- "RI",
1526
- "SC",
1527
- "SD",
1528
- "TN",
1529
- "TX",
1530
- "UT",
1531
- "VA",
1532
- "VT",
1533
- "WA",
1534
- "WI",
1535
- "WV",
1536
- "WY",
1537
- ]
1538
-
1539
-
1540
- class EligibilityResponseDependentHealthCareDiagnosisCode(TypedDict, total=False):
1541
- diagnosis_code: Annotated[str, PropertyInfo(alias="diagnosisCode")]
1542
-
1543
- diagnosis_type_code: Annotated[str, PropertyInfo(alias="diagnosisTypeCode")]
1544
-
1545
-
1546
- class EligibilityResponseDependentResponseProviderAaaError(TypedDict, total=False):
1547
- code: Literal["15", "41", "43", "44", "45", "46", "47", "48", "50", "51", "79", "97", "T4"]
1548
-
1549
- description: str
1550
-
1551
- field: str
1552
-
1553
- followup_action: Annotated[
1554
- Literal[
1555
- "Please Correct and Resubmit",
1556
- "Resubmission Not Allowed",
1557
- "Resubmission Allowed",
1558
- "Do Not Resubmit; Inquiry Initiated to a Third Party",
1559
- "Please Wait 30 Days and Resubmit",
1560
- "Please Wait 10 Days and Resubmit",
1561
- "Do Not Resubmit; We Will Hold Your Request and Respond Again Shortly",
1562
- ],
1563
- PropertyInfo(alias="followupAction"),
1564
- ]
1565
-
1566
- location: str
1567
-
1568
- possible_resolutions: Annotated[str, PropertyInfo(alias="possibleResolutions")]
1569
-
1570
-
1571
- class EligibilityResponseDependentResponseProviderAddress(TypedDict, total=False):
1572
- address1: str
1573
-
1574
- address2: str
1575
-
1576
- city: str
1577
-
1578
- country_code: Annotated[str, PropertyInfo(alias="countryCode")]
1579
-
1580
- country_sub_division_code: Annotated[str, PropertyInfo(alias="countrySubDivisionCode")]
1581
-
1582
- postal_code: Annotated[str, PropertyInfo(alias="postalCode")]
1583
-
1584
- state: Literal[
1585
- "NL",
1586
- "PE",
1587
- "NS",
1588
- "NB",
1589
- "QC",
1590
- "ON",
1591
- "MB",
1592
- "SK",
1593
- "AB",
1594
- "BC",
1595
- "YT",
1596
- "NT",
1597
- "NU",
1598
- "DC",
1599
- "AS",
1600
- "GU",
1601
- "MP",
1602
- "PR",
1603
- "UM",
1604
- "VI",
1605
- "AK",
1606
- "AL",
1607
- "AR",
1608
- "AZ",
1609
- "CA",
1610
- "CO",
1611
- "CT",
1612
- "DE",
1613
- "FL",
1614
- "GA",
1615
- "HI",
1616
- "IA",
1617
- "ID",
1618
- "IL",
1619
- "IN",
1620
- "KS",
1621
- "KY",
1622
- "LA",
1623
- "MA",
1624
- "MD",
1625
- "ME",
1626
- "MI",
1627
- "MN",
1628
- "MO",
1629
- "MS",
1630
- "MT",
1631
- "NC",
1632
- "ND",
1633
- "NE",
1634
- "NH",
1635
- "NJ",
1636
- "NM",
1637
- "NV",
1638
- "NY",
1639
- "OH",
1640
- "OK",
1641
- "OR",
1642
- "PA",
1643
- "RI",
1644
- "SC",
1645
- "SD",
1646
- "TN",
1647
- "TX",
1648
- "UT",
1649
- "VA",
1650
- "VT",
1651
- "WA",
1652
- "WI",
1653
- "WV",
1654
- "WY",
1655
- ]
1656
-
1657
-
1658
- class EligibilityResponseDependentResponseProvider(TypedDict, total=False):
1659
- aaa_errors: Annotated[
1660
- Iterable[EligibilityResponseDependentResponseProviderAaaError], PropertyInfo(alias="aaaErrors")
1661
- ]
1662
-
1663
- address: EligibilityResponseDependentResponseProviderAddress
1664
-
1665
- employers_id: Annotated[str, PropertyInfo(alias="employersId")]
1666
-
1667
- entity_identifier: Annotated[
1668
- Literal[
1669
- "Provider",
1670
- "Third-Party Administrator",
1671
- "Employer",
1672
- "Hospital",
1673
- "Facility",
1674
- "Gateway Provider",
1675
- "Plan Sponsor",
1676
- "Payer",
1677
- ],
1678
- PropertyInfo(alias="entityIdentifier"),
1679
- ]
1680
-
1681
- entity_type: Annotated[Literal["Person", "Non-Person Entity"], PropertyInfo(alias="entityType")]
1682
-
1683
- federal_taxpayers_id_number: Annotated[str, PropertyInfo(alias="federalTaxpayersIdNumber")]
1684
-
1685
- middle_name: Annotated[str, PropertyInfo(alias="middleName")]
1686
-
1687
- npi: str
1688
-
1689
- payor_identification: Annotated[str, PropertyInfo(alias="payorIdentification")]
1690
-
1691
- pharmacy_processor_number: Annotated[str, PropertyInfo(alias="pharmacyProcessorNumber")]
1692
-
1693
- provider_code: Annotated[
1694
- Literal[
1695
- "AD", "AT", "BI", "CO", "CV", "H", "HH", "LA", "OT", "P1", "P2", "PC", "PE", "R", "RF", "SB", "SK", "SU"
1696
- ],
1697
- PropertyInfo(alias="providerCode"),
1698
- ]
1699
-
1700
- provider_first_name: Annotated[str, PropertyInfo(alias="providerFirstName")]
1701
-
1702
- provider_name: Annotated[str, PropertyInfo(alias="providerName")]
1703
-
1704
- provider_org_name: Annotated[str, PropertyInfo(alias="providerOrgName")]
1705
-
1706
- reference_identification: Annotated[str, PropertyInfo(alias="referenceIdentification")]
1707
-
1708
- service_provider_number: Annotated[str, PropertyInfo(alias="serviceProviderNumber")]
1709
-
1710
- services_plan_id: Annotated[str, PropertyInfo(alias="servicesPlanID")]
1711
-
1712
- ssn: str
1713
-
1714
- suffix: str
1715
-
1716
-
1717
- class EligibilityResponseDependent(TypedDict, total=False):
1718
- aaa_errors: Annotated[Iterable[EligibilityResponseDependentAaaError], PropertyInfo(alias="aaaErrors")]
1719
-
1720
- address: EligibilityResponseDependentAddress
1721
-
1722
- birth_sequence_number: Annotated[str, PropertyInfo(alias="birthSequenceNumber")]
1723
-
1724
- date_of_birth: Annotated[str, PropertyInfo(alias="dateOfBirth")]
1725
-
1726
- date_time_period: Annotated[str, PropertyInfo(alias="dateTimePeriod")]
1727
-
1728
- date_time_period_format_qualifier: Annotated[
1729
- Literal["D8", "RD8"], PropertyInfo(alias="dateTimePeriodFormatQualifier")
1730
- ]
1731
-
1732
- description: str
1733
-
1734
- employment_status_code: Annotated[
1735
- Literal["AE", "AO", "AS", "AT", "AU", "CC", "DD", "HD", "IR", "LX", "PE", "RE", "RM", "RR", "RU"],
1736
- PropertyInfo(alias="employmentStatusCode"),
1737
- ]
1738
-
1739
- end_date_time_period: Annotated[str, PropertyInfo(alias="endDateTimePeriod")]
1740
-
1741
- entity_identifier: Annotated[Literal["Dependent"], PropertyInfo(alias="entityIdentifier")]
1742
-
1743
- entity_type: Annotated[Literal["Person", "Non-Person Entity"], PropertyInfo(alias="entityType")]
1744
-
1745
- first_name: Annotated[str, PropertyInfo(alias="firstName")]
1746
-
1747
- gender: Literal["M", "F", "U"]
1748
-
1749
- government_service_affiliation_code: Annotated[
1750
- Literal["A", "B", "C", "D", "E", "F", "G", "H", "I", "J", "K", "L", "M", "N", "O", "Q", "R", "S", "U", "W"],
1751
- PropertyInfo(alias="governmentServiceAffiliationCode"),
1752
- ]
1753
-
1754
- group_description: Annotated[str, PropertyInfo(alias="groupDescription")]
1755
-
1756
- group_number: Annotated[str, PropertyInfo(alias="groupNumber")]
1757
-
1758
- health_care_diagnosis_codes: Annotated[
1759
- Iterable[EligibilityResponseDependentHealthCareDiagnosisCode], PropertyInfo(alias="healthCareDiagnosisCodes")
1760
- ]
1761
-
1762
- information_status_code: Annotated[
1763
- Literal["A", "C", "L", "O", "P", "S", "T"], PropertyInfo(alias="informationStatusCode")
1764
- ]
1765
-
1766
- insured_indicator: Annotated[Literal["N"], PropertyInfo(alias="insuredIndicator")]
1767
-
1768
- last_name: Annotated[str, PropertyInfo(alias="lastName")]
1769
-
1770
- maintenance_reason_code: Annotated[Literal["25"], PropertyInfo(alias="maintenanceReasonCode")]
1771
-
1772
- maintenance_type_code: Annotated[Literal["001"], PropertyInfo(alias="maintenanceTypeCode")]
1773
-
1774
- member_id: Annotated[str, PropertyInfo(alias="memberId")]
1775
-
1776
- middle_name: Annotated[str, PropertyInfo(alias="middleName")]
1777
-
1778
- military_service_rank_code: Annotated[
1779
- Literal[
1780
- "A1",
1781
- "A2",
1782
- "A3",
1783
- "B1",
1784
- "B2",
1785
- "C1",
1786
- "C2",
1787
- "C3",
1788
- "C4",
1789
- "C5",
1790
- "C6",
1791
- "C7",
1792
- "C8",
1793
- "C9",
1794
- "E1",
1795
- "F1",
1796
- "F2",
1797
- "F3",
1798
- "F4",
1799
- "G1",
1800
- "G4",
1801
- "L1",
1802
- "L2",
1803
- "L3",
1804
- "L4",
1805
- "L5",
1806
- "L6",
1807
- "M1",
1808
- "M2",
1809
- "M3",
1810
- "M4",
1811
- "M5",
1812
- "M6",
1813
- "P1",
1814
- "P2",
1815
- "P3",
1816
- "P4",
1817
- "P5",
1818
- "R1",
1819
- "R2",
1820
- "S1",
1821
- "S2",
1822
- "S3",
1823
- "S4",
1824
- "S5",
1825
- "S6",
1826
- "S7",
1827
- "S8",
1828
- "S9",
1829
- "SA",
1830
- "SB",
1831
- "SC",
1832
- "T1",
1833
- "V1",
1834
- "W1",
1835
- ],
1836
- PropertyInfo(alias="militaryServiceRankCode"),
1837
- ]
1838
-
1839
- plan_description: Annotated[str, PropertyInfo(alias="planDescription")]
1840
-
1841
- plan_network_description: Annotated[str, PropertyInfo(alias="planNetworkDescription")]
1842
-
1843
- plan_network_id_number: Annotated[str, PropertyInfo(alias="planNetworkIdNumber")]
1844
-
1845
- plan_number: Annotated[str, PropertyInfo(alias="planNumber")]
1846
-
1847
- relation_to_subscriber: Annotated[
1848
- Literal[
1849
- "Spouse",
1850
- "Child",
1851
- "Employee",
1852
- "Unknown",
1853
- "Organ Donor",
1854
- "Cadaver Donor",
1855
- "Life Partner",
1856
- "Other Relationship",
1857
- ],
1858
- PropertyInfo(alias="relationToSubscriber"),
1859
- ]
1860
-
1861
- relation_to_subscriber_code: Annotated[
1862
- Literal["01", "19", "20", "21", "39", "40", "53", "G8", "Unknown"],
1863
- PropertyInfo(alias="relationToSubscriberCode"),
1864
- ]
1865
-
1866
- response_provider: Annotated[EligibilityResponseDependentResponseProvider, PropertyInfo(alias="responseProvider")]
1867
-
1868
- ssn: str
1869
-
1870
- start_date_time_period: Annotated[str, PropertyInfo(alias="startDateTimePeriod")]
1871
-
1872
- suffix: str
1873
-
1874
- unique_health_identifier: Annotated[str, PropertyInfo(alias="uniqueHealthIdentifier")]
1875
-
1876
-
1877
- class EligibilityResponseError(TypedDict, total=False):
1878
- code: Literal[
1879
- "04",
1880
- "15",
1881
- "33",
1882
- "35",
1883
- "41",
1884
- "42",
1885
- "43",
1886
- "44",
1887
- "45",
1888
- "46",
1889
- "47",
1890
- "48",
1891
- "49",
1892
- "50",
1893
- "51",
1894
- "52",
1895
- "53",
1896
- "54",
1897
- "55",
1898
- "56",
1899
- "57",
1900
- "58",
1901
- "60",
1902
- "61",
1903
- "62",
1904
- "63",
1905
- "64",
1906
- "65",
1907
- "66",
1908
- "67",
1909
- "68",
1910
- "69",
1911
- "70",
1912
- "71",
1913
- "72",
1914
- "73",
1915
- "74",
1916
- "75",
1917
- "76",
1918
- "77",
1919
- "78",
1920
- "79",
1921
- "80",
1922
- "97",
1923
- "98",
1924
- "AA",
1925
- "AE",
1926
- "AF",
1927
- "AG",
1928
- "AO",
1929
- "CI",
1930
- "E8",
1931
- "IA",
1932
- "MA",
1933
- "T4",
1934
- ]
1935
-
1936
- description: str
1937
-
1938
- field: str
1939
-
1940
- followup_action: Annotated[
1941
- Literal[
1942
- "Please Correct and Resubmit",
1943
- "Resubmission Not Allowed",
1944
- "Please Resubmit Original Transaction",
1945
- "Resubmission Allowed",
1946
- "Do Not Resubmit; Inquiry Initiated to a Third Party",
1947
- "Please Wait 30 Days and Resubmit",
1948
- "Please Wait 10 Days and Resubmit",
1949
- "Do Not Resubmit; We Will Hold Your Request and Respond Again Shortly",
1950
- ],
1951
- PropertyInfo(alias="followupAction"),
1952
- ]
1953
-
1954
- location: str
1955
-
1956
- possible_resolutions: Annotated[str, PropertyInfo(alias="possibleResolutions")]
1957
-
1958
-
1959
- class EligibilityResponseMeta(TypedDict, total=False):
1960
- application_mode: Annotated[Literal["production", "test", "information"], PropertyInfo(alias="applicationMode")]
1961
-
1962
- biller_id: Annotated[str, PropertyInfo(alias="billerId")]
1963
-
1964
- outbound_trace_id: Annotated[str, PropertyInfo(alias="outboundTraceId")]
1965
-
1966
- sender_id: Annotated[str, PropertyInfo(alias="senderId")]
1967
-
1968
- submitter_id: Annotated[str, PropertyInfo(alias="submitterId")]
1969
-
1970
- trace_id: Annotated[str, PropertyInfo(alias="traceId")]
1971
-
1972
-
1973
- class EligibilityResponsePayerAaaError(TypedDict, total=False):
1974
- code: Literal["04", "41", "42", "79", "80", "T4"]
1975
-
1976
- description: str
1977
-
1978
- field: str
1979
-
1980
- followup_action: Annotated[
1981
- Literal[
1982
- "Please Correct and Resubmit",
1983
- "Resubmission Not Allowed",
1984
- "Please Resubmit Original Transaction",
1985
- "Resubmission Allowed",
1986
- "Do Not Resubmit; Inquiry Initiated to a Third Party",
1987
- "Please Wait 30 Days and Resubmit",
1988
- "Please Wait 10 Days and Resubmit",
1989
- "Do Not Resubmit; We Will Hold Your Request and Respond Again Shortly",
1990
- ],
1991
- PropertyInfo(alias="followupAction"),
1992
- ]
1993
-
1994
- location: str
1995
-
1996
- possible_resolutions: Annotated[str, PropertyInfo(alias="possibleResolutions")]
1997
-
1998
-
1999
- class EligibilityResponsePayerContactInformationContact(TypedDict, total=False):
2000
- communication_mode: Annotated[
2001
- Literal[
2002
- "Electronic Data Interchange Access Number",
2003
- "Electronic Mail",
2004
- "Facsimile",
2005
- "Telephone",
2006
- "Uniform Resource Locator (URL)",
2007
- ],
2008
- PropertyInfo(alias="communicationMode"),
2009
- ]
2010
-
2011
- communication_number: Annotated[str, PropertyInfo(alias="communicationNumber")]
2012
-
2013
-
2014
- class EligibilityResponsePayerContactInformation(TypedDict, total=False):
2015
- contacts: Iterable[EligibilityResponsePayerContactInformationContact]
2016
-
2017
- name: str
2018
-
2019
-
2020
- class EligibilityResponsePayer(TypedDict, total=False):
2021
- aaa_errors: Annotated[Iterable[EligibilityResponsePayerAaaError], PropertyInfo(alias="aaaErrors")]
2022
-
2023
- centers_for_medicare_and_medicaid_plan_id: Annotated[str, PropertyInfo(alias="centersForMedicareAndMedicaidPlanId")]
2024
-
2025
- contact_information: Annotated[EligibilityResponsePayerContactInformation, PropertyInfo(alias="contactInformation")]
2026
-
2027
- employers_id: Annotated[str, PropertyInfo(alias="employersId")]
2028
-
2029
- entity_identifier: Annotated[
2030
- Literal["Third-Party Administrator", "Employer", "Gateway Provider", "Plan Sponsor", "Payer"],
2031
- PropertyInfo(alias="entityIdentifier"),
2032
- ]
2033
-
2034
- entity_type: Annotated[Literal["Person", "Non-Person Entity"], PropertyInfo(alias="entityType")]
2035
-
2036
- etin: str
2037
-
2038
- federal_taxpayers_id_number: Annotated[str, PropertyInfo(alias="federalTaxpayersIdNumber")]
2039
-
2040
- first_name: Annotated[str, PropertyInfo(alias="firstName")]
2041
-
2042
- last_name: Annotated[str, PropertyInfo(alias="lastName")]
2043
-
2044
- middle_name: Annotated[str, PropertyInfo(alias="middleName")]
2045
-
2046
- naic: str
2047
-
2048
- name: str
2049
-
2050
- npi: str
2051
-
2052
- payor_identification: Annotated[str, PropertyInfo(alias="payorIdentification")]
2053
-
2054
- suffix: str
2055
-
2056
-
2057
- class EligibilityResponsePlanDateInformation(TypedDict, total=False):
2058
- added: str
2059
-
2060
- admission: str
2061
-
2062
- benefit: str
2063
-
2064
- benefit_begin: Annotated[str, PropertyInfo(alias="benefitBegin")]
2065
-
2066
- benefit_end: Annotated[str, PropertyInfo(alias="benefitEnd")]
2067
-
2068
- certification: str
2069
-
2070
- cobra_begin: Annotated[str, PropertyInfo(alias="cobraBegin")]
2071
-
2072
- cobra_end: Annotated[str, PropertyInfo(alias="cobraEnd")]
2073
-
2074
- completion: str
2075
-
2076
- coordination_of_benefits: Annotated[str, PropertyInfo(alias="coordinationOfBenefits")]
2077
-
2078
- date_of_death: Annotated[str, PropertyInfo(alias="dateOfDeath")]
2079
-
2080
- date_of_last_update: Annotated[str, PropertyInfo(alias="dateOfLastUpdate")]
2081
-
2082
- discharge: str
2083
-
2084
- effective_date_of_change: Annotated[str, PropertyInfo(alias="effectiveDateOfChange")]
2085
-
2086
- eligibility: str
2087
-
2088
- eligibility_begin: Annotated[str, PropertyInfo(alias="eligibilityBegin")]
2089
-
2090
- eligibility_end: Annotated[str, PropertyInfo(alias="eligibilityEnd")]
2091
-
2092
- enrollment: str
2093
-
2094
- issue: str
2095
-
2096
- latest_visit_or_consultation: Annotated[str, PropertyInfo(alias="latestVisitOrConsultation")]
2097
-
2098
- period_end: Annotated[str, PropertyInfo(alias="periodEnd")]
2099
-
2100
- period_start: Annotated[str, PropertyInfo(alias="periodStart")]
2101
-
2102
- plan: str
2103
-
2104
- plan_begin: Annotated[str, PropertyInfo(alias="planBegin")]
2105
-
2106
- plan_end: Annotated[str, PropertyInfo(alias="planEnd")]
2107
-
2108
- policy_effective: Annotated[str, PropertyInfo(alias="policyEffective")]
2109
-
2110
- policy_expiration: Annotated[str, PropertyInfo(alias="policyExpiration")]
2111
-
2112
- premium_paid_to_date_begin: Annotated[str, PropertyInfo(alias="premiumPaidToDateBegin")]
2113
-
2114
- premium_paid_to_date_end: Annotated[str, PropertyInfo(alias="premiumPaidToDateEnd")]
2115
-
2116
- primary_care_provider: Annotated[str, PropertyInfo(alias="primaryCareProvider")]
2117
-
2118
- service: str
2119
-
2120
- status: str
2121
-
2122
-
2123
- class EligibilityResponsePlanInformation(TypedDict, total=False):
2124
- agency_claim_number: Annotated[str, PropertyInfo(alias="agencyClaimNumber")]
2125
-
2126
- alternative_list_id: Annotated[str, PropertyInfo(alias="alternativeListId")]
2127
-
2128
- case_number: Annotated[str, PropertyInfo(alias="caseNumber")]
2129
-
2130
- centers_for_medicare_and_medicaid_services_npi: Annotated[
2131
- str, PropertyInfo(alias="centersForMedicareAndMedicaidServicesNPI")
2132
- ]
2133
-
2134
- class_of_contract_code: Annotated[str, PropertyInfo(alias="classOfContractCode")]
2135
-
2136
- contract_number: Annotated[str, PropertyInfo(alias="contractNumber")]
2137
-
2138
- coverage_list_id: Annotated[str, PropertyInfo(alias="coverageListId")]
2139
-
2140
- drug_formulary_number: Annotated[str, PropertyInfo(alias="drugFormularyNumber")]
2141
-
2142
- electronic_device_pin: Annotated[str, PropertyInfo(alias="electronicDevicePin")]
2143
-
2144
- eligibility_category: Annotated[str, PropertyInfo(alias="eligibilityCategory")]
2145
-
2146
- facility_id_number: Annotated[str, PropertyInfo(alias="facilityIdNumber")]
2147
-
2148
- facility_network_identification_number: Annotated[str, PropertyInfo(alias="facilityNetworkIdentificationNumber")]
2149
-
2150
- family_unit_number: Annotated[str, PropertyInfo(alias="familyUnitNumber")]
2151
-
2152
- federal_taxpayers_identification_number: Annotated[str, PropertyInfo(alias="federalTaxpayersIdentificationNumber")]
2153
-
2154
- group_description: Annotated[str, PropertyInfo(alias="groupDescription")]
2155
-
2156
- group_number: Annotated[str, PropertyInfo(alias="groupNumber")]
2157
-
2158
- hic_number: Annotated[str, PropertyInfo(alias="hicNumber")]
2159
-
2160
- id_card_number: Annotated[str, PropertyInfo(alias="idCardNumber")]
2161
-
2162
- id_card_serial_number: Annotated[str, PropertyInfo(alias="idCardSerialNumber")]
2163
-
2164
- insurance_policy_number: Annotated[str, PropertyInfo(alias="insurancePolicyNumber")]
2165
-
2166
- issue_number: Annotated[str, PropertyInfo(alias="issueNumber")]
2167
-
2168
- medicaid_provider_number: Annotated[str, PropertyInfo(alias="medicaidProviderNumber")]
2169
-
2170
- medicaid_recipient_id_number: Annotated[str, PropertyInfo(alias="medicaidRecipientIdNumber")]
2171
-
2172
- medical_assistance_category: Annotated[str, PropertyInfo(alias="medicalAssistanceCategory")]
2173
-
2174
- medical_record_identification_number: Annotated[str, PropertyInfo(alias="medicalRecordIdentificationNumber")]
2175
-
2176
- medicare_provider_number: Annotated[str, PropertyInfo(alias="medicareProviderNumber")]
2177
-
2178
- member_id: Annotated[str, PropertyInfo(alias="memberId")]
2179
-
2180
- patient_account_number: Annotated[str, PropertyInfo(alias="patientAccountNumber")]
2181
-
2182
- personal_identification_number: Annotated[str, PropertyInfo(alias="personalIdentificationNumber")]
2183
-
2184
- plan_description: Annotated[str, PropertyInfo(alias="planDescription")]
2185
-
2186
- plan_network_id_description: Annotated[str, PropertyInfo(alias="planNetworkIdDescription")]
2187
-
2188
- plan_network_id_number: Annotated[str, PropertyInfo(alias="planNetworkIdNumber")]
2189
-
2190
- plan_number: Annotated[str, PropertyInfo(alias="planNumber")]
2191
-
2192
- policy_number: Annotated[str, PropertyInfo(alias="policyNumber")]
2193
-
2194
- prior_authorization_number: Annotated[str, PropertyInfo(alias="priorAuthorizationNumber")]
2195
-
2196
- prior_id_number: Annotated[str, PropertyInfo(alias="priorIdNumber")]
2197
-
2198
- referral_number: Annotated[str, PropertyInfo(alias="referralNumber")]
2199
-
2200
- social_security_number: Annotated[str, PropertyInfo(alias="socialSecurityNumber")]
2201
-
2202
- state_license_number: Annotated[str, PropertyInfo(alias="stateLicenseNumber")]
2203
-
2204
- submitter_identification_number: Annotated[str, PropertyInfo(alias="submitterIdentificationNumber")]
2205
-
2206
- user_identification: Annotated[str, PropertyInfo(alias="userIdentification")]
2207
-
2208
-
2209
- class EligibilityResponsePlanStatus(TypedDict, total=False):
2210
- plan_details: Annotated[str, PropertyInfo(alias="planDetails")]
2211
-
2212
- service_type_codes: Annotated[
2213
- List[
2214
- Literal[
2215
- "1",
2216
- "2",
2217
- "3",
2218
- "4",
2219
- "5",
2220
- "6",
2221
- "7",
2222
- "8",
2223
- "9",
2224
- "10",
2225
- "11",
2226
- "12",
2227
- "13",
2228
- "14",
2229
- "15",
2230
- "16",
2231
- "17",
2232
- "18",
2233
- "19",
2234
- "20",
2235
- "21",
2236
- "22",
2237
- "23",
2238
- "24",
2239
- "25",
2240
- "26",
2241
- "27",
2242
- "28",
2243
- "30",
2244
- "32",
2245
- "33",
2246
- "34",
2247
- "35",
2248
- "36",
2249
- "37",
2250
- "38",
2251
- "39",
2252
- "40",
2253
- "41",
2254
- "42",
2255
- "43",
2256
- "44",
2257
- "45",
2258
- "46",
2259
- "47",
2260
- "48",
2261
- "49",
2262
- "50",
2263
- "51",
2264
- "52",
2265
- "53",
2266
- "54",
2267
- "55",
2268
- "56",
2269
- "57",
2270
- "58",
2271
- "59",
2272
- "60",
2273
- "61",
2274
- "62",
2275
- "63",
2276
- "64",
2277
- "65",
2278
- "66",
2279
- "67",
2280
- "68",
2281
- "69",
2282
- "70",
2283
- "71",
2284
- "72",
2285
- "73",
2286
- "74",
2287
- "75",
2288
- "76",
2289
- "77",
2290
- "78",
2291
- "79",
2292
- "80",
2293
- "81",
2294
- "82",
2295
- "83",
2296
- "84",
2297
- "85",
2298
- "86",
2299
- "87",
2300
- "88",
2301
- "89",
2302
- "90",
2303
- "91",
2304
- "92",
2305
- "93",
2306
- "94",
2307
- "95",
2308
- "96",
2309
- "97",
2310
- "98",
2311
- "99",
2312
- "A0",
2313
- "A1",
2314
- "A2",
2315
- "A3",
2316
- "A4",
2317
- "A5",
2318
- "A6",
2319
- "A7",
2320
- "A8",
2321
- "A9",
2322
- "AA",
2323
- "AB",
2324
- "AC",
2325
- "AD",
2326
- "AE",
2327
- "AF",
2328
- "AG",
2329
- "AH",
2330
- "AI",
2331
- "AJ",
2332
- "AK",
2333
- "AL",
2334
- "AM",
2335
- "AN",
2336
- "AO",
2337
- "AQ",
2338
- "AR",
2339
- "B1",
2340
- "B2",
2341
- "B3",
2342
- "BA",
2343
- "BB",
2344
- "BC",
2345
- "BD",
2346
- "BE",
2347
- "BF",
2348
- "BG",
2349
- "BH",
2350
- "BI",
2351
- "BJ",
2352
- "BK",
2353
- "BL",
2354
- "BM",
2355
- "BN",
2356
- "BP",
2357
- "BQ",
2358
- "BR",
2359
- "BS",
2360
- "BT",
2361
- "BU",
2362
- "BV",
2363
- "BW",
2364
- "BX",
2365
- "BY",
2366
- "BZ",
2367
- "C1",
2368
- "CA",
2369
- "CB",
2370
- "CC",
2371
- "CD",
2372
- "CE",
2373
- "CF",
2374
- "CG",
2375
- "CH",
2376
- "CI",
2377
- "CJ",
2378
- "CK",
2379
- "CL",
2380
- "CM",
2381
- "CN",
2382
- "CO",
2383
- "CP",
2384
- "CQ",
2385
- "DG",
2386
- "DM",
2387
- "DS",
2388
- "GF",
2389
- "GN",
2390
- "GY",
2391
- "IC",
2392
- "MH",
2393
- "NI",
2394
- "ON",
2395
- "PT",
2396
- "PU",
2397
- "RN",
2398
- "RT",
2399
- "TC",
2400
- "TN",
2401
- "UC",
2402
- ]
2403
- ],
2404
- PropertyInfo(alias="serviceTypeCodes"),
2405
- ]
2406
-
2407
- status: str
2408
-
2409
- status_code: Annotated[str, PropertyInfo(alias="statusCode")]
2410
-
2411
-
2412
- class EligibilityResponseProviderAaaError(TypedDict, total=False):
2413
- code: Literal["15", "41", "43", "44", "45", "46", "47", "48", "50", "51", "79", "97", "T4"]
2414
-
2415
- description: str
2416
-
2417
- field: str
2418
-
2419
- followup_action: Annotated[
2420
- Literal[
2421
- "Please Correct and Resubmit",
2422
- "Resubmission Not Allowed",
2423
- "Resubmission Allowed",
2424
- "Do Not Resubmit; Inquiry Initiated to a Third Party",
2425
- "Please Wait 30 Days and Resubmit",
2426
- "Please Wait 10 Days and Resubmit",
2427
- "Do Not Resubmit; We Will Hold Your Request and Respond Again Shortly",
2428
- ],
2429
- PropertyInfo(alias="followupAction"),
2430
- ]
2431
-
2432
- location: str
2433
-
2434
- possible_resolutions: Annotated[str, PropertyInfo(alias="possibleResolutions")]
2435
-
2436
-
2437
- class EligibilityResponseProviderAddress(TypedDict, total=False):
2438
- address1: str
2439
-
2440
- address2: str
2441
-
2442
- city: str
2443
-
2444
- country_code: Annotated[str, PropertyInfo(alias="countryCode")]
2445
-
2446
- country_sub_division_code: Annotated[str, PropertyInfo(alias="countrySubDivisionCode")]
2447
-
2448
- postal_code: Annotated[str, PropertyInfo(alias="postalCode")]
2449
-
2450
- state: Literal[
2451
- "NL",
2452
- "PE",
2453
- "NS",
2454
- "NB",
2455
- "QC",
2456
- "ON",
2457
- "MB",
2458
- "SK",
2459
- "AB",
2460
- "BC",
2461
- "YT",
2462
- "NT",
2463
- "NU",
2464
- "DC",
2465
- "AS",
2466
- "GU",
2467
- "MP",
2468
- "PR",
2469
- "UM",
2470
- "VI",
2471
- "AK",
2472
- "AL",
2473
- "AR",
2474
- "AZ",
2475
- "CA",
2476
- "CO",
2477
- "CT",
2478
- "DE",
2479
- "FL",
2480
- "GA",
2481
- "HI",
2482
- "IA",
2483
- "ID",
2484
- "IL",
2485
- "IN",
2486
- "KS",
2487
- "KY",
2488
- "LA",
2489
- "MA",
2490
- "MD",
2491
- "ME",
2492
- "MI",
2493
- "MN",
2494
- "MO",
2495
- "MS",
2496
- "MT",
2497
- "NC",
2498
- "ND",
2499
- "NE",
2500
- "NH",
2501
- "NJ",
2502
- "NM",
2503
- "NV",
2504
- "NY",
2505
- "OH",
2506
- "OK",
2507
- "OR",
2508
- "PA",
2509
- "RI",
2510
- "SC",
2511
- "SD",
2512
- "TN",
2513
- "TX",
2514
- "UT",
2515
- "VA",
2516
- "VT",
2517
- "WA",
2518
- "WI",
2519
- "WV",
2520
- "WY",
2521
- ]
2522
-
2523
-
2524
- class EligibilityResponseProvider(TypedDict, total=False):
2525
- aaa_errors: Annotated[Iterable[EligibilityResponseProviderAaaError], PropertyInfo(alias="aaaErrors")]
2526
-
2527
- address: EligibilityResponseProviderAddress
2528
-
2529
- employers_id: Annotated[str, PropertyInfo(alias="employersId")]
2530
-
2531
- entity_identifier: Annotated[
2532
- Literal[
2533
- "Provider",
2534
- "Third-Party Administrator",
2535
- "Employer",
2536
- "Hospital",
2537
- "Facility",
2538
- "Gateway Provider",
2539
- "Plan Sponsor",
2540
- "Payer",
2541
- ],
2542
- PropertyInfo(alias="entityIdentifier"),
2543
- ]
2544
-
2545
- entity_type: Annotated[Literal["Person", "Non-Person Entity"], PropertyInfo(alias="entityType")]
2546
-
2547
- federal_taxpayers_id_number: Annotated[str, PropertyInfo(alias="federalTaxpayersIdNumber")]
2548
-
2549
- middle_name: Annotated[str, PropertyInfo(alias="middleName")]
2550
-
2551
- npi: str
2552
-
2553
- payor_identification: Annotated[str, PropertyInfo(alias="payorIdentification")]
2554
-
2555
- pharmacy_processor_number: Annotated[str, PropertyInfo(alias="pharmacyProcessorNumber")]
2556
-
2557
- provider_code: Annotated[
2558
- Literal[
2559
- "AD", "AT", "BI", "CO", "CV", "H", "HH", "LA", "OT", "P1", "P2", "PC", "PE", "R", "RF", "SB", "SK", "SU"
2560
- ],
2561
- PropertyInfo(alias="providerCode"),
2562
- ]
2563
-
2564
- provider_first_name: Annotated[str, PropertyInfo(alias="providerFirstName")]
2565
-
2566
- provider_name: Annotated[str, PropertyInfo(alias="providerName")]
2567
-
2568
- provider_org_name: Annotated[str, PropertyInfo(alias="providerOrgName")]
2569
-
2570
- reference_identification: Annotated[str, PropertyInfo(alias="referenceIdentification")]
2571
-
2572
- service_provider_number: Annotated[str, PropertyInfo(alias="serviceProviderNumber")]
2573
-
2574
- services_plan_id: Annotated[str, PropertyInfo(alias="servicesPlanID")]
2575
-
2576
- ssn: str
2577
-
2578
- suffix: str
2579
-
2580
-
2581
- class EligibilityResponseSubscriberAaaError(TypedDict, total=False):
2582
- code: Literal[
2583
- "15",
2584
- "33",
2585
- "35",
2586
- "42",
2587
- "43",
2588
- "45",
2589
- "47",
2590
- "48",
2591
- "49",
2592
- "51",
2593
- "52",
2594
- "53",
2595
- "54",
2596
- "55",
2597
- "56",
2598
- "57",
2599
- "58",
2600
- "60",
2601
- "61",
2602
- "62",
2603
- "63",
2604
- "69",
2605
- "70",
2606
- "71",
2607
- "72",
2608
- "73",
2609
- "74",
2610
- "75",
2611
- "76",
2612
- "78",
2613
- "98",
2614
- "AA",
2615
- "AE",
2616
- "AF",
2617
- "AG",
2618
- "AO",
2619
- "CI",
2620
- "E8",
2621
- "IA",
2622
- "MA",
2623
- ]
2624
-
2625
- description: str
2626
-
2627
- field: str
2628
-
2629
- followup_action: Annotated[
2630
- Literal[
2631
- "Please Correct and Resubmit",
2632
- "Resubmission Not Allowed",
2633
- "Resubmission Allowed",
2634
- "Do Not Resubmit; Inquiry Initiated to a Third Party",
2635
- "Please Wait 30 Days and Resubmit",
2636
- "Please Wait 10 Days and Resubmit",
2637
- "Do Not Resubmit; We Will Hold Your Request and Respond Again Shortly",
2638
- ],
2639
- PropertyInfo(alias="followupAction"),
2640
- ]
2641
-
2642
- location: str
2643
-
2644
- possible_resolutions: Annotated[str, PropertyInfo(alias="possibleResolutions")]
2645
-
2646
-
2647
- class EligibilityResponseSubscriberAddress(TypedDict, total=False):
2648
- address1: str
2649
-
2650
- address2: str
2651
-
2652
- city: str
2653
-
2654
- country_code: Annotated[str, PropertyInfo(alias="countryCode")]
2655
-
2656
- country_sub_division_code: Annotated[str, PropertyInfo(alias="countrySubDivisionCode")]
2657
-
2658
- postal_code: Annotated[str, PropertyInfo(alias="postalCode")]
2659
-
2660
- state: Literal[
2661
- "NL",
2662
- "PE",
2663
- "NS",
2664
- "NB",
2665
- "QC",
2666
- "ON",
2667
- "MB",
2668
- "SK",
2669
- "AB",
2670
- "BC",
2671
- "YT",
2672
- "NT",
2673
- "NU",
2674
- "DC",
2675
- "AS",
2676
- "GU",
2677
- "MP",
2678
- "PR",
2679
- "UM",
2680
- "VI",
2681
- "AK",
2682
- "AL",
2683
- "AR",
2684
- "AZ",
2685
- "CA",
2686
- "CO",
2687
- "CT",
2688
- "DE",
2689
- "FL",
2690
- "GA",
2691
- "HI",
2692
- "IA",
2693
- "ID",
2694
- "IL",
2695
- "IN",
2696
- "KS",
2697
- "KY",
2698
- "LA",
2699
- "MA",
2700
- "MD",
2701
- "ME",
2702
- "MI",
2703
- "MN",
2704
- "MO",
2705
- "MS",
2706
- "MT",
2707
- "NC",
2708
- "ND",
2709
- "NE",
2710
- "NH",
2711
- "NJ",
2712
- "NM",
2713
- "NV",
2714
- "NY",
2715
- "OH",
2716
- "OK",
2717
- "OR",
2718
- "PA",
2719
- "RI",
2720
- "SC",
2721
- "SD",
2722
- "TN",
2723
- "TX",
2724
- "UT",
2725
- "VA",
2726
- "VT",
2727
- "WA",
2728
- "WI",
2729
- "WV",
2730
- "WY",
2731
- ]
2732
-
2733
-
2734
- class EligibilityResponseSubscriberHealthCareDiagnosisCode(TypedDict, total=False):
2735
- diagnosis_code: Annotated[str, PropertyInfo(alias="diagnosisCode")]
2736
-
2737
- diagnosis_type_code: Annotated[str, PropertyInfo(alias="diagnosisTypeCode")]
2738
-
2739
-
2740
- class EligibilityResponseSubscriberResponseProviderAaaError(TypedDict, total=False):
2741
- code: Literal["15", "41", "43", "44", "45", "46", "47", "48", "50", "51", "79", "97", "T4"]
2742
-
2743
- description: str
2744
-
2745
- field: str
2746
-
2747
- followup_action: Annotated[
2748
- Literal[
2749
- "Please Correct and Resubmit",
2750
- "Resubmission Not Allowed",
2751
- "Resubmission Allowed",
2752
- "Do Not Resubmit; Inquiry Initiated to a Third Party",
2753
- "Please Wait 30 Days and Resubmit",
2754
- "Please Wait 10 Days and Resubmit",
2755
- "Do Not Resubmit; We Will Hold Your Request and Respond Again Shortly",
2756
- ],
2757
- PropertyInfo(alias="followupAction"),
2758
- ]
2759
-
2760
- location: str
2761
-
2762
- possible_resolutions: Annotated[str, PropertyInfo(alias="possibleResolutions")]
2763
-
2764
-
2765
- class EligibilityResponseSubscriberResponseProviderAddress(TypedDict, total=False):
2766
- address1: str
2767
-
2768
- address2: str
2769
-
2770
- city: str
2771
-
2772
- country_code: Annotated[str, PropertyInfo(alias="countryCode")]
2773
-
2774
- country_sub_division_code: Annotated[str, PropertyInfo(alias="countrySubDivisionCode")]
2775
-
2776
- postal_code: Annotated[str, PropertyInfo(alias="postalCode")]
2777
-
2778
- state: Literal[
2779
- "NL",
2780
- "PE",
2781
- "NS",
2782
- "NB",
2783
- "QC",
2784
- "ON",
2785
- "MB",
2786
- "SK",
2787
- "AB",
2788
- "BC",
2789
- "YT",
2790
- "NT",
2791
- "NU",
2792
- "DC",
2793
- "AS",
2794
- "GU",
2795
- "MP",
2796
- "PR",
2797
- "UM",
2798
- "VI",
2799
- "AK",
2800
- "AL",
2801
- "AR",
2802
- "AZ",
2803
- "CA",
2804
- "CO",
2805
- "CT",
2806
- "DE",
2807
- "FL",
2808
- "GA",
2809
- "HI",
2810
- "IA",
2811
- "ID",
2812
- "IL",
2813
- "IN",
2814
- "KS",
2815
- "KY",
2816
- "LA",
2817
- "MA",
2818
- "MD",
2819
- "ME",
2820
- "MI",
2821
- "MN",
2822
- "MO",
2823
- "MS",
2824
- "MT",
2825
- "NC",
2826
- "ND",
2827
- "NE",
2828
- "NH",
2829
- "NJ",
2830
- "NM",
2831
- "NV",
2832
- "NY",
2833
- "OH",
2834
- "OK",
2835
- "OR",
2836
- "PA",
2837
- "RI",
2838
- "SC",
2839
- "SD",
2840
- "TN",
2841
- "TX",
2842
- "UT",
2843
- "VA",
2844
- "VT",
2845
- "WA",
2846
- "WI",
2847
- "WV",
2848
- "WY",
2849
- ]
2850
-
2851
-
2852
- class EligibilityResponseSubscriberResponseProvider(TypedDict, total=False):
2853
- aaa_errors: Annotated[
2854
- Iterable[EligibilityResponseSubscriberResponseProviderAaaError], PropertyInfo(alias="aaaErrors")
2855
- ]
2856
-
2857
- address: EligibilityResponseSubscriberResponseProviderAddress
2858
-
2859
- employers_id: Annotated[str, PropertyInfo(alias="employersId")]
2860
-
2861
- entity_identifier: Annotated[
2862
- Literal[
2863
- "Provider",
2864
- "Third-Party Administrator",
2865
- "Employer",
2866
- "Hospital",
2867
- "Facility",
2868
- "Gateway Provider",
2869
- "Plan Sponsor",
2870
- "Payer",
2871
- ],
2872
- PropertyInfo(alias="entityIdentifier"),
2873
- ]
2874
-
2875
- entity_type: Annotated[Literal["Person", "Non-Person Entity"], PropertyInfo(alias="entityType")]
2876
-
2877
- federal_taxpayers_id_number: Annotated[str, PropertyInfo(alias="federalTaxpayersIdNumber")]
2878
-
2879
- middle_name: Annotated[str, PropertyInfo(alias="middleName")]
2880
-
2881
- npi: str
2882
-
2883
- payor_identification: Annotated[str, PropertyInfo(alias="payorIdentification")]
2884
-
2885
- pharmacy_processor_number: Annotated[str, PropertyInfo(alias="pharmacyProcessorNumber")]
2886
-
2887
- provider_code: Annotated[
2888
- Literal[
2889
- "AD", "AT", "BI", "CO", "CV", "H", "HH", "LA", "OT", "P1", "P2", "PC", "PE", "R", "RF", "SB", "SK", "SU"
2890
- ],
2891
- PropertyInfo(alias="providerCode"),
2892
- ]
2893
-
2894
- provider_first_name: Annotated[str, PropertyInfo(alias="providerFirstName")]
2895
-
2896
- provider_name: Annotated[str, PropertyInfo(alias="providerName")]
2897
-
2898
- provider_org_name: Annotated[str, PropertyInfo(alias="providerOrgName")]
2899
-
2900
- reference_identification: Annotated[str, PropertyInfo(alias="referenceIdentification")]
2901
-
2902
- service_provider_number: Annotated[str, PropertyInfo(alias="serviceProviderNumber")]
2903
-
2904
- services_plan_id: Annotated[str, PropertyInfo(alias="servicesPlanID")]
2905
-
2906
- ssn: str
2907
-
2908
- suffix: str
2909
-
2910
-
2911
- class EligibilityResponseSubscriber(TypedDict, total=False):
2912
- aaa_errors: Annotated[Iterable[EligibilityResponseSubscriberAaaError], PropertyInfo(alias="aaaErrors")]
2913
-
2914
- address: EligibilityResponseSubscriberAddress
2915
-
2916
- birth_sequence_number: Annotated[str, PropertyInfo(alias="birthSequenceNumber")]
2917
-
2918
- date_of_birth: Annotated[str, PropertyInfo(alias="dateOfBirth")]
2919
-
2920
- date_time_period: Annotated[str, PropertyInfo(alias="dateTimePeriod")]
2921
-
2922
- date_time_period_format_qualifier: Annotated[
2923
- Literal["D8", "RD8"], PropertyInfo(alias="dateTimePeriodFormatQualifier")
2924
- ]
2925
-
2926
- description: str
2927
-
2928
- employment_status_code: Annotated[
2929
- Literal["AE", "AO", "AS", "AT", "AU", "CC", "DD", "HD", "IR", "LX", "PE", "RE", "RM", "RR", "RU"],
2930
- PropertyInfo(alias="employmentStatusCode"),
2931
- ]
2932
-
2933
- end_date_time_period: Annotated[str, PropertyInfo(alias="endDateTimePeriod")]
2934
-
2935
- entity_identifier: Annotated[Literal["Insured or Subscriber"], PropertyInfo(alias="entityIdentifier")]
2936
-
2937
- entity_type: Annotated[Literal["Person", "Non-Person Entity"], PropertyInfo(alias="entityType")]
2938
-
2939
- first_name: Annotated[str, PropertyInfo(alias="firstName")]
2940
-
2941
- gender: Literal["M", "F", "U"]
2942
-
2943
- government_service_affiliation_code: Annotated[
2944
- Literal["A", "B", "C", "D", "E", "F", "G", "H", "I", "J", "K", "L", "M", "N", "O", "Q", "R", "S", "U", "W"],
2945
- PropertyInfo(alias="governmentServiceAffiliationCode"),
2946
- ]
2947
-
2948
- group_description: Annotated[str, PropertyInfo(alias="groupDescription")]
2949
-
2950
- group_number: Annotated[str, PropertyInfo(alias="groupNumber")]
2951
-
2952
- health_care_diagnosis_codes: Annotated[
2953
- Iterable[EligibilityResponseSubscriberHealthCareDiagnosisCode], PropertyInfo(alias="healthCareDiagnosisCodes")
2954
- ]
2955
-
2956
- information_status_code: Annotated[
2957
- Literal["A", "C", "L", "O", "P", "S", "T"], PropertyInfo(alias="informationStatusCode")
2958
- ]
2959
-
2960
- insured_indicator: Annotated[Literal["Y"], PropertyInfo(alias="insuredIndicator")]
2961
-
2962
- last_name: Annotated[str, PropertyInfo(alias="lastName")]
2963
-
2964
- maintenance_reason_code: Annotated[Literal["25"], PropertyInfo(alias="maintenanceReasonCode")]
2965
-
2966
- maintenance_type_code: Annotated[Literal["001"], PropertyInfo(alias="maintenanceTypeCode")]
2967
-
2968
- member_id: Annotated[str, PropertyInfo(alias="memberId")]
2969
-
2970
- middle_name: Annotated[str, PropertyInfo(alias="middleName")]
2971
-
2972
- military_service_rank_code: Annotated[
2973
- Literal[
2974
- "A1",
2975
- "A2",
2976
- "A3",
2977
- "B1",
2978
- "B2",
2979
- "C1",
2980
- "C2",
2981
- "C3",
2982
- "C4",
2983
- "C5",
2984
- "C6",
2985
- "C7",
2986
- "C8",
2987
- "C9",
2988
- "E1",
2989
- "F1",
2990
- "F2",
2991
- "F3",
2992
- "F4",
2993
- "G1",
2994
- "G4",
2995
- "L1",
2996
- "L2",
2997
- "L3",
2998
- "L4",
2999
- "L5",
3000
- "L6",
3001
- "M1",
3002
- "M2",
3003
- "M3",
3004
- "M4",
3005
- "M5",
3006
- "M6",
3007
- "P1",
3008
- "P2",
3009
- "P3",
3010
- "P4",
3011
- "P5",
3012
- "R1",
3013
- "R2",
3014
- "S1",
3015
- "S2",
3016
- "S3",
3017
- "S4",
3018
- "S5",
3019
- "S6",
3020
- "S7",
3021
- "S8",
3022
- "S9",
3023
- "SA",
3024
- "SB",
3025
- "SC",
3026
- "T1",
3027
- "V1",
3028
- "W1",
3029
- ],
3030
- PropertyInfo(alias="militaryServiceRankCode"),
3031
- ]
3032
-
3033
- plan_description: Annotated[str, PropertyInfo(alias="planDescription")]
3034
-
3035
- plan_network_description: Annotated[str, PropertyInfo(alias="planNetworkDescription")]
3036
-
3037
- plan_network_id_number: Annotated[str, PropertyInfo(alias="planNetworkIdNumber")]
3038
-
3039
- plan_number: Annotated[str, PropertyInfo(alias="planNumber")]
3040
-
3041
- relation_to_subscriber: Annotated[Literal["Self"], PropertyInfo(alias="relationToSubscriber")]
3042
-
3043
- relation_to_subscriber_code: Annotated[Literal["18"], PropertyInfo(alias="relationToSubscriberCode")]
3044
-
3045
- response_provider: Annotated[EligibilityResponseSubscriberResponseProvider, PropertyInfo(alias="responseProvider")]
3046
-
3047
- ssn: str
3048
-
3049
- start_date_time_period: Annotated[str, PropertyInfo(alias="startDateTimePeriod")]
3050
-
3051
- suffix: str
3052
-
3053
- unique_health_identifier: Annotated[str, PropertyInfo(alias="uniqueHealthIdentifier")]
3054
-
3055
-
3056
- class EligibilityResponseSubscriberTraceNumber(TypedDict, total=False):
3057
- originating_company_identifier: Annotated[str, PropertyInfo(alias="originatingCompanyIdentifier")]
3058
-
3059
- reference_identification: Annotated[str, PropertyInfo(alias="referenceIdentification")]
3060
-
3061
- secondary_reference_identification: Annotated[str, PropertyInfo(alias="secondaryReferenceIdentification")]
3062
-
3063
- trace_type: Annotated[str, PropertyInfo(alias="traceType")]
3064
-
3065
- trace_type_code: Annotated[str, PropertyInfo(alias="traceTypeCode")]
3066
-
3067
-
3068
- class EligibilityResponseWarning(TypedDict, total=False):
3069
- code: str
3070
-
3071
- description: str
3072
-
3073
-
3074
- class EligibilityResponse(TypedDict, total=False):
3075
- in_network: Required[Annotated[bool, PropertyInfo(alias="inNetwork")]]
3076
-
3077
- benefits_information: Annotated[
3078
- Iterable[EligibilityResponseBenefitsInformation], PropertyInfo(alias="benefitsInformation")
3079
- ]
3080
-
3081
- control_number: Annotated[str, PropertyInfo(alias="controlNumber")]
3082
-
3083
- dependents: Iterable[EligibilityResponseDependent]
3084
-
3085
- errors: Iterable[EligibilityResponseError]
3086
-
3087
- implementation_transaction_set_syntax_error: Annotated[
3088
- str, PropertyInfo(alias="implementationTransactionSetSyntaxError")
3089
- ]
3090
-
3091
- meta: EligibilityResponseMeta
3092
-
3093
- payer: EligibilityResponsePayer
3094
-
3095
- plan_date_information: Annotated[EligibilityResponsePlanDateInformation, PropertyInfo(alias="planDateInformation")]
3096
-
3097
- plan_information: Annotated[EligibilityResponsePlanInformation, PropertyInfo(alias="planInformation")]
3098
-
3099
- plan_status: Annotated[Iterable[EligibilityResponsePlanStatus], PropertyInfo(alias="planStatus")]
3100
-
3101
- provider: EligibilityResponseProvider
3102
-
3103
- reassociation_key: Annotated[str, PropertyInfo(alias="reassociationKey")]
3104
-
3105
- status: str
3106
-
3107
- subscriber: EligibilityResponseSubscriber
3108
-
3109
- subscriber_trace_numbers: Annotated[
3110
- Iterable[EligibilityResponseSubscriberTraceNumber], PropertyInfo(alias="subscriberTraceNumbers")
3111
- ]
3112
-
3113
- trading_partner_service_id: Annotated[str, PropertyInfo(alias="tradingPartnerServiceId")]
3114
-
3115
- transaction_set_acknowledgement: Annotated[str, PropertyInfo(alias="transactionSetAcknowledgement")]
3116
-
3117
- warnings: Iterable[EligibilityResponseWarning]
3118
-
3119
- x12: str
3120
-
3121
-
3122
- class LineItem(TypedDict, total=False):
3123
- id: Required[str]
3124
-
3125
- cpt_code: Required[Annotated[str, PropertyInfo(alias="cptCode")]]
3126
-
3127
- service_amount: Required[Annotated[float, PropertyInfo(alias="serviceAmount")]]
3128
-
3129
- service_date: Required[Annotated[str, PropertyInfo(alias="serviceDate")]]