Version: 1.2.0Documentation Index
Fetch the complete documentation index at: https://docs.encoreos.io/llms.txt
Use this file to discover all available pages before exploring further.
Last Updated: 2026-02-05
Status: Active Purpose: Unified glossary of data-related terms to eliminate confusion between similar concepts.
See Also: PF/FW Documentation Review for detailed analysis of terminology overlap.
Wizard-Related Terms
Form Wizard (FW-31)
Also called: Multi-step form, guided form, wizard mode formNOT the same as: Module Wizard (PF-41) Purpose: Multi-step data capture interface built on FW-01 forms with step validation, progress tracking, and draft persistence. Storage:
- Config:
fw_forms.wizard_configJSONB - Steps:
fw_form_pages.step_configJSONB - Progress:
fw_form_submissions.wizard_progressJSONB
- Resident intake wizard (5 steps of questions)
- Employee satisfaction survey with conditional sections
- Multi-part compliance assessment
- You have a complex form that benefits from step-by-step guidance
- Data goes to
fw_form_submissions(form submissions table) - Users need to save/resume progress on data capture
Module Wizard (PF-41)
Also called: Business wizard, configurable wizard, onboarding wizardNOT the same as: Form Wizard (FW-31) Purpose: Configurable business process wizard for module-specific workflows like onboarding, payroll, and admissions. Storage:
- Templates:
pf_wizard_templatestable - Executions: Module-specific tables (e.g.,
hr_onboarding_instances)
- Employee onboarding wizard (HR module)
- Resident admission wizard (RH module)
- Payroll run wizard (HR module)
- Building a business process (not just data capture)
- Data goes to module-specific tables (not form submissions)
- Steps require custom React components (not just form fields)
- Organizations need to customize the wizard flow
Wizard vs Form Quick Reference
| Aspect | Form Wizard (FW-31) | Module Wizard (PF-41) |
|---|---|---|
| Purpose | Data capture | Business process |
| Data Storage | fw_form_submissions | Module-specific tables |
| Step Types | Form fields only | Form, Custom, Review |
| Customization | Field configuration | Full step customization |
| Use Case | Surveys, intake forms | Onboarding, payroll |
Template-Related Terms
Workflow Template (FW-28)
Also called: Automation template, workflow pattern, reusable workflowNOT the same as: Document Template (PF-64), Form Template, Spec Template Purpose: Pre-built workflow automation pattern that can be cloned and customized. Storage:
fw_workflow_templates table
Scope: Organization-wide, can be shared via marketplace.
Example:
- “Employee Onboarding Workflow” template
- “Invoice Approval” workflow template
- “Incident Response” automation template
- Creating reusable automation patterns
- Sharing workflow best practices across organizations
- Quickly starting new automations from proven patterns
Document Template (PF-64)
Also called: Letterhead template, policy template, letter template, PDF templateNOT the same as: Workflow Template (FW-28), Form Template, Spec Template Purpose: Structure template for printable documents (policies, letters, reports) with letterhead and sections. Storage:
- Templates:
pf_document_templatestable - Letterheads:
pf_letterheadstable - Approval Chains:
pf_approval_chain_templatestable
- Healthcare Policy Template (CARF-aligned sections)
- Standard Business Letter template
- Compliance Report Cover template
- Employee Offer Letter template
- Generating printable PDF documents
- Needing consistent branding (letterhead, footer)
- Documents require approval workflows
- Exporting policies, procedures, or formal letters
Form Template (FW-01)
Also called: Reusable form, form pattern, clonable formNOT the same as: Document Template (PF-64), Workflow Template (FW-28) Purpose: Form definition marked as a template that can be cloned to create new forms. Storage:
fw_forms table with settings.is_template = true
Scope: Organization-wide for cloning.
Example:
- “Standard Incident Report” form template
- “Monthly Assessment” form template
- “Satisfaction Survey” form template
- Creating reusable form structures
- Quickly creating new forms from proven patterns
- Sharing form designs within an organization
Spec Template (Developer)
Also called: Documentation template, spec boilerplate, markdown templateNOT the same as: Document Template (PF-64), Workflow Template (FW-28), Form Template Purpose: Markdown template files for writing specifications and documentation. Storage:
specs/_templates/ directory
Scope: Developer tools, not stored in database.
Example:
SPEC_TEMPLATE.md- Feature specification templateWIZARD_SPEC_TEMPLATE.md- Wizard specification templateTASKS_TEMPLATE.md- Task breakdown template
- Writing a new feature specification
- Documenting a wizard UX design
- Creating implementation plans
Wizard Template (PF-41)
Also called: Module wizard template, business wizard templateNOT the same as: Workflow Template (FW-28), Document Template (PF-64) Purpose: Reusable wizard configuration that defines steps, validation, and flow for module wizards. Storage:
pf_wizard_templates table
Scope: Organization-wide (custom) or system-wide (starter templates).
Example:
- “Standard Employee Onboarding” wizard template
- “Resident Admission” wizard template
- “Payroll Run” wizard template
- Organizations need to customize wizard flows
- Creating standardized business processes
- Sharing wizard patterns across sites
Template Quick Reference
| Template Type | Purpose | Storage | Use Case |
|---|---|---|---|
| Workflow Template | Automation patterns | fw_workflow_templates | Reusable automations |
| Document Template | Printable PDFs | pf_document_templates | Policies, letters, reports |
| Form Template | Clonable forms | fw_forms (is_template) | Reusable form structures |
| Wizard Template | Business wizards | pf_wizard_templates | Onboarding, payroll |
| Spec Template | Documentation | specs/_templates/ | Writing specifications |
Document & PDF-Related Terms
Form Submission PDF Export
Also called: Submission PDF, form-to-PDF, submission exportNOT the same as: Document Template (PF-64), Signed PDF (FW-33) Purpose: Convert a form submission’s field data into a downloadable PDF document, optionally using organization letterhead and document template formatting. Implementation:
- Hook:
useFormSubmissionPdffrom@/platform/forms - Template hook:
useGenerateTemplatedPdffrom@/platform/templates - Signed hook:
useSignedPdfGenerationfrom@/cores/fw/hooks(FW-33, for forms with signature fields)
- Export an incident report submission as a branded PDF with letterhead
- Download a completed intake form as a PDF for filing
- Generate a signed consent form PDF with captured signatures
- Users need a printable version of a form submission
- Submissions need to be shared as PDFs externally
- Compliance requires PDF records of form data
Document Template (PF-64) — see Template-Related Terms above
Letterhead (PF-64)
Also called: Organization letterhead, branding templateNOT the same as: Document Template (defines document structure) Purpose: Organization-specific header and footer configuration (logo, name, address, confidentiality notice) applied to PDF documents. Storage:
pf_letterheads table
Example:
- “Formal Letterhead” with logo, address, and confidentiality footer
- “Internal Memo” with minimal branding
- “Confidential” with watermark
Field-Related Terms
Custom Field Definition (PF-16)
Also called: Custom field, entity extension, org-specific fieldNOT the same as: Form Field, Object Field, Field Configuration Purpose: Define metadata schema for extending existing entities with organization-specific data. Storage: Definitions in
pf_custom_field_definitions, values in custom_fields JSONB column on entity tables.
Scope: Organization-wide, applies to all records of the target entity.
Example:
- Adding
badge_numbertohr_employees - Adding
external_case_idtorh_residents - Adding
retention_daystofw_forms
Form Field (FW-01)
Also called: Field, form input, form elementNOT the same as: Custom Field Definition, Object Field Purpose: Define a field within a form for data capture. Storage:
fw_form_fields table.
Scope: Form-specific, applies to one form only.
Example:
- “First Name” field in an intake form
- “Incident Date” field in an incident report
- “Rating” field in a satisfaction survey
Entity Field Configuration (PF-17)
Also called: Field config, field visibility, field rulesNOT the same as: Custom Field Definition (PF-16 defines fields, PF-17 configures their behavior) Purpose: Control visibility, required status, and ordering of fields on existing entities. Storage:
pf_entity_field_configs table.
Scope: Organization + Entity + Context (e.g., role-based visibility).
Example:
- Hide
salaryfrom non-admin users - Make
department_idrequired for managers - Reorder fields in employee profile
Object Field (PF-24)
Also called: Custom object field, object attributeNOT the same as: Custom Field Definition (though they share
pf_custom_field_definitions)
Purpose: Define fields for a custom object type.
Storage: pf_custom_object_fields (links to pf_custom_field_definitions).
Scope: Custom object-specific.
Example:
license_numberfield on “Clinical Licenses” custom objectvehicle_vinfield on “Fleet Vehicles” custom object
Lookup Field (FW-15)
Also called: Table lookup, dynamic dropdown, referenced fieldNOT the same as: Picklist (static), Form Options (form-specific) Purpose: Form field that pulls options dynamically from a database table. Storage:
fw_form_fields.settings JSONB with lookup configuration.
Scope: Real-time from database, respects RLS.
Example:
- Department dropdown from
hr_departments - Employee selector from
hr_employees - Site selector from
pf_sites
Object-Related Terms
Data Object (PF-23)
Also called: Object, entity, table metadataNOT the same as: Custom Object (PF-24 creates new objects, PF-23 provides metadata view) Purpose: Metadata representation of any entity (core or custom) for browsing and discovery. Storage:
pf_object_metadata table.
Scope: Organization-wide view of all objects.
Example:
hr_employeesas a data object in the Object Browserrh_residentsas a data object- Custom objects also appear as data objects
Custom Object (PF-24)
Also called: User-defined object, custom entity, org-specific objectNOT the same as: Data Object (metadata view), Form (data capture interface) Purpose: Create new entity types beyond core Encore Health OS objects. Storage:
- Definitions:
pf_custom_objects - Fields:
pf_custom_object_fields - Records:
pf_custom_object_records
- “Clinical Licenses” to track staff certifications
- “Training Classes” to track training sessions
- “Fleet Vehicles” to track company vehicles
Form (FW-01)
Also called: Data capture form, submission form, workflow formNOT the same as: Custom Object (entity type), Data Object (metadata) Purpose: Data capture interface for one-time submissions, often with workflow. Storage:
- Definitions:
fw_forms - Fields:
fw_form_fields - Submissions:
fw_form_submissions
- Resident intake form
- Incident report form
- Employee satisfaction survey
Option-Related Terms
Picklist (PF-15)
Also called: Dropdown values, reusable options, org-specific valuesNOT the same as: Form Options (form-specific), Lookups (table-based) Purpose: Organization-scoped dropdown values reusable across forms and entities. Storage:
- Lists:
pf_picklists - Items:
pf_picklist_items
- Employment status: Full-time, Part-time, Contractor
- Priority levels: Low, Medium, High, Critical
- Incident types: Fall, Medication Error, Behavioral
Form Options (FW-01)
Also called: Static options, inline options, form-specific valuesNOT the same as: Picklist (reusable), Lookups (table-based) Purpose: Static dropdown options specific to one form field. Storage:
fw_form_fields.options JSONB.
Scope: Form-specific, not reusable.
Example:
- Yes/No for a specific question
- Satisfaction ratings 1-5 for this survey only
- One-off categories not used elsewhere
Lookup Options (FW-15)
Also called: Table lookup, dynamic options, referenced valuesNOT the same as: Picklist (static, org-managed), Form Options (form-specific) Purpose: Dynamic dropdown options pulled from database tables in real-time. Storage: Configuration in
fw_form_fields.settings JSONB.
Scope: Database-level, respects RLS, auto-updates.
Example:
- Departments from
hr_departments - Employees from
hr_employees - Sites from
pf_sites
Quick Reference Table
| Term | System | Purpose | Storage | Reusable? |
|---|---|---|---|---|
| Custom Field Definition | PF-16 | Extend existing entity | custom_fields JSONB | ✅ Org-wide |
| Form Field | FW-01 | Form data capture | fw_form_fields | ❌ Form-specific |
| Field Configuration | PF-17 | Control field behavior | pf_entity_field_configs | ✅ Org-wide |
| Object Field | PF-24 | Custom object structure | pf_custom_object_fields | ❌ Object-specific |
| Lookup Field | FW-15 | Dynamic form dropdown | fw_form_fields.settings | ✅ Any form |
| Data Object | PF-23 | Object metadata view | pf_object_metadata | N/A (metadata) |
| Custom Object | PF-24 | New entity type | pf_custom_objects | ✅ Org-wide |
| Form | FW-01 | Data capture interface | fw_forms | ✅ Org-wide |
| Picklist | PF-15 | Reusable dropdown | pf_picklists | ✅ Org-wide |
| Form Options | FW-01 | Static form dropdown | fw_form_fields.options | ❌ Form-specific |
| Lookup Options | FW-15 | Dynamic table dropdown | fw_form_fields.settings | ✅ Any form |
Common Confusion Pairs
Custom Fields vs Form Fields
- Custom Fields: Add metadata to existing entities (employees, residents)
- Form Fields: Define structure of forms for data capture
Custom Objects vs Forms
- Custom Objects: Create new entity types with CRUD operations
- Forms: Create data capture interfaces with submissions
Picklists vs Lookups
- Picklists: Static values managed in Settings, org-specific
- Lookups: Dynamic values from database tables, auto-updates
Data Objects vs Custom Objects
- Data Objects: Metadata view of any entity (browse/discover)
- Custom Objects: New entity types created by organization
Field Configuration vs Custom Fields
- Field Configuration: Control visibility/behavior of existing fields
- Custom Fields: Add new fields to entities
Form Wizard vs Module Wizard
- Form Wizard (FW-31): Multi-step data capture using forms, data goes to
fw_form_submissions - Module Wizard (PF-41): Business process guidance with custom components, data goes to module-specific tables
Workflow Template vs Document Template
- Workflow Template (FW-28): Reusable automation patterns for workflow builder
- Document Template (PF-64): Structure for printable PDF documents with letterhead
Form Template vs Document Template
- Form Template (FW-01): Clonable form structure for data capture
- Document Template (PF-64): Printable document structure for policies, letters, reports
Form vs Document Template (Most Common Confusion)
- Form (FW-01): Collects data from users → stored in
fw_form_submissions - Document Template (PF-64): Formats data for printable PDF → stored in
pf_document_templates - Connection: Form submissions can be exported as PDFs using PF-64 letterheads via
useFormSubmissionPdf - Forms and Document Templates are complementary — forms capture, templates present
Wizard Template vs Spec Template
- Wizard Template (PF-41): Database-stored wizard configuration for business processes
- Spec Template: Markdown files in
specs/_templates/for writing documentation
Decision Trees
”Which wizard system should I use?"
"Which template type should I use?”
Related Documentation
- PF/FW Documentation Review - Detailed analysis of terminology overlap
- Forms/Templates/UX Review - Forms vs Templates analysis and recommendations
- Template Selection Guide - Decision guide for template types
- Clarity Analysis (Condensed) - Feature comparison
- Use Case Guides - Integration patterns
- Template Index - Spec template reference
Last Updated: 2026-02-05