Sheets GET

GET /sheets?PatNum=123 or GET /sheets?PatNum=123&Offset=400. PatNum is required. Offset is optional for pagination. Version 21.4+.

Example Response (200 OK):

[
  {
    "SheetNum": 45,
    "SheetType": "PatientLetter",
    "PatNum": 123,
    "DateTimeSheet": "2021-11-16 02:45:38",
    "InternalNote": "",
    "Description": "Custom Patient Letter",
    "IsWebForm": "false",
    "SheetDefNum": 25,
    "DocNum": 0,
    "ClinicNum": 0,
    "DateTSheetEdited": "2022-01-23 08:33:02"
  }
]

Response fields (description):

• SheetNum — Primary key of the sheet.
• SheetType — Type of sheet (e.g. PatientLetter, MedicalHistory, ExamSheet, Consent, PatientForm).
• PatNum — Patient number.
• DateTimeSheet — When the sheet was created.
• InternalNote — Internal note (optional, may be empty).
• Description — Human-readable description from the SheetDef.
• IsWebForm — "true" or "false"; whether the sheet is a web form.
• SheetDefNum — FK to sheetdef.SheetDefNum (definition used for this sheet).
• DocNum — FK to document; 0 if not attached to a document.
• ClinicNum — FK to clinic; 0 if not clinic-specific.
• DateTSheetEdited — When the sheet was last edited.

Responses: 200 OK; 400 BadRequest (with explanation); 404 NotFound (with explanation).

Sheets POST (create)

POST /sheets. Creates a sheet with SheetFields using an existing SheetDef. Required: SheetDefNum, PatNum. Optional: InternalNote. Only SheetDefs of type Consent, PatientLetter, PatientForm, MedicalHistory, and ExamSheet are supported. Version 23.1.32+.

Example Request:

{
  "SheetDefNum": 25,
  "PatNum": 465,
  "InternalNote": ""
}

Request fields (description):

• SheetDefNum — Required. FK to sheetdef.SheetDefNum (must be Consent, PatientLetter, PatientForm, MedicalHistory, or ExamSheet).
• PatNum — Required. Patient number.
• InternalNote — Optional. Internal note for the sheet.

Example Response (200 OK):

{
  "SheetNum": 70,
  "SheetType": "PatientLetter",
  "PatNum": 465,
  "DateTimeSheet": "2023-06-21 15:24:52",
  "InternalNote": "",
  "Description": "Patient Letter",
  "IsWebForm": "false",
  "SheetDefNum": 25,
  "DocNum": 0,
  "ClinicNum": 0,
  "DateTSheetEdited": "2023-06-21 15:24:52"
}

Response fields (description):

• SheetNum — Primary key of the created sheet.
• SheetType — Type from the SheetDef.
• PatNum — Patient number.
• DateTimeSheet — Creation timestamp.
• InternalNote — Internal note (if provided).
• Description — Description from SheetDef.
• IsWebForm — "true" or "false".
• SheetDefNum — SheetDef used.
• DocNum — 0 for new sheet.
• ClinicNum — 0 if not clinic-specific.
• DateTSheetEdited — Same as DateTimeSheet on create.

Responses: 200 OK; 400 BadRequest (with explanation); 404 NotFound (with explanation).

Sheets POST DownloadSftp

POST /sheets/DownloadSftp. Converts a sheet to PDF and downloads it to an SFTP site you specify. Directory will be created if it does not exist; existing files with the specified name will be overwritten. If no file name is specified in SftpAddress, the file will be titled "sheet.pdf". Version 22.1+.

Example Request:

{
  "SheetNum": 50,
  "SftpAddress": "MySftpSite/myUsername/Sheets/ExamSheetJones.pdf",
  "SftpUsername": "myUsername",
  "SftpPassword": "myPassword"
}

Request fields (description):

• SheetNum — Required. The sheet to convert to PDF.
• SftpAddress — Required. Full path on the SFTP site (e.g. host/path/filename.pdf). Directory created if missing; default filename "sheet.pdf" if omitted.
• SftpUsername — Required. SFTP username.
• SftpPassword — Required. SFTP password. User must have write permission in the directory.

Example Response (201 Created):

"location": "The full filepath of the saved file."

Responses: 201 Created (location header = full filepath); 400 BadRequest (invalid fields, invalid file extension, SFTP connection errors); 404 NotFound (with explanation).