Broken Links Notebooks

# Table of contents

Aidbox FHIR platform documentation

Features

Architecture

Getting Started

Run Aidbox in Sandbox

Run Aidbox locally

Run Aidbox locally

Run Aidbox on AWS

Upload Sample Data

Tutorials

CRUD, Search Tutorials

Delete data

Change sort order by locale collation

Migrate from Aidbox SearchParameter to FHIR SearchParameter

Set up uniqueness in Resource

Bulk API Tutorials

🎓 Synthea by Bulk API

🎓 $dump-sql tutorial

Security & Access Control Tutorials

Authentication Tutorial

Allow patients to see their own data

Restrict operations on resource type

Relationship-based access control

Creating user & set up full user access

Restricting Access to Patient Data

Create and test access control

RBAC

Flexible RBAC built-in to Aidbox

RBAC with JWT containing role

RBAC with ACL

Set-up token introspection

Prohibit user to login

Debug access control

Managing Admin Access to the Aidbox UI Using Okta Groups

Terminology Tutorials

🎓 Load ICD-10 terminology into Aidbox

Uploading IG terminology content to external FHIR terminology server

Validation Tutorials

Upload FHIR Implementation Guide

Environment Variable

Aidbox UI

IG Package from Aidbox Registry

Public URL to IG Package

Local IG Package

Aidbox FHIR API

UploadFIG Tool

ISiK

Carin BB

US Core

Davinci Pdex

mCode

Integration Toolkit Tutorials

Postmark integration tutorial

Mailgun integration tutorial

Other tutorials

Migrate from Multibox to Aidbox

SDC with Custom Resources

How to create FHIR NPM package

## Overview

Licensing and Support

Aidbox user portal

Projects

Licenses

Members

Aidbox UI

Aidbox Notebooks

REST Console

Database Console

Attrs stats

DB Tables

DB Queries

Versioning

Release Notes

FAQ

Contact us

## Configuration

Settings

Configure Aidbox and Multibox

Init Bundle

## API

REST API

Bulk API

Configure Access Policies for Bulk API

Generate sample data for Bulk API

$dump

$dump-sql

$dump-csv

$export

$load & /fhir/$load

$import & /fhir/$import

aidbox.bulk data import

Bulk import from an S3 bucket

Batch/Transaction

GraphQL API

Other APIs

## Modules

Profiling and validation

FHIR Schema Validator

Aidbox FHIR IGs Registry

Setup Aidbox with FHIR Schema validation engine

Skip validation of references in resource using request header

Asynchronous resource validation

Security & Access Control

Overview

Authentication

Access to AidboxUI

External identity providers

Aidbox

Okta

Azure AD

Azure AD with certificate authentication

Keycloak

GitHub

Microsoft AD FS

Internal Identity Provider

Authentication Flows

Basic Auth

Client Credentials Grant

Resource Owner Grant

Authorization Code Grant

Implicit Grant

Two Factor Authentication

External OAuth 2.0 Providers

Token Exchange

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)

Access policy dev tool

AccessPolicy best practices

SMART on FHIR

SMART Client Authorization

SMART App Launch

SMART Backend services

SMART Client Authentication

SMART: Asymmetric (“private key JWT”) authentication

SMART: Symmetric (“client secret”) authentication

SMART: Scopes for Limiting Access

Pass Inferno tests with Aidbox

Example: SMART App Launch using Aidbox and Keycloak

Example: SMART App Launch using Smartbox and Keycloak

SMART (deprecated)

SMART on FHIR

SMART on FHIR

Set up SMART on FHIR in Aidbox

Get a SMART App launched

SMART on FHIR

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

Audit

Audit Log

Configure Audit Log

Technical reference

User, Session, Client resources

TokenIntrospector resource

Tokens processing

AcessPolicy resource

Storing authorization details

Discovery API

Observability

Subscriptions

Aidbox topic-based subscriptions

Kafka AidboxTopicDestination

Webhook AidboxTopicDestination

GCP Pub/Sub AidboxTopicDestination

Tutorial: produce QuestionnaireResponse to Kafka topic

Aidbox SubSubscriptions

Aidbox Forms

Getting started

Aidbox Forms Interface

Aidbox UI Builder

Aidbox Code Editor (deprecated)

Form creation

Dynamic form creation

Form with calculated fields creation

Form customisation

Versioning

Form sharing

Aidbox Form workflow

Changing data after form signing

FHIR Questionnaire to Aidbox Forms and back conversion

Any familiar form editor (deprecated)

Access Control in Forms

Audit Logging in Forms

Aidbox Form Gallery

Define extensions

Extensions using StructureDefinition

Extensions using FHIRSchema

Custom Resources

Custom resources using FHIR Schema

Custom resources using StructureDefinition

Migrate to FHIR Schema

Migrate custom resources defined with Entity & Attributes to FHIR Schema

Migrate custom resources defined with Zen to FHIR Schema

Aidbox terminology module

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 flat file (CSV)

$import operation

Ready-to-use terminologies

$translate on ConceptMap

SQL on FHIR

Defining flat views with View Definitions

Migrate to the spec-compliant ViewDefinition format

Query data from flat views

Reference

Integration toolkit

C-CDA / FHIR Converter

List of supported templates

Admission Diagnosis Section (V3)

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

Chief Complaint Section

Chief Complaint and Reason for Visit Section

Complications Section (V3)

Course of Care Section

DICOM Object Catalog Section - DCM 121181

Default Section Rules

Discharge Diagnosis Section (V3)

Document Header

Encounters Section (entries optional) (V3)

Encounters Section (entries required) (V3)

