NEnexhealth
Fee Schedules

View fee schedules (beta)

🚧 Beta

Send Nex-Api-Version: v3.1.0 to use this endpoint. It is still changing, and access is limited to approved partner institutions. Contact NexHealth before you build on it.

Changed from v3.0.0: Adds response fields data[].procedure_fees, data[].procedure_fees[].code, data[].procedure_fees[].fee, data[].procedure_fees[].fee.amount (+2 more).

This endpoint returns fee schedules for the specified location, optionally filtered by updated_since or active status (defaults to active only).

get/fee_schedules

Request

  • Base URL
    https://nexhealth.info
  • URL
    https://nexhealth.info/fee_schedules
  • Auth
    API key in header Authorization

Query parameters

subdomainstring required

Used to scope the request to the specified institution

location_idinteger required

Used to scope the request to the specified location

updated_sincestring date-time

Fee schedules updated after the specified time (UTC)

start_cursorstring

First item of the current page. Starts empty

end_cursorstring

Last item of the current page. Starts empty

per_pageinteger

Number of results to return per page. Maximum allowed amount is 1000.

activeboolean

true returns only active records, false only inactive. Defaults to true

Headers

Nex-Api-Versionstring required

The NexHealth API version

Response

Successful

codeboolean

Indicates the success or failure of the request

descriptionstring

Additional context on the request to help with debugging.

errorstring[]

Any errors that occur during the execution of the request.

page_infoobject

Pagination information that can be used for fetching previous and next pages.

Example response

{
  "description": "Description",
  "error": [
    "Error message"
  ],
  "data": [
    {
      "id": 113,
      "name": "Cash",
      "active": true,
      "location_id": 21,
      "updated_at": "2020-06-05T20:16:57.007Z",
      "procedure_fees": [
        {
          "procedure_code_id": "ab123456-11aa-99ff-a111-d1ee12345678",
          "fee": {
            "amount": "62.00",
            "currency": "USD"
          },
          "code": "D0120"
        }
      ]
    }
  ],
  "page_info": {
    "has_previous_page": false,
    "has_next_page": false,
    "start_cursor": "AAAAA",
    "end_cursor": "BBBBBB"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.