---
title: "Show a list of patientFormPdfFilledDocuments"
method: GET
path: "/patientFormPdfFilledDocuments"
tags: ["patientFormPdfFilledDocuments"]
---

# Show a list of patientFormPdfFilledDocuments

`GET /patientFormPdfFilledDocuments`

## Query parameters

- `patientFormPdfTemplate` string
- `user` string
- `deleted` 0 | 1
- `createdBy` string
- `updatedBy` string
- `createdAt` string, date-time
- `updatedAt` string, date-time
- `page` integer
- `limit` integer
- `_populate` string
- `_select` string

## Response `200`

Returns a list of patientFormPdfFilledDocuments

- object
  - `response` PatientFormPdfFilledDocumentResponse[], required
    - `_id` string — Luma's internal ID of an object.
    - `user` string — The ID of the root account user.
    - `deleted` 0 | 1 — Flag for logical deletion where 1 means deleted.
    - `createdBy` string — The ID of the user who created this object.
    - `updatedBy` string — The ID of the user who updated this object.
    - `createdAt` string, date-time — The date/time when this object was created.
    - `updatedAt` string, date-time — The date/time when this object was updated.
    - `patientFormPdfTemplate` string — ID of the PatientFormPdfTemplate this is a filled instance of
    - `fieldsSnapshot` object[] — snapshot of the source PatientFormPdfTemplate's fields at fill-time, so later edits to the live template never retroactively affect an already-filled document
      - `page` integer, required — 0-indexed page number within the source PDF this field is placed on
      - `type` 'text' | 'signature' | 'checkbox' | 'date' | 'number', required — type of the pdf form template field
      - `x` number, required — fraction (0-1) of the page width, measured from the left edge
      - `y` number, required — fraction (0-1) of the page height, measured from the top edge
      - `width` number, required — fraction (0-1) of the page width
      - `height` number, required — fraction (0-1) of the page height
      - `mappingField` string — when set, this field auto-fills from the matching PatientFormMappingFields concept instead of being filled in manually
      - `label` string — custom field label, used for manual fill when mappingField is not set
      - `placeholderText` string — patient-facing guidance text shown inside the field, distinct from the internal label
      - `defaultValue` string — default value pre-filled for this field, regardless of type
      - `minLength` integer — minimum number of characters accepted. Only meaningful when type is text
      - `maxLength` integer — maximum number of characters accepted. Only meaningful when type is text
      - `dateRange` 'any' | 'future' | 'past' — restricts which dates are accepted. Only meaningful when type is date
    - `values` object[] — values submitted for each field in fieldsSnapshot
      - `fieldId` string, required — index (as a string) into this document's fieldsSnapshot array identifying which field this value was submitted for
      - `value` string, required — value submitted for this field. Checkbox fields submit the string 'true'/'false'
    - `renderedFileUpload` string — ID of the generated, filled PDF produced client-side and uploaded via the existing FileUpload flow
  - `page` integer, required
  - `size` integer, required

## Other responses

- `401` — Not authenticated
- `403` — Access token does not have the required scope
- `default` — unexpected error

---

[API](https://skmtc.net/lumahealth/apis/rest-service.md) · [All operations](https://skmtc.net/lumahealth/apis/rest-service/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lumahealth/rest-service/revisions/d3c75c2a2f1d/schema)