Eligibility Input

The goal of the SDK is to take away the complexity of managing the eligibility form, lifecycle, error handling, and allow you to focus on building a UI that blends in to your product.

The useEligibilityInputField manages the state of the input UI, and indicates how it should be used. The input argument is one of a list of strings (reference below). Return value and setValue are strongly typed based on the field name passed in as the function argument (eg, firstName is a string).

1
const {
2
  // The current value, null if it hasn't been set yet (or isn't relevant)
3
  value: FieldType | null
4
5
  // Sets the updated value, cannot be set to null
6
  setValue: (value: FieldType) => void
7
8
  // Whether this field should be displayed at all
9
  isVisible: boolean
10
11
  // Whether this is required (true), or optional (false)
12
  isRequired: boolean
13
14
  // Whether the input field should be disabled (for example, when the eligibility request is being processed)
15
  isDisabled: boolean
16
17
  // Whether the content of this field is valid (example, `false` if the lastName is empty)
18
  isValid: boolean
19
} = useEligibilityInputField(...)

Field Types

State codes are exported as UsStateCodes and UsStateMap.

Usage

These fields can be used outside of an eligibility session, at any point. They are most useful when used within an eligibility session (for more on sessions, see Soft Check and Hard Check).

Bridge determines which fields are required for the eligibility session you are in. Focus on rendering the appropriate UI element for each field, and, Bridge will take care of the rest.

Member ID

The requirement for Member ID is complex. User conversion is far greater when patients aren’t required to find their ID cards. Whether it’s required, depends on the choice of Payer.

Bridge handles the interaction between the Payer selection and Member ID fields. If the user selects a cardless Payer (eg, Aetna), the memberId hook will return isVisible: false.

There are scenarios where a Payer who typically doesn’t require an ID, does. If certain error codes are returned from an eligibility request, Bridge manages showing or requiring the Member ID field for a second attempt.

Example

See the Demo Project form for a working example.

1
import { useEligibilityInputField } from "@usebridge/sdk-react"
2
import { TextField } from "@mui/material"
3
4
/**
5
 * User input for the Hard Eligibility request, submits
6
 */
7
export const MemberIdField = () => {
8
  // Fetch the state of the `memberId` field
9
  const { isVisible, isDisabled, isRequired, value, setValue } = useEligibilityInputField("memberId")
10
11
  // If this isn't visible, render nothing
12
  if(!isVisible) return null
13
14
  // Render a TextField with the appropriate state
15
  return (
16
    <TextField
17
      disabled={isDisabled}
18
      label={`Member ID ${isRequired ? "(Required)" : "(Optional)"}`}
19
      value={value}
20
      onChange={(e) => setValue(e.target.value)}
21
    />
22
  )
23
}