Table of Contents

General

• Introduction
• Glossary
• Code Style
  • General Python style guidelines
  • Django-specific style rules
  • JavaScript rules
  • Project-specific rules
  • Examples
• External documentation
• Project specification
  • Technical requirements
  • Limits and restrictions
  • Client requirements
  • Server requirements
• Style guide
  • Examples

Development

• Project set-up
  • Using docker compose
  • Run in Python virtualenv
  • Run test server in production mode (docker-compose)
  • Run Test Region
  • Test user accounts
• Testing
  • Python / Django tests
  • Testing manually
  • Integration Testing
  • JavaScript Tests
• Styling
  • Stylesheets
  • Compiling stylesheets
  • SCSS Stylesheets
• Single Sign-On
  • Glossary
  • SAML
  • LDAP
• Celery tasks
  • Running the celery worker
  • Implementing tasks
  • Task priorities
  • Triggering tasks
  • Scheduling recurring jobs
  • Monitoring & Troubleshooting
• CKEditor integration
  • Custom Fonts
  • Form widget
  • Form mix-in
  • Upgrading CKEditor
  • CKEditor plugins
• Environment variables
  • Viewing values
  • Setting variables
  • Global variables
  • Compliance calculation settings
  • Deployment variables
  • WSGI server configuration
  • Mirth Connect
  • Azure OpenAI & Google Gemini AI Configuration
  • CI/CD
• Export
  • Invoking an exporter
  • Implementing new exporters
• Front-end Libraries & Utilities
  • Third-party Libraries
  • Local Utilities
• Google Analytics
  • Custom event parameters
  • Disabling Google analytics
• Health Level 7
  • HL7 Integration
• Translations
  • Adding translatable strings to the project
  • Translating
  • Using translations
  • JavaScript translations
  • Adding new language to the project
• Icons
  • Usage Guide
  • Adding new icons
• Logging & error reports
  • Logging user actions
  • Analytics
  • Logging code
• Messaging
  • E-mails
  • Push Messages
  • Instant Messaging
  • SMS/Phone call
• Mirth Connect
  • Development Environment
• Mutex
  • Python code
  • REST API
• Staging Sites
  • Crash reports
  • Deploying branches to staging
  • Stopping Staging Sites
  • Creating new Staging environments
  • Updating Staging environments

Modules

• Compliance
  • Models
  • Compliance getter
  • Utilities
  • Celery tasks
• Export
  • Models
  • Views
  • Toolbar item
  • Export logic
  • Exporters
• Middleware
  • TraceExtrasMiddleware
  • MemoryUsageMiddleware
  • meg_context_processor()
  • AdminSecurityMiddleware
  • MetadataMiddleware
  • CacheControlMiddleware
• Models
  • MEG Forms
  • Form Builder
  • Dashboards
  • QIP
  • eGuides
  • MEG Docs
  • Accounts
  • Calendar
  • HL7 Integration
• Overview Filter
  • JQueryQueryBuilderFilterMixin
  • DeferredValidationModelMultipleChoiceField
  • OverviewFilterForm
• Celery tasks
  • MEG Docs
  • Files
• Template tags
  • Common
  • Utilities
  • Files
  • Components
  • Java Script
  • Feedback form
  • Docs
  • QIP
  • Messaging
  • eGuides
• Utilities
  • Common utilities
  • Unpublishing & restoring
  • Logging & Metrics
  • Celery
  • Date & Time utils
  • Accounts
  • Action logs
  • Analytics
  • API
  • eGuides
  • E-mails
  • Single sign-on
  • Files
  • Messaging
  • Push messages
  • QIP
  • Regions
  • Dashboards
  • Hand Hygiene
  • Translation
  • Custom forms
  • LFPSE
  • Query utils
  • Permission utils
  • Workflow utils
  • Document editor
• Validators
  • OptionalValidatorMixin
  • MinimumLengthOptionalValidator
  • NumericPasswordOptionalValidator
  • CommonPasswordOptionalValidator
  • UserAttributeSimilarityOptionalValidator
  • CustomFileExtensionValidator
  • GreaterThanValidator
  • RichTextValidator
  • RichTextParser
  • TemplateValidator
  • TimezoneValidator
  • validate_email_for_institution()
  • LanguageCodeValidator
  • validate_string_array_or_empty()
  • TypedDictValidator
  • Custom forms
  • Accounts
  • API
  • E-mails
  • MEG Docs
  • HL7 integration
  • Regions
  • Web forms
