Sign in

v1

latestOpenAPI 3.0.0NexHealth License 1.02026-07-2688180386.6 KB
Procedures

View 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.

get/procedures

Query parameters

subdomainstring required

Used to scope the request to the specified institution

sortstring

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

Available fields:

  • updated_at
  • -updated_at
location_idinteger

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

provider_idinteger

Filter for specific provider

patient_idinteger

Filter for specific patient

appointment_idinteger

Filter for specific appointment

updated_sincestring 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

started_afterstring date

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

started_beforestring date

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

ended_afterstring date

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

ended_beforestring date

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

start_cursorstring

First item of the current page. Starts empty

end_cursorstring

Last item of the current page. Starts empty

per_pageinteger

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

Headers

Nex-Api-Versionstring required

The NexHealth API version

Response

Successful

codeboolean

Indicates the success or failure of the request

descriptionstring

Additional context on the request to help with debugging.

errorstring[]

Any errors that occur during the execution of the request.

page_infoobject

Pagination information that can be used for fetching previous and next pages.

Example response

{
  "description": "Description",
  "error": [
    "Error message"
  ],
  "data": [
    {
      "id": 11,
      "location_id": 21,
      "patient_id": 162,
      "provider_id": 84,
      "appointment_id": 283,
      "code": "D6100",
      "name": "Implant Removal",
      "status": "referred",
      "updated_at": "2020-06-05T20:16:57.007Z",
      "body_site": {
        "tooth": [
          "3",
          "14"
        ],
        "surface": "MOD"
      },
      "fee": {
        "amount": "62.00",
        "currency": "USD"
      },
      "start_date": "2022-06-24",
      "end_date": "2022-06-24"
    }
  ],
  "page_info": {
    "has_previous_page": false,
    "has_next_page": false,
    "start_cursor": "AAAAA",
    "end_cursor": "BBBBBB"
  }
}