# searchOpenPaymentsRecipients

**Identifier:** `openpayments_searchOpenPaymentsRecipients`

**Provider:** [OpenPayments](https://kirha.com/providers/openpayments.md)

Find US physicians and non-physician practitioners (NP, PA...) in the CMS Open Payments recipient registry by last name or NPI, optionally narrowed by first name, state, city or specialty. Returns NPIs for getRecipientPayments. Only covers clinicians who received at least one reported payment since 2013.

## Run it with the CLI

```bash
kirha tools run openpayments_searchOpenPaymentsRecipients \
  --input '{}'
```

`--input` takes a JSON object that matches the input schema. Pass `--input -` to read it from stdin.

## Call it over HTTP

```bash
curl https://api.kirha.com/tools/v1/execute \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: **********' \
  --data '{
  "tool_name": "openpayments_searchOpenPaymentsRecipients",
  "input": {}
}'
```

Replace the stars with an API key from https://app.kirha.com/api-keys.

## Input schema

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "city": {
      "minLength": 2,
      "type": "string"
    },
    "firstName": {
      "description": "Prefix match",
      "minLength": 1,
      "type": "string"
    },
    "lastName": {
      "minLength": 2,
      "type": "string"
    },
    "limit": {
      "default": 10,
      "maximum": 50,
      "minimum": 1,
      "type": "integer"
    },
    "npi": {
      "pattern": "^\\d{10}$",
      "type": "string"
    },
    "specialty": {
      "description": "Substring of the NUCC taxonomy, e.g. Cardiovascular, Oncology",
      "minLength": 3,
      "type": "string"
    },
    "state": {
      "description": "US state code, e.g. CA",
      "maxLength": 2,
      "minLength": 2,
      "type": "string"
    }
  },
  "type": "object"
}
```

## Output schema

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "context": {
      "type": "string"
    },
    "npis": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "recipients": {
      "items": {
        "additionalProperties": false,
        "properties": {
          "city": {
            "type": "string"
          },
          "fullName": {
            "type": "string"
          },
          "npi": {
            "type": "string"
          },
          "profileId": {
            "description": "Open Payments covered recipient profile ID",
            "type": "string"
          },
          "recipientType": {
            "type": "string"
          },
          "specialty": {
            "description": "NUCC taxonomy path",
            "type": "string"
          },
          "state": {
            "type": "string"
          }
        },
        "required": [
          "profileId"
        ],
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "context",
    "recipients",
    "npis"
  ],
  "type": "object"
}
```

## Related tools

Other OpenPayments tools that this tool refers to, or that refer to it.

- [`getRecipientPayments`](https://kirha.com/providers/openpayments/getRecipientPayments.md)

-----

[All OpenPayments tools](https://kirha.com/providers/openpayments.md) · [< Back to tools list](https://kirha.com/tools.md)