• Base views & mix-ins
  • Base Dashboard classes
  • Authentication
  • Analytics
  • eGuides
• Dashboard widgets
  • Base & mixin classes
  • Chart Widgets
  • Table Widgets
  • Heatmap widgets
  • Summary widgets
  • QIP widgets

Production

• Status page
• System architecture
  • High level
  • Azure
  • On-prem
  • Security
• New instance
  • Create database
  • Create Kubernetes cluster
  • Deploy the project into the cluster
  • Set up Azure Backup Media Files
  • Restore Azure File Share Backup
  • Site set-up
• On-prem
  • Vagrant box
  • Deployment
  • Mirth Connect
  • SMS
• Making releases
  • Versioning
  • Building and deploying a release manually
  • Rolling back releases
  • Reverting changes
  • Deployment environments
• Release Notes
  • 13.57
  • 13.66
  • 15.11
• Telemetry
  • Accessing telemetry data
  • Configuration
• Terraform Deployment
  • Prerequisites
  • Create Infrastructure
  • Deploy Infrastructure with Terraform
  • Destroy Deployment with Terraform
  • GitLab CI/CD Job
• Troubleshooting
  • System monitoring
  • Crash reports
  • Database
• VPN Connections
  • Creating a new connection
  • Tallaght University Hospital (TUH)
• WSGI Server
  • WSGI express reference

Features

• Django admin
  • Admin preferences
• Cloud save
  • Backup all unsubmitted data
  • Save draft audit to the cloud
  • Retrieve backed-up data
• Compliance
  • Storing compliance
  • Compliance weight
  • Field Compliance calculation setting
  • Calculating compliance
  • Retrieving Compliance Data
• Content Security Policy
  • Overriding CSP settings per view
  • @csp_exempt
  • @csp_update
  • @csp_replace
  • @csp
• Dashboard Widget
  • Config
  • Filters
• Form Excel Import
• Form set-up
  • Form configuration
  • Field configuration
• Insights
  • Glossary
  • Modules
• Group & Institution levels
  • User levels
  • Form levels
  • QIP configurations
  • Document & folder levels
  • Team levels
  • Tag Groups
  • SSO identity provider level
  • Security Policy
  • Report Rule
• Permissions
  • Django permissions
  • Custom permissions
  • Per-form permissions
  • Permission cache
• Custom report template
  • Example
  • Variables
  • Template tags
• Report rules
  • Actions
  • Content
  • Recipients
  • Schedule E-mails
  • Filter logic:
  • Config
• Ringfencing
  • Ward ringfencing
  • User ringfencing
  • Observation ringfencing
  • Model dropdown override
  • Combining all of the above
• Un-publishing data
  • Un-publishing child items
  • Using command-line to update child objects
  • Restoring removed items
  • Logging unpublished items

MEG Docs

• Overview
• Enabling Access to MEG Docs
  • Enabling Access to MEG Docs
  • Permission cache
• Drafting documents
  • Overview
  • Creating a new document
  • Editing a draft
  • Headers & Footers
  • Suggesting changes
  • Comments
  • Submitting draft for review
• Import document repository
  • Creating the metadata spreadsheet
  • Preparing the files
  • Using the API
• Documents & Folders ringfencing
  • Access Hierarchy

Academy

• Overview
• MEG Academy Models
  • Course Folder and Online Course Organization
  • Course Stages and Acknowledgment
  • Security and Progress Tracking

MEG Workflows

• Overview
  • Usage Guide
  • Use Cases in Detail
• Workflow models
  • WorkflowQuerySet
  • Workflow
  • Stage
  • Operation

LFPSE

• Definitions
• Model diagram
• Further documentation
• Event / Form types
• Usage Guide
  • Creating an LFPSE Backend
  • Creating A New Form
  • Updating questions
• Data sources
  • Taxonomy API
  • Taxonomy spreadsheets
  • Question flow chart
  • LFPSE Go Live Procedure
• Python Modules
  • Schema
  • Client
• Submitting Data
  • Submission API
  • Sample requests

Business Intelligence

• Business Intelligence
  • Mongodb database
  • Development Usage Guide