NEnexhealth
Document Types

View document type (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 a single document type by its NexHealth ID for the specified location.

get/document_types/{id}

Request

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

Path parameters

idinteger required

The NexHealth ID of the document type

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

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.