API Reference

View procedures

get
https://nexhealth.info/procedures

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. You may additionally narrow any of these filters by location_id,
but location_id alone does not satisfy the at-least-one-filter requirement.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

For required parameters, we require at least one of the filters with subdomain and location_id

You must provide at least one filter provider_id, patient_id, appointment_id, updated_since

Query Params
string
required

Used to scope the request to the specified institution

string

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

Available fields:

  • updated_at
  • -updated_at
int32

Filter for specific location. Cannot be used as the only filter — combine it with at least one other filter

int32

Filter for specific provider

int32

Filter for specific patient

int32

Filter for specific appointment

date-time

Procedures updated at or after the specified time (UTC). The comparison is inclusive, so a record whose updated_at exactly equals the given value is returned

date

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

date

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

date

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

date

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

string

First item of the current page. Starts empty

string

Last item of the current page. Starts empty

int32
Defaults to 5

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

Headers
string
required
Defaults to v3.0.0

The NexHealth API version

Responses

Updated about 2 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago

Did this page help you?