Matching

Why it matters: an NPI with a slightly wrong name still returns the NPI’s organization. Results come ordered by score, descending, so auto-accept the top hit or review the top few.

• The NPI anchors. It takes the and/or/not shape: or for any of these, and for all of these, not to exclude.
• Name anchors when you have no NPI. name matches exact, token, and edit-distance forms, so a minor misspelling still resolves.
• Location and type rank: city, state, country, postalCode, and institutionType sharpen the order rather than filter.
• Exception: not values are hard exclusions on every field, and strict: true makes every supplied field a hard filter, the legacy behavior: and values must all match, and or values need at least one.
• Tag your requests. metadata attaches your own key/value pairs and is echoed back in the response.

1. By NPI. The NPI resolves to a single organization. Adding a name confirms the hit and cannot exclude it.

{
  "npi": { "or": ["1407589070"] },
  "name": "wentworth-douglass hospital"
}

{
  "results": [
    {
      "aggkHcoId": "187892874929524688",
      "city": "Dover",
      "country": "united states",
      "institutionType": "Hospital",
      "name": "Wentworth - Douglass Hospital",
      "npi": "1407589070",
      "postalCode": "03820",
      "score": 60.0,
      "state": "New Hampshire",
      "website": "wdhospital.org/wdh"
    }
  ]
}

2. By name and location. With only a name, add a location or an institutionType to rank look-alikes higher.

{
  "name": "wentworth douglass hospital",
  "state": { "or": ["new hampshire"] }
}

{
  "results": [
    {
      "aggkHcoId": "187892874929524688",
      "city": "Dover",
      "country": "united states",
      "institutionType": "Hospital",
      "name": "Wentworth - Douglass Hospital",
      "npi": "1407589070",
      "postalCode": "03820",
      "score": 13.0,
      "state": "New Hampshire",
      "website": "wdhospital.org/wdh"
    }
  ]
}