NEnexhealth
Document Types

View document types (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.

Changed from v3.0.0: Adds response field data[].foreign_id.

This endpoint returns document types for the specified location, optionally filtered by active status (defaults to active only).

get/document_types

Request

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

Query parameters

subdomainstring required

Used to scope the request to the specified institution

location_idinteger required

Used to scope the request to the specified location

activeboolean

true returns only active records, false only inactive. Defaults to true

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.

countinteger

Number of total objects, in case of collection.

Example response

{
  "description": "Description",
  "error": [
    "Error message"
  ],
  "data": [
    {
      "id": 1,
      "name": "Health History and Patient Forms",
      "active": true,
      "foreign_id": "1"
    }
  ],
  "count": 2
}

Changes

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