Referral Requirement
Use Referral Specialties Information to notify the patient when the selected face-to-face specialty requires a prior referral in the selected country.
This screen includes:
| # | Element | Description |
|---|---|---|
| 1 | Referral message | Explains that the selected specialty requires a prior referral in the selected country. |
| 2 | Requested specialty | Displays the specialty the patient wants to book. |
| 3 | Visit country | Displays the selected face-to-face visit country. |
| 4 | Required referral specialty | Displays the specialty required before the patient can book the visit. |
| 5 | Cancel action | Closes the popup and returns the patient to the specialty list. |
| 6 | Continue action | Lets the patient continue to the next step. |
Workflow
- Select a face-to-face visit country.
- Select a specialty from the home screen.
- Display the referral information popup when a referral rule applies.
- Select Continue to proceed.
- Select Cancel to return to the specialty list.
Validations
| Scenario | App Behavior | SDK Output |
|---|---|---|
| Session invalid | Block referral rule check | state = unauthenticated |
| Visit type is video | Skip referral popup | state = skipped |
| Country has no referral rule | Continue without popup | referralRule = unavailable |
| Specialty has no referral rule | Continue without popup | referralRule = unavailable |
| Referral rule applies | Display referral popup | referralRule = required |
| Referral information fails to load | Display error state | state = error |
Actions
| Scenario | App Behavior | SDK Output |
|---|---|---|
| Face-to-face specialty selected | Check referral rule | PUT /api/v3/home/referral-specialties/info |
| Referral rule applies | Open referral popup | modal = referral_specialties_info |
| Continue selected | Proceed to next step | state = continued |
| Cancel selected | Return to specialty list | state = cancelled |
| Referral rule unavailable | Continue without popup | state = skipped |
| Request rejected | Preserve specialty list | state = unchanged |
Endpoint Resources
Referral specialties information
PUT
v3/home/referral-specialties/infov3/wizard/info/controlled-substances-prescription
Show referral specialties screen.
note
This endpoint does not create a referral or book an appointment. It returns the referral requirement information that the app displays before the patient continues.