v1

latestOpenAPI 3.0.0NexHealth License 1.02026-07-2688180386.6 KB

Fee Schedules

View fee schedule procedures

This endpoint returns the procedure fees for the specified location. At least one of the fee_schedule_id or updated_since filters must be provided

get/fee_schedule_procedures

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

fee_schedule_idinteger

Filter by fee schedule id

updated_sincestring date-time

Fee schedule procedures 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.

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": [
    {
      "procedure_code_id": "ab123456-11aa-99ff-a111-d1ee12345678",
      "fee": {
        "amount": "62.00",
        "currency": "USD"
      },
      "code": "D0120",
      "id": 113,
      "location_id": 10,
      "fee_schedule_id": 1234,
      "updated_at": "2020-06-05T20:16:57.007Z"
    }
  ],
  "page_info": {
    "has_previous_page": false,
    "has_next_page": false,
    "start_cursor": "AAAAA",
    "end_cursor": "BBBBBB"
  }
}