This resource allows for the management of providers in popHealth

popHealth assumes that providers are in a hierarchy. This resource allows users to see the hierarchy of providers

Supported Formats

json

GET /api/providers
Get a list of providers. Returns all providers that the user has access to.

Supported Formats

json

Params

Param name Description
page
optional

Validations:

  • Must match regular expression /\d+/.

per_page
optional

Validations:

  • Must match regular expression /\d+/.


GET /api/providers/:id
Get an individual provider

This will return an individual provider. It will include the id and name of its parent, if it has a parent. Children providers one level deep will be included in the children property if any children for this provider exist.

Supported Formats

json

Examples

{
  "_id": "5331db9575efe558ad000bc9",
  "address": "1601 S W Archer Road Gainesville FL 32608",
  "cda_identifiers": [
    {
      "_id": "5331db9575efe558ad000bca",
      "extension": "573",
      "root": "Division"
    }
  ],
  "family_name": null,
  "given_name": "North Florida/South Georgia HCS-Gainesville",
  "level": null,
  "parent_id": "5331db9575efe558ad000bc7",
  "parent_ids": [
    "5331db9475efe558ad0008da",
    "5331db9575efe558ad000b8d",
    "5331db9575efe558ad000bc7"
  ],
  "phone": null,
  "specialty": null,
  "team_id": null,
  "title": null,
  "parent": {
    "_id": "5331db9575efe558ad000bc7",
    "address": "1601 S W Archer Road Gainesville FL 32608",
    "cda_identifiers": [
      {
        "_id": "5331db9575efe558ad000bc8",
        "extension": "573",
        "root": "Facility"
      }
    ],
    "family_name": null,
    "given_name": "North Florida/South Georgia HCS-Gainesville",
    "level": null,
    "parent_id": "5331db9575efe558ad000b8d",
    "parent_ids": [
      "5331db9475efe558ad0008da",
      "5331db9575efe558ad000b8d"
    ],
    "phone": null,
    "specialty": null,
    "team_id": null,
    "title": null
  }
}

Params

Param name Description
id
required

Provider ID

Validations:

  • Must be a String


POST /api/providers
Create a new provider

Supported Formats

json

PUT /api/providers/:id
Update a provider

Supported Formats

json

Params

Param name Description
id
required

Provider ID

Validations:

  • Must be a String


DELETE /api/providers/:id
Remove an individual provider

Supported Formats

json

Params

Param name Description
id
required

Provider ID

Validations:

  • Must be a String


GET /api/providers/search?npi=:npi&tin=:tin&address=:address
Search for provider by partial NPI/TIN/Addresss