Skip to main content

Upload


The Upload element allows users to add one or more files. This component includes file validation, icon labels, and a document list preview. Use this element to collect medical summaries, reports, or attachments.

Properties

PropertyValueDescription
TypeUploadUI component type
GroupFieldBelongs to the "Field" group in UI catalog
Identifier53Unique element ID
PreviewSee image preview above
ValueYAccepts one or more uploaded files
MandatoryYRequired to proceed in specific workflows
ErrorYDisplays validation error for unsupported files
MinNo minimum file constraint
MaxFilesAccepts multiple files; capped by internal limits
Read-onlyYCan display uploaded files in read-only state
Text, IconYDisplays file icon and optional label
ChildrenNo nested children
ListNot a container for repeatable entries
EventYTriggers on file select, delete, or update
ShadeYUses shaded background to separate upload area

Usage Example

<UploadField
label="Upload summary document"
acceptedFileTypes={[".pdf", ".docx"]}
required
onChange={handleFileUpload}
/>

SDK Integration

The Visit Took Place (VTP) summary popup uses this element. It connects to the SDK method:

Method: /profile/appointments/{id}/summary/summaries

Use this method to upload, update, or remove post-visit medical documents.


Example UI Placement

LevelIDTypeValueDescription
1discount-uploadUploadDocument uploadUploads medical documents

Notes

  • Displays all uploaded files in a vertical list with name and timestamp.
  • Accepts multiple formats: PDF, DOCX, JPG, PNG.
  • Triggers file select dialog and handles upload events.
  • Commonly used in visit documentation flows.