Skip to main content

Medical Documents

Use the Add Medical Documents screen to upload and manage visit-related documentation after a session ends. The screen opens from the Appointment Details page and enforces file and field requirements. After submission, the app returns to the appointment view automatically.


This screen includes:

  • Upload support for PDF, JPG, and PNG file formats.
  • A dropdown to select the document type, such as prescription, report, or referral.
  • An optional field to enter a document name.
  • Options to update or remove uploaded files.
  • Submission rules that prevent incomplete uploads.
  • Visibility logic based on user role and document type.
  • Inline validation for file format, size, and required fields.
  • Automatic return to the appointment view upon submission.

Workflow​

Upload a Document​

  1. From the Appointment Details screen, select Documents.
  2. Select Attach Medical Document.
  3. Upload a file in PDF, JPG, or PNG format.
  4. Select the appropriate Document Type.
  5. (Optional) Enter a name for the document.
  6. Select Add Documents to submit.
  7. If validation fails, the app highlights required fields in red.

Edit or Remove a Medical Document​

  1. Select Edit next to a previously uploaded document.
  2. Modify the document type or name.
  3. Select Update to save changes.
  4. Select Remove to delete the document.

Finalize Submission​

  1. Confirm that all required documents are uploaded.
  2. Select Save & Report Visit Took Place.
  3. The app validates all fields and redirects to the Appointment Details screen.

Validations​

  • All required document types must be present.
  • File uploads must meet format and size requirements.
  • The app blocks submission if validation fails.

Actions​

  • Submits uploaded documents to the appointment record.
  • Locks edits for the session once submitted.
  • Triggers the Visit Took Place event and updates appointment status.
  • Returns the user to the Appointment Details screen.

SDK and API References​

GET 

/profile/appointments/{id}/summary/documents

Use this endpoint to upload or update medical documents after a session. The screen supports typed file uploads with optional names. It is part of the Visit Took Place workflow.

UI Element Types​

LevelReferenceTypeValuePlacement
1—EditThe header text and close button is the parts of Cover
1discount-uploadUploadThe header text and close button is the parts of Cover
1discount-typeComboDocument type
1document-notesEditName
1createButtonAdd Documents
1updateButtonUpdate
1removeGhostRemove