View procedures (beta)

get

https://nexhealth.info/procedures

🚧
Beta
Send Nex-Api-Version: v3.1.0 to use this endpoint. It is still changing, and access is limited to approved partner institutions. Contact NexHealth before you build on it.

Changed from v3.0.0: Adds response fields data[].foreign_id, data[].treatment_plan_ids.

This endpoint returns a list of procedures.
You can filter by provider_id, patient_id, appointment_id, started_after, started_before, ended_after, ended_before or
updated_since. You must provide at least one filter.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

subdomain

string

required

Used to scope the request to the specified institution

sort

string

Optional comma-separated string of fields to sort on.
Include a leading dash for descending order.

Available fields:

updated_at
-updated_at

location_id

int32

Filter for specific location

provider_id

int32

Filter for specific provider

patient_id

int32

Filter for specific patient

appointment_id

int32

Filter for specific appointment

updated_since

date-time

Procedures updated after the specified time (UTC)

started_after

date

Filter for procedures with start_date after a specific date (including the date)

started_before

date

Filter for procedures with start_date before a specific date (including the date)

ended_after

date

Filter for procedures with end_date after a specific date (including the date)

ended_before

date

Filter for procedures with end_date before a specific date (including the date)

start_cursor

string

First item of the current page. Starts empty

end_cursor

string

Last item of the current page. Starts empty

per_page

int32

Defaults to 5

Number of results to return per page. Maximum allowed amount is 1000.

Headers

Nex-Api-Version

string

required

Defaults to v3.1.0

The NexHealth API version

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful

400Bad Request

401Unauthorized

403Forbidden

404Not Found

500Internal Server Error