Soft Check

Bridge’s React SDK is in beta! Expect breaking changes, bugs, and missing features. Please talk to us before integrating.

Including a Soft Check as part of your patient journey is not mandatory, please reach out to discuss trade-off’s.

Refer to the Soft Eligibility page for a detailed look at what is happening with in a “soft check”. This allows you to run a quick, patient-agnostic eligibility check to confirm the viability of a patient before moving them through your funnel.

Only the Payer and State are required, and Bridge will return a basic “yes / no” on eligibility, with a list of eligible providers.

See the Demo Project for a working example of a Soft Check.

1

Create a Session

Create the SoftEligibilitySession by calling the createSoftEligibilitySession function on the SDK, nested somewhere within your BridgeSdkProvider. You must provide at least one ServiceType ID into the config.

Render the SoftEligibilityProvider component, with the session you just created, as a parent of your eligibilty form.

1export const SessionContainer = ({children}) => {
2 const { createSoftEligibilitySession } = useBridgeSdk()
3 const session = useMemo(() => {
4 createSoftEligibilitySession({ serviceTypeIds: ['svt_xxx'] })
5 }, [createSoftEligibilitySession])
6
7 return (
8 <SoftEligibilityProvider session={session}>
9 {children}
10 </SoftEligibilityProvider>
11 )
12}
13
14### Form Input
15
16Soft checks require the `state` and `payer` fields, never any other information.
17Use the [Payer Autocomplete](./payer-autocomplete) hook, and [Eligibility Input](./eligibility-input) fields to drive your UI.
18
19```typescript
20const payer = useEligibilityInputField("payer")
21const state = useEligibilityInputField("state")
2

Submission

Bridge manages the loading state and validation of your inputs. Import the useSoftEligibilitySubmit hook, to access an isDisabled (true if the fields aren’t valid yet, or if it’s being submitted) and a submit function.

1export const SoftEligibilitySubmitButton = () => {
2 const { isDisabled, submit } = useSoftEligibilitySubmit()
3
4 return (
5 <button disabled={isDisabled} onClick={() => submit()}>
6 Submit
7 </button>
8 )
9}
3

Handle the result

The useSoftEligibilityState hook returns a SoftEligibilitySessionState, that can be used to handle the result of the submission.

1interface SoftEligibilitySessionState {
2 // High level session status
3 status: "PENDING" | "SUBMITTING" | "ERROR" | "INELIGIBLE" | "ELIGIBLE"
4
5 // If the status is ELIGIBLE, this contains the final set of EligibleProviders
6 providers?: Provider[]
7
8 ...
9}
StatusDescription / Action
PENDINGNothing has been submit yet, form is enabled
SUBMITTINGAPI requests are being made, fields are disabled
ERRORRequest failed, fields are enabled, it may be retried
INELIGIBLESoft check was successful, but this Payer/State combination is not
ELIGIBLEPatient may be eligible, there are providers enrolled in this state

When you reach a terminal state, INELIGIBLE or ELIGIBLE, display the result and move the patient to the next step.