OpenAPI Specification
openapi: 3.0.0
info:
title: NexHealth Adjustment Types Fee Schedules API
description: v3.0.0 and v20240412 are two names for the same API version; the Nex-Api-Version header accepts either value. Welcome to the developer hub and documentation for NexHealth API. This section of guide describes the operations, response parameters, request parameters, and parameter constraints related to User API. The term Operations refer to functions or methods. The operations are included in requests and send to the web server. Each operation performs a different action or a query on database.
termsOfService: https://www.nexhealth.com/terms-of-service
contact:
name: NexHealth
email: info@nexhealth.com
license:
name: NexHealth License 1.0
url: https://www.nexhealth.com/privacy
version: v20240412
servers:
- url: https://nexhealth.info
security:
- Authorization: []
tags:
- name: Fee Schedules
description: A fee schedules resource
paths:
/fee_schedule_procedures:
get:
summary: View fee schedule procedures
description: 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
parameters:
- in: header
name: Nex-Api-Version
description: The NexHealth API version
required: true
schema:
type: string
default: v3.0.0
- in: query
name: subdomain
description: Used to scope the request to the specified institution
required: true
schema:
type: string
- in: query
name: location_id
description: Used to scope the request to the specified location
required: true
schema:
type: integer
format: int32
- in: query
name: fee_schedule_id
description: Filter by fee schedule id
required: false
example: 1234
schema:
type: integer
format: int32
- in: query
name: updated_since
description: Fee schedule procedures updated after the specified time (UTC)
required: false
example: '2024-04-12T10:30:00Z'
schema:
type: string
format: date-time
- in: query
name: start_cursor
description: First item of the current page. Starts empty
required: false
schema:
type: string
- in: query
name: end_cursor
description: Last item of the current page. Starts empty
required: false
schema:
type: string
- in: query
name: per_page
description: Number of results to return per page. Maximum allowed amount is 1000.
required: false
schema:
type: integer
format: int32
default: 5
responses:
'200':
description: Successful
content:
application/json:
schema:
$ref: '#/components/schemas/API_V20240412_Entities_FeeScheduleProcedureCode_Collection_Response_WithCursor'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/API_Errors_BadRequest'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/API_Errors_Unauthorized'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/API_Errors_Forbidden'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/API_Errors_InternalServerError'
tags:
- Fee Schedules
operationId: getFeeScheduleProcedures
/fee_schedules:
get:
summary: View fee schedules
description: This endpoint returns the fee schedules for the specified location
parameters:
- in: header
name: Nex-Api-Version
description: The NexHealth API version
required: true
schema:
type: string
default: v3.0.0
- in: query
name: subdomain
description: Used to scope the request to the specified institution
required: true
schema:
type: string
- in: query
name: location_id
description: Used to scope the request to the specified location
required: true
schema:
type: integer
format: int32
- in: query
name: updated_since
description: Fee schedules updated after the specified time (UTC)
required: false
example: '2024-04-12T10:30:00Z'
schema:
type: string
format: date-time
- in: query
name: start_cursor
description: First item of the current page. Starts empty
required: false
schema:
type: string
- in: query
name: end_cursor
description: Last item of the current page. Starts empty
required: false
schema:
type: string
- in: query
name: per_page
description: Number of results to return per page. Maximum allowed amount is 1000.
required: false
schema:
type: integer
format: int32
default: 5
- in: query
name: active
description: Filter active/not active
required: false
example: true
schema:
type: boolean
default: true
responses:
'200':
description: Successful
content:
application/json:
schema:
$ref: '#/components/schemas/API_Entities_FeeSchedule_Collection_Response_WithCursor'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/API_Errors_BadRequest'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/API_Errors_Unauthorized'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/API_Errors_Forbidden'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/API_Errors_InternalServerError'
tags:
- Fee Schedules
operationId: getFeeSchedules
/fee_schedules/{id}:
get:
summary: View fee schedule
description: This endpoint returns a single fee schedule
parameters:
- in: header
name: Nex-Api-Version
description: The NexHealth API version
required: true
schema:
type: string
default: v3.0.0
- in: path
name: id
required: true
schema:
type: integer
format: int64
- in: query
name: subdomain
description: Used to scope the request to the specified institution
required: true
schema:
type: string
- in: query
name: include[]
description: Resources to be included in the response
required: false
explode: true
schema:
type: array
items:
type: string
enum:
- procedure_fees
responses:
'200':
description: Successful
content:
application/json:
schema:
$ref: '#/components/schemas/API_V20240412_Entities_FeeSchedule_Response'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/API_Errors_BadRequest'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/API_Errors_Unauthorized'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/API_Errors_Forbidden'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/API_Errors_NotFound'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/API_Errors_InternalServerError'
tags:
- Fee Schedules
operationId: getFeeSchedulesId
components:
schemas:
API_Errors_InternalServerError:
type: object
properties:
code:
type: boolean
description: Indicates the success or failure of the request.
description:
type: string
description: Additional context about the request to help with debugging.
data:
type: object
error:
type: array
items:
type: string
description: Any errors that occured during the execution of the request.
description: API_Errors_InternalServerError model
API_Errors_Forbidden:
type: object
properties:
code:
type: boolean
description: Indicates the success or failure of the request.
description:
type: string
description: Additional context about the request to help with debugging.
data:
type: object
error:
type: array
items:
type: string
description: Any errors that occured during the execution of the request.
description: API_Errors_Forbidden model
API_Errors_Unauthorized:
type: object
properties:
code:
type: boolean
description: Indicates the success or failure of the request.
description:
type: string
description: Additional context about the request to help with debugging.
data:
type: object
error:
type: array
items:
type: string
description: Any errors that occured during the execution of the request.
description: API_Errors_Unauthorized model
API_V20240412_Entities_FeeSchedule:
type: object
properties:
id:
type: integer
format: int64
example: 113
description: Fee schedule id
name:
type: string
example: Cash
description: The name of the fee schedule
active:
type: boolean
example: true
description: Indicates if the fee schedule is active
nullable: true
location_id:
type: integer
format: int32
example: 21
description: The id of the location this fee schedule belongs to
nullable: true
updated_at:
type: string
format: date-time
example: '2020-06-05T20:16:57.007Z'
description: Fee Schedule update date in UTC
procedure_fees:
type: array
items:
$ref: '#/components/schemas/API_V20240412_Entities_FeeScheduleProcedureCodeBasic'
description: The procedure fees associated with this schedule
API_Errors_NotFound:
type: object
properties:
code:
type: boolean
description: Indicates the success or failure of the request.
description:
type: string
description: Additional context about the request to help with debugging.
data:
type: object
error:
type: array
items:
type: string
description: Any errors that occured during the execution of the request.
description: API_Errors_NotFound model
API_Errors_BadRequest:
type: object
properties:
code:
type: boolean
description: Indicates the success or failure of the request.
description:
type: string
description: Additional context about the request to help with debugging.
data:
type: object
error:
type: array
items:
type: string
description: Any errors that occured during the execution of the request.
description: API_Errors_BadRequest model
API_V20240412_Entities_FeeSchedule_Response:
type: object
properties:
code:
type: boolean
example: false
description: Indicates the success or failure of the request
description:
type: string
example: Description
description: Additional context on the request to help with debugging.
error:
type: array
items:
type: string
example:
- Error message
description: Any errors that occur during the execution of the request.
data:
$ref: '#/components/schemas/API_V20240412_Entities_FeeSchedule'
count:
type: integer
format: int32
example: 2
description: Number of total objects, in case of collection.
description: API_V20240412_Entities_FeeSchedule_Response model
API_V2_Entities_Price:
type: object
properties:
amount:
type: string
example: '62.00'
description: The currency value, in whole units (e.g. dollars)
currency:
type: string
example: USD
description: The ISO currency code
API_V20240412_Entities_FeeScheduleProcedureCode:
type: object
properties:
procedure_code_id:
type: string
example: ab123456-11aa-99ff-a111-d1ee12345678
description: The uuid of the procedure code associated with the fee schedule
nullable: true
fee:
$ref: '#/components/schemas/API_V2_Entities_Price'
code:
type: string
example: D0120
description: The code of the procedure associated with the fee schedule
nullable: true
id:
type: integer
format: int64
example: 113
description: Fee Schedule Procedure Resource id
location_id:
type: integer
format: int32
example: 10
description: The location id of the fee schedule
nullable: true
fee_schedule_id:
type: integer
format: int64
example: 1234
description: The id of the fee schedule associated with the fee schedule procedure
nullable: true
updated_at:
type: string
format: date-time
example: '2020-06-05T20:16:57.007Z'
description: Fee Schedule Procedure update date in UTC
API_V20240412_Entities_FeeScheduleProcedureCode_Collection_Response_WithCursor:
type: object
properties:
code:
type: boolean
example: false
description: Indicates the success or failure of the request
description:
type: string
example: Description
description: Additional context on the request to help with debugging.
error:
type: array
items:
type: string
example:
- Error message
description: Any errors that occur during the execution of the request.
data:
type: array
items:
$ref: '#/components/schemas/API_V20240412_Entities_FeeScheduleProcedureCode'
page_info:
type: object
example:
has_previous_page: false
has_next_page: false
start_cursor: AAAAA
end_cursor: BBBBBB
description: Pagination information that can be used for fetching previous and next pages.
description: API_V20240412_Entities_FeeScheduleProcedureCode_Collection_Response_WithCursor model
API_Entities_FeeSchedule:
type: object
properties:
id:
type: integer
format: int64
example: 113
description: Fee schedule id
name:
type: string
example: Cash
description: The name of the fee schedule
active:
type: boolean
example: true
description: Indicates if the fee schedule is active
nullable: true
location_id:
type: integer
format: int32
example: 21
description: The id of the location this fee schedule belongs to
nullable: true
updated_at:
type: string
format: date-time
example: '2020-06-05T20:16:57.007Z'
description: Fee Schedule update date in UTC
API_Entities_FeeSchedule_Collection_Response_WithCursor:
type: object
properties:
code:
type: boolean
example: false
description: Indicates the success or failure of the request
description:
type: string
example: Description
description: Additional context on the request to help with debugging.
error:
type: array
items:
type: string
example:
- Error message
description: Any errors that occur during the execution of the request.
data:
type: array
items:
$ref: '#/components/schemas/API_Entities_FeeSchedule'
page_info:
type: object
example:
has_previous_page: false
has_next_page: false
start_cursor: AAAAA
end_cursor: BBBBBB
description: Pagination information that can be used for fetching previous and next pages.
description: API_Entities_FeeSchedule_Collection_Response_WithCursor model
API_V20240412_Entities_FeeScheduleProcedureCodeBasic:
type: object
properties:
procedure_code_id:
type: string
example: ab123456-11aa-99ff-a111-d1ee12345678
description: The uuid of the procedure code associated with the fee schedule
nullable: true
fee:
$ref: '#/components/schemas/API_V2_Entities_Price'
code:
type: string
example: D0120
description: The code of the procedure associated with the fee schedule
nullable: true
securitySchemes:
Authorization:
type: apiKey
name: Authorization
in: header