SUMMARY.md

Table of contents

• Introduction
  • Features
  • Architecture
• Getting Started
  • Run Aidbox in Sandbox
  • Run Aidbox locally
  • Use Aidbox with React
  • Run Aidbox on AWS
  • Run Aidbox on managed PostgreSQL
  • Uploading Sample Data
  • Run Aidbox on Kubernetes
    • Deploy Production-ready Aidbox to Kubernetes
    • Highly Available Aidbox
    • How to migrate to Apline Linux
    • Self-signed SSL certificates
  • Migrate from Multibox to Aidbox
• Tutorials
  • Data API
    • How to use multilingual search
    • Custom Search
    • Change sort order by locale collation
    • Set up uniqueness in Resource
    • Manage Indexes in Zen Project
    • How to fix broken dates
  • Administration
    • How to migrate transaction id to bigint
    • Working with pgAgent
  • FHIR conformance
    • Touchstone FHIR 4.0.1 basic server
    • Touchstone FHIR USCore ClinData
    • How to enable US Core IG
      • Start Aidbox with US Core IG enabled
      • Add US Core IG to a running Aidbox instance
    • HL7 FHIR Da Vinci PDex Plan Net IG
  • Validation & FHIR extensions
    • Working with Extensions
  • Subscriptions
    • Subscribe to new Patient resource
  • Integrations
    • Postmark integration
    • Mailgun integration
  • Other tutorials
    • Resource generation with map-to-fhir-bundle-task and subscription triggers
    • HL7 v2 pipeline with Patient mapping
    • Patient Encounter notification Application
    • SDC with Custom Resources
    • APM Aidbox
    • License migration guide
    • Automatically archive AuditEvent resources in GCP storage guide
    • [WIP] Multibox to Aidbox migration best practices

Overview

• Licensing and Support
• Aidbox user portal
  • Projects
  • Licenses
  • Members
• Aidbox UI
  • Aidbox Notebooks
  • REST Console
  • Attrs stats
  • DB Tables
  • DB Queries
• Versioning
• Release Notes
  • Releases Archive
    • 0.4.7 addendum
• FAQ
• Contact us

Aidbox configuration

• Configure Aidbox and Multibox
• Aidbox configuration project
  • Aidbox configuration project structure
  • Set up and use configuration projects
  • Enable IGs
  • Repository
  • Seed Import
  • Seed v2
  • 🎓 Migrate to git Aidbox Configuration Projects
• API constructor (beta)
• Zen Configuration

API

• FHIR API
  • Search
    • Configure Search API
    • SearchParameter
    • Custom Search Parameter
      • Zen Search Parameters
    • Search parameters list
      • _search-language
      • _list
      • _id
      • _lastUpdated & _createdAt
      • _profile
      • _text & _content
      • _ilike
      • _elements
      • _count & _page
      • Summary parameter
      • _total or _totalMethod
      • _timeout
      • _sort
      • _include, _revinclude, _with
      • _result
      • _filter
      • _explain
      • _source
      • _security
    • Search Resource
    • Search with related resources
    • Token search
    • Reference search
    • Date search
    • Composite Search Parameters
    • Number search
    • Location search
    • AidboxQuery
    • SearchQuery
    • . expressions
    • Chained Parameters
    • $lookup
  • Capability Statement
  • $validate
  • $match
  • Observation/$lastn
  • History
  • $everything on Patient
  • Bundle
• REST API
  • CRUD
    • Create
    • Read
    • Update
    • Patch
    • Delete
  • SQL endpoints
  • Aidbox version
  • $matcho
  • $to-format
• Bulk API
  • Configure Access Policies for Bulk API
  • Generate sample data for Bulk API
  • $dump
  • $dump-sql
  • 🎓 $dump-sql tutorial
  • $dump-csv
  • $export
  • $load & /fhir/$load
  • $import & /fhir/$import
  • aidbox.bulk data import
  • Bulk import from an S3 bucket
  • 🎓 Synthea by Bulk APi
• RPC API
• Archive/Restore API
  • create-archive
  • restore-archive
  • prune-archived-data
  • delete-archive
• GraphQL API
• Batch Upsert
• Batch/Transaction
• Reactive API
  • Aidbox Subscriptions
  • Changes API
  • GCP Pub/Sub
• ETAG support
• Plan API
  • Plan API Overview
  • Patient Access API
• Other
  • Compartments API
  • Sequence API
  • Encryption API
  • Cache

Modules

• Workflow Engine
  • Task
    • Aidbox Built-in Tasks
    • Task Executor API
    • Task User API
  • Workflow
    • Workflow User API
  • Services
  • Monitoring
• Topic-Based Subscriptions
  • Set up SubscriptionTopic
  • Tutorial: Subscribe to Topic (R4B)
  • API Reference
    • SubscriptionTopic API
    • Subscription API
