Skip to main content
Purpose: This guide helps compliance officers and administrators create, manage, and monitor procedures.

​
Overview

The Procedures Management module enables compliance officers to create visual step-by-step procedures, link them to policies, track executions, and use AI to generate procedure drafts.

​
Admin Responsibilities

​
Prerequisites

​
Required Permissions

Administrators need these permissions:

​
Creating Procedures

​
Quick Create

1
  • Navigate to GR → Procedures
  • Click Add Procedure
  • Fill in required fields:
    • Title: Clear, descriptive name (e.g., “SOP-001: Medication Administration”)
    • Category: Clinical, Operational, Safety, HR, Financial, IT, Emergency, Other
    • Description: Brief overview of procedure purpose
  • Click Save to create a draft

    • ​
    Using AI Generation

    Generate procedure drafts from existing policies:
    1
  • Navigate to GR → Procedures → New
  • Click Generate with AI button
  • Select an approved policy from the dropdown
  • (Optional) Add additional context for the AI
  • Click Generate Procedure
  • Review the generated steps and confidence score
  • Click Apply to Procedure to populate the editor
  • Edit and refine as needed
    • Note: AI generation is only available when AI features are enabled for your organization.

    ​
    Visual Workflow Editor

    ​
    Canvas Overview

    The procedure editor uses a visual canvas where you can:
    • Add different step types
    • Position steps by dragging
    • Connect steps with edges
    • Configure step properties

    ​
    Adding Steps

    1
  • Open procedure in edit mode
  • Click step type button in the toolbar:
    • Action: Standard task
    • Decision: Branch point
    • Verify: Sign-off step
    • Reference: Link to document
    • System: Automated action
  • New step appears on canvas
  • Drag to position

    • ​
    Configuring Steps

    Click on any step to open the properties panel:

    ​
    Connecting Steps

    1
  • Hover over a step’s bottom handle (output)
  • Drag to another step’s top handle (input)
  • Edge connects the steps
  • Label edges as needed (especially for decisions)

    • ​
    Decision Branches

    For decision steps:
    1
  • Add the decision step to the canvas
  • Configure decision options (e.g., “Yes”, “No”, “Escalate”)
  • Each option creates a separate output handle
  • Connect each handle to the appropriate next step
  • Label each edge with the decision option

    • ​
    Procedure Lifecycle

    ​
    Status Workflow

    ​
    Approving Procedures

    Before approving:
    1
  • Review all steps and connections
  • Verify linked policy (if applicable)
  • Check that all steps have clear instructions
  • Ensure responsible roles are assigned
    • To approve:
    1
  • Open the procedure
  • Click Change Status button
  • Select Approved
  • Set effective date
  • Procedure becomes visible to staff

    • ​
    Creating New Versions

    When updating an approved procedure:
    1
  • Open the approved procedure
  • Click Create Version
  • Enter a change summary
  • Version snapshot is created (immutable)
  • Continue editing the current version
  • Re-approve when changes are complete

    • ​
    Linking to Policies

    • Demonstrates policy implementation
    • Enables compliance traceability
    • Required for accreditation audits
    • Shows staff “the why” behind procedures
    1
  • Open procedure in edit mode
  • Find “Implements Policy” dropdown
  • Select the policy this procedure implements
  • Link is created automatically
  • Appears on both procedure and policy detail pages

    • ​
    Monitoring Executions

    ​
    Execution Dashboard

    View all procedure executions:
    1
  • Navigate to GR → Procedures
  • Open any procedure
  • Click the Executions tab
    • Execution status breakdown:

    ​
    Compliance Reporting

    Use execution data for:
    • Track which procedures are being followed
    • Identify procedures with low execution rates
    • Audit execution records for accreditation
    • Verify staff compliance with SOPs

    ​
    Execution Details

    View execution details to see:
    • Who executed the procedure
    • When each step was completed
    • Notes added during execution
    • Decisions made at branch points
    • Electronic signatures captured

    ​
    Module Settings

    ​
    Available Settings

    Navigate to GR → Settings → Procedures:

    ​
    Configuring Settings

    1
  • Navigate to GR → Settings
  • Open “Procedures” tab
  • Modify settings as needed
  • Click Save

    • ​
    AI Generation Best Practices

    ​
    Getting Good Results

    1
  • Select clear policies: Policies with detailed requirements generate better procedures
  • Add context: Describe specific roles, environment, or constraints
  • Review confidence score: Higher scores indicate better AI understanding
  • Edit generated content: Always review and refine AI output

    • ​
    What AI Generates

    • Procedure title and description
    • Ordered steps with appropriate types
    • Responsible role suggestions
    • Time estimates
    • Verification points
    • Decision branches

    ​
    What to Review

    • Verify step order makes sense
    • Check role assignments are correct
    • Ensure decision options are complete
    • Add organization-specific details
    • Remove any generic placeholder content

    ​
    Troubleshooting

    ​
    Common Issues

    ​
    Issue: Staff Can’t See Procedure

    Symptoms: Staff report procedure not visible Cause: Procedure may be in draft/review status Resolution:
    1
  • Check procedure status
  • If draft/review, approve the procedure
  • Set effective date if needed

    • ​
    Issue: AI Generation Not Working

    Symptoms: Generate with AI button missing or failing Cause: AI features not enabled for organization Resolution:
    1
  • Verify AI compliance features enabled in GR settings
  • Check LOVABLE_API_KEY secret is configured
  • Contact administrator if still not working

    • ​
    Issue: Execution Not Recording

    Symptoms: Steps complete but execution not saved Cause: Permission or connectivity issue Resolution:
    1
  • Check user has gr.procedures.execute permission
  • Verify network connectivity
  • Refresh page and try again

    • ​
    Escalation Path

    If issues can’t be resolved:
    1
  • Check system logs for errors
  • Review recent changes to procedures
  • Contact technical support with:
    • Error messages
    • Steps to reproduce
    • User and organization details

    ​
    Customizing Dropdown Values

    Procedure categories are powered by picklists under the gr.procedure.* namespace. The platform ships defaults so procedure forms work out of the box, but you can tailor the options to match your operational areas. Common procedure picklists to customize: To customize:
    1
  • Navigate to Settings → Picklists (/settings/picklists).
  • Filter or search for the gr.procedure.* picklist you want to edit.
  • If the picklist shows the System badge, select Duplicate to Org to create an editable copy.
  • Add, rename, reorder, or deactivate items as needed.
  • Save your changes — procedure forms pick up the new values immediately.
    • Procedure status values (Draft, In Review, Approved, Active, Retired) stay fixed because they drive the procedure lifecycle. The full list of governance picklists and their default values is in the Picklist Reference.

    ​
    Best Practices

    ​
    Creating Effective Procedures

    • ✅ Keep step instructions clear and actionable
    • ✅ Use active voice (“Review the form” not “The form should be reviewed”)
    • ✅ Assign specific roles, not generic “staff”
    • ✅ Include time estimates for each step
    • ✅ Add verification steps after critical actions

    ​
    Managing Procedures

    • ✅ Review procedures quarterly for accuracy
    • ✅ Update when policies change
    • ✅ Archive rather than delete outdated procedures
    • ✅ Use version history to track changes

    ​
    Monitoring Compliance

    • ✅ Check execution rates regularly
    • ✅ Follow up on abandoned executions
    • ✅ Use execution data in audits
    • ✅ Identify training needs from execution patterns

    ​
    Data Management

    ​
    Version History

    All procedure versions are stored:
    • Version snapshots are immutable
    • Change summaries document updates
    • Previous versions available for audit

    ​
    Data Retention

    • User Guide: docs/gr/procedure-user-guide.md - For staff members
    • Policy Admin Guide: docs/gr/policy-admin-guide.md - Managing linked policies
    • AI Compliance Guide: docs/gr/ai-compliance-admin-guide.md - AI features
    • Module Overview: docs/gr/overview.md - GR module documentation
    Last Updated: 2026-01-28
    Technical Support: Contact your system administrator