> ## Documentation Index
> Fetch the complete documentation index at: https://docs.encoreos.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Custom Fields

> Define and manage custom field definitions for entities across the organization; edit individual field label, key, and type configuration.

The Custom Fields screen manages custom field definitions at the route `/settings/custom-fields`.

## Overview

The screen lists all custom field definitions for the organization in `CustomFieldDefinitionsTable`. A "New Custom Field" button (accent variant) opens `CustomFieldDefinitionForm` in a creation dialog. On successful creation, the dialog closes. Clicking a field in the table navigates to the detail edit page at `/settings/custom-fields/:id`. An informational alert at the top of the page provides context about custom field usage.

## Who it's for

Access follows your organization's role and module configuration.

## Before you start

* Navigate to Settings → Custom Fields.

## Steps

<Steps>
  <Step title="Open Custom Fields">Navigate to Settings → Custom Fields.</Step>
  <Step title="Review existing fields">Browse the definitions table showing all custom field definitions.</Step>
  <Step title="Create a new field">Click "New Custom Field", complete the form, and save.</Step>
  <Step title="Edit a field">Click any existing field in the table to open its detail edit page.</Step>
</Steps>

## Key concepts

* Custom field definitions — reusable field schema applied to entity records
* `CustomFieldDefinitionForm` — shared form for create and edit operations
* `CustomFieldDefinitionsTable` — browsable table of all org field definitions

## Editing a custom field

The Custom Field Details screen edits a single custom field definition at the route `/settings/custom-fields/:id`.

The screen loads a custom field definition by `id` from `useCustomFieldDefinition` and renders `CustomFieldDefinitionForm` pre-populated with the existing values. The breadcrumb label is set to the `field_label` or `field_key`. On save, `updateDefinition` is called and the user is navigated back to `/settings/custom-fields`. A not-found state is shown if no definition matches the ID.

1. Navigate from Custom Fields list or directly to `/settings/custom-fields/:id`.
2. Update the field label, key, type, or other configuration in the form.
3. Submit the form to save the updated definition and return to the Custom Fields list.

* `field_label` — human-readable display name
* `field_key` — programmatic identifier used in data references

## Related

<Columns cols={2}>
  <Card title="Platform Foundation" icon="layer-group" href="/pf/overview">
    Platform Foundation overview.
  </Card>

  <Card title="Governance & parity" icon="scale-balanced" href="/governance/index">
    Documentation coverage and governance.
  </Card>
</Columns>

<Note>
  This page documents shipped product behavior. It is not medical, legal, or
  billing advice. Verify against your organization's policies and applicable
  regulations before using it for clinical, compliance, or billing decisions.
  Protected health information (PHI) shown in the product is governed by your
  tenant's access controls and is never exposed in this documentation.
</Note>

<Accordion title="Documentation sources">
  * src/routes/platform.tsx
  * src/platform/custom-fields/pages/CustomFieldsPage.tsx
  * src/platform/custom-fields/pages/CustomFieldDetailPage.tsx
</Accordion>