Documents GET (by patient)

GET /documents?PatNum=101. PatNum is required. Returns all documents and mounts for the patient (metadata only; no file content). Per OpenDental API Documents.

Example Response:

[
  {
    "DocNum": 34,
    "MountNum": 0,
    "filePath": "\\\\server\\OpenDentImages\\S\\SmithJohn15\\exampleimage.jpg",
    "Description": "Scanned image",
    "PatNum": "101",
    "Note": "",
    "DateCreated": "2021-04-08 08:12:21",
    "docCategory": "Lab Cases",
    "DocCategory": 14,
    "ToothNumbers": "1,2,3,4,5",
    "ProvNum": "0",
    "PrintHeading": "false",
    "DateTStamp": "2021-04-18 11:45:01",
    "serverDateTime": "2021-05-20 13:30:54",
    "FileName": "exampleimage.jpg",
    "ImgType": "Photo"
  },
  {
    "DocNum": 0,
    "MountNum": 15,
    "filePath": "",
    "Description": " 5/11/2021: 4BW",
    "PatNum": "101",
    "Note": "Bitewings",
    "DateCreated": "2021-05-11 13:26:39",
    "docCategory": "Lab Cases",
    "DocCategory": 14,
    "ToothNumbers": "",
    "ProvNum": "0",
    "PrintHeading": "",
    "DateTStamp": "",
    "serverDateTime": ""
  }
]

All response fields (with descriptions):

• DocNum — Unique document ID. 0 for mount-only items.
• MountNum — Mount ID when this is a mount (image group). 0 for standalone documents.
• filePath — Full path to file (AtoZ/cloud). Blank for InDatabase storage or mounts.
• Description — Label shown in the image category tree.
• PatNum — Patient number (FK to patient).
• Note — Optional note; may contain internal markers (e.g. _rawBase64_, _download_).
• DateCreated — When the document was created ("yyyy-MM-dd HH:mm:ss").
• docCategory — Category name (e.g. "Lab Cases", "Patient Pictures").
• DocCategory — DefNum of the category (definition.Category=18).
• ToothNumbers — Comma-separated tooth numbers or ranges (e.g. "1-5,8").
• ProvNum — Provider number; 0 if none.
• PrintHeading — "true" or "false"; if true, extra info shown when printing.
• DateTStamp — Last modified timestamp. Empty for mounts.
• serverDateTime — Server time at response.
• FileName — Stored filename (single-doc GET; may appear in list).
• ImgType — One of: Document, Radiograph, Photo, File, Attachment.

Documents POST SetByUrl / Upload

Per OpenDental API Documents.

POST /documents/SetByUrl — Add document by URL

Open Dental downloads the file from the URL and stores it.

{
  "PatNum": 101,
  "url": "https://www.somesite.com/myimage.jpg",
  "Description": "Extraoral",
  "DateCreated": "2024-09-24 11:45:52",
  "DocCategory": 47,
  "ImgType": "Photo",
  "ToothNumbers": "1,2",
  "ProvNum": 0,
  "PrintHeading": "false"
}

• PatNum — Required. Patient number.
• url — Required. Public URL of the file to download.
• Description — Optional. Label in the image tree.
• DateCreated — Optional. "yyyy-MM-dd HH:mm:ss"; defaults to now.
• DocCategory — Optional. DefNum where definition.Category=18; defaults to first in category.
• ImgType — Optional. Document | Radiograph | Photo | File | Attachment; default Document.
• ToothNumbers — Optional. Comma and/or hyphen ranges (e.g. "1-5,8").
• ProvNum — Optional. Provider number; default 0.
• PrintHeading — Optional. "true" or "false"; default "false".

POST /documents/Upload — Upload file as base64

Send file content as rawBase64. Extension required.

{
  "PatNum": 101,
  "rawBase64": "errGEreRi3fWWtB+gWWEgg...",
  "extension": ".jpg",
  "Description": "Extraoral",
  "DateCreated": "2022-03-15 14:30:00",
  "DocCategory": 47,
  "ImgType": "Photo",
  "ToothNumbers": "1-32",
  "ProvNum": 0,
  "PrintHeading": "false"
}

• PatNum — Required. Patient number.
• rawBase64 — Required. File content encoded as base64 (no data URL prefix).
• extension — Required. File extension including dot (e.g. ".jpg", ".pdf", ".dcm").
• Description — Optional. Label in the image tree.
• DateCreated — Optional. "yyyy-MM-dd HH:mm:ss"; default today.
• DocCategory — Optional. DefNum (Category=18); default first in category.
• ImgType — Optional. Document | Radiograph | Photo | File | Attachment; default Document.
• ToothNumbers — Optional. Comma and/or hyphen ranges.
• ProvNum — Optional. Default 0.
• PrintHeading — Optional. "true" or "false"; default "false".

Documents PUT & DELETE

Per OpenDental API Documents.

PUT /documents/{DocNum} — Update document metadata (Image Info)

All fields in the body are optional. Only sent fields are updated.

{
  "Description": "Pano",
  "DateCreated": "2024-01-25 07:45:35",
  "DocCategory": 190,
  "ImgType": "Radiograph",
  "ToothNumbers": "12-15,20,21",
  "ProvNum": 2,
  "PrintHeading": "true"
}

• Description — Label shown on the image category tree.
• DateCreated — "yyyy-MM-dd HH:mm:ss" format.
• DocCategory — DefNum where definition.Category=18 (image categories).
• ImgType — One of: "Document", "Radiograph", "Photo", "File", "Attachment".
• ToothNumbers — Comma-separated and/or hyphen ranges (e.g. "12-15,20,21").
• ProvNum — ProvNum of a non-hidden provider; 0 for none.
• PrintHeading — "true" or "false"; if true, extra info shown when document is printed.

DELETE /documents/{DocNum}

Deletes the document: removes the database row and any associated file from the A-to-Z folder. No request body. Returns 200 OK, or 400/404 with explanation.