NPI Provider API

Clean REST API for searching, retrieving, and validating U.S. healthcare providers by NPI. Built on top of the public NPPES registry, but returns normalized provider data that is easier to use in production apps.

原始信息汇总

NPI Provider API 数据集概述

基本信息

• 数据集名称: NPI Provider API
• 类别: Medical
• 创建者: Emeka Dozie
• 订阅者数量: 1

定价方案

• BASIC: $0.00 / 月
• PRO: $10.00 / 月
• ULTRA: $25.00 / 月
• MEGA: $50.00 / 月

API 概述

NPI Provider API 是一个围绕公共 NPPES NPI Registry API 构建的轻量级 REST 包装器。它旨在为需要提供商搜索和 NPI 验证的开发者提供服务，无需处理原始的上游响应结构。响应被规范化为更清晰的模式，包含格式化的地址、主要分类对象、简单的提供商类型以及明确的活动/非活动状态。

此 API 适用于：

• 提供商查找工具
• 健康科技管理仪表板
• 内部运营工具
• 认证和入职流程
• CRM 数据丰富
• 保险和资格类检查
• 提供商目录功能

包含的端点

• GET /health
• GET /v1/provider/search
• GET /v1/provider/{npi}
• GET /v1/provider/{npi}/validate

认证

受保护的端点需要 API 密钥头： x-api-key: YOUR_API_KEY

基础 URL

https://npi-provider-api-364433269190.us-central1.run.app

端点详情

1. GET /health

• 描述: 简单的健康检查端点。

• 方法: GET

• 完整 URL 示例: https://npi-provider-api-364433269190.us-central1.run.app/health

• 参数: 无

• 示例请求: bash curl -X GET "https://npi-provider-api-364433269190.us-central1.run.app/health"

• 示例成功响应: json { "status": "ok" }

• 常见错误响应:

  • 500 Internal Server Error

2. GET /v1/provider/search

• 描述: 搜索医疗保健提供商并返回规范化的提供商对象。

• 方法: GET

• 完整 URL 示例: https://npi-provider-api-364433269190.us-central1.run.app/v1/provider/search?last_name=smith&state=CA&limit=3

• 查询参数:

  名称	类型	必需	描述
  first_name	string	否	提供商名字。用于个人提供商。
  last_name	string	否	提供商姓氏。用于个人提供商。
  organization_name	string	否	组织或机构名称。
  npi	string	否	要直接搜索的 10 位 NPI 号码。
  state	string	否	2 个字母的美国州缩写，例如 CA 或 TX。
  city	string	否	城市名称。
  taxonomy_code	string	否	提供商分类代码。此过滤在上游规范化后执行。
  limit	integer	否	要返回的结果数量。默认值：10。最小值：1。最大值：200。
  skip	integer	否	为分页式访问跳过的结果数量。默认值：0。最小值：0。

• 注意: 必须至少提供以下一个搜索参数：first_name、last_name、organization_name、npi、state、city、taxonomy_code。

• 示例请求: bash curl -X GET "https://npi-provider-api-364433269190.us-central1.run.app/v1/provider/search?last_name=smith&state=CA&limit=3" -H "x-api-key: YOUR_API_KEY"

• 示例成功响应: json [ { "npi": "1033185175", "name": "John Smith, MD", "provider_type": "individual", "taxonomy": { "code": "207Q00000X", "description": "Family Medicine", "state": "CA", "license": "A123456" }, "address": "1234 Westlake Blvd, Suite 200, Los Angeles, CA, 90017, US", "phone": "2135550147", "status": "active" } ]

• 常见错误响应:

  • 400 Bad Request
  • 401 Unauthorized
  • 429 Too Many Requests
  • 502 Bad Gateway
  • 504 Gateway Timeout
  • 500 Internal Server Error

3. GET /v1/provider/{npi}

• 描述: 通过 10 位 NPI 检索单个规范化的提供商记录。

• 方法: GET

• 完整 URL 示例: https://npi-provider-api-364433269190.us-central1.run.app/v1/provider/1033185175

• 路径参数:

  名称	类型	必需	描述
  npi	string	是	10 位国家提供商标识符。必须恰好是 10 位数字。

• 示例请求: bash curl -X GET "https://npi-provider-api-364433269190.us-central1.run.app/v1/provider/1033185175" -H "x-api-key: YOUR_API_KEY"

• 示例成功响应: json { "npi": "1033185175", "name": "John Smith, MD", "provider_type": "individual", "taxonomy": { "code": "207Q00000X", "description": "Family Medicine", "state": "CA", "license": "A123456" }, "address": "1234 Westlake Blvd, Suite 200, Los Angeles, CA, 90017, US", "phone": "2135550147", "status": "active" }

• 常见错误响应:

  • 400 Bad Request
  • 401 Unauthorized
  • 404 Not Found
  • 422 Unprocessable Entity
  • 429 Too Many Requests
  • 502 Bad Gateway
  • 504 Gateway Timeout
  • 500 Internal Server Error

4. GET /v1/provider/{npi}/validate

• 描述: 用于检查 NPI 是否存在以及提供商是否处于活动状态的快速验证端点。

• 方法: GET

• 完整 URL 示例: https://npi-provider-api-364433269190.us-central1.run.app/v1/provider/1033185175/validate

• 路径参数:

  名称	类型	必需	描述
  npi	string	是	10 位国家提供商标识符。必须恰好是 10 位数字。

• 示例请求: bash curl -X GET "https://npi-provider-api-364433269190.us-central1.run.app/v1/provider/1033185175/validate" -H "x-api-key: YOUR_API_KEY"

• 示例成功响应（有效 NPI）: json { "npi": "1033185175", "valid": true, "active": true, "name": "John Smith, MD", "taxonomy": { "code": "207Q00000X", "description": "Family Medicine", "state": "CA", "license": "A123456" } }

• 示例成功响应（未知 NPI）: json { "npi": "0000000000", "valid": false, "active": false, "name": null, "taxonomy": null }

• 常见错误响应:

  • 400 Bad Request
  • 401 Unauthorized
  • 422 Unprocessable Entity
  • 429 Too Many Requests
  • 502 Bad Gateway
  • 504 Gateway Timeout
  • 500 Internal Server Error

响应格式说明

• 大多数错误响应遵循以下格式： json { "error": { "code": 400, "message": "Error message here" } }

• 在自定义异常处理程序之前生成的验证错误可能使用 FastAPI 的默认验证格式。

注意事项

• 搜索支持以下过滤器：名字、姓氏、组织名称、NPI、州和城市。
• 此包装器支持 taxonomy_code 过滤，尽管上游公共 API 未明确将其作为记录的搜索参数公开。
• 此 API 旨在简单、可预测且易于集成。