Provider Directory API Documentation

Version 1.0
Instructions to configure the Client - Postman to consume the Provider Access API

Base_URL: https://bhpproviderdirectory.ochca.com/api/v1/

Steps:

Start your API client (i.e., Postman v5.3.1+)

Download and import the predefined Postman collection prepared by OCHCA

Scroll down until you see the "Provider" endpoints.

example: https://bhpproviderdirectory.ochca.com/api/v1/Lookup/facility-types

Click the "Send" button to retrieve the requested resources

How to Use the Postman Collection:

1. Click the "Download Collection" button below. If the download does not start automatically, please right-click the button and select "Save Link as..." to save the file.

2. Open Postman on your computer. (If you don't have it, you can download it here)

3. In Postman, click the "Import" button in the top-left sidebar menu.

4. Drag and drop the downloaded file (usually named OCHCA-Provider-Directory-API.postman_collection.json) into the window that appears, or select it from your files.

5. Confirm the import by clicking the "Import" button.

6. Once imported, you can start exploring and sending requests directly. The collection variables are pre-configured to point to the correct environment.

Overview

The Provider Directory API enables programmatic access to comprehensive healthcare provider and facility data. Built on RESTful principles, it uses JSON for data exchange, ensuring high compatibility and ease of integration.

This documentation details the API endpoints, request/response formats, and integration guidelines.
API Collections
Lookup Collection

The Lookup collection provides access to standardized reference data used throughout the Provider Directory system. These endpoints return code lists and lookup values essential for data validation and display.

Available Endpoints

Endpoint Description Try It
/v1/Lookup/schedule-codes

Provider schedules and availability codes

Live Demo
/v1/Lookup/facility-types

Healthcare facility classification codes

Live Demo
/v1/Lookup/service-codes

Available healthcare services

Live Demo
/v1/Lookup/population-served-codes

Target population demographics

Live Demo
/v1/Lookup/licensure-codes

Professional licensure types

Live Demo
/v1/Lookup/state-codes

US state and territory codes

Live Demo
/v1/Lookup/gender-codes

Gender identity codes

Live Demo
/v1/Lookup/taxonomy

Healthcare provider taxonomy codes

Live Demo
/v1/Lookup/language-codes

Supported languages

Live Demo
/v1/Lookup/cultural-cap-codes

Cultural competency indicators

Live Demo
/v1/Lookup/specialties

Medical specialties

Live Demo
/v1/Lookup/telehealths

Telehealth service options

Live Demo
Provider Collection

The Provider Collection enables you to search and filter providers, access provider details, languages, and specialties through a set of RESTful endpoints.

Available Endpoints

Endpoint Description Try It
/v1/Provider/providers

Returns a paginated list of providers.

Query parameters:

  • page (int, required): 1-based page index. Must be >= 1.
  • pageSize (int, required): Number of results per page. Must be a positive integer.
Live Demo
/v1/Provider/search

Search providers using optional filters. Omit a parameter or pass it empty to ignore that filter.

Query parameters:

  • FirstName (string): Filter by provider first name.
  • LastName (string): Filter by provider last name.
  • Gender (string): Filter by gender. Use the code values returned by /v1/Lookup/gender-codes.
  • Language (string): Filter by language. Use the code values returned by /v1/Lookup/language-codes.
  • CulturalCapabilityTraining (bool): Filter providers with cultural capability training. Example: T (true) or F (false).
  • Speciality (string): Filter by specialty. Use the code values returned by /v1/Lookup/specialties.
  • ProviderType (string): Filter by provider taxonomy. Use a value from /v1/Lookup/taxonomy.
  • Telehealth (bool): Filter providers offering telehealth. Example: T (true) or F (false).
  • AcceptNewPatient (bool): Filter providers currently accepting new patients. Example: T (true) or F (false).
  • CulturalCapability (string): Filter by cultural capability. Use a value returned by /v1/Provider/provider-languages.
  • Medicare (bool): Filter providers accepting Medicare. Example: T (true) or F (false).
  • CHIP (bool): Filter providers accepting CHIP. Example: T (true) or F (false).
  • TGITraining (bool): Filter providers with TGI training. Example: T (true) or F (false).

Notes:

  • If you need to query multiple codes, use the semicolon delimiter (';'). For example: /v1.0/Provider/search?Gender=M;F
Live Demo
/v1/Provider/{providerId}

Get detailed information for a specific provider.

Path parameter:

  • providerId (int, required): Unique identifier of the provider.
Live Demo
/v1/Provider/provider-languages

Get list of supported provider languages with fluency levels.

Live Demo
/v1/Provider/provider-types-list

Get list of provider with related taxonomy codes.

Live Demo
Site Collection

The Site Collection provides access to healthcare facility information, including locations, services, and schedules. These endpoints enable you to search facilities, retrieve detailed site information, and access related provider associations.

Available Endpoints

Endpoint Description Try It
/v1/Site/sites

Returns a paginated list of sites.

Query parameters:

  • page (int, required): 1-based page index. Must be >= 1.
  • pageSize (int, required): Number of results per page. Must be a positive integer.
Live Demo
/v1/Site/{siteId}

Get detailed information for a specific site.

Path parameter:

  • siteId (int, required): Unique identifier of the site.
Live Demo
/v1/Site/search

Search sites using optional filters. Omit a parameter or pass an empty value to ignore that filter.

Query parameters (all optional):

  • SiteName (string): Filter by site name.
  • ZipCode (string): Filter by ZIP code.
  • Address (string): Filter by street address.
  • Address2 (string): Filter by secondary address (unit, suite, etc.).
  • City (string): Filter by city name.
  • State (string): Filter by state abbreviation (e.g., AK, AL, AR, AZ, CA).
  • WithinDistance (string): Search within the specified radius (miles) from the provided coordinates (requires Latitude and Longitude).
  • ProgramTypes (string): Filter by program types offered at the site (e.g., AMHS, CYS, ASO, SUD).
  • IsAdaCompliant (string): Filter by ADA compliance (T/F).
  • IsTddTtyAvail (string): Filter by TDD/TTY availability (T/F).
  • Latitude (string): Latitude coordinate for location-based searches.
  • Longitude (string): Longitude coordinate for location-based searches.
Live Demo
/v1/Site/site-schedule/{siteId}

Return the opening and closing schedule for a specific site.

Live Demo
/v1/Site/provider-site/{siteId}

Get provider-site relationship data for a specific site.

Live Demo
/v1/Site/all-site-names

Get a simple list of all site names, useful for dropdowns or autocomplete.

Live Demo
/v1/Site/all-site-address

Get a list of all site street addresses.

Live Demo
/v1/Site/all-site-address2

Get secondary address details (building, office, suite) for all sites.

Live Demo
An unhandled error has occurred. Reload 🗙