Patient documents

The patient documents endpoints let you write any PDF file to a health record system.

Before you start

• Every request needs a bearer token from POST /authenticates. See Authentication.
• Requests take the practice's subdomain and a location_id. See Institutions, syncs, and locations.

The document center

In many of the health record systems NexHealth integrates with, practices store patient files in a central place called the document center. It holds the files for one patient.

To add a file to a patient's document center:

1. Get the patient's id from GET /patients. To pick a folder, also get a document_type_id from GET /document_types.
2. Send a multipart/form-data POST request to /patients/{id}/documents with subdomain and location_id as query parameters. Put the PDF in the file field and the document_type_id in its own field. The file's name is the name the health record system shows.
3. Read the 201 response. Without a document_type_id, the file goes to the default folder for that health record system.

Each health record system has a default folder for patient documents:

• athenahealth: The "Clinical Documents" section of the patient file
• Cloud9: The "document center" section of a patient file.
• Curve: "Forms & Letters" directory of the patient file
• Denticon: No folders, uploaded as a document to the patient file
• Dentrix: "Miscellaneous" folder in the Document Center
• Dentrix Ascend: No folders, uploaded to Document Manager on the patient file
• Dentrix Enterprise: “Miscellaneous” folder in the Document Center
• Eaglesoft: "Patient Information" folder in Smart Docs
• eClinicalWorks: "Healow Chat Documents" folder in patient documents
• Open Dental: "Enlive User Forms" folder in Images
• ModMed: "Attachments" section of the patient profile

Patient documents response

{
  "code": true,
  "description": "Description",
  "error": [
    "Error"
  ],
  "data": [
    {
      "id": 18,
      "filename": "patient_document.pdf",
      "type": "application/pdf",
      "url": "/documents/18/download",
      "created_at": "2020-06-05T20:16:57.007Z"
    }
  ],
  "count": 1
}