OpenAPI Specification
openapi: 3.0.0
info:
title: NexHealth Adjustment Types Patient Documents 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: Patient Documents
description: A patient documents resource
paths:
/patients/{id}/documents:
get:
summary: View patient documents
parameters:
- in: path
name: id
description: Id of the patient
required: true
schema:
type: integer
format: int32
- in: query
name: subdomain
description: Used to scope the request to the specified institution
required: true
schema:
type: string
responses:
'200':
description: Successful
content:
application/vnd.Nexhealth+json;version=2:
schema:
$ref: '#/components/schemas/API_V2_Entities_PatientDocument_Collection_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'
'404':
description: Not Found
content:
application/vnd.Nexhealth+json;version=2:
schema:
$ref: '#/components/schemas/API_Errors_NotFound'
'500':
description: Internal Server Error
content:
application/vnd.Nexhealth+json;version=2:
schema:
$ref: '#/components/schemas/API_Errors_InternalServerError'
tags:
- Patient Documents
operationId: getPatientsIdDocuments
post:
summary: Create patient document
parameters:
- in: path
name: id
description: Id of the patient
required: true
schema:
type: integer
format: int32
- 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
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
file:
description: The file being uploaded. The name of this file will be used when inserting the file into the EHRs filesystem
type: string
format: binary
document_type_id:
description: The id of the document type to assign to the uploaded document
type: integer
format: int32
required:
- file
required: true
responses:
'201':
description: Successful
content:
application/vnd.Nexhealth+json;version=2:
schema:
$ref: '#/components/schemas/API_V2_Entities_PatientDocument_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'
'404':
description: Not Found
content:
application/vnd.Nexhealth+json;version=2:
schema:
$ref: '#/components/schemas/API_Errors_NotFound'
'500':
description: Internal Server Error
content:
application/vnd.Nexhealth+json;version=2:
schema:
$ref: '#/components/schemas/API_Errors_InternalServerError'
tags:
- Patient Documents
operationId: postPatientsIdDocuments
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_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_V2_Entities_PatientDocument:
type: object
properties:
id:
type: integer
format: int32
example: 18
description: Document id
filename:
type: string
example: patient_document.pdf
description: The filename of the uploaded document
type:
type: string
example: application/pdf
description: The type of the uploaded document
url:
type: string
example: /documents/18/download
description: A download URL for the document
created_at:
type: string
format: date-time
example: '2020-06-05T20:16:57.007Z'
description: The time that the document was first uploaded in UTC
document_type_id:
type: integer
format: int32
example: 1
description: The NexHealth ID of the document type
API_V2_Entities_PatientDocument_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_PatientDocument'
count:
type: integer
format: int32
example: 2
description: Number of total objects, in case of collection.
description: API_V2_Entities_PatientDocument_Response model
API_V2_Entities_PatientDocument_Collection_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:
type: array
items:
$ref: '#/components/schemas/API_V2_Entities_PatientDocument'
count:
type: integer
format: int32
example: 2
description: Number of total objects, in case of collection.
description: API_V2_Entities_PatientDocument_Collection_Response model
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
securitySchemes:
Authorization:
type: apiKey
name: Authorization
in: header