Skip to main content

Manage Documents

se the Manage Documents screen to add or edit visit-related documents for a completed appointment.
The Doctor App opens this screen from the Appointment Details page or from the Visit Took Place workflow.
The screen enforces document rules and returns control to the appointment workspace after confirmation.


This screen includes:

  • Support for PDF, JPG, and PNG files.
  • A document type selector with values such as prescriptions, medical reports, and referrals.
  • A text field for the document name.
  • Controls to Add Documents, Update, and Remove.
  • Validation rules that prevent confirmation when required files or fields are missing.
  • Visibility rules based on user role and document type.
  • Inline feedback for upload failures or missing values.
  • Integration with the Visit Took Place workflow and the Documents tab in Appointment Details.

Workflows​

Add Documents​

  1. On the Appointment Details screen, select the Documents tab.
    Or, on the Visit Took Place screen, select Attach Documents.
  2. In the Manage Documents popup, choose a value in Document type.
  3. (Optional) Enter a document name.
  4. Select one or more files in PDF, JPG, or PNG format.
  5. Select Add Documents.
  6. If a required value is missing, the app highlights the field and blocks submission.

Edit or Remove a Document​

  1. In the Documents list, select Edit next to a document entry.
  2. Update the document type or document name.
  3. Select Update to apply the change.
  4. To remove a document, select Remove.

Finalize Visit Took Place​

  1. Confirm that all required medical documents exist in the visit summary.
  2. In the Visit Took Place workflow, select Save & Report Visit Took Place.
  3. The app validates document rules and returns to the Appointment Details screen with updated records.

Validations​

These scenarios describe how the app validates the Manage Documents screen and what the integrator can expect.

ScenarioApp BehaviorSDK OutputExample
The doctor selects Add Documents with no file attached.The app blocks submission, highlights the file control, and displays an error message.Validation error in the update set; no change to the document list.—
The doctor selects a document type that requires at least one file (for example, medical-report) and no file exists.The app prevents exit from the popup until the requirement is met.Validation error that targets the document group.—
The file format is not PDF, JPG, or PNG.The app rejects the file and displays inline feedback.Validation error for unsupported file type.—
Network or storage error occurs during upload.The app displays an error and keeps the popup open with existing values.Error in the update set; last valid document list remains.—

Actions​

These scenarios describe how the app responds to actions on the Manage Documents screen and what the SDK returns.

ScenarioApp BehaviorSDK OutputExample
The doctor adds a valid document and selects Add Documents.The app appends the document to the visit summary and updates the Documents list.Update set that adds a new document entry to the page object.
The doctor selects Update for a document and provides valid changes.The app updates the document metadata while preserving or replacing the file as specified.Update set that modifies the selected document group.
The doctor selects Remove for a document.The app removes the document from the visit summary list.Update set that deletes the document group from the page object.
The doctor returns to Visit Took Place and selects Save & Report Visit Took Place.The app sends the summary, charges, discounts, and document metadata to the backend and updates appointment status.Server-side confirmation; subsequent page responses reflect the completed visit.—

Endpoint Resources​

Present Document​

PUT 

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

Produces the Manage Documents popup for the specified appointment.
The response body includes:

  • Document type selector.
  • Optional document name input.
  • File upload control for medical documents.

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

Add Document​

PATCH 

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

Returns an update set that adds a medical document to the appointment record.

Update Document​

PATCH 

/profile/appointments/{appointment-id}/summary/documents/{document-id}/update

Returns an update set that changes document metadata or file content for the specified document.

Delete Document​

PATCH 

/profile/appointments/{appointment-id}/summary/documents/{document-id}/delete

Returns an update set that removes the specified medical document from the appointment record.