Present Document
Use Present Document to add, update, or remove visit-related documents for an appointment.
Open this screen from Appointment Details or the Visit Took Place workflow.
This screen includes:
| # | Element | Description |
|---|---|---|
| 1 | Document type | Selects the document category |
| 2 | Document name | Specifies an optional document name |
| 3 | File upload | Adds PDF, JPG, or PNG files |
| 4 | Document actions | Add, update, or remove documents |
Workflow
Add Documents
- Open Appointment Details and select Documents, or open Visit Took Place and select Attach Documents.
- Select a document type.
- Enter a document name when required.
- Select one or more PDF, JPG, or PNG files.
- Select Add Documents.
- Apply the returned update set to the active screen.
Update a Document
- Select an existing document.
- Change the document type, name, or file.
- Select Update.
- Apply the returned update set.
Remove a Document
- Select an existing document.
- Select Remove.
- Apply the returned update set.
Validations
| Scenario | App behavior | SDK output |
|---|---|---|
| No file is selected | Block submission | Validation error |
| Unsupported file type is selected | Reject the file | Validation error |
| Required document value is missing | Block submission | Validation error |
| Upload request fails | Preserve the current document state | Error response |
| Add request succeeds | Add the document to the active screen | PATCH update set |
| Update request succeeds | Update the selected document | PATCH update set |
| Delete request succeeds | Remove the selected document | PATCH update set |
Actions
| Scenario | App behavior | SDK output |
|---|---|---|
| Add Documents selected | Add the document | PATCH update set |
| Document values change | Update the active document fields | PATCH update set |
| Update selected | Save document changes | PATCH update set |
| Remove selected | Remove the document | PATCH update set |
Supported File Types
| File type | Supported |
|---|---|
| Yes | |
| JPG | Yes |
| PNG | Yes |
Endpoint Resources
Present Document
PUT
v3/appointments/{appointment-id}/summary/documents
Displays the Manage Documents screen for the specified appointment.
The returned screen includes a document type selector, optional document name, and file upload control.
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
appointment-id | Integer | Yes | Identifies the appointment |
UI Element Types
| Level | Reference | Type | Value | Placement |
|---|---|---|---|---|
| 1 | discount-upload | Upload | File upload | — |
| 1 | discount-type | Combo | Document type | — |
| 1 | document-notes | Edit | Name | — |
| 1 | create | Button | Add Documents | — |
| 1 | update | Button | Update | — |
| 1 | remove | Ghost | Remove | — |
The API schema uses the references discount-upload and discount-type for document controls. Preserve these reference IDs in SDK integrations.
Add Document
PATCH
v3/appointments/{appointment-id}/summary/documents
Adds a medical document to the appointment record and returns an update set.
Update Document
PATCH
v3/appointments/{appointment-id}/summary/documents/{document-id}/update
Updates document metadata or file content for the specified document.
Delete Document
PATCH
v3/appointments/{appointment-id}/summary/documents/{document-id}/delete
Removes the specified medical document from the appointment record.