Patient Documents

View patient documents

Changed on

This endpoint returns all documents associated with the given patient, ordered by creation date.

get/patients/{id}/documents

Request

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

Path parameters

idinteger required

ID of the patient

Query parameters

subdomainstring required

Used to scope the request to the specified institution

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": 18,
      "filename": "patient_document.pdf",
      "type": "application/pdf",
      "url": "/documents/18/download",
      "created_at": "2020-06-05T20:16:57.007Z",
      "document_type_id": 1
    }
  ],
  "count": 2
}

Changes