Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

NexHealth Patient Alerts API

Short communication contents to Patients requiring a response

NexHealth Patient Alerts API is one of 33 APIs that NexHealth publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Patient Alerts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 4 operations across 2 paths, and defines 10 schemas. It is described by OpenAPI 3.0.0, at version v20240412.

Requests are made against a single base URL, https://nexhealth.info.

4 operations 2 paths 10 schemas 2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
v20240412
Base URL
https://nexhealth.info
Authentication
API Key
Contact
Terms of Service
Resource Areas
1

Authentication & Security 1

NexHealth Patient Alerts API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (Authorization). By default, every request must be authenticated.

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Patient Alerts 4

Short communication contents to Patients requiring a response

POST
/patients/{id}/alerts
Create patient alert
postPatientsIdAlerts 2 params body → 201400401403404500
GET
/patients/{id}/alerts
View patient alerts
getPatientsIdAlerts 3 params → 200400401403404500
GET
/patients/{id}/alerts/{alert_id}
View patient alert
getPatientsIdAlertsAlertId 3 params → 200400401403404500
PATCH
/patients/{id}/alerts/{alert_id}
Edit patient alert
patchPatientsIdAlertsAlertId 3 params body → 200400401403404500

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are API_V2_Entities_PatientAlert (6 properties), API_V2_Entities_PatientAlert_Collection_Response (5 properties), API_V2_Entities_PatientAlert_Response (5 properties), API_Errors_InternalServerError (4 properties). Each schema is shown below with its type and property counts.

patchPatientsIdAlertsAlertId
object
Edit patient alert
1 property 1 required
API_Errors_InternalServerError
object
APIErrorsInternalServerError model
4 properties
API_Errors_Forbidden
object
APIErrorsForbidden model
4 properties
API_Errors_Unauthorized
object
APIErrorsUnauthorized model
4 properties
API_Errors_BadRequest
object
APIErrorsBadRequest model
4 properties
API_V2_Entities_PatientAlert
object
6 properties
API_V2_Entities_PatientAlert_Collection_Response
object
APIV2EntitiesPatientAlertCollectionResponse model
5 properties
postPatientsIdAlerts
object
Create patient alert
1 property 1 required
API_Errors_NotFound
object
APIErrorsNotFound model
4 properties
API_V2_Entities_PatientAlert_Response
object
APIV2EntitiesPatientAlertResponse model
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nexhealth-patient-alerts-api-openapi.yml Raw ↑

Other APIs NexHealth publishes across the network.

NexHealth Adjustment Types API
NexHealth Adjustments API
NexHealth Appointment Types API
NexHealth Appointments API
NexHealth Authenticates API
NexHealth Available Slots API
NexHealth Balances API
NexHealth Charges API
NexHealth Claims API
NexHealth Clinical Notes API
NexHealth Document Types API
NexHealth Fee Schedules API