• Entities & Attributes
• Profiling and validation
  • FHIR Schema Validator
    • FHIR Schema
    • Validator Features
    • Supported FHIR Implementation Guides (IGs)
    • Setup Aidbox with FHIR Schema validation engine
    • Tutorials
      • ISiK
  • Profiling and validation overview
  • Profiling with zen-lang
    • Write a custom zen profile
    • 🎓 Load zen profiles into Aidbox
  • Asynchronous resource validation
  • Profiling with AidboxProfile
  • $json-schema
• Aidbox terminology module
  • 🏗️ FHIR Terminology Repository
    • FTR Specification
    • Create an FTR instance
      • FTR from CSV
      • FTR from FHIR IG
      • FTR from FTR — Direct Dependency
      • FTR from FTR — Supplement
    • FTR Manifest
    • Load SNOMED CT into Aidbox
    • Load LOINC into Aidbox
    • Load ICD-10-CM into Aidbox
    • Load RxNorm into Aidbox
    • Load US VSAC Package to Aidbox
  • Concept
    • $translate-concepts
    • Handling hierarchies using ancestors
  • ValueSet
    • ValueSet Expansion
    • ValueSet Code Validation
    • Create a ValueSet
  • CodeSystem
    • CodeSystem Concept Lookup
    • CodeSystem Subsumption testing
    • CodeSystem Code Composition
  • Import external terminologies
    • Import via FTR
    • Import flat file (CSV)
    • $import operation
    • Ready-to-use terminologies
  • $translate on ConceptMap
  • Terminology Tutorials
    • 🎓 Load ICD-10 terminology into Aidbox
• Security & Access Control
  • Overview
  • Authentication Flows
    • Basic Auth
    • Client Credentials Grant
    • Resource Owner Grant
    • Authorization Code Grant
    • Implicit Grant
    • Two Factor Authentication
    • External OAuth 2.0 Providers
  • Access Control
    • AccessPolicy
    • Evaluation engines
    • Role-Based Access Control (RBAC)
    • Attribute-based Access Control (ABAC)
      • Label-based Access Control
        • How to enable labels-based access control
    • Multitenancy
    • Access control lists (ACL)
    • SMART on FHIR
    • Access policy dev tool
    • AccessPolicy best practices
  • Tutorials
    • Allow patients to see their own data
    • Restrict operations on resource type
    • Configure multi-tenancy
    • Relationship-based access control
    • Authentication Tutorial
    • Creating user & set up full user access
    • Restricting Access to Patient Data
  • How-to guides
    • Create and test access control
    • External identity provider
      • Aidbox
      • Okta
      • Azure AD
      • Azure AD with certificate authentication
      • Keycloak
      • GitHub
      • Microsoft AD FS
    • RBAC
      • Flexible RBAC built-in to Aidbox
      • RBAC with JWT containing role
      • RBAC with ACL
    • SMART on FHIR
      • Set up SMART on FHIR in Aidbox
      • Get a SMART App launched
    • Set-up token introspection
    • Prohibit user to login
    • Debug access control
    • Research possible security issues
  • Technical reference
    • User, Session, Client resources
    • Tokens processing
    • Storing authorization details
    • Discovery API
  • Multitenancy
    • Organization-based hierarchical access control
    • How to enable hierarchical access control
  • Patient data access API
    • How to enable patient data access API
    • How to enable SMART on FHIR on Patient Access API
• Integration toolkit
  • C-CDA / FHIR Converter
    • List of supported templates
      • Advance Directives Section (entries optional) (V3)
      • Advance Directives Section (entries required) (V3)
      • Allergies and Intolerances Section (entries optional) (V3)
      • Allergies and Intolerances Section (entries required) (V3)
      • Assessment Section
      • Default Section Rules
      • Document Header
      • Encounters Section (entries optional) (V3)
      • Encounters Section (entries required) (V3)
      • Family History Section (V3)
      • Functional Status Section (V2)
      • Goals Section
      • Health Concerns Section (V2)
      • History of Present Illness Section
      • Hospital Course Section
      • Hospital Discharge Instructions Section
      • Immunizations Section (entries optional) (V3)
      • Immunizations Section (entries required) (V3)
      • Medical Equipment Section (V2)
      • Medications Administered Section (V2)
      • Medications Section (entries optional) (V2)
      • Medications Section (entries required) (V2)
      • Mental Status Section (V2)
      • Notes
      • Nutrition Section
      • Payers Section (V3)
      • Plan of Treatment Section (V2)
      • Problem Section (entries optional) (V3)
      • Problem Section (entries required) (V3)
      • Procedures Section (entries optional) (V2)
      • Procedures Section (entries required) (V2)
      • Results Section (entries optional) (V3)
      • Results Section (entries required) (V3)
      • Social History Section (V3)
      • Vital Signs Section (entries optional) (V3)
      • Vital Signs Section (entries required) (V3)
    • How to deploy the service
    • Producing C-CDA documents
    • How to customize conversion rules
  • HL7 v2 integration with Aidbox Project
  • HL7 v2 Integration
  • X12 message converter
