@stedi/sdk 0.0.4 → 0.0.10
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.
- package/CHANGELOG.md +3 -0
- package/LICENSE +13 -12
- package/README.md +148 -33
- package/dist-cjs/Stedi.js +51 -0
- package/dist-cjs/StediClient.js +52 -0
- package/dist-cjs/{generated/payers/auth → auth}/httpAuthExtensionConfiguration.js +8 -7
- package/dist-cjs/auth/httpAuthSchemeProvider.js +48 -0
- package/dist-cjs/commandBuilder.js +15 -0
- package/dist-cjs/commands/CreateEventDestinationCommand.js +8 -0
- package/dist-cjs/commands/CreateProfessionalClaimSubmissionCommand.js +8 -0
- package/dist-cjs/commands/DeleteEventDestinationCommand.js +8 -0
- package/dist-cjs/commands/GetClaimCommand.js +8 -0
- package/dist-cjs/commands/GetClaimTimelineCommand.js +8 -0
- package/dist-cjs/commands/GetEventDestinationCommand.js +8 -0
- package/dist-cjs/commands/GetEventDestinationEventCommand.js +8 -0
- package/dist-cjs/commands/GetEventDestinationSecretCommand.js +8 -0
- package/dist-cjs/commands/GetProfessionalClaimSubmissionCommand.js +8 -0
- package/dist-cjs/commands/ListClaimsCommand.js +8 -0
- package/dist-cjs/commands/ListEventDestinationEventsCommand.js +8 -0
- package/dist-cjs/commands/ListEventDestinationsCommand.js +8 -0
- package/dist-cjs/commands/RotateEventDestinationSecretCommand.js +8 -0
- package/dist-cjs/commands/UpdateEventDestinationCommand.js +8 -0
- package/dist-cjs/commands/ValidateProfessionalClaimSubmissionCommand.js +8 -0
- package/dist-cjs/commands/index.js +18 -0
- package/dist-cjs/{generated/claims/endpoint → endpoint}/EndpointParameters.js +1 -8
- package/dist-cjs/endpoint/bdd.js +28 -0
- package/dist-cjs/endpoint/endpointResolver.js +16 -0
- package/dist-cjs/{generated/payers/models/models_0.js → extensionConfiguration.js} +0 -1
- package/dist-cjs/index.js +14 -72
- package/dist-cjs/middleware/stediUserAgentMiddleware.js +24 -0
- package/dist-cjs/models/StediServiceException.js +12 -0
- package/dist-cjs/models/enums.js +248 -0
- package/dist-cjs/models/errors.js +127 -0
- package/dist-cjs/{generated/claims/models → models}/models_0.js +0 -1
- package/dist-cjs/pagination/GetClaimTimelinePaginator.js +7 -0
- package/dist-cjs/{generated/payers/pagination → pagination}/Interfaces.js +0 -1
- package/dist-cjs/pagination/ListClaimsPaginator.js +7 -0
- package/dist-cjs/pagination/ListEventDestinationEventsPaginator.js +7 -0
- package/dist-cjs/pagination/ListEventDestinationsPaginator.js +7 -0
- package/dist-cjs/pagination/index.js +8 -0
- package/dist-cjs/protocol/stediRestJsonProtocol.js +53 -0
- package/dist-cjs/runtimeConfig.browser.js +30 -0
- package/dist-cjs/runtimeConfig.js +40 -0
- package/dist-cjs/{generated/claims/runtimeConfig.native.js → runtimeConfig.native.js} +0 -7
- package/dist-cjs/{generated/claims/runtimeConfig.shared.js → runtimeConfig.shared.js} +20 -20
- package/dist-cjs/runtimeExtensions.js +12 -0
- package/dist-cjs/schemas/schemas_0.js +977 -0
- package/dist-es/Stedi.js +47 -0
- package/dist-es/StediClient.js +48 -0
- package/dist-es/{generated/claims/auth → auth}/httpAuthExtensionConfiguration.js +8 -7
- package/dist-es/{generated/payers/auth → auth}/httpAuthSchemeProvider.js +11 -14
- package/dist-es/commandBuilder.js +11 -0
- package/dist-es/commands/CreateEventDestinationCommand.js +4 -0
- package/dist-es/commands/CreateProfessionalClaimSubmissionCommand.js +4 -0
- package/dist-es/commands/DeleteEventDestinationCommand.js +4 -0
- package/dist-es/commands/GetClaimCommand.js +4 -0
- package/dist-es/commands/GetClaimTimelineCommand.js +4 -0
- package/dist-es/commands/GetEventDestinationCommand.js +4 -0
- package/dist-es/commands/GetEventDestinationEventCommand.js +4 -0
- package/dist-es/commands/GetEventDestinationSecretCommand.js +4 -0
- package/dist-es/commands/GetProfessionalClaimSubmissionCommand.js +4 -0
- package/dist-es/commands/ListClaimsCommand.js +4 -0
- package/dist-es/commands/ListEventDestinationEventsCommand.js +4 -0
- package/dist-es/commands/ListEventDestinationsCommand.js +4 -0
- package/dist-es/commands/RotateEventDestinationSecretCommand.js +4 -0
- package/dist-es/commands/UpdateEventDestinationCommand.js +4 -0
- package/dist-es/commands/ValidateProfessionalClaimSubmissionCommand.js +4 -0
- package/dist-es/commands/index.js +15 -0
- package/dist-es/{generated/payers/endpoint → endpoint}/EndpointParameters.js +1 -8
- package/dist-es/endpoint/bdd.js +25 -0
- package/dist-es/endpoint/endpointResolver.js +12 -0
- package/dist-es/extensionConfiguration.js +1 -0
- package/dist-es/index.js +10 -37
- package/dist-es/middleware/stediUserAgentMiddleware.js +20 -0
- package/dist-es/models/StediServiceException.js +8 -0
- package/dist-es/models/enums.js +245 -0
- package/dist-es/models/errors.js +115 -0
- package/dist-es/models/models_0.js +1 -0
- package/dist-es/pagination/GetClaimTimelinePaginator.js +4 -0
- package/dist-es/pagination/Interfaces.js +1 -0
- package/dist-es/pagination/ListClaimsPaginator.js +4 -0
- package/dist-es/pagination/ListEventDestinationEventsPaginator.js +4 -0
- package/dist-es/pagination/ListEventDestinationsPaginator.js +4 -0
- package/dist-es/pagination/index.js +5 -0
- package/dist-es/protocol/stediRestJsonProtocol.js +49 -0
- package/dist-es/runtimeConfig.browser.js +25 -0
- package/dist-es/runtimeConfig.js +35 -0
- package/dist-es/{generated/payers/runtimeConfig.native.js → runtimeConfig.native.js} +0 -7
- package/dist-es/{generated/payers/runtimeConfig.shared.js → runtimeConfig.shared.js} +16 -16
- package/dist-es/runtimeExtensions.js +8 -0
- package/dist-es/schemas/schemas_0.js +972 -0
- package/dist-types/Stedi.d.ts +146 -0
- package/dist-types/{generated/payers/PayersClient.d.ts → StediClient.d.ts} +33 -39
- package/dist-types/{generated/payers/auth → auth}/httpAuthExtensionConfiguration.d.ts +8 -6
- package/dist-types/{generated/claims/auth → auth}/httpAuthSchemeProvider.d.ts +17 -10
- package/dist-types/commandBuilder.d.ts +22 -0
- package/dist-types/commands/CreateEventDestinationCommand.d.ts +146 -0
- package/dist-types/commands/CreateProfessionalClaimSubmissionCommand.d.ts +799 -0
- package/dist-types/commands/DeleteEventDestinationCommand.d.ts +105 -0
- package/dist-types/commands/GetClaimCommand.d.ts +139 -0
- package/dist-types/commands/GetClaimTimelineCommand.d.ts +218 -0
- package/dist-types/commands/GetEventDestinationCommand.d.ts +124 -0
- package/dist-types/commands/GetEventDestinationEventCommand.d.ts +141 -0
- package/dist-types/commands/GetEventDestinationSecretCommand.d.ts +105 -0
- package/dist-types/commands/GetProfessionalClaimSubmissionCommand.d.ts +785 -0
- package/dist-types/commands/ListClaimsCommand.d.ts +169 -0
- package/dist-types/commands/ListEventDestinationEventsCommand.d.ts +120 -0
- package/dist-types/commands/ListEventDestinationsCommand.d.ts +132 -0
- package/dist-types/commands/RotateEventDestinationSecretCommand.d.ts +113 -0
- package/dist-types/commands/UpdateEventDestinationCommand.d.ts +142 -0
- package/dist-types/commands/ValidateProfessionalClaimSubmissionCommand.d.ts +786 -0
- package/dist-types/commands/index.d.ts +15 -0
- package/dist-types/{generated/payers/endpoint → endpoint}/EndpointParameters.d.ts +1 -1
- package/dist-types/endpoint/bdd.d.ts +2 -0
- package/dist-types/{generated/claims/endpoint → endpoint}/endpointResolver.d.ts +0 -1
- package/dist-types/extensionConfiguration.d.ts +8 -0
- package/dist-types/index.d.ts +18 -34
- package/dist-types/middleware/stediUserAgentMiddleware.d.ts +5 -0
- package/dist-types/models/StediServiceException.d.ts +14 -0
- package/dist-types/models/enums.d.ts +1038 -0
- package/dist-types/models/errors.d.ts +120 -0
- package/dist-types/models/models_0.d.ts +2966 -0
- package/dist-types/pagination/GetClaimTimelinePaginator.d.ts +7 -0
- package/dist-types/pagination/Interfaces.d.ts +8 -0
- package/dist-types/pagination/ListClaimsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListEventDestinationEventsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListEventDestinationsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +5 -0
- package/dist-types/protocol/stediRestJsonProtocol.d.ts +12 -0
- package/dist-types/{generated/claims/runtimeConfig.browser.d.ts → runtimeConfig.browser.d.ts} +18 -16
- package/dist-types/{generated/payers/runtimeConfig.d.ts → runtimeConfig.d.ts} +18 -16
- package/dist-types/{generated/payers/runtimeConfig.native.d.ts → runtimeConfig.native.d.ts} +18 -16
- package/dist-types/{generated/claims/runtimeConfig.shared.d.ts → runtimeConfig.shared.d.ts} +13 -10
- package/dist-types/{generated/claims/runtimeExtensions.d.ts → runtimeExtensions.d.ts} +2 -3
- package/dist-types/schemas/schemas_0.d.ts +123 -0
- package/package.json +60 -79
- package/dist-cjs/_registry.js +0 -47
- package/dist-cjs/_registry.js.map +0 -1
- package/dist-cjs/generated/claims/Claims.js +0 -19
- package/dist-cjs/generated/claims/Claims.js.map +0 -1
- package/dist-cjs/generated/claims/ClaimsClient.js +0 -68
- package/dist-cjs/generated/claims/ClaimsClient.js.map +0 -1
- package/dist-cjs/generated/claims/auth/httpAuthExtensionConfiguration.js +0 -50
- package/dist-cjs/generated/claims/auth/httpAuthExtensionConfiguration.js.map +0 -1
- package/dist-cjs/generated/claims/auth/httpAuthSchemeProvider.js +0 -51
- package/dist-cjs/generated/claims/auth/httpAuthSchemeProvider.js.map +0 -1
- package/dist-cjs/generated/claims/commands/ClaimsCms1500SubmissionCommand.js +0 -494
- package/dist-cjs/generated/claims/commands/ClaimsCms1500SubmissionCommand.js.map +0 -1
- package/dist-cjs/generated/claims/commands/index.js +0 -19
- package/dist-cjs/generated/claims/commands/index.js.map +0 -1
- package/dist-cjs/generated/claims/endpoint/EndpointParameters.js.map +0 -1
- package/dist-cjs/generated/claims/endpoint/bdd.js +0 -24
- package/dist-cjs/generated/claims/endpoint/bdd.js.map +0 -1
- package/dist-cjs/generated/claims/endpoint/endpointResolver.js +0 -23
- package/dist-cjs/generated/claims/endpoint/endpointResolver.js.map +0 -1
- package/dist-cjs/generated/claims/extensionConfiguration.js +0 -3
- package/dist-cjs/generated/claims/extensionConfiguration.js.map +0 -1
- package/dist-cjs/generated/claims/index.js +0 -34
- package/dist-cjs/generated/claims/index.js.map +0 -1
- package/dist-cjs/generated/claims/models/ClaimsServiceException.js +0 -22
- package/dist-cjs/generated/claims/models/ClaimsServiceException.js.map +0 -1
- package/dist-cjs/generated/claims/models/enums.js +0 -591
- package/dist-cjs/generated/claims/models/enums.js.map +0 -1
- package/dist-cjs/generated/claims/models/errors.js +0 -31
- package/dist-cjs/generated/claims/models/errors.js.map +0 -1
- package/dist-cjs/generated/claims/models/models_0.js.map +0 -1
- package/dist-cjs/generated/claims/runtimeConfig.browser.js +0 -45
- package/dist-cjs/generated/claims/runtimeConfig.browser.js.map +0 -1
- package/dist-cjs/generated/claims/runtimeConfig.js +0 -60
- package/dist-cjs/generated/claims/runtimeConfig.js.map +0 -1
- package/dist-cjs/generated/claims/runtimeConfig.native.js.map +0 -1
- package/dist-cjs/generated/claims/runtimeConfig.shared.js.map +0 -1
- package/dist-cjs/generated/claims/runtimeExtensions.js +0 -18
- package/dist-cjs/generated/claims/runtimeExtensions.js.map +0 -1
- package/dist-cjs/generated/claims/schemas/schemas_0.js +0 -507
- package/dist-cjs/generated/claims/schemas/schemas_0.js.map +0 -1
- package/dist-cjs/generated/payers/Payers.js +0 -23
- package/dist-cjs/generated/payers/Payers.js.map +0 -1
- package/dist-cjs/generated/payers/PayersClient.js +0 -68
- package/dist-cjs/generated/payers/PayersClient.js.map +0 -1
- package/dist-cjs/generated/payers/auth/httpAuthExtensionConfiguration.js.map +0 -1
- package/dist-cjs/generated/payers/auth/httpAuthSchemeProvider.js +0 -51
- package/dist-cjs/generated/payers/auth/httpAuthSchemeProvider.js.map +0 -1
- package/dist-cjs/generated/payers/commands/SearchPayersCommand.js +0 -753
- package/dist-cjs/generated/payers/commands/SearchPayersCommand.js.map +0 -1
- package/dist-cjs/generated/payers/commands/index.js +0 -19
- package/dist-cjs/generated/payers/commands/index.js.map +0 -1
- package/dist-cjs/generated/payers/endpoint/EndpointParameters.js +0 -19
- package/dist-cjs/generated/payers/endpoint/EndpointParameters.js.map +0 -1
- package/dist-cjs/generated/payers/endpoint/bdd.js +0 -24
- package/dist-cjs/generated/payers/endpoint/bdd.js.map +0 -1
- package/dist-cjs/generated/payers/endpoint/endpointResolver.js +0 -23
- package/dist-cjs/generated/payers/endpoint/endpointResolver.js.map +0 -1
- package/dist-cjs/generated/payers/extensionConfiguration.js +0 -3
- package/dist-cjs/generated/payers/extensionConfiguration.js.map +0 -1
- package/dist-cjs/generated/payers/index.js +0 -35
- package/dist-cjs/generated/payers/index.js.map +0 -1
- package/dist-cjs/generated/payers/models/PayersServiceException.js +0 -22
- package/dist-cjs/generated/payers/models/PayersServiceException.js.map +0 -1
- package/dist-cjs/generated/payers/models/enums.js +0 -333
- package/dist-cjs/generated/payers/models/enums.js.map +0 -1
- package/dist-cjs/generated/payers/models/errors.js +0 -86
- package/dist-cjs/generated/payers/models/errors.js.map +0 -1
- package/dist-cjs/generated/payers/models/models_0.js.map +0 -1
- package/dist-cjs/generated/payers/pagination/Interfaces.js.map +0 -1
- package/dist-cjs/generated/payers/pagination/SearchPayersPaginator.js +0 -12
- package/dist-cjs/generated/payers/pagination/SearchPayersPaginator.js.map +0 -1
- package/dist-cjs/generated/payers/pagination/index.js +0 -20
- package/dist-cjs/generated/payers/pagination/index.js.map +0 -1
- package/dist-cjs/generated/payers/runtimeConfig.browser.js +0 -45
- package/dist-cjs/generated/payers/runtimeConfig.browser.js.map +0 -1
- package/dist-cjs/generated/payers/runtimeConfig.js +0 -60
- package/dist-cjs/generated/payers/runtimeConfig.js.map +0 -1
- package/dist-cjs/generated/payers/runtimeConfig.native.js +0 -20
- package/dist-cjs/generated/payers/runtimeConfig.native.js.map +0 -1
- package/dist-cjs/generated/payers/runtimeConfig.shared.js +0 -48
- package/dist-cjs/generated/payers/runtimeConfig.shared.js.map +0 -1
- package/dist-cjs/generated/payers/runtimeExtensions.js +0 -18
- package/dist-cjs/generated/payers/runtimeExtensions.js.map +0 -1
- package/dist-cjs/generated/payers/schemas/schemas_0.js +0 -231
- package/dist-cjs/generated/payers/schemas/schemas_0.js.map +0 -1
- package/dist-cjs/index.js.map +0 -1
- package/dist-es/_registry.js +0 -11
- package/dist-es/_registry.js.map +0 -1
- package/dist-es/generated/claims/Claims.js +0 -15
- package/dist-es/generated/claims/Claims.js.map +0 -1
- package/dist-es/generated/claims/ClaimsClient.js +0 -64
- package/dist-es/generated/claims/ClaimsClient.js.map +0 -1
- package/dist-es/generated/claims/auth/httpAuthExtensionConfiguration.js.map +0 -1
- package/dist-es/generated/claims/auth/httpAuthSchemeProvider.js +0 -45
- package/dist-es/generated/claims/auth/httpAuthSchemeProvider.js.map +0 -1
- package/dist-es/generated/claims/commands/ClaimsCms1500SubmissionCommand.js +0 -490
- package/dist-es/generated/claims/commands/ClaimsCms1500SubmissionCommand.js.map +0 -1
- package/dist-es/generated/claims/commands/index.js +0 -3
- package/dist-es/generated/claims/commands/index.js.map +0 -1
- package/dist-es/generated/claims/endpoint/EndpointParameters.js +0 -15
- package/dist-es/generated/claims/endpoint/EndpointParameters.js.map +0 -1
- package/dist-es/generated/claims/endpoint/bdd.js +0 -21
- package/dist-es/generated/claims/endpoint/bdd.js.map +0 -1
- package/dist-es/generated/claims/endpoint/endpointResolver.js +0 -19
- package/dist-es/generated/claims/endpoint/endpointResolver.js.map +0 -1
- package/dist-es/generated/claims/extensionConfiguration.js +0 -2
- package/dist-es/generated/claims/extensionConfiguration.js.map +0 -1
- package/dist-es/generated/claims/index.js +0 -16
- package/dist-es/generated/claims/index.js.map +0 -1
- package/dist-es/generated/claims/models/ClaimsServiceException.js +0 -18
- package/dist-es/generated/claims/models/ClaimsServiceException.js.map +0 -1
- package/dist-es/generated/claims/models/enums.js +0 -588
- package/dist-es/generated/claims/models/enums.js.map +0 -1
- package/dist-es/generated/claims/models/errors.js +0 -27
- package/dist-es/generated/claims/models/errors.js.map +0 -1
- package/dist-es/generated/claims/models/models_0.js +0 -2
- package/dist-es/generated/claims/models/models_0.js.map +0 -1
- package/dist-es/generated/claims/runtimeConfig.browser.js +0 -38
- package/dist-es/generated/claims/runtimeConfig.browser.js.map +0 -1
- package/dist-es/generated/claims/runtimeConfig.js +0 -53
- package/dist-es/generated/claims/runtimeConfig.js.map +0 -1
- package/dist-es/generated/claims/runtimeConfig.native.js +0 -16
- package/dist-es/generated/claims/runtimeConfig.native.js.map +0 -1
- package/dist-es/generated/claims/runtimeConfig.shared.js +0 -44
- package/dist-es/generated/claims/runtimeConfig.shared.js.map +0 -1
- package/dist-es/generated/claims/runtimeExtensions.js +0 -14
- package/dist-es/generated/claims/runtimeExtensions.js.map +0 -1
- package/dist-es/generated/claims/schemas/schemas_0.js +0 -503
- package/dist-es/generated/claims/schemas/schemas_0.js.map +0 -1
- package/dist-es/generated/payers/Payers.js +0 -19
- package/dist-es/generated/payers/Payers.js.map +0 -1
- package/dist-es/generated/payers/PayersClient.js +0 -64
- package/dist-es/generated/payers/PayersClient.js.map +0 -1
- package/dist-es/generated/payers/auth/httpAuthExtensionConfiguration.js +0 -45
- package/dist-es/generated/payers/auth/httpAuthExtensionConfiguration.js.map +0 -1
- package/dist-es/generated/payers/auth/httpAuthSchemeProvider.js.map +0 -1
- package/dist-es/generated/payers/commands/SearchPayersCommand.js +0 -749
- package/dist-es/generated/payers/commands/SearchPayersCommand.js.map +0 -1
- package/dist-es/generated/payers/commands/index.js +0 -3
- package/dist-es/generated/payers/commands/index.js.map +0 -1
- package/dist-es/generated/payers/endpoint/EndpointParameters.js.map +0 -1
- package/dist-es/generated/payers/endpoint/bdd.js +0 -21
- package/dist-es/generated/payers/endpoint/bdd.js.map +0 -1
- package/dist-es/generated/payers/endpoint/endpointResolver.js +0 -19
- package/dist-es/generated/payers/endpoint/endpointResolver.js.map +0 -1
- package/dist-es/generated/payers/extensionConfiguration.js +0 -2
- package/dist-es/generated/payers/extensionConfiguration.js.map +0 -1
- package/dist-es/generated/payers/index.js +0 -17
- package/dist-es/generated/payers/index.js.map +0 -1
- package/dist-es/generated/payers/models/PayersServiceException.js +0 -18
- package/dist-es/generated/payers/models/PayersServiceException.js.map +0 -1
- package/dist-es/generated/payers/models/enums.js +0 -330
- package/dist-es/generated/payers/models/enums.js.map +0 -1
- package/dist-es/generated/payers/models/errors.js +0 -80
- package/dist-es/generated/payers/models/errors.js.map +0 -1
- package/dist-es/generated/payers/models/models_0.js +0 -2
- package/dist-es/generated/payers/models/models_0.js.map +0 -1
- package/dist-es/generated/payers/pagination/Interfaces.js +0 -2
- package/dist-es/generated/payers/pagination/Interfaces.js.map +0 -1
- package/dist-es/generated/payers/pagination/SearchPayersPaginator.js +0 -9
- package/dist-es/generated/payers/pagination/SearchPayersPaginator.js.map +0 -1
- package/dist-es/generated/payers/pagination/index.js +0 -4
- package/dist-es/generated/payers/pagination/index.js.map +0 -1
- package/dist-es/generated/payers/runtimeConfig.browser.js +0 -38
- package/dist-es/generated/payers/runtimeConfig.browser.js.map +0 -1
- package/dist-es/generated/payers/runtimeConfig.js +0 -53
- package/dist-es/generated/payers/runtimeConfig.js.map +0 -1
- package/dist-es/generated/payers/runtimeConfig.native.js.map +0 -1
- package/dist-es/generated/payers/runtimeConfig.shared.js.map +0 -1
- package/dist-es/generated/payers/runtimeExtensions.js +0 -14
- package/dist-es/generated/payers/runtimeExtensions.js.map +0 -1
- package/dist-es/generated/payers/schemas/schemas_0.js +0 -228
- package/dist-es/generated/payers/schemas/schemas_0.js.map +0 -1
- package/dist-es/index.js.map +0 -1
- package/dist-types/_registry.d.ts +0 -27
- package/dist-types/_registry.d.ts.map +0 -1
- package/dist-types/generated/claims/Claims.d.ts +0 -18
- package/dist-types/generated/claims/Claims.d.ts.map +0 -1
- package/dist-types/generated/claims/ClaimsClient.d.ts +0 -183
- package/dist-types/generated/claims/ClaimsClient.d.ts.map +0 -1
- package/dist-types/generated/claims/auth/httpAuthExtensionConfiguration.d.ts +0 -30
- package/dist-types/generated/claims/auth/httpAuthExtensionConfiguration.d.ts.map +0 -1
- package/dist-types/generated/claims/auth/httpAuthSchemeProvider.d.ts.map +0 -1
- package/dist-types/generated/claims/commands/ClaimsCms1500SubmissionCommand.d.ts +0 -514
- package/dist-types/generated/claims/commands/ClaimsCms1500SubmissionCommand.d.ts.map +0 -1
- package/dist-types/generated/claims/commands/index.d.ts +0 -2
- package/dist-types/generated/claims/commands/index.d.ts.map +0 -1
- package/dist-types/generated/claims/endpoint/EndpointParameters.d.ts +0 -33
- package/dist-types/generated/claims/endpoint/EndpointParameters.d.ts.map +0 -1
- package/dist-types/generated/claims/endpoint/bdd.d.ts +0 -3
- package/dist-types/generated/claims/endpoint/bdd.d.ts.map +0 -1
- package/dist-types/generated/claims/endpoint/endpointResolver.d.ts.map +0 -1
- package/dist-types/generated/claims/extensionConfiguration.d.ts +0 -10
- package/dist-types/generated/claims/extensionConfiguration.d.ts.map +0 -1
- package/dist-types/generated/claims/index.d.ts +0 -17
- package/dist-types/generated/claims/index.d.ts.map +0 -1
- package/dist-types/generated/claims/models/ClaimsServiceException.d.ts +0 -15
- package/dist-types/generated/claims/models/ClaimsServiceException.d.ts.map +0 -1
- package/dist-types/generated/claims/models/enums.d.ts +0 -707
- package/dist-types/generated/claims/models/enums.d.ts.map +0 -1
- package/dist-types/generated/claims/models/errors.d.ts +0 -20
- package/dist-types/generated/claims/models/errors.d.ts.map +0 -1
- package/dist-types/generated/claims/models/models_0.d.ts +0 -462
- package/dist-types/generated/claims/models/models_0.d.ts.map +0 -1
- package/dist-types/generated/claims/runtimeConfig.browser.d.ts.map +0 -1
- package/dist-types/generated/claims/runtimeConfig.d.ts +0 -54
- package/dist-types/generated/claims/runtimeConfig.d.ts.map +0 -1
- package/dist-types/generated/claims/runtimeConfig.native.d.ts +0 -53
- package/dist-types/generated/claims/runtimeConfig.native.d.ts.map +0 -1
- package/dist-types/generated/claims/runtimeConfig.shared.d.ts.map +0 -1
- package/dist-types/generated/claims/runtimeExtensions.d.ts.map +0 -1
- package/dist-types/generated/claims/schemas/schemas_0.d.ts +0 -62
- package/dist-types/generated/claims/schemas/schemas_0.d.ts.map +0 -1
- package/dist-types/generated/payers/Payers.d.ts +0 -26
- package/dist-types/generated/payers/Payers.d.ts.map +0 -1
- package/dist-types/generated/payers/PayersClient.d.ts.map +0 -1
- package/dist-types/generated/payers/auth/httpAuthExtensionConfiguration.d.ts.map +0 -1
- package/dist-types/generated/payers/auth/httpAuthSchemeProvider.d.ts +0 -82
- package/dist-types/generated/payers/auth/httpAuthSchemeProvider.d.ts.map +0 -1
- package/dist-types/generated/payers/commands/SearchPayersCommand.d.ts +0 -773
- package/dist-types/generated/payers/commands/SearchPayersCommand.d.ts.map +0 -1
- package/dist-types/generated/payers/commands/index.d.ts +0 -2
- package/dist-types/generated/payers/commands/index.d.ts.map +0 -1
- package/dist-types/generated/payers/endpoint/EndpointParameters.d.ts.map +0 -1
- package/dist-types/generated/payers/endpoint/bdd.d.ts +0 -3
- package/dist-types/generated/payers/endpoint/bdd.d.ts.map +0 -1
- package/dist-types/generated/payers/endpoint/endpointResolver.d.ts +0 -9
- package/dist-types/generated/payers/endpoint/endpointResolver.d.ts.map +0 -1
- package/dist-types/generated/payers/extensionConfiguration.d.ts +0 -10
- package/dist-types/generated/payers/extensionConfiguration.d.ts.map +0 -1
- package/dist-types/generated/payers/index.d.ts +0 -18
- package/dist-types/generated/payers/index.d.ts.map +0 -1
- package/dist-types/generated/payers/models/PayersServiceException.d.ts +0 -15
- package/dist-types/generated/payers/models/PayersServiceException.d.ts.map +0 -1
- package/dist-types/generated/payers/models/enums.d.ts +0 -353
- package/dist-types/generated/payers/models/enums.d.ts.map +0 -1
- package/dist-types/generated/payers/models/errors.d.ts +0 -58
- package/dist-types/generated/payers/models/errors.d.ts.map +0 -1
- package/dist-types/generated/payers/models/models_0.d.ts +0 -575
- package/dist-types/generated/payers/models/models_0.d.ts.map +0 -1
- package/dist-types/generated/payers/pagination/Interfaces.d.ts +0 -9
- package/dist-types/generated/payers/pagination/Interfaces.d.ts.map +0 -1
- package/dist-types/generated/payers/pagination/SearchPayersPaginator.d.ts +0 -8
- package/dist-types/generated/payers/pagination/SearchPayersPaginator.d.ts.map +0 -1
- package/dist-types/generated/payers/pagination/index.d.ts +0 -3
- package/dist-types/generated/payers/pagination/index.d.ts.map +0 -1
- package/dist-types/generated/payers/runtimeConfig.browser.d.ts +0 -54
- package/dist-types/generated/payers/runtimeConfig.browser.d.ts.map +0 -1
- package/dist-types/generated/payers/runtimeConfig.d.ts.map +0 -1
- package/dist-types/generated/payers/runtimeConfig.native.d.ts.map +0 -1
- package/dist-types/generated/payers/runtimeConfig.shared.d.ts +0 -34
- package/dist-types/generated/payers/runtimeConfig.shared.d.ts.map +0 -1
- package/dist-types/generated/payers/runtimeExtensions.d.ts +0 -18
- package/dist-types/generated/payers/runtimeExtensions.d.ts.map +0 -1
- package/dist-types/generated/payers/schemas/schemas_0.d.ts +0 -32
- package/dist-types/generated/payers/schemas/schemas_0.d.ts.map +0 -1
- package/dist-types/index.d.ts.map +0 -1
|
@@ -0,0 +1,2966 @@
|
|
|
1
|
+
import type { ClaimAcknowledgmentStatus, ClaimPaymentInformationStatusCode, ClaimStatus, ClaimStatusReportedBy, ClaimType, EventDestinationsDestinationInputStatus, EventDestinationsDestinationStatus, EventDestinationsEventEnvironment, EventDestinationsEventPayloadObjectType, EventDestinationsEventStatus, ProfessionalClaimSubmissionAttachmentReportTypeCode, ProfessionalClaimSubmissionAttachmentTransmissionCode, ProfessionalClaimSubmissionBenefitsAssignmentCertificationIndicator, ProfessionalClaimSubmissionClaimFilingIndicator, ProfessionalClaimSubmissionClaimFrequencyCode, ProfessionalClaimSubmissionDrugIdentificationUnitOfMeasure, ProfessionalClaimSubmissionEPSDTReferralConditionIndicator, ProfessionalClaimSubmissionGenderCode, ProfessionalClaimSubmissionInsuranceType, ProfessionalClaimSubmissionMedicareSecondaryInsuranceType, ProfessionalClaimSubmissionOtherInsuredRelationshipToInsured, ProfessionalClaimSubmissionPatientRelationshipToInsured, ProfessionalClaimSubmissionPaymentResponsibilityLevelCode, ProfessionalClaimSubmissionProviderAcceptsAssignment, ProfessionalClaimSubmissionProviderSignature, ProfessionalClaimSubmissionPurchasedServiceProviderEntityType, ProfessionalClaimSubmissionPurpose, ProfessionalClaimSubmissionReleaseOfInformationCode, ProfessionalClaimSubmissionResponsibilityLevel } from "./enums";
|
|
2
|
+
/**
|
|
3
|
+
* An error that caused Stedi to reject the claim.
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export interface ClaimRejectionError {
|
|
7
|
+
/**
|
|
8
|
+
* A human-readable explanation of the error.
|
|
9
|
+
* @public
|
|
10
|
+
*/
|
|
11
|
+
description: string | undefined;
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* Signature and assignment-of-benefits indicators for the claim.
|
|
15
|
+
* @public
|
|
16
|
+
*/
|
|
17
|
+
export interface ProfessionalClaimSubmissionAuthorization {
|
|
18
|
+
/**
|
|
19
|
+
* **[CMS-1500 Box 12]** Whether the provider has the patient's signature on file authorizing the release of medical information needed to process the claim.
|
|
20
|
+
* @public
|
|
21
|
+
*/
|
|
22
|
+
patientReleasesMedicalInfo: ProfessionalClaimSubmissionReleaseOfInformationCode | undefined;
|
|
23
|
+
/**
|
|
24
|
+
* **[CMS-1500 Box 13]** Whether the insured has authorized payment of benefits directly to the provider.
|
|
25
|
+
* @public
|
|
26
|
+
*/
|
|
27
|
+
insuredAuthorizesAssignment: ProfessionalClaimSubmissionBenefitsAssignmentCertificationIndicator | undefined;
|
|
28
|
+
/**
|
|
29
|
+
* **[CMS-1500 Box 27]** Whether the billing provider agrees to be paid under the payer's terms. Providers who are contracted with the payer are usually required to accept assignment.
|
|
30
|
+
* @public
|
|
31
|
+
*/
|
|
32
|
+
providerAcceptsAssignment: ProfessionalClaimSubmissionProviderAcceptsAssignment | undefined;
|
|
33
|
+
/**
|
|
34
|
+
* **[CMS-1500 Box 31]** Whether the provider has the rendering provider's signature on file. When `ON_FILE`, the generated CMS-1500 PDF shows `SOF` (Signature on File) in this box.
|
|
35
|
+
* @public
|
|
36
|
+
*/
|
|
37
|
+
providerSignature: ProfessionalClaimSubmissionProviderSignature | undefined;
|
|
38
|
+
}
|
|
39
|
+
/**
|
|
40
|
+
* A mailing address. For United States addresses, use the full nine-digit ZIP code with no separators, such as `100031502`. If you don't know the full ZIP code, you can find it using the [USPS ZIP Code Lookup](https://tools.usps.com/zip-code-lookup.htm) tool.
|
|
41
|
+
* @public
|
|
42
|
+
*/
|
|
43
|
+
export interface ProfessionalClaimSubmissionAddress {
|
|
44
|
+
/**
|
|
45
|
+
* The first line of the street address. This typically contains the building number and street name.
|
|
46
|
+
* @public
|
|
47
|
+
*/
|
|
48
|
+
addressLine1: string | undefined;
|
|
49
|
+
/**
|
|
50
|
+
* The second line of the street address. This typically contains the apartment or suite number.
|
|
51
|
+
* @public
|
|
52
|
+
*/
|
|
53
|
+
addressLine2?: string | undefined;
|
|
54
|
+
/**
|
|
55
|
+
* The city name.
|
|
56
|
+
* @public
|
|
57
|
+
*/
|
|
58
|
+
city: string | undefined;
|
|
59
|
+
/**
|
|
60
|
+
* The two-letter state or province code. Required when the city is in the United States or Canada.
|
|
61
|
+
* @public
|
|
62
|
+
*/
|
|
63
|
+
state?: string | undefined;
|
|
64
|
+
/**
|
|
65
|
+
* The postal or ZIP code, with no separators or spaces. For United States addresses, use the full nine-digit ZIP code, such as `100031502`.
|
|
66
|
+
* @public
|
|
67
|
+
*/
|
|
68
|
+
postalCode?: string | undefined;
|
|
69
|
+
}
|
|
70
|
+
/**
|
|
71
|
+
* A person or department to contact, with up to one phone number, email address, and fax number. Provide at least one way to reach the contact.
|
|
72
|
+
* @public
|
|
73
|
+
*/
|
|
74
|
+
export interface ProfessionalClaimSubmissionContact {
|
|
75
|
+
/**
|
|
76
|
+
* The name of the contact person or department. When omitted, questions are directed to the entity itself.
|
|
77
|
+
* @public
|
|
78
|
+
*/
|
|
79
|
+
name?: string | undefined;
|
|
80
|
+
/**
|
|
81
|
+
* The contact's phone number.
|
|
82
|
+
* @public
|
|
83
|
+
*/
|
|
84
|
+
phoneNumber?: string | undefined;
|
|
85
|
+
/**
|
|
86
|
+
* The extension for `phoneNumber`.
|
|
87
|
+
* @public
|
|
88
|
+
*/
|
|
89
|
+
phoneExtension?: string | undefined;
|
|
90
|
+
/**
|
|
91
|
+
* The contact's email address.
|
|
92
|
+
* @public
|
|
93
|
+
*/
|
|
94
|
+
email?: string | undefined;
|
|
95
|
+
/**
|
|
96
|
+
* The contact's fax number.
|
|
97
|
+
* @public
|
|
98
|
+
*/
|
|
99
|
+
faxNumber?: string | undefined;
|
|
100
|
+
}
|
|
101
|
+
/**
|
|
102
|
+
* Identifiers for the billing provider.
|
|
103
|
+
* @public
|
|
104
|
+
*/
|
|
105
|
+
export interface ProfessionalClaimSubmissionBillingProviderIdentifiers {
|
|
106
|
+
/**
|
|
107
|
+
* **[CMS-1500 Box 33a]** The billing provider's [National Provider Identifier (NPI)](https://www.stedi.com/docs/healthcare/national-provider-identifier). When the billing provider isn't assigned an NPI, supply `commercialNumber` or `locationNumber` instead.
|
|
108
|
+
* @public
|
|
109
|
+
*/
|
|
110
|
+
npi?: string | undefined;
|
|
111
|
+
/**
|
|
112
|
+
* **[CMS-1500 Box 33b]** The billing provider's state license number, assigned by a state licensing board. Include only when the payer requires it in addition to the NPI.
|
|
113
|
+
* @public
|
|
114
|
+
*/
|
|
115
|
+
stateLicenseNumber?: string | undefined;
|
|
116
|
+
/**
|
|
117
|
+
* **[CMS-1500 Box 33b]** The billing provider's taxonomy code from the National Uniform Claim Committee [Health Care Provider Taxonomy Code Set](https://taxonomy.nucc.org/), which identifies the provider's type and specialty.
|
|
118
|
+
* @public
|
|
119
|
+
*/
|
|
120
|
+
taxonomyCode?: string | undefined;
|
|
121
|
+
/**
|
|
122
|
+
* **[CMS-1500 Box 33b]** A location number assigned to the billing provider by the payer. Include only when the payer requires it in addition to the NPI, or when the provider has no NPI.
|
|
123
|
+
* @public
|
|
124
|
+
*/
|
|
125
|
+
locationNumber?: string | undefined;
|
|
126
|
+
/**
|
|
127
|
+
* **[CMS-1500 Box 33b]** A commercial number assigned to the billing provider by the payer. Include only when the payer requires it in addition to the NPI, or when the provider has no NPI.
|
|
128
|
+
* @public
|
|
129
|
+
*/
|
|
130
|
+
commercialNumber?: string | undefined;
|
|
131
|
+
}
|
|
132
|
+
/**
|
|
133
|
+
* The name of an individual person.
|
|
134
|
+
* @public
|
|
135
|
+
*/
|
|
136
|
+
export interface ProfessionalClaimSubmissionPersonName {
|
|
137
|
+
/**
|
|
138
|
+
* The person's last name. Don't include a name suffix such as Jr. or III here. Use the `suffix` property instead.
|
|
139
|
+
* @public
|
|
140
|
+
*/
|
|
141
|
+
lastName: string | undefined;
|
|
142
|
+
/**
|
|
143
|
+
* The person's first name.
|
|
144
|
+
* @public
|
|
145
|
+
*/
|
|
146
|
+
firstName?: string | undefined;
|
|
147
|
+
/**
|
|
148
|
+
* The person's middle name or initial.
|
|
149
|
+
* @public
|
|
150
|
+
*/
|
|
151
|
+
middleName?: string | undefined;
|
|
152
|
+
/**
|
|
153
|
+
* The person's name suffix, such as Jr. or III. Include only a personal name suffix here, not professional or academic credentials such as M.D.
|
|
154
|
+
* @public
|
|
155
|
+
*/
|
|
156
|
+
suffix?: string | undefined;
|
|
157
|
+
}
|
|
158
|
+
/**
|
|
159
|
+
* A name that belongs to either a person or an organization. Provide exactly one of `person` or `organization`.
|
|
160
|
+
* @public
|
|
161
|
+
*/
|
|
162
|
+
export type ProfessionalClaimSubmissionQualifiedName = ProfessionalClaimSubmissionQualifiedName.OrganizationMember | ProfessionalClaimSubmissionQualifiedName.PersonMember | ProfessionalClaimSubmissionQualifiedName.$UnknownMember;
|
|
163
|
+
/**
|
|
164
|
+
* @public
|
|
165
|
+
*/
|
|
166
|
+
export declare namespace ProfessionalClaimSubmissionQualifiedName {
|
|
167
|
+
/**
|
|
168
|
+
* The organization's business name.
|
|
169
|
+
* @public
|
|
170
|
+
*/
|
|
171
|
+
interface OrganizationMember {
|
|
172
|
+
organization: string;
|
|
173
|
+
person?: never;
|
|
174
|
+
$unknown?: never;
|
|
175
|
+
}
|
|
176
|
+
/**
|
|
177
|
+
* The person's name.
|
|
178
|
+
* @public
|
|
179
|
+
*/
|
|
180
|
+
interface PersonMember {
|
|
181
|
+
organization?: never;
|
|
182
|
+
person: ProfessionalClaimSubmissionPersonName;
|
|
183
|
+
$unknown?: never;
|
|
184
|
+
}
|
|
185
|
+
/**
|
|
186
|
+
* @public
|
|
187
|
+
*/
|
|
188
|
+
interface $UnknownMember {
|
|
189
|
+
organization?: never;
|
|
190
|
+
person?: never;
|
|
191
|
+
$unknown: [string, any];
|
|
192
|
+
}
|
|
193
|
+
/**
|
|
194
|
+
* @deprecated unused in schema-serde mode.
|
|
195
|
+
*
|
|
196
|
+
*/
|
|
197
|
+
interface Visitor<T> {
|
|
198
|
+
organization: (value: string) => T;
|
|
199
|
+
person: (value: ProfessionalClaimSubmissionPersonName) => T;
|
|
200
|
+
_: (name: string, value: any) => T;
|
|
201
|
+
}
|
|
202
|
+
}
|
|
203
|
+
/**
|
|
204
|
+
* The person or organization that will receive payment for the claim from the payer.
|
|
205
|
+
* @public
|
|
206
|
+
*/
|
|
207
|
+
export interface ProfessionalClaimSubmissionBillingProvider {
|
|
208
|
+
/**
|
|
209
|
+
* **[CMS-1500 Box 33]** The billing provider's name, either a person or an organization.
|
|
210
|
+
* @public
|
|
211
|
+
*/
|
|
212
|
+
name: ProfessionalClaimSubmissionQualifiedName | undefined;
|
|
213
|
+
/**
|
|
214
|
+
* **[CMS-1500 Box 33]** The billing provider's physical address. This must be a street address where care is delivered or an administrative facility, not a PO Box.
|
|
215
|
+
* @public
|
|
216
|
+
*/
|
|
217
|
+
address: ProfessionalClaimSubmissionAddress | undefined;
|
|
218
|
+
/**
|
|
219
|
+
* **[CMS-1500 Box 33]** The contact for the billing provider. Include only when the billing provider's contact information differs from the submitter's.
|
|
220
|
+
* @public
|
|
221
|
+
*/
|
|
222
|
+
contact?: ProfessionalClaimSubmissionContact | undefined;
|
|
223
|
+
/**
|
|
224
|
+
* **[CMS-1500 Box 33a, 33b]** Identifiers for the billing provider. You must provide the billing provider's NPI. When the provider doesn't have an NPI, you can supply an alternative, such as `commercialNumber` or `locationNumber`.
|
|
225
|
+
* @public
|
|
226
|
+
*/
|
|
227
|
+
identifiers?: ProfessionalClaimSubmissionBillingProviderIdentifiers | undefined;
|
|
228
|
+
}
|
|
229
|
+
/**
|
|
230
|
+
* Identifiers for the service facility.
|
|
231
|
+
* @public
|
|
232
|
+
*/
|
|
233
|
+
export interface ProfessionalClaimSubmissionServiceFacilityIdentifiers {
|
|
234
|
+
/**
|
|
235
|
+
* **[CMS-1500 Box 32a]** The facility's [National Provider Identifier (NPI)](https://www.stedi.com/docs/healthcare/national-provider-identifier). Only required when the facility's NPI differs from the billing provider's NPI. Don't include when the service facility is the patient's home.
|
|
236
|
+
* @public
|
|
237
|
+
*/
|
|
238
|
+
npi?: string | undefined;
|
|
239
|
+
/**
|
|
240
|
+
* **[CMS-1500 Box 32b]** The facility's state license number, assigned by a state licensing board. Include only when the payer requires it in addition to the NPI.
|
|
241
|
+
* @public
|
|
242
|
+
*/
|
|
243
|
+
stateLicenseNumber?: string | undefined;
|
|
244
|
+
/**
|
|
245
|
+
* **[CMS-1500 Box 32b]** A commercial number assigned to the facility by the payer. Include only when the payer requires it in addition to the NPI.
|
|
246
|
+
* @public
|
|
247
|
+
*/
|
|
248
|
+
commercialNumber?: string | undefined;
|
|
249
|
+
/**
|
|
250
|
+
* **[CMS-1500 Box 32b]** A location number assigned to the facility by the payer. Include only when the payer requires it in addition to the NPI.
|
|
251
|
+
* @public
|
|
252
|
+
*/
|
|
253
|
+
locationNumber?: string | undefined;
|
|
254
|
+
}
|
|
255
|
+
/**
|
|
256
|
+
* A name that belongs to an organization.
|
|
257
|
+
* @public
|
|
258
|
+
*/
|
|
259
|
+
export type ProfessionalClaimSubmissionQualifiedOrganizationName = ProfessionalClaimSubmissionQualifiedOrganizationName.OrganizationMember | ProfessionalClaimSubmissionQualifiedOrganizationName.$UnknownMember;
|
|
260
|
+
/**
|
|
261
|
+
* @public
|
|
262
|
+
*/
|
|
263
|
+
export declare namespace ProfessionalClaimSubmissionQualifiedOrganizationName {
|
|
264
|
+
/**
|
|
265
|
+
* The organization's business name.
|
|
266
|
+
* @public
|
|
267
|
+
*/
|
|
268
|
+
interface OrganizationMember {
|
|
269
|
+
organization: string;
|
|
270
|
+
$unknown?: never;
|
|
271
|
+
}
|
|
272
|
+
/**
|
|
273
|
+
* @public
|
|
274
|
+
*/
|
|
275
|
+
interface $UnknownMember {
|
|
276
|
+
organization?: never;
|
|
277
|
+
$unknown: [string, any];
|
|
278
|
+
}
|
|
279
|
+
/**
|
|
280
|
+
* @deprecated unused in schema-serde mode.
|
|
281
|
+
*
|
|
282
|
+
*/
|
|
283
|
+
interface Visitor<T> {
|
|
284
|
+
organization: (value: string) => T;
|
|
285
|
+
_: (name: string, value: any) => T;
|
|
286
|
+
}
|
|
287
|
+
}
|
|
288
|
+
/**
|
|
289
|
+
* The facility where the patient received care, also called the service facility location. The address should be a physical location.
|
|
290
|
+
* @public
|
|
291
|
+
*/
|
|
292
|
+
export interface ProfessionalClaimSubmissionServiceFacility {
|
|
293
|
+
/**
|
|
294
|
+
* **[CMS-1500 Box 32]** The facility's organization name. When services were rendered in the patient's home, we recommend setting this to Residence or something similar.
|
|
295
|
+
* @public
|
|
296
|
+
*/
|
|
297
|
+
name: ProfessionalClaimSubmissionQualifiedOrganizationName | undefined;
|
|
298
|
+
/**
|
|
299
|
+
* **[CMS-1500 Box 32]** The facility's physical address. This must be a street address, not a PO Box. If the service was rendered in an area where there are no street addresses, enter a description of where the service was rendered. For example, 'crossroad of State Road 34 and 45' or 'Exit near Mile marker 265 on Interstate 80'.
|
|
300
|
+
* @public
|
|
301
|
+
*/
|
|
302
|
+
address: ProfessionalClaimSubmissionAddress | undefined;
|
|
303
|
+
/**
|
|
304
|
+
* **[CMS-1500 Box 32a, 32b]** Identifiers for the service facility.
|
|
305
|
+
* @public
|
|
306
|
+
*/
|
|
307
|
+
identifiers?: ProfessionalClaimSubmissionServiceFacilityIdentifiers | undefined;
|
|
308
|
+
}
|
|
309
|
+
/**
|
|
310
|
+
* The billing provider's federal tax identification number. Provide exactly one of `ein` or `ssn`.
|
|
311
|
+
* @public
|
|
312
|
+
*/
|
|
313
|
+
export type ProfessionalClaimSubmissionTaxId = ProfessionalClaimSubmissionTaxId.EinMember | ProfessionalClaimSubmissionTaxId.SsnMember | ProfessionalClaimSubmissionTaxId.$UnknownMember;
|
|
314
|
+
/**
|
|
315
|
+
* @public
|
|
316
|
+
*/
|
|
317
|
+
export declare namespace ProfessionalClaimSubmissionTaxId {
|
|
318
|
+
/**
|
|
319
|
+
* The billing provider's Social Security Number. Must be a string of exactly nine numbers with no separators. If you provide this, don't provide `ein`.
|
|
320
|
+
* @public
|
|
321
|
+
*/
|
|
322
|
+
interface SsnMember {
|
|
323
|
+
ssn: string;
|
|
324
|
+
ein?: never;
|
|
325
|
+
$unknown?: never;
|
|
326
|
+
}
|
|
327
|
+
/**
|
|
328
|
+
* The billing provider's Employer Identification Number (EIN). Typically a string of exactly nine numbers with no separators, unless otherwise instructed by the payer. If you provide this, don't provide `ssn`.
|
|
329
|
+
* @public
|
|
330
|
+
*/
|
|
331
|
+
interface EinMember {
|
|
332
|
+
ssn?: never;
|
|
333
|
+
ein: string;
|
|
334
|
+
$unknown?: never;
|
|
335
|
+
}
|
|
336
|
+
/**
|
|
337
|
+
* @public
|
|
338
|
+
*/
|
|
339
|
+
interface $UnknownMember {
|
|
340
|
+
ssn?: never;
|
|
341
|
+
ein?: never;
|
|
342
|
+
$unknown: [string, any];
|
|
343
|
+
}
|
|
344
|
+
/**
|
|
345
|
+
* @deprecated unused in schema-serde mode.
|
|
346
|
+
*
|
|
347
|
+
*/
|
|
348
|
+
interface Visitor<T> {
|
|
349
|
+
ssn: (value: string) => T;
|
|
350
|
+
ein: (value: string) => T;
|
|
351
|
+
_: (name: string, value: any) => T;
|
|
352
|
+
}
|
|
353
|
+
}
|
|
354
|
+
/**
|
|
355
|
+
* Billing details for the claim, including the billing provider, service facility, tax identification, and charges.
|
|
356
|
+
* @public
|
|
357
|
+
*/
|
|
358
|
+
export interface ProfessionalClaimSubmissionBilling {
|
|
359
|
+
/**
|
|
360
|
+
* **[CMS-1500 Box 25]** The billing provider's federal tax identification number, provided as either an Employer Identification Number (EIN) or a Social Security Number (SSN).
|
|
361
|
+
* @public
|
|
362
|
+
*/
|
|
363
|
+
taxId: ProfessionalClaimSubmissionTaxId | undefined;
|
|
364
|
+
/**
|
|
365
|
+
* **[CMS-1500 Box 26]** The patient control number, a unique tracking ID you assign to the claim so you can correlate it with responses from the payer. The payer returns this ID in claim acknowledgments, Electronic Remittance Advice (ERAs), and claim status checks. We recommend using a random, 17-character alphanumeric string.
|
|
366
|
+
* @public
|
|
367
|
+
*/
|
|
368
|
+
patientControlNumber: string | undefined;
|
|
369
|
+
/**
|
|
370
|
+
* **[CMS-1500 Box 28]** The total charge for the claim, equal to the sum of all service line charges. It is acceptable to set this to `0` (zero).
|
|
371
|
+
* @public
|
|
372
|
+
*/
|
|
373
|
+
totalCharge: string | undefined;
|
|
374
|
+
/**
|
|
375
|
+
* **[CMS-1500 Box 29]** The total amount the patient, or the patient's representative, has already paid toward services in this claim. This is the patient's payment only. Don't include amounts paid by other payers.
|
|
376
|
+
* @public
|
|
377
|
+
*/
|
|
378
|
+
amountPaid?: string | undefined;
|
|
379
|
+
/**
|
|
380
|
+
* **[CMS-1500 Box 32, 32a, 32b]** The facility where the patient received care, also called the service facility location. This can be a healthcare facility like a surgical center or reference lab, or the patient's address when you rendered services in their home. Include when services were rendered somewhere other than the billing provider's address.
|
|
381
|
+
* - For telehealth services, the service facility location is the provider's address, even though the patient may have been in their home or elsewhere when receiving services.
|
|
382
|
+
* - When the billing provider is a physician group located at the same address as a hospital but is a separate entity, you can differentiate the service facility location by including the specific suite or building number of the physician group.
|
|
383
|
+
* @public
|
|
384
|
+
*/
|
|
385
|
+
serviceFacility?: ProfessionalClaimSubmissionServiceFacility | undefined;
|
|
386
|
+
/**
|
|
387
|
+
* **[CMS-1500 Box 33, 33a, 33b]** The person or organization, such as a clinic or group practice, that will receive payment for the claim from the payer.
|
|
388
|
+
* @public
|
|
389
|
+
*/
|
|
390
|
+
billingProvider: ProfessionalClaimSubmissionBillingProvider | undefined;
|
|
391
|
+
}
|
|
392
|
+
/**
|
|
393
|
+
* A piece of supporting documentation attached to the claim, such as medical records or an operative note. Only include when the payer requires it. Visit [Submit claim attachments](https://www.stedi.com/docs/healthcare/submit-claim-attachments) for more information.
|
|
394
|
+
* @public
|
|
395
|
+
*/
|
|
396
|
+
export interface ProfessionalClaimSubmissionAttachment {
|
|
397
|
+
/**
|
|
398
|
+
* The type of report being attached.
|
|
399
|
+
* @public
|
|
400
|
+
*/
|
|
401
|
+
reportTypeCode: ProfessionalClaimSubmissionAttachmentReportTypeCode | undefined;
|
|
402
|
+
/**
|
|
403
|
+
* How you're sending the attachment to the payer.
|
|
404
|
+
* @public
|
|
405
|
+
*/
|
|
406
|
+
transmissionCode: ProfessionalClaimSubmissionAttachmentTransmissionCode | undefined;
|
|
407
|
+
/**
|
|
408
|
+
* A control number assigned to the attachment. The payer uses this identifier to match the attachment to the claim.
|
|
409
|
+
* - You must include either this property or `attachmentId` in the request, but not both. Including both properties will result in an error.
|
|
410
|
+
* - We recommend using a ULID or UUID of up to 50 characters.
|
|
411
|
+
* - Stedi autogenerates a control number if you don't provide one.
|
|
412
|
+
* @public
|
|
413
|
+
*/
|
|
414
|
+
attachmentControlNumber?: string | undefined;
|
|
415
|
+
/**
|
|
416
|
+
* The unique identifier for an attachment file you previously uploaded to Stedi. This value is returned in the `attachmentId` property of the [Create Claim Attachment (275) JSON](https://www.stedi.com/docs/healthcare/api-reference/post-healthcare-submit-claim-attachment) response. Stedi uses it to generate and submit the 275 claim attachment transaction to the payer.
|
|
417
|
+
* - This property is required when you're submitting attachment files through Stedi.
|
|
418
|
+
* - You must include either this property or `attachmentControlNumber` in the request, but not both. Including both properties will result in an error.
|
|
419
|
+
* @public
|
|
420
|
+
*/
|
|
421
|
+
attachmentId?: string | undefined;
|
|
422
|
+
}
|
|
423
|
+
/**
|
|
424
|
+
* **[CMS-1500 Box 19]** A free-text note with additional information about the claim. Provide exactly one note type.
|
|
425
|
+
* @public
|
|
426
|
+
*/
|
|
427
|
+
export type ProfessionalClaimSubmissionClaimNote = ProfessionalClaimSubmissionClaimNote.AdditionalInformationMember | ProfessionalClaimSubmissionClaimNote.CertificationNarrativeMember | ProfessionalClaimSubmissionClaimNote.DiagnosisDescriptionMember | ProfessionalClaimSubmissionClaimNote.GoalsRehabilitationOrDischargePlansMember | ProfessionalClaimSubmissionClaimNote.ThirdPartyOrganizationMember | ProfessionalClaimSubmissionClaimNote.$UnknownMember;
|
|
428
|
+
/**
|
|
429
|
+
* @public
|
|
430
|
+
*/
|
|
431
|
+
export declare namespace ProfessionalClaimSubmissionClaimNote {
|
|
432
|
+
/**
|
|
433
|
+
* Additional information that helps explain the claim, such as a special billing situation or extra context. Don't use this to describe unspecified procedure codes.
|
|
434
|
+
* @public
|
|
435
|
+
*/
|
|
436
|
+
interface AdditionalInformationMember {
|
|
437
|
+
additionalInformation: string;
|
|
438
|
+
certificationNarrative?: never;
|
|
439
|
+
goalsRehabilitationOrDischargePlans?: never;
|
|
440
|
+
diagnosisDescription?: never;
|
|
441
|
+
thirdPartyOrganization?: never;
|
|
442
|
+
$unknown?: never;
|
|
443
|
+
}
|
|
444
|
+
/**
|
|
445
|
+
* A narrative that certifies medical necessity or another payer-required certification.
|
|
446
|
+
* @public
|
|
447
|
+
*/
|
|
448
|
+
interface CertificationNarrativeMember {
|
|
449
|
+
additionalInformation?: never;
|
|
450
|
+
certificationNarrative: string;
|
|
451
|
+
goalsRehabilitationOrDischargePlans?: never;
|
|
452
|
+
diagnosisDescription?: never;
|
|
453
|
+
thirdPartyOrganization?: never;
|
|
454
|
+
$unknown?: never;
|
|
455
|
+
}
|
|
456
|
+
/**
|
|
457
|
+
* Therapy or rehabilitation notes summarizing goals, rehabilitation potential, or discharge plans.
|
|
458
|
+
* @public
|
|
459
|
+
*/
|
|
460
|
+
interface GoalsRehabilitationOrDischargePlansMember {
|
|
461
|
+
additionalInformation?: never;
|
|
462
|
+
certificationNarrative?: never;
|
|
463
|
+
goalsRehabilitationOrDischargePlans: string;
|
|
464
|
+
diagnosisDescription?: never;
|
|
465
|
+
thirdPartyOrganization?: never;
|
|
466
|
+
$unknown?: never;
|
|
467
|
+
}
|
|
468
|
+
/**
|
|
469
|
+
* A description of the diagnosis, usually provided to clarify an unspecified or unlisted procedure code.
|
|
470
|
+
* @public
|
|
471
|
+
*/
|
|
472
|
+
interface DiagnosisDescriptionMember {
|
|
473
|
+
additionalInformation?: never;
|
|
474
|
+
certificationNarrative?: never;
|
|
475
|
+
goalsRehabilitationOrDischargePlans?: never;
|
|
476
|
+
diagnosisDescription: string;
|
|
477
|
+
thirdPartyOrganization?: never;
|
|
478
|
+
$unknown?: never;
|
|
479
|
+
}
|
|
480
|
+
/**
|
|
481
|
+
* Information about a third-party organization related to the claim.
|
|
482
|
+
* @public
|
|
483
|
+
*/
|
|
484
|
+
interface ThirdPartyOrganizationMember {
|
|
485
|
+
additionalInformation?: never;
|
|
486
|
+
certificationNarrative?: never;
|
|
487
|
+
goalsRehabilitationOrDischargePlans?: never;
|
|
488
|
+
diagnosisDescription?: never;
|
|
489
|
+
thirdPartyOrganization: string;
|
|
490
|
+
$unknown?: never;
|
|
491
|
+
}
|
|
492
|
+
/**
|
|
493
|
+
* @public
|
|
494
|
+
*/
|
|
495
|
+
interface $UnknownMember {
|
|
496
|
+
additionalInformation?: never;
|
|
497
|
+
certificationNarrative?: never;
|
|
498
|
+
goalsRehabilitationOrDischargePlans?: never;
|
|
499
|
+
diagnosisDescription?: never;
|
|
500
|
+
thirdPartyOrganization?: never;
|
|
501
|
+
$unknown: [string, any];
|
|
502
|
+
}
|
|
503
|
+
/**
|
|
504
|
+
* @deprecated unused in schema-serde mode.
|
|
505
|
+
*
|
|
506
|
+
*/
|
|
507
|
+
interface Visitor<T> {
|
|
508
|
+
additionalInformation: (value: string) => T;
|
|
509
|
+
certificationNarrative: (value: string) => T;
|
|
510
|
+
goalsRehabilitationOrDischargePlans: (value: string) => T;
|
|
511
|
+
diagnosisDescription: (value: string) => T;
|
|
512
|
+
thirdPartyOrganization: (value: string) => T;
|
|
513
|
+
_: (name: string, value: any) => T;
|
|
514
|
+
}
|
|
515
|
+
}
|
|
516
|
+
/**
|
|
517
|
+
* A date range. `end` is inclusive. At least one of `start` or `end` is present.
|
|
518
|
+
* @public
|
|
519
|
+
*/
|
|
520
|
+
export interface ProfessionalClaimSubmissionDateRange {
|
|
521
|
+
/**
|
|
522
|
+
* The start date of the range, in `YYYY-MM-DD` format.
|
|
523
|
+
* @public
|
|
524
|
+
*/
|
|
525
|
+
start?: string | undefined;
|
|
526
|
+
/**
|
|
527
|
+
* The end date of the range, inclusive, in `YYYY-MM-DD` format.
|
|
528
|
+
* @public
|
|
529
|
+
*/
|
|
530
|
+
end?: string | undefined;
|
|
531
|
+
}
|
|
532
|
+
/**
|
|
533
|
+
* Dates relevant to the patient's condition and care. Include only the dates that apply to the claim.
|
|
534
|
+
* @public
|
|
535
|
+
*/
|
|
536
|
+
export interface ProfessionalClaimSubmissionClinicalDates {
|
|
537
|
+
/**
|
|
538
|
+
* **[CMS-1500 Box 14]** The date the patient first experienced acute symptoms of the current illness or injury. Required when a service in the claim is the first for a new illness or injury, when the claim is related to an employment or accident condition, or when the payer requires it. For an emergency, provide this date when it is known and differs from the date of service.
|
|
539
|
+
* @public
|
|
540
|
+
*/
|
|
541
|
+
onsetOfCurrentIllness?: string | undefined;
|
|
542
|
+
/**
|
|
543
|
+
* **[CMS-1500 Box 14]** The date of the patient's last menstrual period (LMP) before pregnancy. Provide for claims related to a pregnancy.
|
|
544
|
+
* @public
|
|
545
|
+
*/
|
|
546
|
+
lastMenstrualPeriod?: string | undefined;
|
|
547
|
+
/**
|
|
548
|
+
* **[CMS-1500 Box 15]** The date the patient first received treatment for the current condition. Required when this date impacts adjudication for services such as spinal manipulation, physical or occupational therapy, or pregnancy.
|
|
549
|
+
* @public
|
|
550
|
+
*/
|
|
551
|
+
initialTreatment?: string | undefined;
|
|
552
|
+
/**
|
|
553
|
+
* **[CMS-1500 Box 15]** The date the patient was last seen by the attending or supervising physician for the qualifying condition. Required for routine foot care services when this date impacts adjudication.
|
|
554
|
+
* @public
|
|
555
|
+
*/
|
|
556
|
+
lastSeen?: string | undefined;
|
|
557
|
+
/**
|
|
558
|
+
* **[CMS-1500 Box 15]** The date the patient first experienced acute symptoms of a chronic condition. Required for certain spinal manipulation claims billed to Medicare.
|
|
559
|
+
* @public
|
|
560
|
+
*/
|
|
561
|
+
acuteManifestationOfChronicCondition?: string | undefined;
|
|
562
|
+
/**
|
|
563
|
+
* **[CMS-1500 Box 15]** The date of the accident related to this claim. Required when `patientCondition.isAutoAccidentRelated` or `patientCondition.isOtherAccidentRelated` is `true`, and when the condition is employment-related and resulted from an accident.
|
|
564
|
+
* @public
|
|
565
|
+
*/
|
|
566
|
+
accident?: string | undefined;
|
|
567
|
+
/**
|
|
568
|
+
* **[CMS-1500 Box 15]** The date of the patient's last X-ray, for claims related to spinal manipulation.
|
|
569
|
+
* @public
|
|
570
|
+
*/
|
|
571
|
+
lastXray?: string | undefined;
|
|
572
|
+
/**
|
|
573
|
+
* **[CMS-1500 Box 15]** The date of the patient's hearing or vision prescription. Required for claims billing hearing devices or vision frames and lenses.
|
|
574
|
+
* @public
|
|
575
|
+
*/
|
|
576
|
+
prescription?: string | undefined;
|
|
577
|
+
/**
|
|
578
|
+
* **[CMS-1500 Box 15]** The date the provider assumed care of the patient, for shared-care arrangements.
|
|
579
|
+
* @public
|
|
580
|
+
*/
|
|
581
|
+
assumedCare?: string | undefined;
|
|
582
|
+
/**
|
|
583
|
+
* **[CMS-1500 Box 15]** The date the provider relinquished care of the patient, for shared-care arrangements.
|
|
584
|
+
* @public
|
|
585
|
+
*/
|
|
586
|
+
relinquishedCare?: string | undefined;
|
|
587
|
+
/**
|
|
588
|
+
* **[CMS-1500 Box 15]** The date of the patient's first visit or consultation, when required by the payer.
|
|
589
|
+
* @public
|
|
590
|
+
*/
|
|
591
|
+
firstVisitOrConsultation?: string | undefined;
|
|
592
|
+
/**
|
|
593
|
+
* **[CMS-1500 Box 15]** The date the repricer received the claim, when applicable.
|
|
594
|
+
* @public
|
|
595
|
+
*/
|
|
596
|
+
repricerReceived?: string | undefined;
|
|
597
|
+
/**
|
|
598
|
+
* **[CMS-1500 Box 15]** The last date the patient worked, for disability or workers' compensation claims.
|
|
599
|
+
* @public
|
|
600
|
+
*/
|
|
601
|
+
lastWorked?: string | undefined;
|
|
602
|
+
/**
|
|
603
|
+
* **[CMS-1500 Box 15]** The date the patient returned to work, for disability or workers' compensation claims.
|
|
604
|
+
* @public
|
|
605
|
+
*/
|
|
606
|
+
returnedToWork?: string | undefined;
|
|
607
|
+
/**
|
|
608
|
+
* **[CMS-1500 Box 16]** The date range during which the patient was unable to work, when applicable. Provide only `to` when the patient is no longer unable to work and the start date is unknown.
|
|
609
|
+
* @public
|
|
610
|
+
*/
|
|
611
|
+
unableToWork?: ProfessionalClaimSubmissionDateRange | undefined;
|
|
612
|
+
/**
|
|
613
|
+
* **[CMS-1500 Box 18]** The date range during which the patient was hospitalized for services in this claim. Provide `from` for the admission date and `to` for the discharge date; omit `to` while the patient is still hospitalized.
|
|
614
|
+
* @public
|
|
615
|
+
*/
|
|
616
|
+
hospitalization?: ProfessionalClaimSubmissionDateRange | undefined;
|
|
617
|
+
}
|
|
618
|
+
/**
|
|
619
|
+
* Whether the patient's illness or injury is related to employment or an accident.
|
|
620
|
+
* @public
|
|
621
|
+
*/
|
|
622
|
+
export interface ProfessionalClaimSubmissionPatientCondition {
|
|
623
|
+
/**
|
|
624
|
+
* **[CMS-1500 Box 10a]** Whether the patient's condition is related to their employment.
|
|
625
|
+
* @public
|
|
626
|
+
*/
|
|
627
|
+
isEmploymentRelated?: boolean | undefined;
|
|
628
|
+
/**
|
|
629
|
+
* **[CMS-1500 Box 10b]** Whether the patient's condition is related to an automobile accident. When `true`, set `autoAccidentState`. Other insurance, such as automobile liability coverage, may be the primary payer.
|
|
630
|
+
* @public
|
|
631
|
+
*/
|
|
632
|
+
isAutoAccidentRelated?: boolean | undefined;
|
|
633
|
+
/**
|
|
634
|
+
* **[CMS-1500 Box 10c]** Whether the patient's condition is related to an accident other than an automobile accident.
|
|
635
|
+
* @public
|
|
636
|
+
*/
|
|
637
|
+
isOtherAccidentRelated?: boolean | undefined;
|
|
638
|
+
/**
|
|
639
|
+
* **[CMS-1500 Box 10b]** The two-letter state code where the automobile accident occurred. Required when `isAutoAccidentRelated` is `true`.
|
|
640
|
+
* @public
|
|
641
|
+
*/
|
|
642
|
+
autoAccidentState?: string | undefined;
|
|
643
|
+
}
|
|
644
|
+
/**
|
|
645
|
+
* Identifiers for a referring provider.
|
|
646
|
+
* @public
|
|
647
|
+
*/
|
|
648
|
+
export interface ProfessionalClaimSubmissionReferringProviderIdentifiers {
|
|
649
|
+
/**
|
|
650
|
+
* **[CMS-1500 Box 17b]** The referring provider's [National Provider Identifier (NPI)](https://www.stedi.com/docs/healthcare/national-provider-identifier), a unique 10-digit ID issued by the Centers for Medicare & Medicaid Services (CMS).
|
|
651
|
+
* @public
|
|
652
|
+
*/
|
|
653
|
+
npi?: string | undefined;
|
|
654
|
+
/**
|
|
655
|
+
* **[CMS-1500 Box 17a]** The referring provider's state license number, assigned by a state licensing board. Include only when the payer requires it in addition to the NPI.
|
|
656
|
+
* @public
|
|
657
|
+
*/
|
|
658
|
+
stateLicenseNumber?: string | undefined;
|
|
659
|
+
/**
|
|
660
|
+
* **[CMS-1500 Box 17a]** A commercial number assigned to the referring provider by the payer. Include only when the payer requires it in addition to the NPI.
|
|
661
|
+
* @public
|
|
662
|
+
*/
|
|
663
|
+
commercialNumber?: string | undefined;
|
|
664
|
+
}
|
|
665
|
+
/**
|
|
666
|
+
* A name that belongs to a person.
|
|
667
|
+
* @public
|
|
668
|
+
*/
|
|
669
|
+
export type ProfessionalClaimSubmissionQualifiedPersonName = ProfessionalClaimSubmissionQualifiedPersonName.PersonMember | ProfessionalClaimSubmissionQualifiedPersonName.$UnknownMember;
|
|
670
|
+
/**
|
|
671
|
+
* @public
|
|
672
|
+
*/
|
|
673
|
+
export declare namespace ProfessionalClaimSubmissionQualifiedPersonName {
|
|
674
|
+
/**
|
|
675
|
+
* The person's name.
|
|
676
|
+
* @public
|
|
677
|
+
*/
|
|
678
|
+
interface PersonMember {
|
|
679
|
+
person: ProfessionalClaimSubmissionPersonName;
|
|
680
|
+
$unknown?: never;
|
|
681
|
+
}
|
|
682
|
+
/**
|
|
683
|
+
* @public
|
|
684
|
+
*/
|
|
685
|
+
interface $UnknownMember {
|
|
686
|
+
person?: never;
|
|
687
|
+
$unknown: [string, any];
|
|
688
|
+
}
|
|
689
|
+
/**
|
|
690
|
+
* @deprecated unused in schema-serde mode.
|
|
691
|
+
*
|
|
692
|
+
*/
|
|
693
|
+
interface Visitor<T> {
|
|
694
|
+
person: (value: ProfessionalClaimSubmissionPersonName) => T;
|
|
695
|
+
_: (name: string, value: any) => T;
|
|
696
|
+
}
|
|
697
|
+
}
|
|
698
|
+
/**
|
|
699
|
+
* A provider involved in referring the patient for the care on this claim. Each provider should be an individual, not an organization, and you should supply at least the `lastName` and an identifier, which is typically the `npi`.
|
|
700
|
+
* @public
|
|
701
|
+
*/
|
|
702
|
+
export interface ProfessionalClaimSubmissionReferringProvider {
|
|
703
|
+
/**
|
|
704
|
+
* **[CMS-1500 Box 17]** The full name of the referring provider.
|
|
705
|
+
* @public
|
|
706
|
+
*/
|
|
707
|
+
name: ProfessionalClaimSubmissionQualifiedPersonName | undefined;
|
|
708
|
+
/**
|
|
709
|
+
* **[CMS-1500 Box 17a, 17b]** Identifiers for the referring provider.
|
|
710
|
+
* @public
|
|
711
|
+
*/
|
|
712
|
+
identifiers?: ProfessionalClaimSubmissionReferringProviderIdentifiers | undefined;
|
|
713
|
+
}
|
|
714
|
+
/**
|
|
715
|
+
* Payer-issued reference numbers that apply to the entire claim.
|
|
716
|
+
* @public
|
|
717
|
+
*/
|
|
718
|
+
export interface ProfessionalClaimSubmissionReferenceNumbers {
|
|
719
|
+
/**
|
|
720
|
+
* **[CMS-1500 Box 23]** A payer-issued prior authorization number that approves the services on this claim. Required when the payer or Utilization Management Organization (UMO) assigned an authorization number and the services were preauthorized. To override this for a specific service line, set `serviceLines[].priorAuthorizations` instead.
|
|
721
|
+
* @public
|
|
722
|
+
*/
|
|
723
|
+
priorAuthorization?: string | undefined;
|
|
724
|
+
/**
|
|
725
|
+
* **[CMS-1500 Box 23]** A referral number for the provider referral tied to the services on this claim. Required when the payer or Utilization Management Organization (UMO) assigned a referral number and a referral is involved.
|
|
726
|
+
* @public
|
|
727
|
+
*/
|
|
728
|
+
referral?: string | undefined;
|
|
729
|
+
/**
|
|
730
|
+
* **[CMS-1500 Box 23]** The Clinical Laboratory Improvement Amendments (CLIA) certification number. Required for all CLIA-certified facilities performing CLIA-covered laboratory services. When the claim contains both in-house and outsourced laboratory services, use the CLIA number for services performed by the billing or rendering provider.
|
|
731
|
+
* @public
|
|
732
|
+
*/
|
|
733
|
+
clia?: string | undefined;
|
|
734
|
+
/**
|
|
735
|
+
* **[CMS-1500 Box 23]** The facility's six-digit FDA Mammography Quality Standards Act (MQSA) certification number. Required when mammography services are rendered by a certified mammography provider.
|
|
736
|
+
* @public
|
|
737
|
+
*/
|
|
738
|
+
mammographyCertification?: string | undefined;
|
|
739
|
+
}
|
|
740
|
+
/**
|
|
741
|
+
* Information identifying this claim as a replacement or cancellation of a previously submitted claim.
|
|
742
|
+
* @public
|
|
743
|
+
*/
|
|
744
|
+
export interface ProfessionalClaimSubmissionResubmission {
|
|
745
|
+
/**
|
|
746
|
+
* Whether this claim replaces or cancels a previously submitted claim.
|
|
747
|
+
* @public
|
|
748
|
+
*/
|
|
749
|
+
code?: ProfessionalClaimSubmissionClaimFrequencyCode | undefined;
|
|
750
|
+
/**
|
|
751
|
+
* The Payer Claim Control Number (sometimes called the ICN) of the original claim being replaced or cancelled. Generally required when `code` is set. One exception is Original Medicare, which specifies that you omit this value from resubmissions.
|
|
752
|
+
* @public
|
|
753
|
+
*/
|
|
754
|
+
originalReferenceNumber?: string | undefined;
|
|
755
|
+
}
|
|
756
|
+
/**
|
|
757
|
+
* Identifiers for a supervising provider.
|
|
758
|
+
* @public
|
|
759
|
+
*/
|
|
760
|
+
export interface ProfessionalClaimSubmissionSupervisingProviderIdentifiers {
|
|
761
|
+
/**
|
|
762
|
+
* **[CMS-1500 Box 17b]** The supervising provider's [National Provider Identifier (NPI)](https://www.stedi.com/docs/healthcare/national-provider-identifier), a unique 10-digit ID issued by the Centers for Medicare & Medicaid Services (CMS).
|
|
763
|
+
* @public
|
|
764
|
+
*/
|
|
765
|
+
npi?: string | undefined;
|
|
766
|
+
/**
|
|
767
|
+
* **[CMS-1500 Box 17a]** The supervising provider's state license number, assigned by a state licensing board. Include only when the payer requires it in addition to the NPI.
|
|
768
|
+
* @public
|
|
769
|
+
*/
|
|
770
|
+
stateLicenseNumber?: string | undefined;
|
|
771
|
+
/**
|
|
772
|
+
* **[CMS-1500 Box 17a]** A commercial number assigned to the supervising provider by the payer. Include only when the payer requires it in addition to the NPI.
|
|
773
|
+
* @public
|
|
774
|
+
*/
|
|
775
|
+
commercialNumber?: string | undefined;
|
|
776
|
+
/**
|
|
777
|
+
* **[CMS-1500 Box 17a]** A location number assigned to the supervising provider by the payer. Include only when the payer requires it in addition to the NPI.
|
|
778
|
+
* @public
|
|
779
|
+
*/
|
|
780
|
+
locationNumber?: string | undefined;
|
|
781
|
+
}
|
|
782
|
+
/**
|
|
783
|
+
* The provider who oversaw the rendering provider and the care reported in this claim. This should be an individual, not an organization, and you should supply at least the `lastName` and an identifier, which is typically the `npi`.
|
|
784
|
+
* @public
|
|
785
|
+
*/
|
|
786
|
+
export interface ProfessionalClaimSubmissionSupervisingProvider {
|
|
787
|
+
/**
|
|
788
|
+
* **[CMS-1500 Box 17]** The full name of the supervising provider.
|
|
789
|
+
* @public
|
|
790
|
+
*/
|
|
791
|
+
name: ProfessionalClaimSubmissionQualifiedPersonName | undefined;
|
|
792
|
+
/**
|
|
793
|
+
* **[CMS-1500 Box 17a, 17b]** Identifiers for the supervising provider.
|
|
794
|
+
* @public
|
|
795
|
+
*/
|
|
796
|
+
identifiers?: ProfessionalClaimSubmissionSupervisingProviderIdentifiers | undefined;
|
|
797
|
+
}
|
|
798
|
+
/**
|
|
799
|
+
* Clinical details about the encounter, including diagnoses, related providers, relevant dates, and supporting information.
|
|
800
|
+
* @public
|
|
801
|
+
*/
|
|
802
|
+
export interface ProfessionalClaimSubmissionEncounter {
|
|
803
|
+
/**
|
|
804
|
+
* The primary place of service code identifying where the services were rendered. When omitted, it is inferred from the most common place of service across the claim's service lines. Visit [Place of Service Codes](https://www.cms.gov/medicare/coding-billing/place-of-service-codes/code-sets) for a complete list.
|
|
805
|
+
* @public
|
|
806
|
+
*/
|
|
807
|
+
primaryPlaceOfService?: string | undefined;
|
|
808
|
+
/**
|
|
809
|
+
* **[CMS-1500 Box 21]** The principal diagnosis for the claim, which describes the main reason for the encounter. Must be an [ICD-10-CM code](https://www.cdc.gov/nchs/icd/icd-10-cm/index.html). Stedi combines this with `additionalDiagnosisCodes` and the diagnosis codes on the service lines to form the claim's diagnosis list, which can hold at most 12 codes.
|
|
810
|
+
* - Use valid, billable codes at the highest level of specificity available.
|
|
811
|
+
* - Don't submit the decimal point (e.g., submit `I639` not `I63.9`).
|
|
812
|
+
* - Don't submit header codes (codes with fewer than three characters, such as `E10` for Type 1 diabetes).
|
|
813
|
+
* @public
|
|
814
|
+
*/
|
|
815
|
+
primaryDiagnosisCode: string | undefined;
|
|
816
|
+
/**
|
|
817
|
+
* **[CMS-1500 Box 21]** Additional diagnoses for the claim beyond `primaryDiagnosisCode`, in order of importance. Use this for diagnoses that apply to the claim but are not tied to a specific service line; you don't need to repeat codes that already appear in a service line's `diagnosisCodes`. Stedi places these directly after the primary diagnosis in the claim's diagnosis list.
|
|
818
|
+
* - Use valid, billable codes at the highest level of specificity available.
|
|
819
|
+
* - Don't submit the decimal point (e.g., submit `I639` not `I63.9`).
|
|
820
|
+
* - Don't submit header codes (codes with fewer than three characters, such as `E10` for Type 1 diabetes).
|
|
821
|
+
* @public
|
|
822
|
+
*/
|
|
823
|
+
additionalDiagnosisCodes?: string[] | undefined;
|
|
824
|
+
/**
|
|
825
|
+
* **[CMS-1500 Box 10a, 10b, 10c]** Whether the patient's illness or injury is related to employment or an accident.
|
|
826
|
+
* @public
|
|
827
|
+
*/
|
|
828
|
+
patientCondition?: ProfessionalClaimSubmissionPatientCondition | undefined;
|
|
829
|
+
/**
|
|
830
|
+
* **[CMS-1500 Box 10d]** Up to four National Uniform Claim Committee (NUCC) condition codes. A condition code is a two-character code that provides extra information about the patient's condition or the claim itself, such as whether the claim is part of disaster relief. For a list, visit the [NUCC Condition Codes](https://www.nucc.org/index.php/code-sets-mainmenu-41/condition-codes-mainmenu-38).
|
|
831
|
+
* @public
|
|
832
|
+
*/
|
|
833
|
+
claimCodes?: string[] | undefined;
|
|
834
|
+
/**
|
|
835
|
+
* **[CMS-1500 Box 24h]** Early and Periodic Screening, Diagnosis, and Treatment (EPSDT) referral condition indicators for the claim. EPSDT is a Medicaid program that provides preventive health care services for children under age 21.
|
|
836
|
+
* - Include when the claim bills an EPSDT screening service, with the referral outcome of the screening.
|
|
837
|
+
* - Use `NOT_USED` when the screening did not result in a referral.
|
|
838
|
+
* - Mark services that resulted from a screening with `serviceLines[].isEpsdtRelated`.
|
|
839
|
+
* @public
|
|
840
|
+
*/
|
|
841
|
+
epsdtReferralCodes?: ProfessionalClaimSubmissionEPSDTReferralConditionIndicator[] | undefined;
|
|
842
|
+
/**
|
|
843
|
+
* **[CMS-1500 Box 14, 15, 16, 18]** Dates relevant to the patient's condition and care, such as the onset of the current illness, hospitalization dates, and dates the patient was unable to work.
|
|
844
|
+
* @public
|
|
845
|
+
*/
|
|
846
|
+
clinicalDates?: ProfessionalClaimSubmissionClinicalDates | undefined;
|
|
847
|
+
/**
|
|
848
|
+
* **[CMS-1500 Box 17, 17a, 17b]** The provider who referred the patient to the rendering provider for the care on this claim. Supply this whenever the claim involves a referral. When the patient passed through a chain of referrals, this is the most recent referral, the one the rendering provider acted on; identify the provider who wrote the earliest referral in `priorReferringProvider`.
|
|
849
|
+
* @public
|
|
850
|
+
*/
|
|
851
|
+
referringProvider?: ProfessionalClaimSubmissionReferringProvider | undefined;
|
|
852
|
+
/**
|
|
853
|
+
* **[CMS-1500 Box 17, 17a, 17b]** The provider who wrote the initial referral that began this patient's episode of care, often the patient's primary care provider. Supply this only when a different provider then referred the patient onward to the rendering provider, such as when a primary care provider refers to a specialist who refers to another specialist. Requires `referringProvider` to also be set.
|
|
854
|
+
* @public
|
|
855
|
+
*/
|
|
856
|
+
priorReferringProvider?: ProfessionalClaimSubmissionReferringProvider | undefined;
|
|
857
|
+
/**
|
|
858
|
+
* **[CMS-1500 Box 17, 17a, 17b]** The provider who oversaw the rendering provider and the care reported in this claim, when the rendering provider was supervised by a physician.
|
|
859
|
+
* @public
|
|
860
|
+
*/
|
|
861
|
+
supervisingProvider?: ProfessionalClaimSubmissionSupervisingProvider | undefined;
|
|
862
|
+
/**
|
|
863
|
+
* **[CMS-1500 Box 19]** A free-text note with additional information the payer may need to process the claim that doesn't fit anywhere else on the form.
|
|
864
|
+
* @public
|
|
865
|
+
*/
|
|
866
|
+
claimNote?: ProfessionalClaimSubmissionClaimNote | undefined;
|
|
867
|
+
/**
|
|
868
|
+
* **[CMS-1500 Box 19]** Supporting documentation attached to the claim, such as medical records or operative notes. Include only when required by the payer.
|
|
869
|
+
* @public
|
|
870
|
+
*/
|
|
871
|
+
attachments?: ProfessionalClaimSubmissionAttachment[] | undefined;
|
|
872
|
+
/**
|
|
873
|
+
* **[CMS-1500 Box 22]** Whether this claim replaces or voids a previously submitted claim. Omit when you're submitting a new claim and when you're resubmitting a claim that was rejected before it entered the payer's processing system. You must also omit this property for every resubmission to Original Medicare because Original Medicare doesn't accept `REPLACEMENT_OF_PRIOR_CLAIM`.
|
|
874
|
+
* @public
|
|
875
|
+
*/
|
|
876
|
+
resubmission?: ProfessionalClaimSubmissionResubmission | undefined;
|
|
877
|
+
/**
|
|
878
|
+
* **[CMS-1500 Box 23]** Payer-issued reference numbers for the claim, such as a prior authorization, referral, CLIA, or mammography certification number.
|
|
879
|
+
* @public
|
|
880
|
+
*/
|
|
881
|
+
referenceNumbers?: ProfessionalClaimSubmissionReferenceNumbers | undefined;
|
|
882
|
+
}
|
|
883
|
+
/**
|
|
884
|
+
* The person or entity that carries the insurance policy being billed, also called the subscriber or primary policyholder. May be different from the patient.
|
|
885
|
+
* @public
|
|
886
|
+
*/
|
|
887
|
+
export interface ProfessionalClaimSubmissionInsured {
|
|
888
|
+
/**
|
|
889
|
+
* **[CMS-1500 Box 1]** The type of health insurance plan being billed. Pick the type that best matches the plan and payer. For most commercial payers, use `OTHER`.
|
|
890
|
+
* @public
|
|
891
|
+
*/
|
|
892
|
+
insuranceType: ProfessionalClaimSubmissionInsuranceType | undefined;
|
|
893
|
+
/**
|
|
894
|
+
* **[CMS-1500 Box 1a]** The member ID for the insured's insurance policy, typically found on the insurance card. For Medicare claims, this is the insured's Medicare Beneficiary Identifier (MBI).
|
|
895
|
+
* @public
|
|
896
|
+
*/
|
|
897
|
+
memberId?: string | undefined;
|
|
898
|
+
/**
|
|
899
|
+
* **[CMS-1500 Box 4]** The full name of the insured. This is a person for most claims. Provide an organization only for workers' compensation or other property and casualty claims where the policy is held by an entity, such as the patient's employer.
|
|
900
|
+
* @public
|
|
901
|
+
*/
|
|
902
|
+
name: ProfessionalClaimSubmissionQualifiedName | undefined;
|
|
903
|
+
/**
|
|
904
|
+
* **[CMS-1500 Box 7]** The mailing address for the insured's permanent residence.
|
|
905
|
+
* @public
|
|
906
|
+
*/
|
|
907
|
+
address?: ProfessionalClaimSubmissionAddress | undefined;
|
|
908
|
+
/**
|
|
909
|
+
* **[CMS-1500 Box 11]** The payer's code for the employer or other party that purchased the plan, typically found on the insurance card. For workers' compensation claims, use the Federal Employees' Compensation Act (FECA) number for the case.
|
|
910
|
+
* @public
|
|
911
|
+
*/
|
|
912
|
+
policyOrGroupNumber?: string | undefined;
|
|
913
|
+
/**
|
|
914
|
+
* **[CMS-1500 Box 11a]** The insured's date of birth. Used to distinguish the insured from other members with similar names.
|
|
915
|
+
* @public
|
|
916
|
+
*/
|
|
917
|
+
dateOfBirth?: string | undefined;
|
|
918
|
+
/**
|
|
919
|
+
* **[CMS-1500 Box 11a]** The insured's sex.
|
|
920
|
+
* @public
|
|
921
|
+
*/
|
|
922
|
+
gender?: ProfessionalClaimSubmissionGenderCode | undefined;
|
|
923
|
+
/**
|
|
924
|
+
* **[CMS-1500 Box 11b]** The insured's Social Security Number. Only include when specifically instructed by a payer.
|
|
925
|
+
* @public
|
|
926
|
+
*/
|
|
927
|
+
ssn?: string | undefined;
|
|
928
|
+
/**
|
|
929
|
+
* **[CMS-1500 Box 11b]** The claim number assigned by a property or casualty insurer. Include for workers' compensation, automobile accident, or other liability claims when the payer requires it.
|
|
930
|
+
* @public
|
|
931
|
+
*/
|
|
932
|
+
propertyCasualtyClaimNumber?: string | undefined;
|
|
933
|
+
/**
|
|
934
|
+
* **[CMS-1500 Box 11c]** The name of the insured's insurance plan, typically found on the insurance card.
|
|
935
|
+
* @public
|
|
936
|
+
*/
|
|
937
|
+
planName?: string | undefined;
|
|
938
|
+
/**
|
|
939
|
+
* **[CMS-1500 Box 11]** The payer's responsibility level for this claim. This form supports claims to primary payers only.
|
|
940
|
+
* @public
|
|
941
|
+
*/
|
|
942
|
+
paymentResponsibilityLevelCode: ProfessionalClaimSubmissionPaymentResponsibilityLevelCode | undefined;
|
|
943
|
+
}
|
|
944
|
+
/**
|
|
945
|
+
* Signature and assignment-of-benefits indicators for coverage under another policy.
|
|
946
|
+
* @public
|
|
947
|
+
*/
|
|
948
|
+
export interface ProfessionalClaimSubmissionOtherInsuredAuthorization {
|
|
949
|
+
/**
|
|
950
|
+
* Whether the other insured has authorized payment of benefits directly to the provider.
|
|
951
|
+
* @public
|
|
952
|
+
*/
|
|
953
|
+
insuredAuthorizesAssignment: ProfessionalClaimSubmissionBenefitsAssignmentCertificationIndicator | undefined;
|
|
954
|
+
/**
|
|
955
|
+
* Whether the provider generated the patient's signature because the patient was physically unable to sign.
|
|
956
|
+
* @public
|
|
957
|
+
*/
|
|
958
|
+
providerGeneratedPatientSignature?: boolean | undefined;
|
|
959
|
+
/**
|
|
960
|
+
* Whether the provider has the other insured's authorization to release medical information needed to process the claim.
|
|
961
|
+
* @public
|
|
962
|
+
*/
|
|
963
|
+
patientReleasesMedicalInfo: ProfessionalClaimSubmissionReleaseOfInformationCode | undefined;
|
|
964
|
+
}
|
|
965
|
+
/**
|
|
966
|
+
* An identifier for the other payer. Provide exactly one.
|
|
967
|
+
* @public
|
|
968
|
+
*/
|
|
969
|
+
export type ProfessionalClaimSubmissionOtherPayerId = ProfessionalClaimSubmissionOtherPayerId.CmsPlanIdMember | ProfessionalClaimSubmissionOtherPayerId.PayerIdMember | ProfessionalClaimSubmissionOtherPayerId.$UnknownMember;
|
|
970
|
+
/**
|
|
971
|
+
* @public
|
|
972
|
+
*/
|
|
973
|
+
export declare namespace ProfessionalClaimSubmissionOtherPayerId {
|
|
974
|
+
/**
|
|
975
|
+
* The other payer's payer identification number.
|
|
976
|
+
* @public
|
|
977
|
+
*/
|
|
978
|
+
interface PayerIdMember {
|
|
979
|
+
payerId: string;
|
|
980
|
+
cmsPlanId?: never;
|
|
981
|
+
$unknown?: never;
|
|
982
|
+
}
|
|
983
|
+
/**
|
|
984
|
+
* The other payer's CMS plan ID, such as a Health Plan ID (HPID) or Other Entity Identifier (OEID).
|
|
985
|
+
* @public
|
|
986
|
+
*/
|
|
987
|
+
interface CmsPlanIdMember {
|
|
988
|
+
payerId?: never;
|
|
989
|
+
cmsPlanId: string;
|
|
990
|
+
$unknown?: never;
|
|
991
|
+
}
|
|
992
|
+
/**
|
|
993
|
+
* @public
|
|
994
|
+
*/
|
|
995
|
+
interface $UnknownMember {
|
|
996
|
+
payerId?: never;
|
|
997
|
+
cmsPlanId?: never;
|
|
998
|
+
$unknown: [string, any];
|
|
999
|
+
}
|
|
1000
|
+
/**
|
|
1001
|
+
* @deprecated unused in schema-serde mode.
|
|
1002
|
+
*
|
|
1003
|
+
*/
|
|
1004
|
+
interface Visitor<T> {
|
|
1005
|
+
payerId: (value: string) => T;
|
|
1006
|
+
cmsPlanId: (value: string) => T;
|
|
1007
|
+
_: (name: string, value: any) => T;
|
|
1008
|
+
}
|
|
1009
|
+
}
|
|
1010
|
+
/**
|
|
1011
|
+
* The payer that provides coverage under another policy.
|
|
1012
|
+
* @public
|
|
1013
|
+
*/
|
|
1014
|
+
export interface ProfessionalClaimSubmissionOtherPayer {
|
|
1015
|
+
/**
|
|
1016
|
+
* The other payer's business name.
|
|
1017
|
+
* @public
|
|
1018
|
+
*/
|
|
1019
|
+
name: ProfessionalClaimSubmissionQualifiedOrganizationName | undefined;
|
|
1020
|
+
/**
|
|
1021
|
+
* The other payer's identifier.
|
|
1022
|
+
* @public
|
|
1023
|
+
*/
|
|
1024
|
+
id: ProfessionalClaimSubmissionOtherPayerId | undefined;
|
|
1025
|
+
}
|
|
1026
|
+
/**
|
|
1027
|
+
* A policy, other than the one being billed, under which the patient is covered. Used for coordination of benefits.
|
|
1028
|
+
* @public
|
|
1029
|
+
*/
|
|
1030
|
+
export interface ProfessionalClaimSubmissionOtherInsured {
|
|
1031
|
+
/**
|
|
1032
|
+
* **[CMS-1500 Box 9]** The name of the person insured under the other policy.
|
|
1033
|
+
* @public
|
|
1034
|
+
*/
|
|
1035
|
+
name: ProfessionalClaimSubmissionQualifiedName | undefined;
|
|
1036
|
+
/**
|
|
1037
|
+
* **[CMS-1500 Box 9]** The member ID for the other policy.
|
|
1038
|
+
* @public
|
|
1039
|
+
*/
|
|
1040
|
+
memberId: string | undefined;
|
|
1041
|
+
/**
|
|
1042
|
+
* The other payer's responsibility level for this claim, relative to the payer being billed.
|
|
1043
|
+
* @public
|
|
1044
|
+
*/
|
|
1045
|
+
responsibilityLevel: ProfessionalClaimSubmissionResponsibilityLevel | undefined;
|
|
1046
|
+
/**
|
|
1047
|
+
* How the patient is related to the person insured under the other policy.
|
|
1048
|
+
* @public
|
|
1049
|
+
*/
|
|
1050
|
+
relationshipToInsured: ProfessionalClaimSubmissionOtherInsuredRelationshipToInsured | undefined;
|
|
1051
|
+
/**
|
|
1052
|
+
* The type of plan or payer the other coverage is filed under.
|
|
1053
|
+
* @public
|
|
1054
|
+
*/
|
|
1055
|
+
claimFilingIndicator: ProfessionalClaimSubmissionClaimFilingIndicator | undefined;
|
|
1056
|
+
/**
|
|
1057
|
+
* The payer that provides the other coverage.
|
|
1058
|
+
* @public
|
|
1059
|
+
*/
|
|
1060
|
+
otherPayer: ProfessionalClaimSubmissionOtherPayer | undefined;
|
|
1061
|
+
/**
|
|
1062
|
+
* The mailing address of the person insured under the other policy.
|
|
1063
|
+
* @public
|
|
1064
|
+
*/
|
|
1065
|
+
address?: ProfessionalClaimSubmissionAddress | undefined;
|
|
1066
|
+
/**
|
|
1067
|
+
* **[CMS-1500 Box 9a]** The policy or group number for the other coverage.
|
|
1068
|
+
* @public
|
|
1069
|
+
*/
|
|
1070
|
+
policyOrGroupNumber?: string | undefined;
|
|
1071
|
+
/**
|
|
1072
|
+
* **[CMS-1500 Box 9d]** The name of the other insurance plan.
|
|
1073
|
+
* @public
|
|
1074
|
+
*/
|
|
1075
|
+
planName?: string | undefined;
|
|
1076
|
+
/**
|
|
1077
|
+
* The Social Security Number of the person insured under the other policy. Only include when specifically instructed by a payer.
|
|
1078
|
+
* @public
|
|
1079
|
+
*/
|
|
1080
|
+
ssn?: string | undefined;
|
|
1081
|
+
/**
|
|
1082
|
+
* The Medicare secondary payer reason, when the other coverage makes Medicare the secondary payer.
|
|
1083
|
+
* @public
|
|
1084
|
+
*/
|
|
1085
|
+
medicareSecondaryInsuranceType?: ProfessionalClaimSubmissionMedicareSecondaryInsuranceType | undefined;
|
|
1086
|
+
/**
|
|
1087
|
+
* Signature and assignment-of-benefits indicators for the other coverage.
|
|
1088
|
+
* @public
|
|
1089
|
+
*/
|
|
1090
|
+
authorization: ProfessionalClaimSubmissionOtherInsuredAuthorization | undefined;
|
|
1091
|
+
}
|
|
1092
|
+
/**
|
|
1093
|
+
* The person who received care, when they are someone other than the insured.
|
|
1094
|
+
* @public
|
|
1095
|
+
*/
|
|
1096
|
+
export interface ProfessionalClaimSubmissionPatient {
|
|
1097
|
+
/**
|
|
1098
|
+
* **[CMS-1500 Box 2]** The full name of the person who received care.
|
|
1099
|
+
* @public
|
|
1100
|
+
*/
|
|
1101
|
+
name: ProfessionalClaimSubmissionQualifiedPersonName | undefined;
|
|
1102
|
+
/**
|
|
1103
|
+
* **[CMS-1500 Box 3]** The patient's date of birth. Used to distinguish the patient from other members with similar names.
|
|
1104
|
+
* @public
|
|
1105
|
+
*/
|
|
1106
|
+
dateOfBirth: string | undefined;
|
|
1107
|
+
/**
|
|
1108
|
+
* **[CMS-1500 Box 3]** The patient's sex.
|
|
1109
|
+
* @public
|
|
1110
|
+
*/
|
|
1111
|
+
gender: ProfessionalClaimSubmissionGenderCode | undefined;
|
|
1112
|
+
/**
|
|
1113
|
+
* **[CMS-1500 Box 5]** The mailing address for the patient's permanent residence.
|
|
1114
|
+
* @public
|
|
1115
|
+
*/
|
|
1116
|
+
address: ProfessionalClaimSubmissionAddress | undefined;
|
|
1117
|
+
/**
|
|
1118
|
+
* **[CMS-1500 Box 6]** How the patient is related to the insured.
|
|
1119
|
+
* @public
|
|
1120
|
+
*/
|
|
1121
|
+
relationshipToInsured: ProfessionalClaimSubmissionPatientRelationshipToInsured | undefined;
|
|
1122
|
+
}
|
|
1123
|
+
/**
|
|
1124
|
+
* The payer being billed for the claim.
|
|
1125
|
+
* @public
|
|
1126
|
+
*/
|
|
1127
|
+
export interface ProfessionalClaimSubmissionPayer {
|
|
1128
|
+
/**
|
|
1129
|
+
* **[CMS-1500 Carrier Block]** The Stedi payer ID for the payer being billed. Visit the [Payer Network](https://www.stedi.com/healthcare/network) for a complete list.
|
|
1130
|
+
* - You can send requests using the primary payer ID, the Stedi payer ID, or any alias listed in the payer record.
|
|
1131
|
+
* - You must include leading 0 characters. Payer IDs are alphanumeric strings and must be treated as complete strings, not integers. For example, use `00540` for SISCO, not `540`.
|
|
1132
|
+
* @public
|
|
1133
|
+
*/
|
|
1134
|
+
id: string | undefined;
|
|
1135
|
+
/**
|
|
1136
|
+
* **[CMS-1500 Carrier Block]** The payer's business name, such as `Aetna` or `Cigna`.
|
|
1137
|
+
* @public
|
|
1138
|
+
*/
|
|
1139
|
+
name?: ProfessionalClaimSubmissionQualifiedOrganizationName | undefined;
|
|
1140
|
+
/**
|
|
1141
|
+
* **[CMS-1500 Carrier Block]** The payer's mailing address.
|
|
1142
|
+
* @public
|
|
1143
|
+
*/
|
|
1144
|
+
address?: ProfessionalClaimSubmissionAddress | undefined;
|
|
1145
|
+
/**
|
|
1146
|
+
* **[CMS-1500 Carrier Block]** The ID of the receiver that processes the claim, typically the clearinghouse or payer. Only include when the receiver differs from the payer.
|
|
1147
|
+
* @public
|
|
1148
|
+
*/
|
|
1149
|
+
receiverId?: string | undefined;
|
|
1150
|
+
}
|
|
1151
|
+
/**
|
|
1152
|
+
* A prescription number or compound drug link sequence number. Provide exactly one.
|
|
1153
|
+
* @public
|
|
1154
|
+
*/
|
|
1155
|
+
export type ProfessionalClaimSubmissionPrescriptionOrCompoundDrugAssociationNumber = ProfessionalClaimSubmissionPrescriptionOrCompoundDrugAssociationNumber.LinkSequenceNumberMember | ProfessionalClaimSubmissionPrescriptionOrCompoundDrugAssociationNumber.PharmacyPrescriptionNumberMember | ProfessionalClaimSubmissionPrescriptionOrCompoundDrugAssociationNumber.$UnknownMember;
|
|
1156
|
+
/**
|
|
1157
|
+
* @public
|
|
1158
|
+
*/
|
|
1159
|
+
export declare namespace ProfessionalClaimSubmissionPrescriptionOrCompoundDrugAssociationNumber {
|
|
1160
|
+
/**
|
|
1161
|
+
* A provider-assigned number, unique to this claim, that ties together the components of a compound drug when there is no prescription number.
|
|
1162
|
+
* @public
|
|
1163
|
+
*/
|
|
1164
|
+
interface LinkSequenceNumberMember {
|
|
1165
|
+
linkSequenceNumber: string;
|
|
1166
|
+
pharmacyPrescriptionNumber?: never;
|
|
1167
|
+
$unknown?: never;
|
|
1168
|
+
}
|
|
1169
|
+
/**
|
|
1170
|
+
* The pharmacy prescription number. For a compound drug, all components share the same prescription number so the payer can relate them.
|
|
1171
|
+
* @public
|
|
1172
|
+
*/
|
|
1173
|
+
interface PharmacyPrescriptionNumberMember {
|
|
1174
|
+
linkSequenceNumber?: never;
|
|
1175
|
+
pharmacyPrescriptionNumber: string;
|
|
1176
|
+
$unknown?: never;
|
|
1177
|
+
}
|
|
1178
|
+
/**
|
|
1179
|
+
* @public
|
|
1180
|
+
*/
|
|
1181
|
+
interface $UnknownMember {
|
|
1182
|
+
linkSequenceNumber?: never;
|
|
1183
|
+
pharmacyPrescriptionNumber?: never;
|
|
1184
|
+
$unknown: [string, any];
|
|
1185
|
+
}
|
|
1186
|
+
/**
|
|
1187
|
+
* @deprecated unused in schema-serde mode.
|
|
1188
|
+
*
|
|
1189
|
+
*/
|
|
1190
|
+
interface Visitor<T> {
|
|
1191
|
+
linkSequenceNumber: (value: string) => T;
|
|
1192
|
+
pharmacyPrescriptionNumber: (value: string) => T;
|
|
1193
|
+
_: (name: string, value: any) => T;
|
|
1194
|
+
}
|
|
1195
|
+
}
|
|
1196
|
+
/**
|
|
1197
|
+
* Drug identification details for a service line, required when a drug is billed and a prescription was written.
|
|
1198
|
+
* @public
|
|
1199
|
+
*/
|
|
1200
|
+
export interface ProfessionalClaimSubmissionDrugIdentification {
|
|
1201
|
+
/**
|
|
1202
|
+
* The dispensed drug's National Drug Code (NDC).
|
|
1203
|
+
* @public
|
|
1204
|
+
*/
|
|
1205
|
+
nationalDrugCode: string | undefined;
|
|
1206
|
+
/**
|
|
1207
|
+
* The quantity of the drug administered, expressed in the unit given by `unitOfMeasure`.
|
|
1208
|
+
* @public
|
|
1209
|
+
*/
|
|
1210
|
+
unitCount: string | undefined;
|
|
1211
|
+
/**
|
|
1212
|
+
* The unit of measure for `unitCount`.
|
|
1213
|
+
* @public
|
|
1214
|
+
*/
|
|
1215
|
+
unitOfMeasure: ProfessionalClaimSubmissionDrugIdentificationUnitOfMeasure | undefined;
|
|
1216
|
+
/**
|
|
1217
|
+
* A prescription number or, for compound drugs, a link sequence number that ties the components of the compound together.
|
|
1218
|
+
* @public
|
|
1219
|
+
*/
|
|
1220
|
+
associationNumber?: ProfessionalClaimSubmissionPrescriptionOrCompoundDrugAssociationNumber | undefined;
|
|
1221
|
+
/**
|
|
1222
|
+
* The original National Drug Code (NDC), when it differs from the code reported in `nationalDrugCode`.
|
|
1223
|
+
* @public
|
|
1224
|
+
*/
|
|
1225
|
+
originalNdc?: string | undefined;
|
|
1226
|
+
}
|
|
1227
|
+
/**
|
|
1228
|
+
* Identifiers for an ordering provider.
|
|
1229
|
+
* @public
|
|
1230
|
+
*/
|
|
1231
|
+
export interface ProfessionalClaimSubmissionOrderingProviderIdentifiers {
|
|
1232
|
+
/**
|
|
1233
|
+
* **[CMS-1500 Box 17b]** The ordering provider's [National Provider Identifier (NPI)](https://www.stedi.com/docs/healthcare/national-provider-identifier), a unique 10-digit ID issued by the Centers for Medicare & Medicaid Services (CMS).
|
|
1234
|
+
* @public
|
|
1235
|
+
*/
|
|
1236
|
+
npi?: string | undefined;
|
|
1237
|
+
/**
|
|
1238
|
+
* **[CMS-1500 Box 17a]** The ordering provider's state license number, assigned by a state licensing board. Include only when the payer requires it in addition to the NPI.
|
|
1239
|
+
* @public
|
|
1240
|
+
*/
|
|
1241
|
+
stateLicenseNumber?: string | undefined;
|
|
1242
|
+
/**
|
|
1243
|
+
* **[CMS-1500 Box 17a]** A commercial number assigned to the ordering provider by the payer. Include only when the payer requires it in addition to the NPI.
|
|
1244
|
+
* @public
|
|
1245
|
+
*/
|
|
1246
|
+
commercialNumber?: string | undefined;
|
|
1247
|
+
}
|
|
1248
|
+
/**
|
|
1249
|
+
* The provider who ordered the services, tests, or supplies on a service line. This should be an individual, not an organization, and you should supply at least the `lastName` and an identifier, which is typically the `npi`.
|
|
1250
|
+
* @public
|
|
1251
|
+
*/
|
|
1252
|
+
export interface ProfessionalClaimSubmissionOrderingProvider {
|
|
1253
|
+
/**
|
|
1254
|
+
* **[CMS-1500 Box 17]** The full name of the ordering provider.
|
|
1255
|
+
* @public
|
|
1256
|
+
*/
|
|
1257
|
+
name: ProfessionalClaimSubmissionQualifiedPersonName | undefined;
|
|
1258
|
+
/**
|
|
1259
|
+
* **[CMS-1500 Box 17a, 17b]** Identifiers for the ordering provider.
|
|
1260
|
+
* @public
|
|
1261
|
+
*/
|
|
1262
|
+
identifiers?: ProfessionalClaimSubmissionOrderingProviderIdentifiers | undefined;
|
|
1263
|
+
}
|
|
1264
|
+
/**
|
|
1265
|
+
* A prior authorization number that applies to a service line. Use this only for service-level numbers that differ from the claim-level authorization in `encounter.referenceNumbers.priorAuthorization`.
|
|
1266
|
+
* @public
|
|
1267
|
+
*/
|
|
1268
|
+
export interface ProfessionalClaimSubmissionServiceLinePriorAuthorizationNumber {
|
|
1269
|
+
/**
|
|
1270
|
+
* The payer-issued prior authorization number for this service line.
|
|
1271
|
+
* @public
|
|
1272
|
+
*/
|
|
1273
|
+
priorAuthorizationNumber: string | undefined;
|
|
1274
|
+
/**
|
|
1275
|
+
* The identifier of the other payer that issued this prior authorization number. Include only when the number was issued by a payer other than the one being billed, and match the other payer's identifier in `otherInsured[].otherPayer.id`.
|
|
1276
|
+
* @public
|
|
1277
|
+
*/
|
|
1278
|
+
otherPayerPrimaryId?: string | undefined;
|
|
1279
|
+
}
|
|
1280
|
+
/**
|
|
1281
|
+
* A procedure, service, or supply code with any applicable modifiers.
|
|
1282
|
+
* @public
|
|
1283
|
+
*/
|
|
1284
|
+
export interface ProfessionalClaimSubmissionProcedureCode {
|
|
1285
|
+
/**
|
|
1286
|
+
* The procedure, service, or supply code, typically a CPT or HCPCS code.
|
|
1287
|
+
* @public
|
|
1288
|
+
*/
|
|
1289
|
+
code: string | undefined;
|
|
1290
|
+
/**
|
|
1291
|
+
* Up to four modifier codes that convey special circumstances related to the service, such as `25` or `JW`.
|
|
1292
|
+
* @public
|
|
1293
|
+
*/
|
|
1294
|
+
modifiers?: string[] | undefined;
|
|
1295
|
+
}
|
|
1296
|
+
/**
|
|
1297
|
+
* Identifiers for a purchased service provider.
|
|
1298
|
+
* @public
|
|
1299
|
+
*/
|
|
1300
|
+
export interface ProfessionalClaimSubmissionPurchasedServiceProviderIdentifiers {
|
|
1301
|
+
/**
|
|
1302
|
+
* **[CMS-1500 Box 32a]** The purchased service provider's [National Provider Identifier (NPI)](https://www.stedi.com/docs/healthcare/national-provider-identifier), a unique 10-digit ID issued by the Centers for Medicare & Medicaid Services (CMS).
|
|
1303
|
+
* @public
|
|
1304
|
+
*/
|
|
1305
|
+
npi: string | undefined;
|
|
1306
|
+
}
|
|
1307
|
+
/**
|
|
1308
|
+
* The outside provider the billing provider bought the service from.
|
|
1309
|
+
* @public
|
|
1310
|
+
*/
|
|
1311
|
+
export interface ProfessionalClaimSubmissionPurchasedServiceProvider {
|
|
1312
|
+
/**
|
|
1313
|
+
* Whether the outside provider is a person or an organization.
|
|
1314
|
+
* @public
|
|
1315
|
+
*/
|
|
1316
|
+
entityType: ProfessionalClaimSubmissionPurchasedServiceProviderEntityType | undefined;
|
|
1317
|
+
/**
|
|
1318
|
+
* Identifiers for the purchased service provider.
|
|
1319
|
+
* @public
|
|
1320
|
+
*/
|
|
1321
|
+
identifiers: ProfessionalClaimSubmissionPurchasedServiceProviderIdentifiers | undefined;
|
|
1322
|
+
}
|
|
1323
|
+
/**
|
|
1324
|
+
* A service the billing provider bought from an outside provider and is billing to the payer.
|
|
1325
|
+
* @public
|
|
1326
|
+
*/
|
|
1327
|
+
export interface ProfessionalClaimSubmissionPurchasedService {
|
|
1328
|
+
/**
|
|
1329
|
+
* **[CMS-1500 Box 20]** The price the billing provider paid the outside provider for this service.
|
|
1330
|
+
* @public
|
|
1331
|
+
*/
|
|
1332
|
+
chargeAmount: string | undefined;
|
|
1333
|
+
/**
|
|
1334
|
+
* The outside provider the billing provider bought this service from.
|
|
1335
|
+
* @public
|
|
1336
|
+
*/
|
|
1337
|
+
provider: ProfessionalClaimSubmissionPurchasedServiceProvider | undefined;
|
|
1338
|
+
}
|
|
1339
|
+
/**
|
|
1340
|
+
* Identifiers for the rendering provider.
|
|
1341
|
+
* @public
|
|
1342
|
+
*/
|
|
1343
|
+
export interface ProfessionalClaimSubmissionRenderingProviderIdentifiers {
|
|
1344
|
+
/**
|
|
1345
|
+
* **[CMS-1500 Box 24j]** The rendering provider's [National Provider Identifier (NPI)](https://www.stedi.com/docs/healthcare/national-provider-identifier), a unique 10-digit ID issued by the Centers for Medicare & Medicaid Services (CMS).
|
|
1346
|
+
* @public
|
|
1347
|
+
*/
|
|
1348
|
+
npi?: string | undefined;
|
|
1349
|
+
/**
|
|
1350
|
+
* **[CMS-1500 Box 24i]** The rendering provider's state license number, assigned by a state licensing board. Include only when the payer requires it in addition to the NPI.
|
|
1351
|
+
* @public
|
|
1352
|
+
*/
|
|
1353
|
+
stateLicenseNumber?: string | undefined;
|
|
1354
|
+
/**
|
|
1355
|
+
* **[CMS-1500 Box 24i]** A commercial number assigned to the rendering provider by the payer. Include only when the payer requires it in addition to the NPI.
|
|
1356
|
+
* @public
|
|
1357
|
+
*/
|
|
1358
|
+
commercialNumber?: string | undefined;
|
|
1359
|
+
/**
|
|
1360
|
+
* **[CMS-1500 Box 24i]** A location number assigned to the rendering provider by the payer. Include only when the payer requires it in addition to the NPI.
|
|
1361
|
+
* @public
|
|
1362
|
+
*/
|
|
1363
|
+
locationNumber?: string | undefined;
|
|
1364
|
+
/**
|
|
1365
|
+
* **[CMS-1500 Box 24i]** The rendering provider's taxonomy code from the National Uniform Claim Committee [Health Care Provider Taxonomy Code Set](https://taxonomy.nucc.org/), which identifies the provider's type and specialty.
|
|
1366
|
+
* @public
|
|
1367
|
+
*/
|
|
1368
|
+
taxonomyCode?: string | undefined;
|
|
1369
|
+
}
|
|
1370
|
+
/**
|
|
1371
|
+
* The provider who performed the service. This can be an individual or an organization, such as a laboratory. When a substitute provider (locum tenens) was used, supply that provider's information here. You can omit this object when the rendering provider is the same as the billing provider.
|
|
1372
|
+
* @public
|
|
1373
|
+
*/
|
|
1374
|
+
export interface ProfessionalClaimSubmissionRenderingProvider {
|
|
1375
|
+
/**
|
|
1376
|
+
* **[CMS-1500 Box 24j]** The rendering provider's name. Provide a person's name or an organization's business name.
|
|
1377
|
+
* @public
|
|
1378
|
+
*/
|
|
1379
|
+
name: ProfessionalClaimSubmissionQualifiedName | undefined;
|
|
1380
|
+
/**
|
|
1381
|
+
* **[CMS-1500 Box 24i, 24j]** Identifiers for the rendering provider.
|
|
1382
|
+
* @public
|
|
1383
|
+
*/
|
|
1384
|
+
identifiers?: ProfessionalClaimSubmissionRenderingProviderIdentifiers | undefined;
|
|
1385
|
+
}
|
|
1386
|
+
/**
|
|
1387
|
+
* A single service, procedure, or supply being billed.
|
|
1388
|
+
* @public
|
|
1389
|
+
*/
|
|
1390
|
+
export interface ProfessionalClaimSubmissionServiceLine {
|
|
1391
|
+
/**
|
|
1392
|
+
* **[CMS-1500 Box 24a]** The date or date range when the patient received the service.
|
|
1393
|
+
* @public
|
|
1394
|
+
*/
|
|
1395
|
+
datesOfService: ProfessionalClaimSubmissionDateRange | undefined;
|
|
1396
|
+
/**
|
|
1397
|
+
* **[CMS-1500 Box 24b]** The place of service code identifying where the patient received the service. Visit [Place of Service Codes](https://www.cms.gov/medicare/coding-billing/place-of-service-codes/code-sets) for a complete list.
|
|
1398
|
+
* @public
|
|
1399
|
+
*/
|
|
1400
|
+
placeOfService?: string | undefined;
|
|
1401
|
+
/**
|
|
1402
|
+
* **[CMS-1500 Box 24c]** Whether the service was related to an emergency, meaning the patient required immediate intervention for a severe, life-threatening, or potentially disabling condition.
|
|
1403
|
+
* @public
|
|
1404
|
+
*/
|
|
1405
|
+
isEmergency?: boolean | undefined;
|
|
1406
|
+
/**
|
|
1407
|
+
* **[CMS-1500 Box 24d]** The procedure, service, or supply code being billed, with any applicable modifiers.
|
|
1408
|
+
* @public
|
|
1409
|
+
*/
|
|
1410
|
+
procedureCode: ProfessionalClaimSubmissionProcedureCode | undefined;
|
|
1411
|
+
/**
|
|
1412
|
+
* **[CMS-1500 Box 24e]** Up to four diagnoses this service relates to. Must be [ICD-10-CM codes](https://www.cdc.gov/nchs/icd/icd-10-cm/index.html). List them in order of importance to the service, with the most relevant diagnosis first. Across `encounter.primaryDiagnosisCode` and the codes on every service line, a claim can use at most 12 distinct diagnosis codes.
|
|
1413
|
+
* - You must submit a valid, billable code at the highest level of specificity. Include the 4th - 7th characters as applicable.
|
|
1414
|
+
* - Don't submit the decimal point for ICD codes. The decimal point is implied.
|
|
1415
|
+
* - Don't submit ICD-10 header codes. Header codes exist to group related codes and aren't valid for billing. These header codes can change with each new version of ICD-10, so we recommend reviewing your diagnosis codes every year to ensure that they aren't classified as header codes in the most recent version. To determine whether a code is a header code, you can also search the Value Set Authority Center. If the 'Header' property is set, the code is a header code and you shouldn't use it in claim submissions.
|
|
1416
|
+
* @public
|
|
1417
|
+
*/
|
|
1418
|
+
diagnosisCodes: string[] | undefined;
|
|
1419
|
+
/**
|
|
1420
|
+
* **[CMS-1500 Box 24f]** The charge for this service line, including the provider's base charge and any applicable tax or postage. It is acceptable to set this to `0` (zero).
|
|
1421
|
+
* @public
|
|
1422
|
+
*/
|
|
1423
|
+
lineItemChargeAmount: string | undefined;
|
|
1424
|
+
/**
|
|
1425
|
+
* **[CMS-1500 Box 24g]** The number of units of the service provided. The units depend on the procedure code and the nature of the service. For example, they may correspond to office visits (1 unit per visit), individual diagnostic tests (1 unit per test), or time (when a service is billed in 15-minute increments, 4 units could equal 1 hour). For anesthesia procedure codes (00100-01999), report the total anesthesia time in minutes; Stedi reports the unit of measure as minutes for these codes automatically.
|
|
1426
|
+
* @public
|
|
1427
|
+
*/
|
|
1428
|
+
units: string | undefined;
|
|
1429
|
+
/**
|
|
1430
|
+
* **[CMS-1500 Box 24h]** Whether the service is related to an Early and Periodic Screening, Diagnosis, and Treatment (EPSDT) encounter. Set this on services that resulted from an EPSDT screening, not on the screening service itself. Report the screening's referral outcome in `encounter.epsdtReferralCodes`.
|
|
1431
|
+
* @public
|
|
1432
|
+
*/
|
|
1433
|
+
isEpsdtRelated?: boolean | undefined;
|
|
1434
|
+
/**
|
|
1435
|
+
* **[CMS-1500 Box 24h]** Whether the service was related to a family planning program.
|
|
1436
|
+
* @public
|
|
1437
|
+
*/
|
|
1438
|
+
isFamilyPlanning?: boolean | undefined;
|
|
1439
|
+
/**
|
|
1440
|
+
* **[CMS-1500 Box 24i, 24j]** The provider who performed this service. Include only when the rendering provider for this line differs from the claim. This is also where you supply a substitute (locum tenens) provider's information.
|
|
1441
|
+
* @public
|
|
1442
|
+
*/
|
|
1443
|
+
renderingProvider?: ProfessionalClaimSubmissionRenderingProvider | undefined;
|
|
1444
|
+
/**
|
|
1445
|
+
* **[CMS-1500 Box 17, 17a, 17b]** The provider who ordered the services, tests, or supplies billed on this service line. For example, a physician who ordered lab work or imaging. Include when the ordering provider differs from the rendering provider for this line.
|
|
1446
|
+
* @public
|
|
1447
|
+
*/
|
|
1448
|
+
orderingProvider?: ProfessionalClaimSubmissionOrderingProvider | undefined;
|
|
1449
|
+
/**
|
|
1450
|
+
* **[CMS-1500 Box 20]** The purchase of this service from a provider outside the billing provider's practice, such as an independent laboratory. Only include when the billing provider bought the service and is billing the payer for it.
|
|
1451
|
+
* @public
|
|
1452
|
+
*/
|
|
1453
|
+
purchasedService?: ProfessionalClaimSubmissionPurchasedService | undefined;
|
|
1454
|
+
/**
|
|
1455
|
+
* A control number you assign to this service line for your own tracking. Each must be unique within the claim. If you don't set it, Stedi sets it for you – a random ULID.
|
|
1456
|
+
* @public
|
|
1457
|
+
*/
|
|
1458
|
+
lineItemControlNumber?: string | undefined;
|
|
1459
|
+
/**
|
|
1460
|
+
* **[CMS-1500 Box 24]** Drug identification details for the service line. Required when a drug is billed for this line and a prescription was written.
|
|
1461
|
+
* @public
|
|
1462
|
+
*/
|
|
1463
|
+
drugIdentification?: ProfessionalClaimSubmissionDrugIdentification | undefined;
|
|
1464
|
+
/**
|
|
1465
|
+
* **[CMS-1500 Box 24]** A free-text description that clarifies the procedure code and any modifiers. Provide when billing an unspecified or unlisted procedure code.
|
|
1466
|
+
* @public
|
|
1467
|
+
*/
|
|
1468
|
+
narrativeForUnspecifiedCode?: string | undefined;
|
|
1469
|
+
/**
|
|
1470
|
+
* **[CMS-1500 Box 24]** Supporting documentation attached to this service line. Only include when the payer requires it. Visit [Submit claim attachments](https://www.stedi.com/docs/healthcare/submit-claim-attachments) for more information.
|
|
1471
|
+
* @public
|
|
1472
|
+
*/
|
|
1473
|
+
attachments?: ProfessionalClaimSubmissionAttachment[] | undefined;
|
|
1474
|
+
/**
|
|
1475
|
+
* Prior authorization numbers that apply to this service line. Include only numbers that differ from the claim-level prior authorization in `encounter.referenceNumbers.priorAuthorization`. You can use the same number on multiple service lines.
|
|
1476
|
+
* @public
|
|
1477
|
+
*/
|
|
1478
|
+
priorAuthorizations?: ProfessionalClaimSubmissionServiceLinePriorAuthorizationNumber[] | undefined;
|
|
1479
|
+
}
|
|
1480
|
+
/**
|
|
1481
|
+
* The entity submitting the claim to Stedi.
|
|
1482
|
+
* @public
|
|
1483
|
+
*/
|
|
1484
|
+
export interface ProfessionalClaimSubmissionSubmitter {
|
|
1485
|
+
/**
|
|
1486
|
+
* **[CMS-1500 Carrier Block]** The name of the submitter, either a person or an organization.
|
|
1487
|
+
* @public
|
|
1488
|
+
*/
|
|
1489
|
+
name: ProfessionalClaimSubmissionQualifiedName | undefined;
|
|
1490
|
+
/**
|
|
1491
|
+
* **[CMS-1500 Carrier Block]** The contact for questions about this claim submission. Provide at least a phone number or an email address.
|
|
1492
|
+
* @public
|
|
1493
|
+
*/
|
|
1494
|
+
contact?: ProfessionalClaimSubmissionContact | undefined;
|
|
1495
|
+
/**
|
|
1496
|
+
* **[CMS-1500 Carrier Block]** The submitter's Electronic Transmitter Identification Number (ETIN), a payer-assigned ID that identifies the entity transmitting the claim.
|
|
1497
|
+
* @public
|
|
1498
|
+
*/
|
|
1499
|
+
etin?: string | undefined;
|
|
1500
|
+
}
|
|
1501
|
+
/**
|
|
1502
|
+
* The request to submit a professional claim.
|
|
1503
|
+
* @public
|
|
1504
|
+
*/
|
|
1505
|
+
export interface CreateProfessionalClaimSubmissionInput {
|
|
1506
|
+
/**
|
|
1507
|
+
* **[CMS-1500 Carrier Block]** The purpose of the submission. Use `CHARGEABLE` for standard fee-for-service claims, which covers most submissions.
|
|
1508
|
+
* @public
|
|
1509
|
+
*/
|
|
1510
|
+
purpose: ProfessionalClaimSubmissionPurpose | undefined;
|
|
1511
|
+
/**
|
|
1512
|
+
* **[CMS-1500 Carrier Block]** The payer being billed for this claim, identified by a Stedi payer ID. Visit the [Payer Network](https://www.stedi.com/healthcare/network) for a complete list of payers and their IDs.
|
|
1513
|
+
* @public
|
|
1514
|
+
*/
|
|
1515
|
+
payer: ProfessionalClaimSubmissionPayer | undefined;
|
|
1516
|
+
/**
|
|
1517
|
+
* **[CMS-1500 Carrier Block]** The entity submitting the claim to Stedi.
|
|
1518
|
+
* @public
|
|
1519
|
+
*/
|
|
1520
|
+
submitter: ProfessionalClaimSubmissionSubmitter | undefined;
|
|
1521
|
+
/**
|
|
1522
|
+
* **[CMS-1500 Box 1, 1a, 4, 7, 11, 11a, 11b, 11c]** The person who carries the insurance policy being billed. The insured is also called the subscriber, primary policyholder, or primary cardholder, and may be a different person from the patient. For example, when a spouse or child receives care under an employee's plan, the employee is the insured.
|
|
1523
|
+
* @public
|
|
1524
|
+
*/
|
|
1525
|
+
insured: ProfessionalClaimSubmissionInsured | undefined;
|
|
1526
|
+
/**
|
|
1527
|
+
* **[CMS-1500 Box 2, 3, 5, 6]** The person who received care. Only include this object when the patient is someone other than the insured, such as a spouse or dependent on the insured's plan. When the patient is the insured, leave this empty.
|
|
1528
|
+
* @public
|
|
1529
|
+
*/
|
|
1530
|
+
patient?: ProfessionalClaimSubmissionPatient | undefined;
|
|
1531
|
+
/**
|
|
1532
|
+
* **[CMS-1500 Box 12, 13, 27, 31]** Signature and assignment-of-benefits indicators for the claim, covering whether the provider has the patient's and insured's authorizations on file and whether the provider accepts the payer's terms.
|
|
1533
|
+
* @public
|
|
1534
|
+
*/
|
|
1535
|
+
authorization: ProfessionalClaimSubmissionAuthorization | undefined;
|
|
1536
|
+
/**
|
|
1537
|
+
* **[CMS-1500 Box 10a, 10b, 10c, 10d, 14, 15, 16, 17, 17a, 17b, 18, 19, 21, 22, 23, 24h]** Clinical details about the encounter, including diagnosis codes, the related providers, relevant dates, and supporting information for the claim.
|
|
1538
|
+
* @public
|
|
1539
|
+
*/
|
|
1540
|
+
encounter: ProfessionalClaimSubmissionEncounter | undefined;
|
|
1541
|
+
/**
|
|
1542
|
+
* **[CMS-1500 Box 25, 26, 28, 29, 32, 32a, 32b, 33, 33a, 33b]** Billing details for the claim, including the billing provider, service facility, tax identification, and total charges.
|
|
1543
|
+
* @public
|
|
1544
|
+
*/
|
|
1545
|
+
billing: ProfessionalClaimSubmissionBilling | undefined;
|
|
1546
|
+
/**
|
|
1547
|
+
* **[CMS-1500 Box 17, 17a, 17b, 20, 24a-24j]** The individual services, procedures, or supplies being billed. Each service line corresponds to one row in Box 24 of the CMS-1500 form.
|
|
1548
|
+
* @public
|
|
1549
|
+
*/
|
|
1550
|
+
serviceLines: ProfessionalClaimSubmissionServiceLine[] | undefined;
|
|
1551
|
+
/**
|
|
1552
|
+
* **[CMS-1500 Box 9, 9a, 9d]** Coverage the patient holds under another insurance policy, relevant to coordination of benefits. Include this when the patient has coverage from another payer in addition to the one you're billing.
|
|
1553
|
+
* @public
|
|
1554
|
+
*/
|
|
1555
|
+
otherInsured?: ProfessionalClaimSubmissionOtherInsured[] | undefined;
|
|
1556
|
+
/**
|
|
1557
|
+
* A unique string to identify this request to the server. You can safely retry requests with the same idempotency key within 24 hours of making the first request. This prevents you from sending duplicate claims due to network errors or other intermittent failures. If you reuse a key on a new request while Stedi is still processing the original, Stedi returns a `409 Conflict` error. [Learn more](https://www.stedi.com/docs/api-reference/index#idempotency-keys).
|
|
1558
|
+
* @public
|
|
1559
|
+
*/
|
|
1560
|
+
idempotencyKey?: string | undefined;
|
|
1561
|
+
}
|
|
1562
|
+
/**
|
|
1563
|
+
* The response to a professional claim submission.
|
|
1564
|
+
* @public
|
|
1565
|
+
*/
|
|
1566
|
+
export interface CreateProfessionalClaimSubmissionOutput {
|
|
1567
|
+
/**
|
|
1568
|
+
* A unique identifier for the claim within Stedi. This ID stays the same throughout the claim's entire lifecycle. For example, the claim ID is the same for the initial submission and any resubmissions. This is how Stedi links a particular claim to responses, such as 277CA claim acknowledgments.
|
|
1569
|
+
* @public
|
|
1570
|
+
*/
|
|
1571
|
+
claimId: string | undefined;
|
|
1572
|
+
/**
|
|
1573
|
+
* A unique identifier for a specific submission of a claim within Stedi. Stedi generates a submission ID for the initial submission and then a new submission ID for every resubmission of the same claim. This is different from the claim ID, which doesn't change throughout the claim's lifecycle.
|
|
1574
|
+
* @public
|
|
1575
|
+
*/
|
|
1576
|
+
submissionId: string | undefined;
|
|
1577
|
+
/**
|
|
1578
|
+
* Failed claim edits that caused Stedi to reject the claim.
|
|
1579
|
+
* - When present, Stedi stored the claim and generated a 277CA claim acknowledgment for the rejection, but didn't send the claim to the payer. You must fix all errors before resubmitting.
|
|
1580
|
+
* - When absent, the claim data passed Stedi's edits and Stedi sent the claim to the payer.
|
|
1581
|
+
* @public
|
|
1582
|
+
*/
|
|
1583
|
+
errors?: ClaimRejectionError[] | undefined;
|
|
1584
|
+
}
|
|
1585
|
+
/**
|
|
1586
|
+
* A single way in which the request failed validation.
|
|
1587
|
+
* @public
|
|
1588
|
+
*/
|
|
1589
|
+
export interface ValidationFailure {
|
|
1590
|
+
/**
|
|
1591
|
+
* A JSON pointer to the part of the request that failed validation
|
|
1592
|
+
* @public
|
|
1593
|
+
*/
|
|
1594
|
+
path?: string | undefined;
|
|
1595
|
+
/**
|
|
1596
|
+
* What was wrong with this part of the request
|
|
1597
|
+
* @public
|
|
1598
|
+
*/
|
|
1599
|
+
message: string | undefined;
|
|
1600
|
+
}
|
|
1601
|
+
/**
|
|
1602
|
+
* Input for fetching a claim submission as professional claim JSON.
|
|
1603
|
+
* @public
|
|
1604
|
+
*/
|
|
1605
|
+
export interface GetProfessionalClaimSubmissionInput {
|
|
1606
|
+
/**
|
|
1607
|
+
* A unique identifier for a specific submission of a claim within Stedi. Stedi generates a submission ID for the initial submission and then a new submission ID for every resubmission of the same claim. This is different from the claim ID, which doesn't change throughout the claim's lifecycle.
|
|
1608
|
+
*
|
|
1609
|
+
* You can retrieve this ID from the `submissionId` property in the [Professional Claims CMS-1500 JSON submission endpoint](/docs/healthcare/api-reference/post-healthcare-claims-cms-1500-json) response.
|
|
1610
|
+
* @public
|
|
1611
|
+
*/
|
|
1612
|
+
id: string | undefined;
|
|
1613
|
+
}
|
|
1614
|
+
/**
|
|
1615
|
+
* A professional claim in the Stedi JSON format.
|
|
1616
|
+
* @public
|
|
1617
|
+
*/
|
|
1618
|
+
export interface ProfessionalClaimSubmissionData {
|
|
1619
|
+
/**
|
|
1620
|
+
* **[CMS-1500 Carrier Block]** The purpose of the submission. Use `CHARGEABLE` for standard fee-for-service claims, which covers most submissions.
|
|
1621
|
+
* @public
|
|
1622
|
+
*/
|
|
1623
|
+
purpose: ProfessionalClaimSubmissionPurpose | undefined;
|
|
1624
|
+
/**
|
|
1625
|
+
* **[CMS-1500 Carrier Block]** The payer being billed for this claim, identified by a Stedi payer ID. Visit the [Payer Network](https://www.stedi.com/healthcare/network) for a complete list of payers and their IDs.
|
|
1626
|
+
* @public
|
|
1627
|
+
*/
|
|
1628
|
+
payer: ProfessionalClaimSubmissionPayer | undefined;
|
|
1629
|
+
/**
|
|
1630
|
+
* **[CMS-1500 Carrier Block]** The entity submitting the claim to Stedi.
|
|
1631
|
+
* @public
|
|
1632
|
+
*/
|
|
1633
|
+
submitter: ProfessionalClaimSubmissionSubmitter | undefined;
|
|
1634
|
+
/**
|
|
1635
|
+
* **[CMS-1500 Box 1, 1a, 4, 7, 11, 11a, 11b, 11c]** The person who carries the insurance policy being billed. The insured is also called the subscriber, primary policyholder, or primary cardholder, and may be a different person from the patient. For example, when a spouse or child receives care under an employee's plan, the employee is the insured.
|
|
1636
|
+
* @public
|
|
1637
|
+
*/
|
|
1638
|
+
insured: ProfessionalClaimSubmissionInsured | undefined;
|
|
1639
|
+
/**
|
|
1640
|
+
* **[CMS-1500 Box 2, 3, 5, 6]** The person who received care. Only include this object when the patient is someone other than the insured, such as a spouse or dependent on the insured's plan. When the patient is the insured, leave this empty.
|
|
1641
|
+
* @public
|
|
1642
|
+
*/
|
|
1643
|
+
patient?: ProfessionalClaimSubmissionPatient | undefined;
|
|
1644
|
+
/**
|
|
1645
|
+
* **[CMS-1500 Box 12, 13, 27, 31]** Signature and assignment-of-benefits indicators for the claim, covering whether the provider has the patient's and insured's authorizations on file and whether the provider accepts the payer's terms.
|
|
1646
|
+
* @public
|
|
1647
|
+
*/
|
|
1648
|
+
authorization: ProfessionalClaimSubmissionAuthorization | undefined;
|
|
1649
|
+
/**
|
|
1650
|
+
* **[CMS-1500 Box 10a, 10b, 10c, 10d, 14, 15, 16, 17, 17a, 17b, 18, 19, 21, 22, 23, 24h]** Clinical details about the encounter, including diagnosis codes, the related providers, relevant dates, and supporting information for the claim.
|
|
1651
|
+
* @public
|
|
1652
|
+
*/
|
|
1653
|
+
encounter: ProfessionalClaimSubmissionEncounter | undefined;
|
|
1654
|
+
/**
|
|
1655
|
+
* **[CMS-1500 Box 25, 26, 28, 29, 32, 32a, 32b, 33, 33a, 33b]** Billing details for the claim, including the billing provider, service facility, tax identification, and total charges.
|
|
1656
|
+
* @public
|
|
1657
|
+
*/
|
|
1658
|
+
billing: ProfessionalClaimSubmissionBilling | undefined;
|
|
1659
|
+
/**
|
|
1660
|
+
* **[CMS-1500 Box 17, 17a, 17b, 20, 24a-24j]** The individual services, procedures, or supplies being billed. Each service line corresponds to one row in Box 24 of the CMS-1500 form.
|
|
1661
|
+
* @public
|
|
1662
|
+
*/
|
|
1663
|
+
serviceLines: ProfessionalClaimSubmissionServiceLine[] | undefined;
|
|
1664
|
+
/**
|
|
1665
|
+
* **[CMS-1500 Box 9, 9a, 9d]** Coverage the patient holds under another insurance policy, relevant to coordination of benefits. Include this when the patient has coverage from another payer in addition to the one you're billing.
|
|
1666
|
+
* @public
|
|
1667
|
+
*/
|
|
1668
|
+
otherInsured?: ProfessionalClaimSubmissionOtherInsured[] | undefined;
|
|
1669
|
+
}
|
|
1670
|
+
/**
|
|
1671
|
+
* The claim submission in the Stedi professional claim JSON format.
|
|
1672
|
+
* @public
|
|
1673
|
+
*/
|
|
1674
|
+
export interface GetProfessionalClaimSubmissionOutput {
|
|
1675
|
+
/**
|
|
1676
|
+
* A unique identifier for the claim within Stedi. This ID stays the same throughout the claim's entire lifecycle. For example, the claim ID is the same for the initial submission and any resubmissions. This is how Stedi links a particular claim to responses, such as 277CA claim acknowledgments.
|
|
1677
|
+
* @public
|
|
1678
|
+
*/
|
|
1679
|
+
claimId: string | undefined;
|
|
1680
|
+
/**
|
|
1681
|
+
* A unique identifier for a specific submission of a claim within Stedi. Stedi generates a submission ID for the initial submission and then a new submission ID for every resubmission of the same claim. This is different from the claim ID, which doesn't change throughout the claim's lifecycle.
|
|
1682
|
+
* @public
|
|
1683
|
+
*/
|
|
1684
|
+
submissionId: string | undefined;
|
|
1685
|
+
/**
|
|
1686
|
+
* The payer identifier in Stedi's system.
|
|
1687
|
+
* @public
|
|
1688
|
+
*/
|
|
1689
|
+
stediPayerId?: string | undefined;
|
|
1690
|
+
/**
|
|
1691
|
+
* The submitted claim in the Stedi professional claim JSON format.
|
|
1692
|
+
* @public
|
|
1693
|
+
*/
|
|
1694
|
+
data: ProfessionalClaimSubmissionData | undefined;
|
|
1695
|
+
/**
|
|
1696
|
+
* The time Stedi processed the submission.
|
|
1697
|
+
* @public
|
|
1698
|
+
*/
|
|
1699
|
+
processedAt: Date | undefined;
|
|
1700
|
+
}
|
|
1701
|
+
/**
|
|
1702
|
+
* The request to validate a professional claim.
|
|
1703
|
+
* @public
|
|
1704
|
+
*/
|
|
1705
|
+
export interface ValidateProfessionalClaimSubmissionInput {
|
|
1706
|
+
/**
|
|
1707
|
+
* **[CMS-1500 Carrier Block]** The purpose of the submission. Use `CHARGEABLE` for standard fee-for-service claims, which covers most submissions.
|
|
1708
|
+
* @public
|
|
1709
|
+
*/
|
|
1710
|
+
purpose: ProfessionalClaimSubmissionPurpose | undefined;
|
|
1711
|
+
/**
|
|
1712
|
+
* **[CMS-1500 Carrier Block]** The payer being billed for this claim, identified by a Stedi payer ID. Visit the [Payer Network](https://www.stedi.com/healthcare/network) for a complete list of payers and their IDs.
|
|
1713
|
+
* @public
|
|
1714
|
+
*/
|
|
1715
|
+
payer: ProfessionalClaimSubmissionPayer | undefined;
|
|
1716
|
+
/**
|
|
1717
|
+
* **[CMS-1500 Carrier Block]** The entity submitting the claim to Stedi.
|
|
1718
|
+
* @public
|
|
1719
|
+
*/
|
|
1720
|
+
submitter: ProfessionalClaimSubmissionSubmitter | undefined;
|
|
1721
|
+
/**
|
|
1722
|
+
* **[CMS-1500 Box 1, 1a, 4, 7, 11, 11a, 11b, 11c]** The person who carries the insurance policy being billed. The insured is also called the subscriber, primary policyholder, or primary cardholder, and may be a different person from the patient. For example, when a spouse or child receives care under an employee's plan, the employee is the insured.
|
|
1723
|
+
* @public
|
|
1724
|
+
*/
|
|
1725
|
+
insured: ProfessionalClaimSubmissionInsured | undefined;
|
|
1726
|
+
/**
|
|
1727
|
+
* **[CMS-1500 Box 2, 3, 5, 6]** The person who received care. Only include this object when the patient is someone other than the insured, such as a spouse or dependent on the insured's plan. When the patient is the insured, leave this empty.
|
|
1728
|
+
* @public
|
|
1729
|
+
*/
|
|
1730
|
+
patient?: ProfessionalClaimSubmissionPatient | undefined;
|
|
1731
|
+
/**
|
|
1732
|
+
* **[CMS-1500 Box 12, 13, 27, 31]** Signature and assignment-of-benefits indicators for the claim, covering whether the provider has the patient's and insured's authorizations on file and whether the provider accepts the payer's terms.
|
|
1733
|
+
* @public
|
|
1734
|
+
*/
|
|
1735
|
+
authorization: ProfessionalClaimSubmissionAuthorization | undefined;
|
|
1736
|
+
/**
|
|
1737
|
+
* **[CMS-1500 Box 10a, 10b, 10c, 10d, 14, 15, 16, 17, 17a, 17b, 18, 19, 21, 22, 23, 24h]** Clinical details about the encounter, including diagnosis codes, the related providers, relevant dates, and supporting information for the claim.
|
|
1738
|
+
* @public
|
|
1739
|
+
*/
|
|
1740
|
+
encounter: ProfessionalClaimSubmissionEncounter | undefined;
|
|
1741
|
+
/**
|
|
1742
|
+
* **[CMS-1500 Box 25, 26, 28, 29, 32, 32a, 32b, 33, 33a, 33b]** Billing details for the claim, including the billing provider, service facility, tax identification, and total charges.
|
|
1743
|
+
* @public
|
|
1744
|
+
*/
|
|
1745
|
+
billing: ProfessionalClaimSubmissionBilling | undefined;
|
|
1746
|
+
/**
|
|
1747
|
+
* **[CMS-1500 Box 17, 17a, 17b, 20, 24a-24j]** The individual services, procedures, or supplies being billed. Each service line corresponds to one row in Box 24 of the CMS-1500 form.
|
|
1748
|
+
* @public
|
|
1749
|
+
*/
|
|
1750
|
+
serviceLines: ProfessionalClaimSubmissionServiceLine[] | undefined;
|
|
1751
|
+
/**
|
|
1752
|
+
* **[CMS-1500 Box 9, 9a, 9d]** Coverage the patient holds under another insurance policy, relevant to coordination of benefits. Include this when the patient has coverage from another payer in addition to the one you're billing.
|
|
1753
|
+
* @public
|
|
1754
|
+
*/
|
|
1755
|
+
otherInsured?: ProfessionalClaimSubmissionOtherInsured[] | undefined;
|
|
1756
|
+
}
|
|
1757
|
+
/**
|
|
1758
|
+
* The response to a professional claim validation. A response with no errors means Stedi would accept the claim as-is.
|
|
1759
|
+
* @public
|
|
1760
|
+
*/
|
|
1761
|
+
export interface ValidateProfessionalClaimSubmissionOutput {
|
|
1762
|
+
/**
|
|
1763
|
+
* Failed claim edits that would cause Stedi to reject the claim. Absent when the claim passes Stedi's pre-submission checks.
|
|
1764
|
+
* @public
|
|
1765
|
+
*/
|
|
1766
|
+
errors?: ClaimRejectionError[] | undefined;
|
|
1767
|
+
}
|
|
1768
|
+
/**
|
|
1769
|
+
* A date range. `end` is inclusive. A single date of service carries only `start`.
|
|
1770
|
+
* @public
|
|
1771
|
+
*/
|
|
1772
|
+
export interface ClaimDateRange {
|
|
1773
|
+
/**
|
|
1774
|
+
* The start date of the range, in `YYYY-MM-DD` format.
|
|
1775
|
+
* @public
|
|
1776
|
+
*/
|
|
1777
|
+
start: string | undefined;
|
|
1778
|
+
/**
|
|
1779
|
+
* The end date of the range, inclusive, in `YYYY-MM-DD` format.
|
|
1780
|
+
* @public
|
|
1781
|
+
*/
|
|
1782
|
+
end?: string | undefined;
|
|
1783
|
+
}
|
|
1784
|
+
/**
|
|
1785
|
+
* A summary of a 277CA claim acknowledgment from a clearinghouse or the payer.
|
|
1786
|
+
* @public
|
|
1787
|
+
*/
|
|
1788
|
+
export interface ClaimAcknowledgmentSummary {
|
|
1789
|
+
/**
|
|
1790
|
+
* A unique identifier for the acknowledgment within Stedi.
|
|
1791
|
+
* @public
|
|
1792
|
+
*/
|
|
1793
|
+
id: string | undefined;
|
|
1794
|
+
/**
|
|
1795
|
+
* The status the clearinghouse or payer reported for the claim in the 277CA.
|
|
1796
|
+
* - `REJECTED`: A clearinghouse or the payer rejected the claim. The payer won't adjudicate the claim until you correct and resubmit it.
|
|
1797
|
+
* - `ACCEPTED`: A clearinghouse or the payer accepted the claim. A clearinghouse acceptance means the claim passed its edits and the clearinghouse forwarded it to the payer. A payer acceptance means the payer will adjudicate the claim.
|
|
1798
|
+
* - `RECEIVED`: A clearinghouse or the payer received the claim but hasn't yet accepted or rejected it.
|
|
1799
|
+
* - `INVALID`: Stedi couldn't determine the status because the 277CA carries a status category code Stedi doesn't recognize.
|
|
1800
|
+
* @public
|
|
1801
|
+
*/
|
|
1802
|
+
status: ClaimAcknowledgmentStatus | undefined;
|
|
1803
|
+
/**
|
|
1804
|
+
* The entity that reported the status in the 277CA.
|
|
1805
|
+
* - `PAYER`: The payer reported the status in the 277CA.
|
|
1806
|
+
* - `CLEARINGHOUSE`: A clearinghouse reported the status, either Stedi or an intermediary clearinghouse between Stedi and the payer.
|
|
1807
|
+
* @public
|
|
1808
|
+
*/
|
|
1809
|
+
reportedBy: ClaimStatusReportedBy | undefined;
|
|
1810
|
+
/**
|
|
1811
|
+
* The name of the clearinghouse or payer that reported the status, as it appears in the 277CA.
|
|
1812
|
+
* @public
|
|
1813
|
+
*/
|
|
1814
|
+
sourceName: string | undefined;
|
|
1815
|
+
/**
|
|
1816
|
+
* The time Stedi processed the acknowledgment.
|
|
1817
|
+
* @public
|
|
1818
|
+
*/
|
|
1819
|
+
processedAt: Date | undefined;
|
|
1820
|
+
}
|
|
1821
|
+
/**
|
|
1822
|
+
* The name of the patient who received the services on the claim.
|
|
1823
|
+
* @public
|
|
1824
|
+
*/
|
|
1825
|
+
export interface ClaimPatientName {
|
|
1826
|
+
/**
|
|
1827
|
+
* The patient's first name.
|
|
1828
|
+
* @public
|
|
1829
|
+
*/
|
|
1830
|
+
firstName?: string | undefined;
|
|
1831
|
+
/**
|
|
1832
|
+
* The patient's middle name.
|
|
1833
|
+
* @public
|
|
1834
|
+
*/
|
|
1835
|
+
middleName?: string | undefined;
|
|
1836
|
+
/**
|
|
1837
|
+
* The patient's last name.
|
|
1838
|
+
* @public
|
|
1839
|
+
*/
|
|
1840
|
+
lastName?: string | undefined;
|
|
1841
|
+
/**
|
|
1842
|
+
* The patient's name suffix.
|
|
1843
|
+
* @public
|
|
1844
|
+
*/
|
|
1845
|
+
suffix?: string | undefined;
|
|
1846
|
+
}
|
|
1847
|
+
/**
|
|
1848
|
+
* A summary of the claim payment information the payer reported for a claim in an 835 ERA. Each record corresponds to one CLP loop in the ERA.
|
|
1849
|
+
* @public
|
|
1850
|
+
*/
|
|
1851
|
+
export interface ClaimPaymentInformationSummary {
|
|
1852
|
+
/**
|
|
1853
|
+
* A unique identifier for the claim payment information record within Stedi.
|
|
1854
|
+
* @public
|
|
1855
|
+
*/
|
|
1856
|
+
id: string | undefined;
|
|
1857
|
+
/**
|
|
1858
|
+
* The status the payer assigned to the claim.
|
|
1859
|
+
* @public
|
|
1860
|
+
*/
|
|
1861
|
+
statusCode: ClaimPaymentInformationStatusCode | undefined;
|
|
1862
|
+
/**
|
|
1863
|
+
* The total charge amount of the claim.
|
|
1864
|
+
* @public
|
|
1865
|
+
*/
|
|
1866
|
+
totalClaimChargeAmount: string | undefined;
|
|
1867
|
+
/**
|
|
1868
|
+
* The amount the payer paid on the claim. This is the charge amount less all adjustments, and can be positive, zero, or negative.
|
|
1869
|
+
* @public
|
|
1870
|
+
*/
|
|
1871
|
+
claimPaymentAmount: string | undefined;
|
|
1872
|
+
/**
|
|
1873
|
+
* The amount the patient owes, such as a deductible, copay, or coinsurance.
|
|
1874
|
+
* @public
|
|
1875
|
+
*/
|
|
1876
|
+
patientResponsibilityAmount?: string | undefined;
|
|
1877
|
+
/**
|
|
1878
|
+
* The check number for check payments, or the EFT trace number for electronic payments. Use it to match this claim payment information to the funds the payer sent.
|
|
1879
|
+
* @public
|
|
1880
|
+
*/
|
|
1881
|
+
checkOrEftTraceNumber?: string | undefined;
|
|
1882
|
+
/**
|
|
1883
|
+
* The time Stedi processed the 835 ERA that reported this claim payment information.
|
|
1884
|
+
* @public
|
|
1885
|
+
*/
|
|
1886
|
+
processedAt: Date | undefined;
|
|
1887
|
+
}
|
|
1888
|
+
/**
|
|
1889
|
+
* A summary of a claim submission.
|
|
1890
|
+
* @public
|
|
1891
|
+
*/
|
|
1892
|
+
export interface ClaimSubmissionSummary {
|
|
1893
|
+
/**
|
|
1894
|
+
* A unique identifier for a specific submission of a claim within Stedi. Stedi generates a submission ID for the initial submission and then a new submission ID for every resubmission of the same claim. This is different from the claim ID, which doesn't change throughout the claim's lifecycle.
|
|
1895
|
+
* @public
|
|
1896
|
+
*/
|
|
1897
|
+
id: string | undefined;
|
|
1898
|
+
/**
|
|
1899
|
+
* The payer identifier in Stedi's system. This is the Stedi payer ID listed in the Stedi [Payer Network](https://www.stedi.com/healthcare/network).
|
|
1900
|
+
* @public
|
|
1901
|
+
*/
|
|
1902
|
+
stediPayerId?: string | undefined;
|
|
1903
|
+
/**
|
|
1904
|
+
* The patient control number you assigned to the claim.
|
|
1905
|
+
* @public
|
|
1906
|
+
*/
|
|
1907
|
+
patientControlNumber: string | undefined;
|
|
1908
|
+
/**
|
|
1909
|
+
* The name of the patient who received the services on the claim.
|
|
1910
|
+
* @public
|
|
1911
|
+
*/
|
|
1912
|
+
patientName?: ClaimPatientName | undefined;
|
|
1913
|
+
/**
|
|
1914
|
+
* The total charge amount of the submitted claim.
|
|
1915
|
+
* @public
|
|
1916
|
+
*/
|
|
1917
|
+
totalClaimChargeAmount: string | undefined;
|
|
1918
|
+
/**
|
|
1919
|
+
* The dates of service from the claim. A single date of service carries only `start`. Absent when the submitted dates aren't valid calendar dates.
|
|
1920
|
+
* @public
|
|
1921
|
+
*/
|
|
1922
|
+
datesOfService?: ClaimDateRange | undefined;
|
|
1923
|
+
/**
|
|
1924
|
+
* The time Stedi processed the submission.
|
|
1925
|
+
* @public
|
|
1926
|
+
*/
|
|
1927
|
+
processedAt: Date | undefined;
|
|
1928
|
+
}
|
|
1929
|
+
/**
|
|
1930
|
+
* The top-level fields of a claim.
|
|
1931
|
+
* @public
|
|
1932
|
+
*/
|
|
1933
|
+
export interface ClaimSummary {
|
|
1934
|
+
/**
|
|
1935
|
+
* A unique identifier for the claim within Stedi. This ID stays the same throughout the claim's entire lifecycle. For example, the claim ID is the same for the initial submission and any resubmissions.
|
|
1936
|
+
* @public
|
|
1937
|
+
*/
|
|
1938
|
+
id: string | undefined;
|
|
1939
|
+
/**
|
|
1940
|
+
* The payer identifier in Stedi's system. This is the Stedi payer ID listed in the Stedi [Payer Network](https://www.stedi.com/healthcare/network).
|
|
1941
|
+
* @public
|
|
1942
|
+
*/
|
|
1943
|
+
stediPayerId?: string | undefined;
|
|
1944
|
+
/**
|
|
1945
|
+
* The patient control number you assigned to the claim.
|
|
1946
|
+
* @public
|
|
1947
|
+
*/
|
|
1948
|
+
patientControlNumber: string | undefined;
|
|
1949
|
+
/**
|
|
1950
|
+
* The name of the patient who received the services on the claim.
|
|
1951
|
+
* @public
|
|
1952
|
+
*/
|
|
1953
|
+
patientName?: ClaimPatientName | undefined;
|
|
1954
|
+
/**
|
|
1955
|
+
* The claim's current processing status.
|
|
1956
|
+
* - `SUBMITTED`: You submitted the claim to Stedi but haven't yet received a 277CA response from Stedi or the payer.
|
|
1957
|
+
* - `REJECTED`: Either Stedi or the payer rejected the claim before the start of adjudication. This can happen even when the payer has acknowledged receipt.
|
|
1958
|
+
* - `ACCEPTED`: The payer has accepted the claim into their adjudication system and it's currently being processed or adjudicated.
|
|
1959
|
+
* - `RECEIVED`: The clearinghouse or payer has acknowledged receipt of the claim. This doesn't mean the claim has been accepted for adjudication.
|
|
1960
|
+
* - `PROCESSED`: The payer has adjudicated the claim. Check `totalClaimPaidAmount` to see how much was paid.
|
|
1961
|
+
* - `DENIED`: The payer has denied the claim.
|
|
1962
|
+
* - `UNKNOWN`: Stedi can't determine a single status for this claim, usually because the payer's responses are mixed or incomplete.
|
|
1963
|
+
* @public
|
|
1964
|
+
*/
|
|
1965
|
+
status: ClaimStatus | undefined;
|
|
1966
|
+
/**
|
|
1967
|
+
* The entity that reported the claim's current status.
|
|
1968
|
+
* - `PAYER`: The payer reported the status, in a 277CA claim acknowledgment or an 835 ERA.
|
|
1969
|
+
* - `CLEARINGHOUSE`: A clearinghouse reported the status, either Stedi or an intermediary clearinghouse between Stedi and the payer.
|
|
1970
|
+
* @public
|
|
1971
|
+
*/
|
|
1972
|
+
statusReportedBy: ClaimStatusReportedBy | undefined;
|
|
1973
|
+
/**
|
|
1974
|
+
* The type of claim. Each type corresponds to a different 837 transaction set.
|
|
1975
|
+
* - `PROFESSIONAL`: An 837P professional claim, the electronic equivalent of the CMS-1500 form.
|
|
1976
|
+
* - `INSTITUTIONAL`: An 837I institutional claim, the electronic equivalent of the UB-04 form.
|
|
1977
|
+
* - `DENTAL`: An 837D dental claim, the electronic equivalent of the ADA Dental Claim Form.
|
|
1978
|
+
* @public
|
|
1979
|
+
*/
|
|
1980
|
+
type: ClaimType | undefined;
|
|
1981
|
+
/**
|
|
1982
|
+
* The total charge amount of the claim's most recent submission.
|
|
1983
|
+
* @public
|
|
1984
|
+
*/
|
|
1985
|
+
totalClaimChargeAmount: string | undefined;
|
|
1986
|
+
/**
|
|
1987
|
+
* The total amount payers have paid on this claim, summed across every claim payment information record linked to it. Excludes claim payment information with the `PREDETERMINATION_PRICING_ONLY` status, where the payer priced the claim without paying it. Reversals carry a negative amount, so they subtract from the total. Absent until Stedi receives an 835 ERA for the claim.
|
|
1988
|
+
* @public
|
|
1989
|
+
*/
|
|
1990
|
+
totalClaimPaidAmount?: string | undefined;
|
|
1991
|
+
/**
|
|
1992
|
+
* The dates of service from the claim's most recent submission. A single date of service carries only `start`. Absent when the submitted dates aren't valid calendar dates.
|
|
1993
|
+
* @public
|
|
1994
|
+
*/
|
|
1995
|
+
datesOfService?: ClaimDateRange | undefined;
|
|
1996
|
+
/**
|
|
1997
|
+
* The time Stedi processed the claim's most recent submission.
|
|
1998
|
+
* @public
|
|
1999
|
+
*/
|
|
2000
|
+
submittedAt: Date | undefined;
|
|
2001
|
+
}
|
|
2002
|
+
/**
|
|
2003
|
+
* A timeline entry in a claim's history. Exactly one property is set, and its name identifies the type of entry.
|
|
2004
|
+
* @public
|
|
2005
|
+
*/
|
|
2006
|
+
export type ClaimTimelineEvent = ClaimTimelineEvent.ClaimAcknowledgmentMember | ClaimTimelineEvent.ClaimPaymentInformationMember | ClaimTimelineEvent.DentalClaimSubmissionMember | ClaimTimelineEvent.InstitutionalClaimSubmissionMember | ClaimTimelineEvent.ProfessionalClaimSubmissionMember | ClaimTimelineEvent.$UnknownMember;
|
|
2007
|
+
/**
|
|
2008
|
+
* @public
|
|
2009
|
+
*/
|
|
2010
|
+
export declare namespace ClaimTimelineEvent {
|
|
2011
|
+
/**
|
|
2012
|
+
* An 837P professional claim submission, either the initial submission or a resubmission.
|
|
2013
|
+
* @public
|
|
2014
|
+
*/
|
|
2015
|
+
interface ProfessionalClaimSubmissionMember {
|
|
2016
|
+
professionalClaimSubmission: ClaimSubmissionSummary;
|
|
2017
|
+
dentalClaimSubmission?: never;
|
|
2018
|
+
institutionalClaimSubmission?: never;
|
|
2019
|
+
claimAcknowledgment?: never;
|
|
2020
|
+
claimPaymentInformation?: never;
|
|
2021
|
+
$unknown?: never;
|
|
2022
|
+
}
|
|
2023
|
+
/**
|
|
2024
|
+
* An 837D dental claim submission, either the initial submission or a resubmission.
|
|
2025
|
+
* @public
|
|
2026
|
+
*/
|
|
2027
|
+
interface DentalClaimSubmissionMember {
|
|
2028
|
+
professionalClaimSubmission?: never;
|
|
2029
|
+
dentalClaimSubmission: ClaimSubmissionSummary;
|
|
2030
|
+
institutionalClaimSubmission?: never;
|
|
2031
|
+
claimAcknowledgment?: never;
|
|
2032
|
+
claimPaymentInformation?: never;
|
|
2033
|
+
$unknown?: never;
|
|
2034
|
+
}
|
|
2035
|
+
/**
|
|
2036
|
+
* An 837I institutional claim submission, either the initial submission or a resubmission.
|
|
2037
|
+
* @public
|
|
2038
|
+
*/
|
|
2039
|
+
interface InstitutionalClaimSubmissionMember {
|
|
2040
|
+
professionalClaimSubmission?: never;
|
|
2041
|
+
dentalClaimSubmission?: never;
|
|
2042
|
+
institutionalClaimSubmission: ClaimSubmissionSummary;
|
|
2043
|
+
claimAcknowledgment?: never;
|
|
2044
|
+
claimPaymentInformation?: never;
|
|
2045
|
+
$unknown?: never;
|
|
2046
|
+
}
|
|
2047
|
+
/**
|
|
2048
|
+
* A 277CA claim acknowledgment from a clearinghouse or the payer.
|
|
2049
|
+
* @public
|
|
2050
|
+
*/
|
|
2051
|
+
interface ClaimAcknowledgmentMember {
|
|
2052
|
+
professionalClaimSubmission?: never;
|
|
2053
|
+
dentalClaimSubmission?: never;
|
|
2054
|
+
institutionalClaimSubmission?: never;
|
|
2055
|
+
claimAcknowledgment: ClaimAcknowledgmentSummary;
|
|
2056
|
+
claimPaymentInformation?: never;
|
|
2057
|
+
$unknown?: never;
|
|
2058
|
+
}
|
|
2059
|
+
/**
|
|
2060
|
+
* Payment information the payer reported for this claim in an 835 Electronic Remittance Advice (ERA).
|
|
2061
|
+
* @public
|
|
2062
|
+
*/
|
|
2063
|
+
interface ClaimPaymentInformationMember {
|
|
2064
|
+
professionalClaimSubmission?: never;
|
|
2065
|
+
dentalClaimSubmission?: never;
|
|
2066
|
+
institutionalClaimSubmission?: never;
|
|
2067
|
+
claimAcknowledgment?: never;
|
|
2068
|
+
claimPaymentInformation: ClaimPaymentInformationSummary;
|
|
2069
|
+
$unknown?: never;
|
|
2070
|
+
}
|
|
2071
|
+
/**
|
|
2072
|
+
* @public
|
|
2073
|
+
*/
|
|
2074
|
+
interface $UnknownMember {
|
|
2075
|
+
professionalClaimSubmission?: never;
|
|
2076
|
+
dentalClaimSubmission?: never;
|
|
2077
|
+
institutionalClaimSubmission?: never;
|
|
2078
|
+
claimAcknowledgment?: never;
|
|
2079
|
+
claimPaymentInformation?: never;
|
|
2080
|
+
$unknown: [string, any];
|
|
2081
|
+
}
|
|
2082
|
+
/**
|
|
2083
|
+
* @deprecated unused in schema-serde mode.
|
|
2084
|
+
*
|
|
2085
|
+
*/
|
|
2086
|
+
interface Visitor<T> {
|
|
2087
|
+
professionalClaimSubmission: (value: ClaimSubmissionSummary) => T;
|
|
2088
|
+
dentalClaimSubmission: (value: ClaimSubmissionSummary) => T;
|
|
2089
|
+
institutionalClaimSubmission: (value: ClaimSubmissionSummary) => T;
|
|
2090
|
+
claimAcknowledgment: (value: ClaimAcknowledgmentSummary) => T;
|
|
2091
|
+
claimPaymentInformation: (value: ClaimPaymentInformationSummary) => T;
|
|
2092
|
+
_: (name: string, value: any) => T;
|
|
2093
|
+
}
|
|
2094
|
+
}
|
|
2095
|
+
/**
|
|
2096
|
+
* Input for retrieving a claim.
|
|
2097
|
+
* @public
|
|
2098
|
+
*/
|
|
2099
|
+
export interface GetClaimInput {
|
|
2100
|
+
/**
|
|
2101
|
+
* A unique identifier for the claim within Stedi. You can retrieve this ID from the `claimId` property in the Create Professional Claim Submission JSON endpoint response or from the List Claims lifecycle endpoint.
|
|
2102
|
+
* @public
|
|
2103
|
+
*/
|
|
2104
|
+
id: string | undefined;
|
|
2105
|
+
}
|
|
2106
|
+
/**
|
|
2107
|
+
* The claim, with its current status and the summary fields from its most recent submission.
|
|
2108
|
+
* @public
|
|
2109
|
+
*/
|
|
2110
|
+
export interface GetClaimOutput {
|
|
2111
|
+
/**
|
|
2112
|
+
* A unique identifier for the claim within Stedi. This ID stays the same throughout the claim's entire lifecycle. For example, the claim ID is the same for the initial submission and any resubmissions.
|
|
2113
|
+
* @public
|
|
2114
|
+
*/
|
|
2115
|
+
id: string | undefined;
|
|
2116
|
+
/**
|
|
2117
|
+
* The payer identifier in Stedi's system. This is the Stedi payer ID listed in the Stedi [Payer Network](https://www.stedi.com/healthcare/network).
|
|
2118
|
+
* @public
|
|
2119
|
+
*/
|
|
2120
|
+
stediPayerId?: string | undefined;
|
|
2121
|
+
/**
|
|
2122
|
+
* The patient control number you assigned to the claim.
|
|
2123
|
+
* @public
|
|
2124
|
+
*/
|
|
2125
|
+
patientControlNumber: string | undefined;
|
|
2126
|
+
/**
|
|
2127
|
+
* The name of the patient who received the services on the claim.
|
|
2128
|
+
* @public
|
|
2129
|
+
*/
|
|
2130
|
+
patientName?: ClaimPatientName | undefined;
|
|
2131
|
+
/**
|
|
2132
|
+
* The claim's current processing status.
|
|
2133
|
+
* - `SUBMITTED`: You submitted the claim to Stedi but haven't yet received a 277CA response from Stedi or the payer.
|
|
2134
|
+
* - `REJECTED`: Either Stedi or the payer rejected the claim before the start of adjudication. This can happen even when the payer has acknowledged receipt.
|
|
2135
|
+
* - `ACCEPTED`: The payer has accepted the claim into their adjudication system and it's currently being processed or adjudicated.
|
|
2136
|
+
* - `RECEIVED`: The clearinghouse or payer has acknowledged receipt of the claim. This doesn't mean the claim has been accepted for adjudication.
|
|
2137
|
+
* - `PROCESSED`: The payer has adjudicated the claim. Check `totalClaimPaidAmount` to see how much was paid.
|
|
2138
|
+
* - `DENIED`: The payer has denied the claim.
|
|
2139
|
+
* - `UNKNOWN`: Stedi can't determine a single status for this claim, usually because the payer's responses are mixed or incomplete.
|
|
2140
|
+
* @public
|
|
2141
|
+
*/
|
|
2142
|
+
status: ClaimStatus | undefined;
|
|
2143
|
+
/**
|
|
2144
|
+
* The entity that reported the claim's current status.
|
|
2145
|
+
* - `PAYER`: The payer reported the status, in a 277CA claim acknowledgment or an 835 ERA.
|
|
2146
|
+
* - `CLEARINGHOUSE`: A clearinghouse reported the status, either Stedi or an intermediary clearinghouse between Stedi and the payer.
|
|
2147
|
+
* @public
|
|
2148
|
+
*/
|
|
2149
|
+
statusReportedBy: ClaimStatusReportedBy | undefined;
|
|
2150
|
+
/**
|
|
2151
|
+
* The type of claim. Each type corresponds to a different 837 transaction set.
|
|
2152
|
+
* - `PROFESSIONAL`: An 837P professional claim, the electronic equivalent of the CMS-1500 form.
|
|
2153
|
+
* - `INSTITUTIONAL`: An 837I institutional claim, the electronic equivalent of the UB-04 form.
|
|
2154
|
+
* - `DENTAL`: An 837D dental claim, the electronic equivalent of the ADA Dental Claim Form.
|
|
2155
|
+
* @public
|
|
2156
|
+
*/
|
|
2157
|
+
type: ClaimType | undefined;
|
|
2158
|
+
/**
|
|
2159
|
+
* The total charge amount of the claim's most recent submission.
|
|
2160
|
+
* @public
|
|
2161
|
+
*/
|
|
2162
|
+
totalClaimChargeAmount: string | undefined;
|
|
2163
|
+
/**
|
|
2164
|
+
* The total amount payers have paid on this claim, summed across every claim payment information record linked to it. Excludes claim payment information with the `PREDETERMINATION_PRICING_ONLY` status, where the payer priced the claim without paying it. Reversals carry a negative amount, so they subtract from the total. Absent until Stedi receives an 835 ERA for the claim.
|
|
2165
|
+
* @public
|
|
2166
|
+
*/
|
|
2167
|
+
totalClaimPaidAmount?: string | undefined;
|
|
2168
|
+
/**
|
|
2169
|
+
* The dates of service from the claim's most recent submission. A single date of service carries only `start`. Absent when the submitted dates aren't valid calendar dates.
|
|
2170
|
+
* @public
|
|
2171
|
+
*/
|
|
2172
|
+
datesOfService?: ClaimDateRange | undefined;
|
|
2173
|
+
/**
|
|
2174
|
+
* The time Stedi processed the claim's most recent submission.
|
|
2175
|
+
* @public
|
|
2176
|
+
*/
|
|
2177
|
+
submittedAt: Date | undefined;
|
|
2178
|
+
}
|
|
2179
|
+
/**
|
|
2180
|
+
* Input for retrieving a claim's timeline.
|
|
2181
|
+
* @public
|
|
2182
|
+
*/
|
|
2183
|
+
export interface GetClaimTimelineInput {
|
|
2184
|
+
/**
|
|
2185
|
+
* The maximum number of timeline entries to return per page. Defaults to 100.
|
|
2186
|
+
* @public
|
|
2187
|
+
*/
|
|
2188
|
+
pageSize?: number | undefined;
|
|
2189
|
+
/**
|
|
2190
|
+
* The `nextPageToken` from a previous call to this operation. If not specified, Stedi returns the first page of results.
|
|
2191
|
+
* @public
|
|
2192
|
+
*/
|
|
2193
|
+
pageToken?: string | undefined;
|
|
2194
|
+
/**
|
|
2195
|
+
* A unique identifier for the claim within Stedi. You can retrieve this ID from the `claimId` property in a claim submission response or from the list claims endpoint.
|
|
2196
|
+
* @public
|
|
2197
|
+
*/
|
|
2198
|
+
id: string | undefined;
|
|
2199
|
+
}
|
|
2200
|
+
/**
|
|
2201
|
+
* A page of a claim's timeline.
|
|
2202
|
+
* @public
|
|
2203
|
+
*/
|
|
2204
|
+
export interface GetClaimTimelineOutput {
|
|
2205
|
+
/**
|
|
2206
|
+
* Token you can supply in subsequent requests to retrieve the next page of results. If absent, there are no more results.
|
|
2207
|
+
* @public
|
|
2208
|
+
*/
|
|
2209
|
+
nextPageToken?: string | undefined;
|
|
2210
|
+
/**
|
|
2211
|
+
* Timeline entries for the claim, newest first, including submissions, acknowledgments, and claim payment information.
|
|
2212
|
+
* @public
|
|
2213
|
+
*/
|
|
2214
|
+
items: ClaimTimelineEvent[] | undefined;
|
|
2215
|
+
}
|
|
2216
|
+
/**
|
|
2217
|
+
* Input for listing claims.
|
|
2218
|
+
* @public
|
|
2219
|
+
*/
|
|
2220
|
+
export interface ListClaimsInput {
|
|
2221
|
+
/**
|
|
2222
|
+
* The maximum number of claims to return per page. Defaults to 100.
|
|
2223
|
+
* @public
|
|
2224
|
+
*/
|
|
2225
|
+
pageSize?: number | undefined;
|
|
2226
|
+
/**
|
|
2227
|
+
* The `nextPageToken` from a previous call to this operation. If not specified, Stedi returns the first page of results.
|
|
2228
|
+
* @public
|
|
2229
|
+
*/
|
|
2230
|
+
pageToken?: string | undefined;
|
|
2231
|
+
/**
|
|
2232
|
+
* Filter for claims with specific statuses. You can include this parameter multiple times to filter for multiple statuses.
|
|
2233
|
+
* - `SUBMITTED`: You submitted the claim to Stedi but haven't yet received a 277CA response from Stedi or the payer.
|
|
2234
|
+
* - `RECEIVED`: The clearinghouse or payer has acknowledged receipt of the claim. This doesn't mean the claim has been accepted for adjudication.
|
|
2235
|
+
* - `ACCEPTED`: The payer has accepted the claim into their adjudication system and it's currently being processed or adjudicated.
|
|
2236
|
+
* - `REJECTED`: Either Stedi or the payer rejected the claim before the start of adjudication. This can happen even when the payer has acknowledged receipt.
|
|
2237
|
+
* - `PROCESSED`: The payer has adjudicated the claim. Check `totalClaimPaidAmount` to see how much was paid.
|
|
2238
|
+
* - `DENIED`: The payer has denied the claim.
|
|
2239
|
+
* - `UNKNOWN`: Stedi can't determine a single status for this claim, usually because the payer's responses are mixed or incomplete.
|
|
2240
|
+
* @public
|
|
2241
|
+
*/
|
|
2242
|
+
status?: ClaimStatus[] | undefined;
|
|
2243
|
+
/**
|
|
2244
|
+
* Filter for claims with specific patient control numbers. You can include this parameter multiple times to filter for multiple patient control numbers.
|
|
2245
|
+
* @public
|
|
2246
|
+
*/
|
|
2247
|
+
patientControlNumbers?: string[] | undefined;
|
|
2248
|
+
/**
|
|
2249
|
+
* Filter for claims with `submittedAt` after this time.
|
|
2250
|
+
* @public
|
|
2251
|
+
*/
|
|
2252
|
+
submittedAfter?: Date | undefined;
|
|
2253
|
+
/**
|
|
2254
|
+
* Filter for claims with `submittedAt` before this time.
|
|
2255
|
+
* @public
|
|
2256
|
+
*/
|
|
2257
|
+
submittedBefore?: Date | undefined;
|
|
2258
|
+
}
|
|
2259
|
+
/**
|
|
2260
|
+
* A page of claims.
|
|
2261
|
+
* @public
|
|
2262
|
+
*/
|
|
2263
|
+
export interface ListClaimsOutput {
|
|
2264
|
+
/**
|
|
2265
|
+
* Token you can supply in subsequent requests to retrieve the next page of results. If absent, there are no more results.
|
|
2266
|
+
* @public
|
|
2267
|
+
*/
|
|
2268
|
+
nextPageToken?: string | undefined;
|
|
2269
|
+
/**
|
|
2270
|
+
* The claim records on this page, newest first by `submittedAt`. Each claim record includes summary information about the most recent submission, including processing status, charge and paid totals, patient name, dates of service, and claim type.
|
|
2271
|
+
* @public
|
|
2272
|
+
*/
|
|
2273
|
+
items: ClaimSummary[] | undefined;
|
|
2274
|
+
}
|
|
2275
|
+
/**
|
|
2276
|
+
* Input for creating a new destination.
|
|
2277
|
+
* @public
|
|
2278
|
+
*/
|
|
2279
|
+
export interface CreateEventDestinationInput {
|
|
2280
|
+
/**
|
|
2281
|
+
* A human-readable name for the destination. Stedi displays this name in the portal.
|
|
2282
|
+
* @public
|
|
2283
|
+
*/
|
|
2284
|
+
name: string | undefined;
|
|
2285
|
+
/**
|
|
2286
|
+
* A description of the destination's purpose, such as "Receives transaction enrollment task notifications."
|
|
2287
|
+
* @public
|
|
2288
|
+
*/
|
|
2289
|
+
description?: string | undefined;
|
|
2290
|
+
/**
|
|
2291
|
+
* The event types you want Stedi to send to this destination. Visit [event types](https://www.stedi.com/docs/healthcare/event-destinations-event-types) for a complete list.
|
|
2292
|
+
* @public
|
|
2293
|
+
*/
|
|
2294
|
+
eventTypes: string[] | undefined;
|
|
2295
|
+
/**
|
|
2296
|
+
* The URL where you want Stedi to deliver payloads through HTTP `POST`.
|
|
2297
|
+
* @public
|
|
2298
|
+
*/
|
|
2299
|
+
destinationUrl: string | undefined;
|
|
2300
|
+
/**
|
|
2301
|
+
* Maximum concurrent deliveries for this destination. If not set, Stedi applies your account default (typically 5). Stedi rejects requests exceeding your account maximum (typically 20) with a `400` error. Contact Stedi to change your limits.
|
|
2302
|
+
* @public
|
|
2303
|
+
*/
|
|
2304
|
+
concurrencyLimit?: number | undefined;
|
|
2305
|
+
/**
|
|
2306
|
+
* The destination's status upon creation. Default is `ENABLED`.
|
|
2307
|
+
* @public
|
|
2308
|
+
*/
|
|
2309
|
+
status?: EventDestinationsDestinationInputStatus | undefined;
|
|
2310
|
+
/**
|
|
2311
|
+
* A unique string to identify this request to the server. If not set, Stedi generates one automatically.
|
|
2312
|
+
*
|
|
2313
|
+
* The key can be up to 255 characters. You can safely retry requests with the same idempotency key within 24 hours of making the first request. This prevents duplicate operations due to network errors or other intermittent failures. [Learn more](https://www.stedi.com/docs/api-reference/index#idempotency-keys).
|
|
2314
|
+
* @public
|
|
2315
|
+
*/
|
|
2316
|
+
idempotencyKey?: string | undefined;
|
|
2317
|
+
}
|
|
2318
|
+
/**
|
|
2319
|
+
* Output containing the created destination details and signing secret.
|
|
2320
|
+
* @public
|
|
2321
|
+
*/
|
|
2322
|
+
export interface CreateEventDestinationOutput {
|
|
2323
|
+
/**
|
|
2324
|
+
* The unique identifier for the destination.
|
|
2325
|
+
* @public
|
|
2326
|
+
*/
|
|
2327
|
+
id: string | undefined;
|
|
2328
|
+
/**
|
|
2329
|
+
* Creation timestamp for this destination.
|
|
2330
|
+
* @public
|
|
2331
|
+
*/
|
|
2332
|
+
createdAt: Date | undefined;
|
|
2333
|
+
/**
|
|
2334
|
+
* Last update timestamp for this destination.
|
|
2335
|
+
* @public
|
|
2336
|
+
*/
|
|
2337
|
+
updatedAt: Date | undefined;
|
|
2338
|
+
/**
|
|
2339
|
+
* The destination's current status. Stedi only sends event payloads to `ENABLED` destinations.
|
|
2340
|
+
* @public
|
|
2341
|
+
*/
|
|
2342
|
+
status: EventDestinationsDestinationStatus | undefined;
|
|
2343
|
+
/**
|
|
2344
|
+
* The timestamp for Stedi's most recent delivery attempt to this destination. Absent when Stedi hasn't yet attempted a delivery.
|
|
2345
|
+
* @public
|
|
2346
|
+
*/
|
|
2347
|
+
lastDeliveryTime?: Date | undefined;
|
|
2348
|
+
/**
|
|
2349
|
+
* A human-readable name for the destination. Stedi displays this name in the portal.
|
|
2350
|
+
* @public
|
|
2351
|
+
*/
|
|
2352
|
+
name: string | undefined;
|
|
2353
|
+
/**
|
|
2354
|
+
* A description of the destination's purpose, such as "Receives transaction enrollment task notifications."
|
|
2355
|
+
* @public
|
|
2356
|
+
*/
|
|
2357
|
+
description: string | undefined;
|
|
2358
|
+
/**
|
|
2359
|
+
* The event types Stedi sends to this destination. Visit [event types](https://www.stedi.com/docs/healthcare/event-destinations-event-types) for a complete list.
|
|
2360
|
+
* @public
|
|
2361
|
+
*/
|
|
2362
|
+
eventTypes: string[] | undefined;
|
|
2363
|
+
/**
|
|
2364
|
+
* The URL where Stedi delivers payloads through HTTP `POST`.
|
|
2365
|
+
* @public
|
|
2366
|
+
*/
|
|
2367
|
+
destinationUrl: string | undefined;
|
|
2368
|
+
/**
|
|
2369
|
+
* The maximum number of concurrent deliveries for this destination. Contact Stedi to change your account limits.
|
|
2370
|
+
* @public
|
|
2371
|
+
*/
|
|
2372
|
+
concurrencyLimit?: number | undefined;
|
|
2373
|
+
/**
|
|
2374
|
+
* The signing secret for verifying event payloads. Store it securely. Visit [verify event signatures](https://www.stedi.com/docs/healthcare/event-destinations-message-handling#verify-authenticity-and-receipt-time) for details.
|
|
2375
|
+
* @public
|
|
2376
|
+
*/
|
|
2377
|
+
signingSecret: string | undefined;
|
|
2378
|
+
}
|
|
2379
|
+
/**
|
|
2380
|
+
* Input for deleting a destination.
|
|
2381
|
+
* @public
|
|
2382
|
+
*/
|
|
2383
|
+
export interface DeleteEventDestinationInput {
|
|
2384
|
+
/**
|
|
2385
|
+
* The unique identifier for the destination. You can retrieve destination IDs with the [List Destinations](https://www.stedi.com/docs/healthcare/api-reference/get-event-destinations-list-destinations) endpoint.
|
|
2386
|
+
* @public
|
|
2387
|
+
*/
|
|
2388
|
+
destinationId: string | undefined;
|
|
2389
|
+
/**
|
|
2390
|
+
* A unique string to identify this request to the server. If not set, Stedi generates one automatically.
|
|
2391
|
+
*
|
|
2392
|
+
* The key can be up to 255 characters. You can safely retry requests with the same idempotency key within 24 hours of making the first request. This prevents duplicate operations due to network errors or other intermittent failures. [Learn more](https://www.stedi.com/docs/api-reference/index#idempotency-keys).
|
|
2393
|
+
* @public
|
|
2394
|
+
*/
|
|
2395
|
+
idempotencyKey?: string | undefined;
|
|
2396
|
+
}
|
|
2397
|
+
/**
|
|
2398
|
+
* A successful response confirms the destination has been permanently deleted.
|
|
2399
|
+
* @public
|
|
2400
|
+
*/
|
|
2401
|
+
export interface DeleteEventDestinationOutput {
|
|
2402
|
+
}
|
|
2403
|
+
/**
|
|
2404
|
+
* A summary representation of a destination, returned in list responses.
|
|
2405
|
+
* @public
|
|
2406
|
+
*/
|
|
2407
|
+
export interface EventDestinationsDestinationSummary {
|
|
2408
|
+
/**
|
|
2409
|
+
* The unique identifier for the destination.
|
|
2410
|
+
* @public
|
|
2411
|
+
*/
|
|
2412
|
+
id: string | undefined;
|
|
2413
|
+
/**
|
|
2414
|
+
* Creation timestamp for this destination.
|
|
2415
|
+
* @public
|
|
2416
|
+
*/
|
|
2417
|
+
createdAt: Date | undefined;
|
|
2418
|
+
/**
|
|
2419
|
+
* Last update timestamp for this destination.
|
|
2420
|
+
* @public
|
|
2421
|
+
*/
|
|
2422
|
+
updatedAt: Date | undefined;
|
|
2423
|
+
/**
|
|
2424
|
+
* The destination's current status. Stedi only sends event payloads to `ENABLED` destinations.
|
|
2425
|
+
* @public
|
|
2426
|
+
*/
|
|
2427
|
+
status: EventDestinationsDestinationStatus | undefined;
|
|
2428
|
+
/**
|
|
2429
|
+
* The timestamp for Stedi's most recent delivery attempt to this destination. Absent when Stedi hasn't yet attempted a delivery.
|
|
2430
|
+
* @public
|
|
2431
|
+
*/
|
|
2432
|
+
lastDeliveryTime?: Date | undefined;
|
|
2433
|
+
/**
|
|
2434
|
+
* A human-readable name for the destination. Stedi displays this name in the portal.
|
|
2435
|
+
* @public
|
|
2436
|
+
*/
|
|
2437
|
+
name: string | undefined;
|
|
2438
|
+
/**
|
|
2439
|
+
* A description of the destination's purpose, such as "Receives transaction enrollment task notifications."
|
|
2440
|
+
* @public
|
|
2441
|
+
*/
|
|
2442
|
+
description: string | undefined;
|
|
2443
|
+
/**
|
|
2444
|
+
* The event types Stedi sends to this destination. Visit [event types](https://www.stedi.com/docs/healthcare/event-destinations-event-types) for a complete list.
|
|
2445
|
+
* @public
|
|
2446
|
+
*/
|
|
2447
|
+
eventTypes: string[] | undefined;
|
|
2448
|
+
/**
|
|
2449
|
+
* The URL where Stedi delivers payloads through HTTP `POST`.
|
|
2450
|
+
* @public
|
|
2451
|
+
*/
|
|
2452
|
+
destinationUrl: string | undefined;
|
|
2453
|
+
/**
|
|
2454
|
+
* The maximum number of concurrent deliveries for this destination. Contact Stedi to change your account limits.
|
|
2455
|
+
* @public
|
|
2456
|
+
*/
|
|
2457
|
+
concurrencyLimit?: number | undefined;
|
|
2458
|
+
}
|
|
2459
|
+
/**
|
|
2460
|
+
* A reference to a resource affected by an event.
|
|
2461
|
+
* @public
|
|
2462
|
+
*/
|
|
2463
|
+
export interface EventDestinationsEventPayloadResourceRef {
|
|
2464
|
+
/**
|
|
2465
|
+
* The resource identifier.
|
|
2466
|
+
* @public
|
|
2467
|
+
*/
|
|
2468
|
+
id: string | undefined;
|
|
2469
|
+
/**
|
|
2470
|
+
* The resource type. Uses dot notation to indicate nested resources. For example, `enrollment.document` indicates a document associated with a transaction enrollment request.
|
|
2471
|
+
* @public
|
|
2472
|
+
*/
|
|
2473
|
+
type: string | undefined;
|
|
2474
|
+
}
|
|
2475
|
+
/**
|
|
2476
|
+
* A v1 thin event envelope that signals a state change. Consumers fetch current resource state via API using the resource reference. This is the exact payload delivered to webhook destinations.
|
|
2477
|
+
* @public
|
|
2478
|
+
*/
|
|
2479
|
+
export interface EventDestinationsV1EventPayload {
|
|
2480
|
+
/**
|
|
2481
|
+
* Object type discriminator. Identifies the schema version of this payload.
|
|
2482
|
+
* @public
|
|
2483
|
+
*/
|
|
2484
|
+
object: EventDestinationsEventPayloadObjectType | undefined;
|
|
2485
|
+
/**
|
|
2486
|
+
* Stedi account identifier (UUID).
|
|
2487
|
+
* @public
|
|
2488
|
+
*/
|
|
2489
|
+
account: string | undefined;
|
|
2490
|
+
/**
|
|
2491
|
+
* The environment in which the event was produced.
|
|
2492
|
+
* @public
|
|
2493
|
+
*/
|
|
2494
|
+
environment: EventDestinationsEventEnvironment | undefined;
|
|
2495
|
+
/**
|
|
2496
|
+
* An ISO 8601 timestamp of when the event was created.
|
|
2497
|
+
* @public
|
|
2498
|
+
*/
|
|
2499
|
+
created: Date | undefined;
|
|
2500
|
+
/**
|
|
2501
|
+
* Information about the resource that triggered the event. You can use this information to retrieve additional information about the resource.
|
|
2502
|
+
* @public
|
|
2503
|
+
*/
|
|
2504
|
+
resource: EventDestinationsEventPayloadResourceRef | undefined;
|
|
2505
|
+
/**
|
|
2506
|
+
* An identifier for the event, formatted as `evt_\{UUID\}`.
|
|
2507
|
+
* @public
|
|
2508
|
+
*/
|
|
2509
|
+
id?: string | undefined;
|
|
2510
|
+
/**
|
|
2511
|
+
* The event type in dot notation, such as `enrollment.activated`.
|
|
2512
|
+
* @public
|
|
2513
|
+
*/
|
|
2514
|
+
type?: string | undefined;
|
|
2515
|
+
/**
|
|
2516
|
+
* Other resources related to the event. Only present when there are related resources.
|
|
2517
|
+
* @public
|
|
2518
|
+
*/
|
|
2519
|
+
relatedResources?: EventDestinationsEventPayloadResourceRef[] | undefined;
|
|
2520
|
+
}
|
|
2521
|
+
/**
|
|
2522
|
+
* The event payload, discriminated by object type. Each variant corresponds to a versioned event schema.
|
|
2523
|
+
* @public
|
|
2524
|
+
*/
|
|
2525
|
+
export type EventDestinationsEventPayload = EventDestinationsEventPayload.V1EventMember | EventDestinationsEventPayload.$UnknownMember;
|
|
2526
|
+
/**
|
|
2527
|
+
* @public
|
|
2528
|
+
*/
|
|
2529
|
+
export declare namespace EventDestinationsEventPayload {
|
|
2530
|
+
/**
|
|
2531
|
+
* A `v1` thin event payload.
|
|
2532
|
+
* @public
|
|
2533
|
+
*/
|
|
2534
|
+
interface V1EventMember {
|
|
2535
|
+
v1Event: EventDestinationsV1EventPayload;
|
|
2536
|
+
$unknown?: never;
|
|
2537
|
+
}
|
|
2538
|
+
/**
|
|
2539
|
+
* @public
|
|
2540
|
+
*/
|
|
2541
|
+
interface $UnknownMember {
|
|
2542
|
+
v1Event?: never;
|
|
2543
|
+
$unknown: [string, any];
|
|
2544
|
+
}
|
|
2545
|
+
/**
|
|
2546
|
+
* @deprecated unused in schema-serde mode.
|
|
2547
|
+
*
|
|
2548
|
+
*/
|
|
2549
|
+
interface Visitor<T> {
|
|
2550
|
+
v1Event: (value: EventDestinationsV1EventPayload) => T;
|
|
2551
|
+
_: (name: string, value: any) => T;
|
|
2552
|
+
}
|
|
2553
|
+
}
|
|
2554
|
+
/**
|
|
2555
|
+
* A summary representation of an event, returned in list responses.
|
|
2556
|
+
* @public
|
|
2557
|
+
*/
|
|
2558
|
+
export interface EventDestinationsEventSummary {
|
|
2559
|
+
/**
|
|
2560
|
+
* The unique identifier for the event, formatted as `evt_\{UUID\}`.
|
|
2561
|
+
* @public
|
|
2562
|
+
*/
|
|
2563
|
+
id: string | undefined;
|
|
2564
|
+
/**
|
|
2565
|
+
* The current status of the event. Can be:
|
|
2566
|
+
* - `DELIVERED`: Stedi successfully delivered the event to all relevant event destinations.
|
|
2567
|
+
* - `PENDING`: Stedi is still trying to deliver the event to one or more event destinations. Events may stay in this state for multiple days as Stedi automatically retries.
|
|
2568
|
+
* - `FAILED`: Stedi couldn't deliver the event to at least one event destination and is no longer retrying. Deliveries to some event destinations may have been successful.
|
|
2569
|
+
* @public
|
|
2570
|
+
*/
|
|
2571
|
+
status: EventDestinationsEventStatus | undefined;
|
|
2572
|
+
/**
|
|
2573
|
+
* An ISO 8601 timestamp of when the event was created.
|
|
2574
|
+
* @public
|
|
2575
|
+
*/
|
|
2576
|
+
createdAt: Date | undefined;
|
|
2577
|
+
/**
|
|
2578
|
+
* The type of event, such as `enrollment.activated`.
|
|
2579
|
+
* @public
|
|
2580
|
+
*/
|
|
2581
|
+
eventType: string | undefined;
|
|
2582
|
+
}
|
|
2583
|
+
/**
|
|
2584
|
+
* Input for retrieving a destination.
|
|
2585
|
+
* @public
|
|
2586
|
+
*/
|
|
2587
|
+
export interface GetEventDestinationInput {
|
|
2588
|
+
/**
|
|
2589
|
+
* The unique identifier for the destination. You can retrieve destination IDs with the [List Destinations](https://www.stedi.com/docs/healthcare/api-reference/get-event-destinations-list-destinations) endpoint.
|
|
2590
|
+
* @public
|
|
2591
|
+
*/
|
|
2592
|
+
destinationId: string | undefined;
|
|
2593
|
+
}
|
|
2594
|
+
/**
|
|
2595
|
+
* Output containing the destination details.
|
|
2596
|
+
* @public
|
|
2597
|
+
*/
|
|
2598
|
+
export interface GetEventDestinationOutput {
|
|
2599
|
+
/**
|
|
2600
|
+
* The unique identifier for the destination.
|
|
2601
|
+
* @public
|
|
2602
|
+
*/
|
|
2603
|
+
id: string | undefined;
|
|
2604
|
+
/**
|
|
2605
|
+
* Creation timestamp for this destination.
|
|
2606
|
+
* @public
|
|
2607
|
+
*/
|
|
2608
|
+
createdAt: Date | undefined;
|
|
2609
|
+
/**
|
|
2610
|
+
* Last update timestamp for this destination.
|
|
2611
|
+
* @public
|
|
2612
|
+
*/
|
|
2613
|
+
updatedAt: Date | undefined;
|
|
2614
|
+
/**
|
|
2615
|
+
* The destination's current status. Stedi only sends event payloads to `ENABLED` destinations.
|
|
2616
|
+
* @public
|
|
2617
|
+
*/
|
|
2618
|
+
status: EventDestinationsDestinationStatus | undefined;
|
|
2619
|
+
/**
|
|
2620
|
+
* The timestamp for Stedi's most recent delivery attempt to this destination. Absent when Stedi hasn't yet attempted a delivery.
|
|
2621
|
+
* @public
|
|
2622
|
+
*/
|
|
2623
|
+
lastDeliveryTime?: Date | undefined;
|
|
2624
|
+
/**
|
|
2625
|
+
* A human-readable name for the destination. Stedi displays this name in the portal.
|
|
2626
|
+
* @public
|
|
2627
|
+
*/
|
|
2628
|
+
name: string | undefined;
|
|
2629
|
+
/**
|
|
2630
|
+
* A description of the destination's purpose, such as "Receives transaction enrollment task notifications."
|
|
2631
|
+
* @public
|
|
2632
|
+
*/
|
|
2633
|
+
description: string | undefined;
|
|
2634
|
+
/**
|
|
2635
|
+
* The event types Stedi sends to this destination. Visit [event types](https://www.stedi.com/docs/healthcare/event-destinations-event-types) for a complete list.
|
|
2636
|
+
* @public
|
|
2637
|
+
*/
|
|
2638
|
+
eventTypes: string[] | undefined;
|
|
2639
|
+
/**
|
|
2640
|
+
* The URL where Stedi delivers payloads through HTTP `POST`.
|
|
2641
|
+
* @public
|
|
2642
|
+
*/
|
|
2643
|
+
destinationUrl: string | undefined;
|
|
2644
|
+
/**
|
|
2645
|
+
* The maximum number of concurrent deliveries for this destination. Contact Stedi to change your account limits.
|
|
2646
|
+
* @public
|
|
2647
|
+
*/
|
|
2648
|
+
concurrencyLimit?: number | undefined;
|
|
2649
|
+
}
|
|
2650
|
+
/**
|
|
2651
|
+
* Input for retrieving an event.
|
|
2652
|
+
* @public
|
|
2653
|
+
*/
|
|
2654
|
+
export interface GetEventDestinationEventInput {
|
|
2655
|
+
/**
|
|
2656
|
+
* The unique identifier for the event, formatted as `evt_\{UUID\}`.
|
|
2657
|
+
* @public
|
|
2658
|
+
*/
|
|
2659
|
+
eventId: string | undefined;
|
|
2660
|
+
}
|
|
2661
|
+
/**
|
|
2662
|
+
* Output containing the event details.
|
|
2663
|
+
* @public
|
|
2664
|
+
*/
|
|
2665
|
+
export interface GetEventDestinationEventOutput {
|
|
2666
|
+
/**
|
|
2667
|
+
* The unique identifier for the event, formatted as `evt_\{UUID\}`.
|
|
2668
|
+
* @public
|
|
2669
|
+
*/
|
|
2670
|
+
id: string | undefined;
|
|
2671
|
+
/**
|
|
2672
|
+
* The current status of the event. Can be:
|
|
2673
|
+
* - `DELIVERED`: Stedi successfully delivered the event to all relevant event destinations.
|
|
2674
|
+
* - `PENDING`: Stedi is still trying to deliver the event to one or more event destinations. Events may stay in this state for multiple days as Stedi automatically retries.
|
|
2675
|
+
* - `FAILED`: Stedi couldn't deliver the event to at least one event destination and is no longer retrying. Deliveries to some event destinations may have been successful.
|
|
2676
|
+
* @public
|
|
2677
|
+
*/
|
|
2678
|
+
status: EventDestinationsEventStatus | undefined;
|
|
2679
|
+
/**
|
|
2680
|
+
* An ISO 8601 timestamp of when the event was created.
|
|
2681
|
+
* @public
|
|
2682
|
+
*/
|
|
2683
|
+
createdAt: Date | undefined;
|
|
2684
|
+
/**
|
|
2685
|
+
* The type of event, such as `enrollment.activated`.
|
|
2686
|
+
* @public
|
|
2687
|
+
*/
|
|
2688
|
+
eventType: string | undefined;
|
|
2689
|
+
/**
|
|
2690
|
+
* The event payload Stedi delivers to event destinations.
|
|
2691
|
+
* @public
|
|
2692
|
+
*/
|
|
2693
|
+
eventPayload: EventDestinationsEventPayload | undefined;
|
|
2694
|
+
}
|
|
2695
|
+
/**
|
|
2696
|
+
* Input for retrieving a destination's signing secret.
|
|
2697
|
+
* @public
|
|
2698
|
+
*/
|
|
2699
|
+
export interface GetEventDestinationSecretInput {
|
|
2700
|
+
/**
|
|
2701
|
+
* The unique identifier for the destination. You can retrieve destination IDs with the [List Destinations](https://www.stedi.com/docs/healthcare/api-reference/get-event-destinations-list-destinations) endpoint.
|
|
2702
|
+
* @public
|
|
2703
|
+
*/
|
|
2704
|
+
destinationId: string | undefined;
|
|
2705
|
+
}
|
|
2706
|
+
/**
|
|
2707
|
+
* Output containing the destination's signing secret.
|
|
2708
|
+
* @public
|
|
2709
|
+
*/
|
|
2710
|
+
export interface GetEventDestinationSecretOutput {
|
|
2711
|
+
/**
|
|
2712
|
+
* The signing secret for verifying event payloads. Visit [verify event signatures](https://www.stedi.com/docs/healthcare/event-destinations-message-handling#verify-authenticity-and-receipt-time) for details.
|
|
2713
|
+
* @public
|
|
2714
|
+
*/
|
|
2715
|
+
signingSecret: string | undefined;
|
|
2716
|
+
/**
|
|
2717
|
+
* Expiration timestamp for the previous secret. Only present when a secret rotation is in progress.
|
|
2718
|
+
* @public
|
|
2719
|
+
*/
|
|
2720
|
+
previousSecretExpiresAt?: Date | undefined;
|
|
2721
|
+
}
|
|
2722
|
+
/**
|
|
2723
|
+
* Input for listing events.
|
|
2724
|
+
* @public
|
|
2725
|
+
*/
|
|
2726
|
+
export interface ListEventDestinationEventsInput {
|
|
2727
|
+
/**
|
|
2728
|
+
* The maximum number of elements to return in a page. If not specified, the default is 100.
|
|
2729
|
+
* @public
|
|
2730
|
+
*/
|
|
2731
|
+
pageSize?: number | undefined;
|
|
2732
|
+
/**
|
|
2733
|
+
* The `nextPageToken` value from a previous response. You can use this to get the next page of results. If not set, Stedi returns the first page of results.
|
|
2734
|
+
* @public
|
|
2735
|
+
*/
|
|
2736
|
+
pageToken?: string | undefined;
|
|
2737
|
+
/**
|
|
2738
|
+
* Filter results by event ID, such as `evt_019d554b-311b-7813-b491-0a8973762eae`.
|
|
2739
|
+
* @public
|
|
2740
|
+
*/
|
|
2741
|
+
eventId?: string | undefined;
|
|
2742
|
+
/**
|
|
2743
|
+
* Filter results by one or more event statuses. Can be:
|
|
2744
|
+
* - `DELIVERED`: Stedi successfully delivered the event to all relevant event destinations.
|
|
2745
|
+
* - `PENDING`: Stedi is still trying to deliver the event to one or more event destinations.
|
|
2746
|
+
* - `FAILED`: Stedi couldn't deliver the event to at least one event destination and is no longer retrying.
|
|
2747
|
+
* @public
|
|
2748
|
+
*/
|
|
2749
|
+
status?: EventDestinationsEventStatus[] | undefined;
|
|
2750
|
+
/**
|
|
2751
|
+
* Filter results by event type, such as `enrollment.activated`.
|
|
2752
|
+
* @public
|
|
2753
|
+
*/
|
|
2754
|
+
eventType?: string | undefined;
|
|
2755
|
+
/**
|
|
2756
|
+
* Filter results by their `createdAt` timestamp. Each value is in the format `operator:ISO-8601-timestamp`.
|
|
2757
|
+
* - The supported operators are `gt` (after), `gte` (at or after), `lt` (before), and `lte` (at or before). For example: Setting this to `lt:2024-02-01T00:00:00Z` filters for events created before the specified timestamp.
|
|
2758
|
+
* - Combine multiple values with `&` to specify a date range. For example: `created=gt:2026-01-01T00:00:00Z&created=lt:2026-02-01T00:00:00Z`.
|
|
2759
|
+
* @public
|
|
2760
|
+
*/
|
|
2761
|
+
created?: string[] | undefined;
|
|
2762
|
+
}
|
|
2763
|
+
/**
|
|
2764
|
+
* Output containing the list of events.
|
|
2765
|
+
* @public
|
|
2766
|
+
*/
|
|
2767
|
+
export interface ListEventDestinationEventsOutput {
|
|
2768
|
+
/**
|
|
2769
|
+
* Token that you can supply in subsequent requests to retrieve the next page of results. If not returned, there are no more results.
|
|
2770
|
+
* @public
|
|
2771
|
+
*/
|
|
2772
|
+
nextPageToken?: string | undefined;
|
|
2773
|
+
/**
|
|
2774
|
+
* The list of event summaries.
|
|
2775
|
+
* @public
|
|
2776
|
+
*/
|
|
2777
|
+
items: EventDestinationsEventSummary[] | undefined;
|
|
2778
|
+
}
|
|
2779
|
+
/**
|
|
2780
|
+
* Input for listing destinations.
|
|
2781
|
+
* @public
|
|
2782
|
+
*/
|
|
2783
|
+
export interface ListEventDestinationsInput {
|
|
2784
|
+
/**
|
|
2785
|
+
* Number of items to return per page.
|
|
2786
|
+
* @public
|
|
2787
|
+
*/
|
|
2788
|
+
pageSize?: number | undefined;
|
|
2789
|
+
/**
|
|
2790
|
+
* The `nextPageToken` value from a previous response. You can use this to get the next page of results. If not set, Stedi returns the first page of results.
|
|
2791
|
+
* @public
|
|
2792
|
+
*/
|
|
2793
|
+
pageToken?: string | undefined;
|
|
2794
|
+
/**
|
|
2795
|
+
* Filter results by destination status.
|
|
2796
|
+
* @public
|
|
2797
|
+
*/
|
|
2798
|
+
status?: EventDestinationsDestinationStatus | undefined;
|
|
2799
|
+
/**
|
|
2800
|
+
* Filter results by event type. Visit [event types](https://www.stedi.com/docs/healthcare/event-destinations-event-types) for a complete list.
|
|
2801
|
+
* @public
|
|
2802
|
+
*/
|
|
2803
|
+
eventType?: string | undefined;
|
|
2804
|
+
}
|
|
2805
|
+
/**
|
|
2806
|
+
* Output containing the list of destinations.
|
|
2807
|
+
* @public
|
|
2808
|
+
*/
|
|
2809
|
+
export interface ListEventDestinationsOutput {
|
|
2810
|
+
/**
|
|
2811
|
+
* Token that you can supply in subsequent requests to retrieve the next page of results. If not returned, there are no more results.
|
|
2812
|
+
* @public
|
|
2813
|
+
*/
|
|
2814
|
+
nextPageToken?: string | undefined;
|
|
2815
|
+
/**
|
|
2816
|
+
* The list of destination summaries.
|
|
2817
|
+
* @public
|
|
2818
|
+
*/
|
|
2819
|
+
items: EventDestinationsDestinationSummary[] | undefined;
|
|
2820
|
+
}
|
|
2821
|
+
/**
|
|
2822
|
+
* Input for rotating a destination's signing secret.
|
|
2823
|
+
* @public
|
|
2824
|
+
*/
|
|
2825
|
+
export interface RotateEventDestinationSecretInput {
|
|
2826
|
+
/**
|
|
2827
|
+
* The unique identifier for the destination. You can retrieve destination IDs with the [List Destinations](https://www.stedi.com/docs/healthcare/api-reference/get-event-destinations-list-destinations) endpoint.
|
|
2828
|
+
* @public
|
|
2829
|
+
*/
|
|
2830
|
+
destinationId: string | undefined;
|
|
2831
|
+
/**
|
|
2832
|
+
* The number of hours you want the previous secret to remain valid after rotation.
|
|
2833
|
+
* - Default is 24 hours.
|
|
2834
|
+
* - Set to `0` when you want the previous secret to expire immediately — in-flight payloads signed with the previous secret fail verification.
|
|
2835
|
+
* - You can't rotate again until this grace period expires.
|
|
2836
|
+
* @public
|
|
2837
|
+
*/
|
|
2838
|
+
previousSecretExpiryHours?: number | undefined;
|
|
2839
|
+
/**
|
|
2840
|
+
* A unique string to identify this request to the server. If not set, Stedi generates one automatically.
|
|
2841
|
+
*
|
|
2842
|
+
* The key can be up to 255 characters. You can safely retry requests with the same idempotency key within 24 hours of making the first request. This prevents duplicate operations due to network errors or other intermittent failures. [Learn more](https://www.stedi.com/docs/api-reference/index#idempotency-keys).
|
|
2843
|
+
* @public
|
|
2844
|
+
*/
|
|
2845
|
+
idempotencyKey?: string | undefined;
|
|
2846
|
+
}
|
|
2847
|
+
/**
|
|
2848
|
+
* Output containing the new signing secret.
|
|
2849
|
+
* @public
|
|
2850
|
+
*/
|
|
2851
|
+
export interface RotateEventDestinationSecretOutput {
|
|
2852
|
+
/**
|
|
2853
|
+
* The new signing secret for verifying event payloads. Visit [verify event signatures](https://www.stedi.com/docs/healthcare/event-destinations-message-handling#verify-authenticity-and-receipt-time) for details.
|
|
2854
|
+
* @public
|
|
2855
|
+
*/
|
|
2856
|
+
signingSecret: string | undefined;
|
|
2857
|
+
/**
|
|
2858
|
+
* Expiration timestamp for the secret this rotation replaced. Equals the rotation time when you set `previousSecretExpiryHours` to `0`. You can't rotate again until this timestamp passes.
|
|
2859
|
+
* @public
|
|
2860
|
+
*/
|
|
2861
|
+
previousSecretExpiresAt?: Date | undefined;
|
|
2862
|
+
}
|
|
2863
|
+
/**
|
|
2864
|
+
* Input for updating a destination.
|
|
2865
|
+
* @public
|
|
2866
|
+
*/
|
|
2867
|
+
export interface UpdateEventDestinationInput {
|
|
2868
|
+
/**
|
|
2869
|
+
* The unique identifier for the destination. You can retrieve destination IDs with the [List Destinations](https://www.stedi.com/docs/healthcare/api-reference/get-event-destinations-list-destinations) endpoint.
|
|
2870
|
+
* @public
|
|
2871
|
+
*/
|
|
2872
|
+
destinationId: string | undefined;
|
|
2873
|
+
/**
|
|
2874
|
+
* A human-readable name for the destination. Stedi displays this name in the portal.
|
|
2875
|
+
* @public
|
|
2876
|
+
*/
|
|
2877
|
+
name?: string | undefined;
|
|
2878
|
+
/**
|
|
2879
|
+
* A description of the destination's purpose, such as "Receives transaction enrollment task notifications."
|
|
2880
|
+
* @public
|
|
2881
|
+
*/
|
|
2882
|
+
description?: string | undefined;
|
|
2883
|
+
/**
|
|
2884
|
+
* The event types you want Stedi to send to this destination. Visit [event types](https://www.stedi.com/docs/healthcare/event-destinations-event-types) for a complete list.
|
|
2885
|
+
* @public
|
|
2886
|
+
*/
|
|
2887
|
+
eventTypes?: string[] | undefined;
|
|
2888
|
+
/**
|
|
2889
|
+
* The URL where you want Stedi to deliver payloads through HTTP `POST`.
|
|
2890
|
+
* @public
|
|
2891
|
+
*/
|
|
2892
|
+
destinationUrl?: string | undefined;
|
|
2893
|
+
/**
|
|
2894
|
+
* Maximum concurrent deliveries for this destination. If not set, Stedi applies your account default (typically 5). Stedi rejects requests exceeding your account maximum (typically 20) with a `400` error. Contact Stedi to change your limits.
|
|
2895
|
+
* @public
|
|
2896
|
+
*/
|
|
2897
|
+
concurrencyLimit?: number | undefined;
|
|
2898
|
+
/**
|
|
2899
|
+
* The destination's status. Set to `ENABLED` to receive event deliveries or `DISABLED` to pause them.
|
|
2900
|
+
* @public
|
|
2901
|
+
*/
|
|
2902
|
+
status?: EventDestinationsDestinationInputStatus | undefined;
|
|
2903
|
+
/**
|
|
2904
|
+
* A unique string to identify this request to the server. If not set, Stedi generates one automatically.
|
|
2905
|
+
*
|
|
2906
|
+
* The key can be up to 255 characters. You can safely retry requests with the same idempotency key within 24 hours of making the first request. This prevents duplicate operations due to network errors or other intermittent failures. [Learn more](https://www.stedi.com/docs/api-reference/index#idempotency-keys).
|
|
2907
|
+
* @public
|
|
2908
|
+
*/
|
|
2909
|
+
idempotencyKey?: string | undefined;
|
|
2910
|
+
}
|
|
2911
|
+
/**
|
|
2912
|
+
* Output containing the updated destination details.
|
|
2913
|
+
* @public
|
|
2914
|
+
*/
|
|
2915
|
+
export interface UpdateEventDestinationOutput {
|
|
2916
|
+
/**
|
|
2917
|
+
* The unique identifier for the destination.
|
|
2918
|
+
* @public
|
|
2919
|
+
*/
|
|
2920
|
+
id: string | undefined;
|
|
2921
|
+
/**
|
|
2922
|
+
* Creation timestamp for this destination.
|
|
2923
|
+
* @public
|
|
2924
|
+
*/
|
|
2925
|
+
createdAt: Date | undefined;
|
|
2926
|
+
/**
|
|
2927
|
+
* Last update timestamp for this destination.
|
|
2928
|
+
* @public
|
|
2929
|
+
*/
|
|
2930
|
+
updatedAt: Date | undefined;
|
|
2931
|
+
/**
|
|
2932
|
+
* The destination's current status. Stedi only sends event payloads to `ENABLED` destinations.
|
|
2933
|
+
* @public
|
|
2934
|
+
*/
|
|
2935
|
+
status: EventDestinationsDestinationStatus | undefined;
|
|
2936
|
+
/**
|
|
2937
|
+
* The timestamp for Stedi's most recent delivery attempt to this destination. Absent when Stedi hasn't yet attempted a delivery.
|
|
2938
|
+
* @public
|
|
2939
|
+
*/
|
|
2940
|
+
lastDeliveryTime?: Date | undefined;
|
|
2941
|
+
/**
|
|
2942
|
+
* A human-readable name for the destination. Stedi displays this name in the portal.
|
|
2943
|
+
* @public
|
|
2944
|
+
*/
|
|
2945
|
+
name: string | undefined;
|
|
2946
|
+
/**
|
|
2947
|
+
* A description of the destination's purpose, such as "Receives transaction enrollment task notifications."
|
|
2948
|
+
* @public
|
|
2949
|
+
*/
|
|
2950
|
+
description: string | undefined;
|
|
2951
|
+
/**
|
|
2952
|
+
* The event types Stedi sends to this destination. Visit [event types](https://www.stedi.com/docs/healthcare/event-destinations-event-types) for a complete list.
|
|
2953
|
+
* @public
|
|
2954
|
+
*/
|
|
2955
|
+
eventTypes: string[] | undefined;
|
|
2956
|
+
/**
|
|
2957
|
+
* The URL where Stedi delivers payloads through HTTP `POST`.
|
|
2958
|
+
* @public
|
|
2959
|
+
*/
|
|
2960
|
+
destinationUrl: string | undefined;
|
|
2961
|
+
/**
|
|
2962
|
+
* The maximum number of concurrent deliveries for this destination. Contact Stedi to change your account limits.
|
|
2963
|
+
* @public
|
|
2964
|
+
*/
|
|
2965
|
+
concurrencyLimit?: number | undefined;
|
|
2966
|
+
}
|