Searching Health Resources

Workflow Guide

This guide describes the operations related to b.well directory of providers and available connections. The searchHealthResources method enables comprehensive searching across resource types within the b.well ecosystem. It allows users to find and retrieve information about healthcare providers, facilities, and support services, including practitioners, clinics, hospitals, health systems, insurance providers, and laboratories, from a single search.

Prerequisites

• Completed Authentication and Account Creation

Summary of Steps

1. Use searchHealthResources to find the desired Provider, Health System, Pharmacy, Insurance or Lab
2. Optionally, allow users to request a connection be added to the directory using

Step 1: Search the b.well Directory for Health Resources

Use the searchHealthResources endpoint to search the b.well directory.

Search Parameters

• Search Term (String): Key filter for searches, applicable for names, specialties, locations, or addresses.

• Filters: Filters results based on organization type.

  • • PRACTICE used for hospitals, clinics, and health system connections.
    • PRACTITIONER used for healthcare providers.
    • LABORATORY used for laboratory connections.
    • INSURANCE used for insurance provider connections
    • PHARMACY used for pharmacy connections
  • ID: Only return search results included in the array of IDs
  • Include Populated PROA Only: Return only results that have PROA connections
  • Location: Sorts results by geographical location using latitude and longitude

• Sort Options:

  • By default, results are sorted by relevance in descending (DESC) order when no sortBy value is specified.
    • The most relevant results have the highest score so sorting by DESC is required to see the most relevant results first
  • Available sorting options include:
    • Relevance (default)
    • Distance
    • Content

• Pagination:

  • page: Specifies the page number for results.
  • pageSize: Determines the number of results per page.

Step 2: Submit a Connection for Review

In cases where the user is unable to find their desired connection, they can submit a request to the b.well team. The b.well team will attempt to add the requested connection to the b.well directory.

For this use case, use submitProviderForReview. Based on client configuration, the user may be notified of the availability of the connection via email or other notification system.

For complete request and response schema, see SearchManager documentation.