• Custom Resources
  • $metadata
  • Custom resources using Aidbox Project
  • Custom Resources using Entity
• Aidbox Forms
  • Getting started
  • Aidbox UI Builder
    • Form creation
      • Form Settings
      • Widgets
      • Components
      • Rules
      • Versioning
      • Form customisation
      • Form signature
      • How To
    • Import FHIR Questionnaire
    • Form sharing
  • Aidbox Code Editor
    • Form creation
    • Dynamic form creation
    • Form with calculated fields creation
    • Form customisation
    • Versioning
    • Form sharing
    • Aidbox Form workflow
    • Сhanging data after form signing
    • FHIR Questionnaire to Aidbox Forms and back conversion
  • Any familiar form editor
  • Aidbox Forms Library
• Audit
  • Audit Log
  • Configure Audit Log
• Observability
  • Getting started
    • Run Aidbox with OpenTelemetry locally
    • How to export telemetry to the OTEL collector
  • Logs
    • How to export logs to the OTEL collector
    • How-to guides
      • Elastic Logs and Monitoring Integration
      • Datadog Log management integration
      • Loki Log management integration
    • Tutorials
      • 🎓 Log analysis and visualization tutorial
      • 🎓 Export logs to Datadog tutorial
      • Set up logs with Aidbox project
    • Background information
      • Extending Aidbox Logs
    • Technical reference
      • Log appenders
      • Log transformations
      • Log Schema
      • OTEL logs exporter parameters
  • Metrics
    • How to export metrics to the OTEL collector
    • How-to guides
      • Use Aidbox Metrics Server
      • Set-up Grafana integration
    • Technical reference
      • OpenTelemetry Metrics
      • OTEL metrics exporter parameters
  • Traces
    • How to use tracing
    • OTEL traces exporter parameters
• MDM
  • Train model
  • Configure MDM module
  • Find duplicates
  • Mathematical details
• SMARTbox | FHIR API for EHRs
  • Get started
    • Set up Smartbox locally
    • Deploy Smartbox with Kubernetes
  • How-to guides
    • Pass Inferno tests with Smartbox
    • Perform EHR launch
    • Pass Inferno Visual Inspection and Attestation
    • Revoke granted access
    • Set up EHR-level customization
    • Check email templates
    • Setup email provider
    • Register users
    • Set up SSO with Auth0
    • Publish Terms of Use link onto the documentation page
    • Find out what resources were exported during the $export operation
    • Find documentation endpoint
  • Background information
    • Considerations for Testing with Inferno ONC
    • Adding Clients for Inferno tests
    • Multitenancy approach
    • What is Tenant
    • Email templating

FHIR Implementation Guides

• US Core IG
  • US Core IG support reference

Storage

• AidboxDB
  • Migrate to AidboxDB 16
• Database schema
• SQL on FHIR
  • Defining flat views with View Definitions
    • Migrate to the spec-compliant ViewDefinition format
  • Query data from flat views
  • Reference
• First-Class Extensions
• Aidbox & FHIR formats
• HA AidboxDB
• Backup and Restore
  • Crunchy Operator (pgBackRest)
  • pg_dump
  • pg_basebackup
  • WAL-G
• Indexes
  • Get suggested indexes
  • Create indexes manually
  • Zen Indexes
• Delete data
• S3-compatible storages
  • AWS S3
  • GCP Cloud Storage
  • Azure Blob Storage
  • Oracle Cloud Storage

Integrations

• Analytics
  • Power BI
• Email providers
  • Setup SMTP provider

App development

• Aidbox SDK
  • Aidbox JavaScript SDK
  • Apps
  • NodeJs SDK
  • Python SDK
  • SDK internals
• Mappings
  • Mappings with lisp/mapping
• Receive logs from your app
  • X-Audit header
  • Health check
• Administration
• Working with Aidbox from .NET
• Testing with Stresty

Reference

• Zen schema reference
  • aidbox
    • mdm
      • splink-engine
      • model
• RPC reference
  • aidbox
    • mdm
      • aidbox.mdm/update-mdm-tables
      • aidbox.mdm/match
• Configuration
  • Environment variables
    • Aidbox required environment variables
    • Optional environment variables
    • AidboxDB environment variables
    • Aidbox Configuration project
    • FTR
    • Mailgun environment variables
    • Postmark environment variables
  • Aidbox project
    • aidbox.config/config
• Aidbox Forms reference
  • Layout DSL
  • Document DSL
  • Launch DSL
  • Lisp
  • FinalizeConstraints DSL
  • Finalize DSL
  • Form DSL
  • Lisp API
  • Form API
  • Workflow API
  • Addendum API
  • FHIR SDC API
  • Aidbox SDC API
• Aidbox SQL functions
• SMART on FHIR