OpenAPI Specification
openapi: 3.0.0
info:
title: NexHealth Adjustment Types Payment Plans 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: Payment Plans
description: Payment plans resource
paths:
/payment_plans:
get:
summary: View payment plans
parameters:
- 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: sort
description: "Optional comma-separated string of fields to sort on.\nInclude a leading dash for descending order.\n\nAvailable fields:\n * updated_at\n * -updated_at\n"
required: false
schema:
type: string
- 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: patient_id
description: Filter by patient
required: false
schema:
type: integer
format: int32
- in: query
name: guarantor_id
description: Filter by guarantor
required: false
schema:
type: integer
format: int32
- in: query
name: updated_since
description: Filter for payment plans updated since a specific time
required: false
schema:
type: string
format: date-time
responses:
'200':
description: Successful
content:
application/vnd.Nexhealth+json;version=2:
schema:
$ref: '#/components/schemas/API_V2_Entities_PaymentPlan_Collection_Response_WithCursor'
'400':
description: Bad Request
content:
application/vnd.Nexhealth+json;version=2:
schema:
$ref: '#/components/schemas/API_Errors_BadRequest'
'401':
description: Unauthorized
content:
application/vnd.Nexhealth+json;version=2:
schema:
$ref: '#/components/schemas/API_Errors_Unauthorized'
'403':
description: Forbidden
content:
application/vnd.Nexhealth+json;version=2:
schema:
$ref: '#/components/schemas/API_Errors_Forbidden'
'500':
description: Internal Server Error
content:
application/vnd.Nexhealth+json;version=2:
schema:
$ref: '#/components/schemas/API_Errors_InternalServerError'
tags:
- Payment Plans
operationId: getPaymentPlans
/payment_plans/{id}:
get:
summary: View payment plan
parameters:
- in: path
name: id
required: true
schema:
type: integer
format: int64
- in: query
name: include[]
description: Resources to be included in the response
required: false
explode: true
schema:
type: array
items:
type: string
enum:
- patient
- guarantor
responses:
'200':
description: Successful
content:
application/vnd.Nexhealth+json;version=2:
schema:
$ref: '#/components/schemas/API_V2_Entities_PaymentPlanDetailed_Response'
'400':
description: Bad Request
content:
application/vnd.Nexhealth+json;version=2:
schema:
$ref: '#/components/schemas/API_Errors_BadRequest'
'401':
description: Unauthorized
content:
application/vnd.Nexhealth+json;version=2:
schema:
$ref: '#/components/schemas/API_Errors_Unauthorized'
'403':
description: Forbidden
content:
application/vnd.Nexhealth+json;version=2:
schema:
$ref: '#/components/schemas/API_Errors_Forbidden'
'500':
description: Internal Server Error
content:
application/vnd.Nexhealth+json;version=2:
schema:
$ref: '#/components/schemas/API_Errors_InternalServerError'
tags:
- Payment Plans
operationId: getPaymentPlansId
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_V2_Entities_PaymentPlanDetailed_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_V2_Entities_PaymentPlanDetailed'
count:
type: integer
format: int32
example: 2
description: Number of total objects, in case of collection.
description: API_V2_Entities_PaymentPlanDetailed_Response model
API_V2_Entities_PaymentPlan_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_V2_Entities_PaymentPlan'
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_V2_Entities_PaymentPlan_Collection_Response_WithCursor model
API_V2_Entities_PaymentPlan:
type: object
properties:
id:
type: integer
format: int64
example: 113
description: Resource id
patient_id:
type: integer
format: int32
example: 115
description: The ID of patient this plan is for
guarantor_id:
type: integer
format: int32
example: 115
description: The ID of the person paying for the plan
first_payment_due_date:
type: string
format: date
example: '2020-06-05'
description: The date the first payment is due (this doesn’t include down payments)
created_date:
type: string
format: date
example: '2020-06-05'
description: The date the payment plan was created
active:
type: boolean
description: Indicates whether the payment plan has been closed, cleared, or deleted from the system
API_V2_Entities_PaymentPlanDetailed:
type: object
properties:
id:
type: integer
format: int64
example: 113
description: Resource id
patient_id:
type: integer
format: int32
example: 115
description: The ID of patient this plan is for
guarantor_id:
type: integer
format: int32
example: 115
description: The ID of the person paying for the plan
first_payment_due_date:
type: string
format: date
example: '2020-06-05'
description: The date the first payment is due (this doesn’t include down payments)
created_date:
type: string
format: date
example: '2020-06-05'
description: The date the payment plan was created
active:
type: boolean
description: Indicates whether the payment plan has been closed, cleared, or deleted from the system
patient:
$ref: '#/components/schemas/API_V2_Entities_PatientBasic'
guarantor:
$ref: '#/components/schemas/API_V2_Entities_PatientBasic'
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_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_V2_Entities_PatientBasic:
type: object
properties:
id:
type: integer
format: int32
example: 415
description: User id
email:
type: string
example: Amy.Ramos@nexhealth.com
description: User email
nullable: true
first_name:
type: string
example: John
description: First name
middle_name:
type: string
example: Anthony
description: Middle name
nullable: true
last_name:
type: string
example: Smith
description: Last name
name:
type: string
example: John Smith
description: Full name
created_at:
type: string
format: date-time
example: '2020-06-05T20:16:57.007Z'
description: User creation date in UTC
updated_at:
type: string
format: date-time
example: '2020-06-05T20:16:57.007Z'
description: User last updation date in UTC
institution_id:
type: integer
format: int32
example: 105
description: The institution this user belongs to
foreign_id:
type: string
example: '100437'
description: Foreign Id is a unique identifier from the integrated system
nullable: true
foreign_id_type:
type: string
example: --DataSource-
description: Foreign Id type is a unique string identifier for the integrated system
bio:
type: object
example:
city: New York
state: NY
gender: Female
zip_code: '20814'
new_patient: false
non_patient: true
phone_number: '5163042196'
date_of_birth: '1964-05-03'
address_line_1: ''
address_line_2: ''
street_address: ''
cell_phone_number: ''
home_phone_number: ''
work_phone_number: ''
description: Patient biographical data, fields shown in our example response represent all possible data we retrieve but depending on system and what is actually saved in the health records system you cannot assume any field will consistently be returned
inactive:
type: boolean
example: false
description: Is the user inactivated?
last_sync_time:
type: string
format: date-time
example: '2024-04-12T10:30:00Z'
description: The most recent time the resource's data changed meaningfully at the source
nullable: true
guarantor_id:
type: integer
format: int32
example: 472
description: User id of this patient's responsible party
nullable: true
billing_type:
type: string
example: Standard Billing - finance charges
description: Used by practices in some integrated systems to categorize and filter patients when creating reports, requesting payments, and performing other related office tasks. Some integrated systems call this an account type rather than a billing type
nullable: true
chart_id:
type: string
example: '017407'
description: User-facing ID for referencing patient data, used in some integrated systems. Depending on the system, the chart ID supplements or replaces the foreign_id as the ID visible to EHR users
nullable: true
preferred_language:
type: string
example: es
description: Patient's preferred language as an ISO 639-1 code, if specified in the integrated system
nullable: true
preferred_locale:
type: string
example: es
description: The patient's preferred language setting used for displaying NexHealth forms and communications
nullable: true
location_ids:
type: array
items:
type: integer
format: int32
example:
- 101
- 102
- 103
description: Array of location ids associated with the user
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
securitySchemes:
Authorization:
type: apiKey
name: Authorization
in: header