NEnexhealth
Schedule Templates

View schedule templates (beta)

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

This endpoint returns the EHR schedule templates available to a location, which are the ones belonging to the location and the ones that apply to every location of its data source. Results can be narrowed down with the optional filters.

get/schedule_templates

Request

  • Base URL
    https://nexhealth.info
  • URL
    https://nexhealth.info/schedule_templates
  • Auth
    API key in header Authorization

Query parameters

subdomainstring required

Used to scope the request to the specified institution

location_idinteger required

The NexHealth ID of the location

namestring

Filter schedule templates by a part of their name

activeboolean

Filter by active status

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": 7,
      "name": "Hygiene week",
      "color_hex": "#4caf50",
      "active": true,
      "location_id": 115,
      "foreign_id": "42"
    }
  ],
  "page_info": {
    "has_previous_page": false,
    "has_next_page": false,
    "start_cursor": "AAAAA",
    "end_cursor": "BBBBBB"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.