Family History Section (V3)

Functional Status Section (V2)

General Status Section

Goals Section

Health Concerns Section (V2)

History of Present Illness Section

Hospital Consultations Section

Hospital Course Section

Hospital Discharge Instructions Section

Hospital Discharge Physical Section

Hospital Discharge Studies Summary Section

Immunizations Section (entries optional) (V3)

Immunizations Section (entries required) (V3)

Medical (General) History Section

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

Objective Section

Operative Note Fluids Section

Operative Note Surgical Procedure Section

Past Medical History (V3)

Payers Section (V3)

Plan of Treatment Section (V2)

Postprocedure Diagnosis Section (V3)

Preoperative Diagnosis Section (V3)

Problem Section (entries optional) (V3)

Problem Section (entries required) (V3)

Procedure Description Section

Procedure Disposition Section

Procedure Estimated Blood Loss Section

Procedure Implants Section

Procedure Specimens Taken Section

Procedures Section (entries optional) (V2)

Procedures Section (entries required) (V2)

Reason for Visit Section

Results Section (entries optional) (V3)

Results Section (entries required) (V3)

Review of Systems Section

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

HL7 v2 integration with Aidbox Project

Mappings with lisp/mapping

X12 message converter

Analytics

Power BI

Mappings

Email Providers integration

Setup SMTP provider

SMARTbox | FHIR API for EHRs

Other modules

MDM

Train model

Configure MDM module

Find duplicates: $match

Mathematical details

## Storage

AidboxDB

HA AidboxDB

Migrate to AidboxDB 16

Database schema

PostgreSQL Extensions

Other

Aidbox & FHIR formats

Working with pgAgent

S3-compatible storages

AWS S3

GCP Cloud Storage

Azure Blob Storage

Oracle Cloud Storage

## Deployment and maintenance

Deploy Aidbox

Run Aidbox on Kubernetes

Deploy Production-ready Aidbox to Kubernetes

Deploy Aidbox with Helm Charts

Highly Available Aidbox

Self-signed SSL certificates

Run Aidbox on managed PostgreSQL

Backup and Restore

Crunchy Operator (pgBackRest)

pg\_dump

pg\_basebackup

WAL-G

Indexes

Get suggested indexes

Create indexes manually

## App development

Use Aidbox with React

Aidbox SDK

Aidbox JavaScript SDK

Apps

NodeJs SDK

Python SDK

SDK internals

Examples

## Reference

FHIR Schema reference

Settings reference

General

FHIR

Security & Access Control

Modules

Database

Web Server

Observability

Zen Project

Environment variables

Aidbox required environment variables

Optional environment variables

AidboxDB environment variables

Email Providers reference

Notification resource reference

Mailgun environment variables

Postmark environment variables

Aidbox Forms reference

Layout DSL (deprecated)

Document DSL (deprecated)

Launch DSL (deprecated)

Lisp (deprecated)

FinalizeConstraints DSL (deprecated)

Finalize DSL (deprecated)

Form DSL (deprecated)

Lisp API (deprecated)

Form API (deprecated)

Workflow API (deprecated)

Addendum API (deprecated)

FHIR SDC API

Aidbox SDC API

Generating Questionnaire from PDF API

Aidbox SQL functions

## Deprecated

Deprecated

Zen-related

RPC reference

aidbox

mdm

aidbox.mdm/update-mdm-tables

aidbox.mdm/match

FTR

Aidbox configuration project

Run Aidbox locally using Aidbox Configuraiton project

Aidbox configuration project structure

Set up and use configuration projects

Enable IGs

Repository

Seed Import

Manage Indexes in Zen Project

Seed v2

🎓 Migrate to git Aidbox Configuration Projects

Aidbox Configuration project reference

Zen Configuration

Aidbox project RPC reference

aidbox.config/config

Custom resources using Aidbox Project

First-Class Extensions using Zen

Zen Indexes

US Core IG

US Core IG support reference

Workflow Engine

Task

Aidbox Built-in Tasks

Task Executor API

Task User API

Workflow

Workflow User API

Services

Monitoring

FHIR conformance Deprecated guides

Touchstone FHIR 4.0.1 basic server

Touchstone FHIR USCore ClinData

How to enable US Core IG

Start Aidbox locally with US Core IG enabled

Add US Core IG to a running Aidbox instance

HL7 FHIR Da Vinci PDex Plan Net IG

Terminology Deprecated Tutorials

Inferno Test-Suite US Core 3.1.1

API constructor (beta)

zen-lang validator

Write a custom zen profile

🎓 Load zen profiles into Aidbox

FHIR topic-based subscriptions

Set up SubscriptionTopic

Tutorial: Subscribe to Topic (R4B)

API Reference

SubscriptionTopic API

Subscription API

🏗️ 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

Import via FTR

Zen Search Parameters

Entity / Attribute

Entities & Attributes

First-Class Extensions using Attribute

Custom Resources using Entity

Working with Extensions

Aidbox Search Parameters

Other

Custom Search

Subscribe to new Patient resource

App Development Deprecated Tutorials

Receive logs from your app

X-Audit header

Working with Aidbox from .NET

Patient Encounter notification Application

Other Deprecated Tutorials

Resource generation with map-to-fhir-bundle-task and subscription triggers

APM Aidbox

License migration guide

Automatically archive AuditEvent resources in GCP storage guide

HL7 v2 pipeline with Patient mapping

How to migrate to Apline Linux

How to migrate transaction id to bigint

How to fix broken dates

Configure multi-tenancy

AidboxProfile

GCP Pub/Sub

Define extensions