Firely Server

Firely Products

  • Back to all Firely Products

Firely Server Docs:

  • Overview
  • Getting started
  • Setting up Firely Server
  • Maintenance and Management
  • Connecting Data Sources
  • Features
  • Security and Tools
  • Performance
  • Programming API Reference
    • Architecture
    • Facade
    • Plugins
    • Programming API
    • Dependencies and licenses
  • Compliance & Certification
  • Upgrading and Release Notes
  • FAQ
  • Contact us
Firely Server
    Firely Server banner

  • Firely Docs »
  • Firely Server »
  • Programming API Reference
  • View page source

Programming API Reference

Firely Server offers an extensive programming API which allows changing the behaviour of the server. Customizations can be implemented using a plugin infrastructure. The reference documentation lists the available plugins for configuring the pipeline, and the public programming API of Firely Server for building Plugins and Facades.

  • Architecture
  • Facade
    • Facade setup configuration
    • Exercise: Build your first Facade
    • Prerequisites and Preparations
    • Starting your project
    • Mapping the database
    • Enable Search
    • Next search step
    • Finalizing search
    • Debugging the Facade
    • Finalizing your project
    • Enable changes to the repository
  • Plugins
    • Configure the pipeline
    • Configuration classes
    • Detailed logging of loading plugins
    • The order of plugins
    • Important classes and interfaces
    • Template for a plugin
    • Returning non-FHIR content from a plugin
    • Example: $document
  • Programming API
    • IResource
    • ElementModel, manipulating IResource and ISourceNode
    • IVonkContext
    • Interaction Handling
    • Pipeline configuration
    • Repository interfaces
    • Constructing bundles
    • Access Control in Plugins and Facades
    • Capability Statement Management
    • Resource resolver for conformance resources
  • Dependencies and licenses
Previous Next

© Copyright 2025, Firely.

Built with Sphinx using a theme provided by Read the Docs.