51.0.1Table of Contents

 

This online document contains instructions for how to install Smile CDR, how to plan and execute a deployment that meets your specific needs, how to manage and maintain that deployment, and how to keep it healthy.

If this is your first time reading these documents, we highly recommend you start by reading the Basic Concepts page.


0.0.0 Quick Start
0.0.0 Quick Installation
0.0.1 Installing Smile CDR
0.0.2 Installing to Linux / OSX
0.0.3 Basic Configuration
0.0.4 Quick Start
0.1.0 Populating Sample Data
0.1.1 Populating Sample Data
1.0.0 Product Overview
1.0.0 Smile CDR Maturity Model
1.0.1 Smile CDR Maturity Model
1.0.2 List of Levels
1.0.3 Stable Features
1.0.4 Experimental Features
1.0.5 Trial Features
1.0.6 Deprecated Features
1.1.0 Smile CDR Premium Solutions
1.1.1 Smile CDR Premium Solutions
1.2.0 List of Features by Maturity
1.2.1 List of Features by Maturity
1.2.2 Experimental Features
1.2.3 Trial Features
1.2.4 Deprecated Features
1.2.5 Removed Features
1.3.0 FHIR Certification
1.3.1 FHIR Certification
2.0.0 Product Concepts
2.0.0 Node and Module Framework
2.0.1 Smile HDP Node and Module Framework
2.0.2 Nodes and Modules
2.0.3 The Cluster Manager Module
2.0.4 Module Dependencies
2.1.0 Endpoint and Storage Modules
2.1.1 Concepts in Smile CDR
2.1.2 The FHIR Storage Module
2.1.3 The FHIR REST Endpoint Module
2.1.4 Clustering
2.2.0 Security in Smile CDR
2.2.1 Security in Smile CDR
2.2.2 Inbound Security Module
2.2.3 FHIR Listener Module
2.2.4 Admin Modules
2.2.5 Auth Directory
2.2.6 Audit Database
2.2.7 Outbound Security Modules
3.0.0 The FHIR Standard
3.0.0 FHIR Introduction
3.0.1 FHIR Introduction
3.0.2 Resources
3.0.3 Datatypes
3.0.4 Parts of a Resource
3.0.5 Encodings (MIME Types, Wire Formats)
3.0.6 The JSON Format
3.0.7 The XML Format
3.1.0 FHIR Versions
3.1.1 FHIR versions
3.2.0 FHIR CRUD Operations
3.2.1 FHIR CRUD Operations
3.2.2 Testing Tools
3.2.3 FHIR Create
3.2.4 FHIR Read / vRead
3.2.5 FHIR Update
3.2.6 FHIR Patch
3.2.7 FHIR Delete
3.2.8 Controlling the Response Payload
3.2.9 Storage Outcome Status Codes
3.3.0 FHIR Searching Basics
3.3.1 FHIR Searching Basics
3.3.2 How Searching Works
3.3.3 Basic Searching: Finding Patients
3.3.4 Quantities: Finding Laboratory Values
3.3.5 Dates and Times: Narrowing Your Search Window
3.3.6 Paging Search Results
3.3.7 Sorting Search Results
3.3.8 Fulltext Searching
3.3.9 The Patient $everything Search (Across Patient Chart)
3.4.0 FHIR Search: References and Includes
3.4.1 FHIR Search: References and Includes
3.4.2 References Example
3.4.3 Searching By Reference
3.4.4 Chained References
3.4.5 Reverse Chained References
3.4.6 Including Reference Targets
3.4.7 Reverse Includes
3.4.8 Chaining into Contained Resources
3.4.9 Canonical References
3.4.10 Example: Using subject Group Membership to Filter Results
3.4.11 REST Operation: $hapi.fhir.replace-references
3.5.0 FHIR Search: Custom Search Parameters
3.5.1 FHIR Search: Custom Search Parameters
3.5.2 An Example Search Parameter
3.5.3 Search Parameter Expressions
3.5.4 Introducing Search Parameters on Existing Data
3.6.0 FHIR Search: Combo Search Parameters
3.6.1 Combo Search Index Parameters
3.6.2 Composite vs Combo Search Index Parameters
3.6.3 Example
3.6.4 Support for Component Types
3.7.0 FHIR Search: Enforcing Uniqueness
3.7.1 Enforcing Uniqueness in FHIR Data
3.7.2 Unique Combo Search Index Parameters
3.8.0 FHIR Transactions and Batches
3.8.1 FHIR Transactions and Batches
3.8.2 FHIR Transaction
3.8.3 Creating Multiple Related Resources
3.8.4 Placeholder IDs and References
3.8.5 Conditional Creates
3.8.6 Conditional Updates
3.8.7 Example: Conditional Create Patient and Create Other Data
3.8.8 Deletes
3.8.9 Patching
3.8.10 Example: Conditional Create + Patch On Same Resource
3.8.11 FHIR Transaction Response
3.8.12 FHIR Batch
3.8.13 FHIR Batch Response
3.9.0 FHIRPath Expressions
3.9.1 FHIRPath Expressions
3.9.2 Testing FHIRPath Expressions
3.9.3 Expression: Extension With Reference Value
3.9.4 Expression: Nested Extension
3.9.5 Expression: Contained Resource
3.9.6 Expression: Bundle (FHIR Message) Entry Resource
3.9.7 Expression: Bundle (FHIR Document) Entry Resource
3.9.8 Example: Indexing Automatically Created Placeholder Resources
3.9.9 Expression: Multiple Paths
4.0.0 Installing
4.0.0 Platform Requirements
4.0.1 Platform Requirements
4.0.2 Server Requirements
4.0.3 Java Requirements
4.0.4 Database Requirements
4.0.5 Database Testing Matrix
4.0.6 Support for AWS Secrets Manager JDBC Connections
4.0.7 Network Infrastructure
4.0.8 Event Streaming
4.1.0 Preparing a Linux Host
4.1.1 Preparing a new Linux Host
4.1.2 Ubuntu Host with PostgreSQL / NGINX / Letsencrypt
4.1.3 Install letsencrypt and obtain Certs (optional)
4.1.4 Install nginx And Configure it to Front the Server
4.1.5 Red Hat Enterprise Linux (RHEL) or CentOS
4.2.0 Installing Smile CDR, NGINX and PostgreSQL in a Docker Stack
4.2.1 Installing Smile CDR, NGINX and PostgreSQL as a Docker Stack
4.2.2 Initial Setup of Docker and Context
4.2.3 Prepare Configuration for Smile CDR Docker Service
4.2.4 Prepare Configuration for NGINX Docker Service
4.2.5 Prepare Configuration for PostgreSQL Docker Service
4.2.6 Create Docker compose file for Smile CDR Docker stack
4.2.7 Build and Launch Smile CDR Stack
4.3.0 Deploying a Kubernetes Managed Cluster
4.3.1 Deploying a Kubernetes Managed Cluster
4.3.2 Overview of Smile CDR Kubernetes Deployment Process
4.3.3 Pre-requisite Steps
4.3.4 Configuring Kubernetes
4.3.5 Kubernetes and Smile CDR Database Connections
4.3.6 Service Definitions
4.3.7 ConfigMap Definitions
4.3.8 Deployment Definitions
4.3.9 Deploying Smile CDR in a Kubernetes Cluster
4.3.10 Configuring Reverse Proxy and Load Balancer
4.3.11 Considerations When Deploying Smile CDR Using OpenShift
4.4.0 Docker Container Installation
4.4.1 Docker Container Installation
4.4.2 Quick Start
4.4.3 Basic Configuration
4.4.4 Customizing Smile CDR in Docker Container
4.4.5 Using System Environment for Variable Substitution
4.4.6 Configuring Databases for Smile CDR Installed in Container
4.5.0 Configuring Smile CDR
4.5.1 Configuring Smile CDR
4.5.2 The Initial Configuration
4.5.3 The Node Configuration Properties File
4.5.4 Node Configuration Properties
4.5.5 Module Property Source
4.5.6 Maintaining Module Configuration
4.5.7 Variable Substitution
4.5.8 Fetching Configuration Using Scripts
4.5.9 Configuring Your Database
4.5.10 Starting the CDR
4.5.11 API Gateways
4.5.12 Resource Paths
4.6.0 Unix Service Installation
4.6.1 Unix Service Installation
4.6.2 Testing the Service
4.6.3 Starting Automatically on Boot
4.7.0 Tuning your Installation
4.7.1 Tuning Your Installation
4.7.2 Memory Settings
4.8.0 Designing a Cluster
4.8.1 Designing a Cluster
4.8.2 Node and Module Design
4.8.3 Process IDs
4.8.4 Adding and Removing Processes
4.8.5 Multi-Node Clusters
4.8.6 Sample Architecture
4.9.0 Message Brokers
4.9.1 Message Brokers
4.9.2 Subscription Channels
4.9.3 Subscription Channel Names
4.9.4 Modules Dependent On Message Brokers
4.9.5 Sending your own messages to Message Brokers
4.10.0 Message Broker Failure Management
4.10.1 Message Broker Failure Management
4.11.0 Message Broker: Kafka
4.11.1 Message Broker: Kafka
4.11.2 Kafka Topic Names
4.11.3 Kafka - Overriding Default Configuration Settings
4.12.0 Message Broker: ActiveMQ
4.12.1 Message Broker: ActiveMQ
4.12.2 Resource Limits
4.13.0 Pre-Seeding Configuration and Data
4.13.1 Pre-Seeding Configuration and Data
4.13.2 Pre-Seeding Module Configuration
4.13.3 Variable Substitution for Pre-Seeding files
4.13.4 Pre-Seeding Users
4.13.5 Pre-Seeding OpenID Connect Servers
4.13.6 Pre-Seeding OpenID Connect Clients
4.13.7 Pre-Seeding OpenID Connect Keystores
4.13.8 Pre-Seeding Packages
4.13.9 Pre-Seeding FHIR Resources
4.14.0 Production Checklist
4.14.1 Production Checklist
4.14.2 Host Server Setup
4.14.3 Network Infrastructure
4.14.4 CDR Process Settings
4.14.5 FHIR Server Performance
4.14.6 Monitoring
4.14.7 Security
4.14.8 Message Broker
4.14.9 Cluster Design
4.15.0 Module Licensing
4.15.1 Module Licensing
5.0.0 Upgrading
5.0.0 Upgrading Smile CDR
5.0.1 Upgrading an Existing Installation
5.0.2 Simple Upgrade Process - Upgrading the Binary on a Single Server
5.0.3 Upgrade Docker Container as Non-root
5.0.4 Upgrading a Cluster of Servers with Zero Downtime
5.0.5 Subscriptions
5.0.6 Migrate smilecdr command
5.0.7 Recommended Upgrade Strategy
5.0.8 Database Upgrade Impact
5.1.0 Migration To 2020.02
5.1.1 Migration from 2019.11 (and Below) to 2020.02
5.1.2 Migrating Existing Clusters
6.0.0 Operating
6.0.0 Monitoring Basics
6.0.1 Monitoring Basics
6.0.2 HTTP Endpoint Health Check
6.0.3 Runtime Health Checks
6.1.0 Externalized Metrics
6.1.1 Externalized Metrics
6.1.2 Step 1 - Install Prometheus
6.1.3 Step 2 - Install Grafana
6.1.4 Step 3 - Creating a Prometheus data source on Grafana
6.1.5 Step 4 - Configure Smile CDR
6.1.6 Step 5 - Creating a Grafana Dashboard  
6.2.0 OpenTelemetry Integration
6.2.1 OpenTelemetry Integration
6.2.2 Observability Backends
6.2.3 Enabling OpenTelemetry Instrumentation in Smile CDR
6.2.4 Agent Configuration
6.2.5 Enabling/Disabling Exported Data
6.2.6 Correlating Logs and Traces
6.2.7 Vendor specific OpenTelemetry tools and agents
6.2.8 Custom Telemetry Data Provided by Smile CDR
6.3.0 Performance Tuning
6.3.1 Performance Tuning for FHIR Storage (Relational)
6.3.2 Improving Write Performance
6.3.3 Example Properties File
6.3.4 Disabling Non Resource DB History
6.3.5 Enabling Index Storage Optimization
6.4.0 Troubleshooting
6.4.1 Troubleshooting Smile CDR
7.0.0 Database Administration
7.0.0 Database Design
7.0.1 Database Design
7.0.2 Cluster Manager Database
7.0.3 FHIR Relational Storage
7.0.4 FHIR MongoDB (Non-Relational) Storage
7.1.0 Database Connection Pool
7.1.1 Database Connection Pool
7.2.0 Setting Up PostgreSQL
7.2.1 Setting Up PostgreSQL
7.2.2 Supported Versions
7.2.3 Creating a Database for Smile CDR
7.2.4 Database Connection Properties
7.2.5 Cluster Manager Database
7.2.6 FHIR Storage Database
7.2.7 FHIR Storage Database: Standard
7.2.8 FHIR Storage Database: Database Partition Mode
7.2.9 FHIR Storage Database: 5 Hash Partition
7.3.0 Troubleshooting PostgreSQL
7.3.1 Troubleshooting Postgresql
7.3.2 Host Name Verification Error
7.3.3 Network Timeouts
7.4.0 Setting Up MySQL
7.4.1 Setting Up MySQL
7.4.2 Supported Versions
7.4.3 Creating a Database for Smile CDR
7.4.4 Database Connection Properties
7.4.5 Setting up a Cluster Manager Database
7.4.6 Setting up a FHIR Storage (Relational) Database
7.5.0 Setting Up MariaDB
7.5.1 Setting Up MariaDB
7.5.2 Supported Versions
7.5.3 Creating a Database for Smile CDR
7.5.4 Database Connection Properties
7.5.5 Setting up a Cluster Manager Database
7.5.6 Setting up a FHIR Storage (Relational) Database
7.6.0 Setting Up Oracle
7.6.1 Setting Up Oracle
7.6.2 Supported Versions
7.6.3 Setting up a Cluster Manager Database
7.6.4 Setting up a FHIR Storage (Relational) Database
7.7.0 Setting Up SQL Server (MSSQL)
7.7.1 Setting Up SQL Server (MSSQL)
7.7.2 Supported Versions
7.7.3 Creating a Database for Smile CDR
7.7.4 Preparing an SQL Server Database for Smile CDR
7.7.5 Database Connection Properties
7.7.6 Setting up a Cluster Manager Database
7.7.7 Setting up a FHIR Storage (Relational) Database
7.7.8 Troubleshooting
7.8.0 AWS IAM Authentication
7.8.1 AWS IAM Authentication
8.0.0 Tutorials
8.0.0 Introduction
8.0.1 Smile CDR Tutorials
8.0.2 Identify your Setup
8.1.0 HL7 v2.x Ingestion Tutorial
8.1.1 HL7 v2.x Ingestion Tutorial
8.1.2 Transmitting to Smile CDR
8.1.3 ORU (Observation Result) Messages
8.1.4 ADT (Admission/Discharge/Transfer) Messages
8.2.0 Federated OAuth2/OIDC Tutorial
8.2.1 Federated OAuth2/OIDC Tutorial
8.2.2 Setting up Smile CDR - SMART Outbound Security Module
8.2.3 Setting up Smile CDR - OIDC Client Definition
8.2.4 Setting up Smile CDR - OIDC Server Definition
8.2.5 Setting up the IDP
8.2.6 Starting the Federated Flow
8.2.7 Token Signature Algorithms
8.2.8 Considerations
8.3.0 MDM Tutorial
8.3.1 Smile CDR MDM Tutorial
9.0.0 Changelog
9.0.0 Changelog (2024 Releases)
9.0.1 Changelog: 2024
9.0.2 Smile CDR 2025.02.R01 (TBD)
9.0.3 Smile CDR 2024.11.R03 (Despina)
9.0.4 Smile CDR 2024.11.R02 (Despina)
9.0.5 Smile CDR 2024.11.R01 (Despina)
9.0.6 Smile CDR 2024.08.R05 (Copernicus)
9.0.7 Smile CDR 2024.08.R04 (Copernicus)
9.0.8 Smile CDR 2024.08.R03 (Copernicus)
9.0.9 Smile CDR 2024.08.R02 (Copernicus)
9.0.10 Smile CDR 2024.08.R01 (Copernicus)
9.0.11 Smile CDR 2024.05.R05 (Borealis)
9.0.12 Smile CDR 2024.05.R04 (Borealis)
9.0.13 Smile CDR 2024.05.R03 (Borealis)
9.0.14 Smile CDR 2024.05.R02 (Borealis)
9.0.15 Smile CDR 2024.05.R01 (Borealis)
9.0.16 Smile CDR 2024.02.R07 (Apollo)
9.0.17 Smile CDR 2024.02.R04 (Apollo)
9.0.18 Smile CDR 2024.02.R03 (Apollo)
9.0.19 Smile CDR 2024.02.R02 (Apollo)
9.0.20 Smile CDR 2024.02.R01 (Apollo)
9.0.21 Smile CDR 2023.11.R05 (Zed)
9.0.22 Smile CDR 2023.11.R04 (Zed)
9.0.23 Smile CDR 2023.08.R09 (Yucatán)
9.1.0 Changelog (2023 Releases)
9.1.1 Changelog: 2023
9.1.2 Smile CDR 2023.11.R03 (Zed)
9.1.3 Smile CDR 2023.11.R02 (Zed)
9.1.4 Smile CDR 2023.11.R01 (Zed)
9.1.5 Smile CDR 2023.08.R08 (Yucatán)
9.1.6 Smile CDR 2023.08.R07 (Yucatán)
9.1.7 Smile CDR 2023.08.R06 (Yucatán)
9.1.8 Smile CDR 2023.08.R05 (Yucatán)
9.1.9 Smile CDR 2023.08.R04 (Yucatán)
9.1.10 Smile CDR 2023.08.R03 (Yucatán)
9.1.11 Smile CDR 2023.08.R02 (Yucatán)
9.1.12 Smile CDR 2023.08.R01 (Yucatán)
9.1.13 Smile CDR 2023.05.R03 (Xenon)
9.1.14 Smile CDR 2023.05.R02 (Xenon)
9.1.15 Smile CDR 2023.05.R01 (Xenon)
9.1.16 Smile CDR 2023.02.R07 (Wizard)
9.1.17 Smile CDR 2023.02.R06 (Wizard)
9.1.18 Smile CDR 2023.02.R05 (Wizard)
9.1.19 Smile CDR 2023.02.R04 (Wizard)
9.1.20 Smile CDR 2023.02.R03 (Wizard)
9.1.21 Smile CDR 2023.02.R02 (Wizard)
9.1.22 Smile CDR 2023.02.R01 (Wizard)
9.1.23 Smile CDR 2022.11.R05 (Vishwa)
9.1.24 Smile CDR 2022.11.R04 (Vishwa)
9.1.25 Smile CDR 2022.11.R03 (Vishwa)
9.2.0 Changelog (2022 Releases)
9.2.1 Changelog: 2022
9.2.2 Smile CDR 2022.11.R02 (Vishwa)
9.2.3 Smile CDR 2022.11.R01 (Vishwa)
9.2.4 Smile CDR 2022.08.R05 (Unicorn)
9.2.5 Smile CDR 2022.08.R04 (Unicorn)
9.2.6 Smile CDR 2022.08.R03 (Unicorn)
9.2.7 Smile CDR 2022.08.R02 (Unicorn)
9.2.8 Smile CDR 2022.08.R01 (Unicorn)
9.2.9 Smile CDR 2022.05.R07 (Tanuki)
9.2.10 Smile CDR 2022.05.R06 (Tanuki)
9.2.11 Smile CDR 2022.05.R05 (Tanuki)
9.2.12 Smile CDR 2022.05.R04 (Tanuki)
9.2.13 Smile CDR 2022.05.R03 (Tanuki)
9.2.14 Smile CDR 2022.05.R02 (Tanuki)
9.2.15 Smile CDR 2022.05.R01 (Tanuki)
9.2.16 Smile CDR 2022.02.R08 (Sojourner)
9.2.17 Smile CDR 2022.02.R07 (Sojourner)
9.2.18 Smile CDR 2022.02.R06 (Sojourner)
9.2.19 Smile CDR 2022.02.R05 (Sojourner)
9.2.20 Smile CDR 2022.02.R04 (Sojourner)
9.2.21 Smile CDR 2022.02.R03 (Sojourner)
9.2.22 Smile CDR 2022.02.R02 (Sojourner)
9.2.23 Smile CDR 2022.02.R01 (Sojourner)
9.2.24 Smile CDR 2021.11.R07 (Raccoon)
9.2.25 Smile CDR 2021.11.R06 (Raccoon)
9.2.26 Smile CDR 2021.11.R05 (Raccoon)
9.2.27 Smile CDR 2021.11.R04 (Raccoon)
9.2.28 Smile CDR 2021.08.R09 (Quasar)
9.2.29 Smile CDR 2021.08.R08 (Quasar)
9.3.0 Changelog (2021 Releases)
9.3.1 Changelog: 2021
9.3.2 Smile CDR 2021.11.R03 (Raccoon)
9.3.3 Smile CDR 2021.11.R02 (Raccoon)
9.3.4 Smile CDR 2021.11.R01 (Raccoon)
9.3.5 Smile CDR 2021.08.R06 (Quasar)
9.3.6 Smile CDR 2021.08.R05 (Quasar)
9.3.7 Smile CDR 2021.08.R04 (Quasar)
9.3.8 Smile CDR 2021.08.R03 (Quasar)
9.3.9 Smile CDR 2021.08.R02 (Quasar)
9.3.10 Smile CDR 2021.08.R01 (Quasar)
9.3.11 Smile CDR 2021.05.R03 (Pangolin)
9.3.12 Smile CDR 2021.05.R02 (Pangolin)
9.3.13 Smile CDR 2021.05.R01 (Pangolin)
9.3.14 Smile CDR 2021.02.R05 (Odyssey)
9.3.15 Smile CDR 2021.02.R04 (Odyssey)
9.3.16 Smile CDR 2021.02.R03 (Odyssey)
9.3.17 Smile CDR 2021.02.R02 (Odyssey)
9.3.18 Smile CDR 2021.02.R01 (Odyssey)
9.3.19 Smile CDR 2020.11.R02 (Numbat)
9.4.0 Changelog (2020 Releases)
9.4.1 Changelog: 2020
9.4.2 Smile CDR 2020.11.R01 (Numbat)
9.4.3 Smile CDR 2020.08.R03 (Manticore)
9.4.4 Smile CDR 2020.08.R02 (Manticore)
9.4.5 Smile CDR 2020.08.R01 (Manticore)
9.4.6 Smile CDR 2020.05.R02 (Labrador)
9.4.7 Smile CDR 2020.05.R01 (Labrador)
9.4.8 Smile CDR 2020.02.R01 (Koala)
9.5.0 Changelog (2019 Releases)
9.5.1 Changelog: 2019
9.5.2 Smile CDR 2019.11.R01 (Jitterbug)
9.5.3 Smile CDR 2019.08.R01 (Igloo)
9.5.4 Smile CDR 2019.05.R02 (Hippo)
9.5.5 Smile CDR 2019.05.R01 (Hippo)
9.5.6 Smile CDR 2019.02.R01 (Gale)
9.6.0 Changelog (2018 Releases)
9.6.1 Changelog: 2018
9.6.2 Smile CDR 2018.11.R01 (Food)
9.6.3 Smile CDR 2018.09.R01 (Economist)
9.6.4 Smile CDR 2018.05.R01 (Dromedário)
9.6.5 Smile CDR 2018.03.R01 (Crouton)
9.7.0 Changelog (2017 Releases)
9.7.1 Changelog: 2017
9.7.2 Smile CDR 2017.11.R01 (Buccaneer)
9.7.3 Smile CDR 2017.09.R01 (Aardvark)
9.7.4 Smile CDR 2017.07.R01
10.0.0 FHIR Storage
10.0.0 FHIR Storage Modules
10.0.1 FHIR Storage Modules
10.0.2 Feature Comparison Summary
10.0.3 Features
10.0.4 FHIR Operations
10.0.5 Search Parameters
10.0.6 Search Parameter Types
10.1.0 FHIR Endpoint Module
10.1.1 FHIR Endpoint Module
10.1.2 Creating the Module
10.1.3 Request Transaction IDs
10.1.4 Capturing Source Information
10.1.5 Response Watermarking
10.1.6 Validation
10.1.7 Configuration
10.2.0 FHIRWeb Console
10.2.1 FHIRWeb Console
10.2.2 Architecture
10.2.3 Security
10.2.4 Creating the Module
10.2.5 Using the Console
10.2.6 Configuration
10.3.0 OpenAPI / Swagger Support
10.3.1 OpenAPI / Swagger Support
10.3.2 Swagger UI
10.3.3 OpenID Connect Support
10.3.4 Limitations
10.4.0 FHIR Endpoint Customization
10.4.1 FHIR Endpoint Customization
10.4.2 Customizing Available Interactions
10.4.3 Customizing CapabilityStatement and OpenApi
10.5.0 Resource IDs
10.5.1 Resource IDs
10.5.2 Server Assigned IDs
10.5.3 Client Assigned IDs
10.6.0 Search Parameters
10.6.1 Search Parameters
10.6.2 Search Parameter Concepts
10.6.3 Default Search Parameters
10.6.4 Managing Search Parameters
10.6.5 Search Parameter Statistics
10.6.6 Filter Search Parameter
10.7.0 Search Parameter Features
10.7.1 Search Parameter Features
10.7.2 Searching by English nickname (:nickname)
10.7.3 Index Missing Search Parameters (:missing)
10.7.4 Suppress Text Index on Tokens (:text)
10.7.5 Index Contained Resources
10.8.0 Phonetic Search Parameters
10.8.1 Phonetic Search Parameters
10.9.0 Search Parameter Tuning
10.9.1 Search Parameter Initialization
10.9.2 Checking Active Parameters
10.9.3 Seeding Search Parameters
10.10.0 Search Parameter Reindexing
10.10.1 Manual Reindexing
10.10.2 $reindex Operation (Server)
10.10.3 $reindex Operation (Instance)
10.10.4 $reindex-dryrun Operation (Instance)
10.10.5 Legacy Manual Reindex Operation
10.11.0 Searching for Data
10.11.1 Searching For Data
10.11.2 FHIR Search Extensions
10.11.3 Unsupported Search Parameters
10.11.4 Limitations
10.12.0 Creating Data
10.12.1 Creating Data
10.12.2 Validating References and Referential Integrity
10.12.3 Transactions and Submitting Bundles
10.12.4 Auto-Creating Reference Targets
10.12.5 Auto-Create Placeholder Reference Targets
10.12.6 Auto-Create Placeholder Reference Targets with Identifier
10.12.7 Auto-Created Placeholder Extension
10.12.8 Searching for Auto-Created Resources
10.12.9 Auto-Creating Reference Targets and Enforcing Uniqueness
10.12.10 Mass Ingestion Mode
10.13.0 Reading Data
10.13.1 Reading Data
10.13.2 Diff Operation
10.13.3 Diff Instance
10.13.4 Diff Type
10.13.5 $everything operation
10.14.0 Updating Data
10.14.1 Updating Data
10.14.2 Patching Data
10.14.3 Tag Retention
10.14.4 Concurrent Write Errors
10.15.0 Deleting Data
10.15.1 Deleting Data
10.15.2 Deletes and Referential Integrity
10.15.3 Transactional Delete
10.15.4 Referential Integrity
10.15.5 Cascading Deletes
10.15.6 The $expunge Operation
10.15.7 Delete Expunge
10.16.0 Binary Data
10.16.1 Binary Data
10.16.2 Externalized Binary Storage
10.16.3 Binary Access Operations
10.16.4 Serving Raw Media Resources
10.16.5 Serving binary data within a FHIR Resource
10.17.0 Working with Duplicates
10.17.1 Working with Duplicates
10.18.0 Request Tracing and Provenance
10.18.1 Request Tracing and Provenance
10.18.2 Request Tracing
10.18.3 Performance Tracing
10.18.4 Storing Source Information
10.19.0 Resource Versions and Versioned References
10.19.1 Resource Versions
10.19.2 Disabling Resource History
10.19.3 Rewriting Resource History
10.19.4 Versioned Resource References
10.19.5 Allow Versioned References
10.19.6 Automatically Version References
10.20.0 Tags, Profiles, and Security Labels
10.20.1 Tags, Profiles and Security Labels
10.20.2 Search Parameters
10.21.0 Partitioning and Multitenancy
10.21.1 Partitioning and Multitenancy
10.21.2 Storage Module Support
10.21.3 Enabling Partitioning in Smile CDR
10.21.4 Request Partition Selection Mode
10.21.5 Request Partition Security
10.21.6 Tenant Identification Strategies
10.21.7 Seeding Partitions
10.21.8 Patient ID Partition Mode
10.21.9 Cross-Partition References
10.21.10 Disabling Partition Security
10.21.11 Supported Modules
10.22.0 Custom Resource Types
10.22.1 Custom Resource Types
10.22.2 Defining Custom Resource Type Classes
10.22.3 Example Project
10.22.4 Search Parameters
10.23.0 Batch and Scheduled Jobs
10.23.1 Batch And Scheduled Jobs
10.23.2 Batch Jobs
10.23.3 Architecture
10.23.4 Optimizing Batch Job Performance
10.23.5 Clustered Scheduled Jobs
10.23.6 Local Scheduled Jobs
10.23.7 Scheduler Performance
11.0.0 FHIR Storage (Relational)
11.0.0 FHIR Storage (Relational) Module
11.0.1 FHIR Storage (Relational) Module
11.0.2 Preparing for a New Installation
11.0.3 Creating the Module
11.0.4 Database Schema
11.0.5 Multi-Node Architectures
11.0.6 Configuration
11.0.7 Full-Text Indexing Configuration
11.1.0 Resource Storage Mode
11.1.1 Resource Storage Mode
11.1.2 Resource Body Storage
11.2.0 Full-Text Indexing
11.2.1 Full-Text Indexing
11.2.2 Indexes
11.2.3 Full-Text Providers
11.2.4 Lucene Disk Provider
11.2.5 Elasticsearch/OpenSearch Provider
11.3.0 Performance and Caching
11.3.1 FHIR Performance and Caching
11.3.2 The Query Cache
11.3.3 Search Counts
11.4.0 Chained Searching and Sorting
11.4.1 Chained Searching And Sorting
11.4.2 Uplifted Refchains and Chaining Performance
11.4.3 Document and Message Search Parameters
11.4.4 Chained Sorting
11.5.0 MegaScale
11.5.1 MegaScale
11.5.2 Architecture
11.5.3 Limitations
11.5.4 Configuration
11.5.5 Connection Provider Interceptor
11.6.0 Meta Source Migration
11.6.1 Resource Meta Source Migration
11.7.0 Database Partition Mode
11.7.1 Database Partition Mode
11.7.2 Support
11.7.3 Citus Data Support
12.0.0 FHIR Storage (MongoDB)
12.0.0 FHIR Storage (MongoDB) Module
12.0.1 FHIR Storage (MongoDB) Module
12.0.2 Preparing for a New Installation
12.0.3 Creating the Module
12.0.4 MongoDB Document Schema
12.0.5 MongoDB Uplift Search Parameter Extensions
12.0.6 Uplifting Tokens
12.0.7 Uplifting Reference Chains
12.0.8 Configuration
12.1.0 MongoDB Sharding / Partitioning
12.1.1 Sharding / Partitioning on MongoDB
12.1.2 Scope and Limitations
12.1.3 Enabling Sharding
12.1.4 Architecture
13.0.0 Validation and Conformance
13.0.0 Introduction
13.0.1 Validation
13.0.2 Validation Modes
13.1.0 Validation Support Repository
13.1.1 Validation Support Repository
13.1.2 Potential Architectures
13.1.3 Single FHIR Repository (RDBMS)
13.1.4 Dedicated Validation Support Repository
13.1.5 Non-Repository Models
13.2.0 Validation Support Repository Options
13.2.1 Validation Support Repository Options
13.2.2 Validating References
13.2.3 Handling Missing CodeSystems
13.2.4 Handling Multiple Codings
13.2.5 Code Display Mismatch Policy
13.2.6 Validation Support Cache
13.3.0 Conformance Data
13.3.1 Conformance Data
13.3.2 StructureDefinition resources
13.3.3 CodeSystem Resources
13.3.4 ValueSet Resources
13.4.0 Repository Validation
13.4.1 Repository Validation
13.4.2 Validation Support Repository
13.4.3 Methods
13.5.0 Repository Validation: Java
13.5.1 Java Based Repository Validation
13.6.0 Repository Validation: Javascript
13.6.1 JavaScript Based Repository Validation
13.6.2 Function: repositoryValidationProvideRules(theRuleBuilder)
13.6.3 Example: Require a Specific Profile
13.6.4 Example: Allow Several Profiles for a Resource Type
13.6.5 Example: Require Profile and Validate
13.7.0 Repository Validation: Validation Bean
13.7.1 Java Repository Validation Bean
13.8.0 Endpoint Validation
13.8.1 Endpoint Validation
13.9.0 Packages and Implementation Guides
13.9.1 Packages and Implementation Guides
13.9.2 Background: Implementation Guides
13.9.3 Background: Packages
13.9.4 Ingesting Packages into Smile CDR
13.9.5 Package Pre-Seed Installation
13.9.6 Pre-Seeding Resources into the Repository
13.9.7 Creating Packages
13.10.0 Package Registry Endpoint Module
13.10.1 Package Registry Endpoint module
13.10.2 Swagger UI
13.10.3 Operation: Fetch Metadata By Package ID
13.10.4 Operation: Fetch Package
13.10.5 Operation: Search For Packages
13.10.6 Operation: Install By Param
13.10.7 Operation: Install By Spec
13.10.8 Operation: Delete By Spec
13.11.0 Remote Terminology Services
13.11.1 Remote Terminology Service
13.11.2 Scope
13.11.3 Remote Terminology Server Requirements
13.11.4 Remote Terminology Server Authentication
13.12.0 Suppressing Messages
13.12.1 Suppressing Validation Messages
13.13.0 Validation Performance
13.13.1 Validation Performance
13.14.0 Automatic Provenance Injection
13.14.1 Automatic Provenance Injection
13.14.2 Provenance Injection Feature
13.14.3 Provenance Injection Data
14.0.0 Terminology
14.0.0 Terminology Introduction
14.0.1 Terminology
14.0.2 Unsupported Operations
14.1.0 Uploading Codes
14.1.1 Uploading CodeSystems
14.1.2 Uploading External CodeSystems
14.1.3 Uploading ICD-10-CM
14.1.4 Uploading LOINC
14.1.5 Uploading SNOMED CT
14.1.6 Uploading Custom Vocabularies
14.1.7 Applying Deltas to External CodeSystems
14.1.8 Delta Add Operation: $apply-codesystem-delta-add
14.1.9 Delta Remove Operation: $apply-codesystem-delta-remove
14.1.10 Reference: CSV Vocabulary Input Files
14.2.0 Terminology and Full-Text Indexing
14.2.1 Terminology and Full-Text Indexing
14.3.0 ValueSet Expansion
14.3.1 ValueSet Expansion
14.3.2 ValueSet Expansion Pre-Calculation
14.3.3 Expanding Hierarchical CodeSystems and ValueSets
14.3.4 Searching for Codes
14.4.0 FHIR Response Terminology Mapping
14.4.1 FHIR Response Terminology Enhancement
14.4.2 Response Terminology Mapping
14.4.3 Response Coding Displays
15.0.0 Subscription
15.0.0 Introduction
15.0.1 Subscription
15.0.2 The Subscription Resource
15.0.3 Subscription Activation
15.0.4 Delivery Retry Handling
15.0.5 MultiTenancy and Subscriptions
15.0.6 Criteria
15.0.7 Synchronization of Subscription updates
15.0.8 Troubleshooting Subscriptions
15.1.0 Architecture
15.1.1 Smile CDR Subscription Architecture
15.1.2 Enabling and Configuring Subscription Processing
15.2.0 Channel Types
15.2.1 Channel Types
15.2.2 Channel Type: rest-hook
15.2.3 Channel Type: email
15.2.4 Channel Type: websocket
15.2.5 Channel Type: message
15.3.0 Delivery Options
15.3.1 Delivery Options
15.3.2 Payload Search Result Mode
15.3.3 Replication Mode
15.3.4 Strip Version IDs
15.3.5 Delivering Latest Version
15.3.6 Delivering Delete Events
15.3.7 Custom Delivery Class
15.3.8 Kafka Record Header Delivery
15.3.9 DEPRECATED: Delivery to Site-defined External Queue
15.4.0 Manual Triggering
15.4.1 Manually Triggering Subscriptions
15.5.0 Topic Subscriptions
15.5.1 Topic Subscriptions
16.0.0 Interceptors
16.0.0 Interceptors
16.0.1 Interceptors
16.0.2 HAPI FHIR and Smile CDR Pointcuts
16.0.3 Deploying Interceptors to Smile CDR Modules
16.0.4 Registering a Client Interceptor
16.0.5 Example Interceptors
16.1.0 Pointcuts
16.1.1 Pointcuts
16.2.0 Starter Project
16.2.1 Starter Project
16.3.0 Examples: FHIR Endpoints
16.3.1 FHIR Endpoint Examples
16.3.2 Example: Override CapabilityStatement Generation
16.3.3 Example: Starter Server interceptor for all SERVER_xxx pointcuts
16.4.0 Examples: HL7v2 Endpoints
16.4.1 HL7v2 Endpoint Examples
16.4.2 Example: Starter Server interceptor for all HL7v2 pointcuts
16.5.0 Examples: FHIR Storage
16.5.1 FHIR Storage Examples
16.5.2 Example: Response Attribute Enhancement
16.5.3 Example: Server-Reserved Tags
16.5.4 Example: JavaScript Storage Interceptor
16.5.5 Example: MegaScale Connection Provider
16.5.6 Example: Starter Storage interceptor for all STORAGE_xxx pointcuts
16.6.0 Examples: FHIR Gateway
16.6.1 FHIR Gateway Examples
16.6.2 Pointcuts
16.6.3 Example: Direct Search based on Parameter Value
16.6.4 Example: Modify Target Search based on Previous Target Search
16.6.5 Example: Modify Target Search Results
16.6.6 Example: Modify Target Search Uri
16.6.7 Example: Search Using Alternate Patient ID
16.6.8 Example: Starter Gateway interceptor for all FHIRGW_xxx pointcuts
16.7.0 Examples: FHIR Client
16.7.1 FHIR Client interceptor Examples
16.7.2 Example: Starter Client interceptor for all CLIENT_xxx pointcuts
16.8.0 Examples: MDM
16.8.1 MDM Examples
16.8.2 Example: Operate on resources analyzed by MDM, before and after analysis
16.8.3 Example: Starter MDM interceptor for all MDM_xxx pointcuts
16.9.0 Examples: Subscription
16.9.1 Subscription Examples
16.9.2 Example: Adding Authorization header
16.9.3 Example: Starter Subscription interceptor for all SUBSCRIPTION_xxx pointcuts
16.10.0 Examples: Channel Import
16.10.1 Channel Import Examples
16.10.2 Example: Starter Channel Import interceptor for CHANNEL_IMPORT_MESSAGE_PRE_PROCESSED pointcut
16.11.0 Examples: Cluster Manager
16.11.1 Cluster Manager Examples
16.11.2 Example: Starter Server interceptor for all appSphere Pointcuts
16.12.0 Examples: Prior Auth CRD
16.12.1 Prior Auth CRD Examples
16.12.2 Example: Starter Prior Auth CRD interceptor for PRIOR_AUTH_CRD_GATHER_CONTEXT pointcut
16.13.0 Examples: System To System Data Exchange
16.13.1 System-to-System Data Exchange Examples
16.13.2 Example: Custom Member Match
16.14.0 2024.02.01 Migration Guide
16.14.1 2024.02.R01 Interceptor Upgrade Guide
17.0.0 Channel Import
17.0.0 Channel Import Overview
17.0.1 Channel Import Overview
17.0.2 Enabling and Configuring Channel Import
17.0.3 Channel Import With Partitioning Enabled
18.0.0 Realtime Export
18.0.0 Realtime Export Overview
18.0.1 Realtime Export Overview
18.0.2 Operational Overview
18.0.3 Limitations
18.0.4 Troubleshooting
18.1.0 Realtime Export Rules Definition
18.1.1 Realtime Export Rules Definition
18.1.2 Transformers
18.1.3 Named Transformers
18.1.4 Managing high-cardinality elements
18.2.0 Using FHIRPath
18.2.1 Using FHIRPath
18.2.2 Collection Subsetting
18.2.3 Self-referral
18.2.4 Conditionals
19.0.0 Security
19.0.0 Authentication Protocols
19.0.1 Authentication Protocols
19.0.2 HTTP Basic
19.0.3 OpenID Connect (OIDC) and SMART on FHIR
19.0.4 Security Access Markup Language (SAML)
19.1.0 Authorization and Consent
19.1.1 Authorization and Consent
19.1.2 Authorization Service
19.1.3 Consent Service
19.2.0 Inbound Security Module
19.2.1 Inbound Security Module
19.2.2 Permissions
19.2.3 Callback Script
19.3.0 Local Inbound Security Module
19.3.1 Local Inbound Security Module
19.3.2 Configuration: Credentials
19.3.3 Caching
19.3.4 User Self Registration
19.4.0 LDAP Inbound Security Module
19.4.1 LDAP Inbound Security Module
19.4.2 Requirements
19.4.3 Permissions
19.4.4 Callback Scripts
19.4.5 Configuration
19.5.0 Scripted Inbound Security Module
19.5.1 Scripted Inbound Security
19.5.2 Script Format
19.5.3 Script Examples
19.6.0 SAML Inbound Security Module
19.6.1 SAML Inbound Security Module
19.6.2 SAML 2.0 Authentication Request Protocol
19.6.3 Enabling SAML Authentication
19.6.4 Entity ID Template
19.6.5 Authentication Scripts
19.6.6 Function: authenticate(theRequest, theOutcomeFactory)
19.6.7 Authorizing SMART on FHIR Apps using SAML
19.7.0 Trusted Client Mode
19.7.1 Trusted Client Mode
19.7.2 Configuring Trusted Client Mode
19.7.3 Making Trusted Client Requests
19.7.4 Automatically Creating Users
19.8.0 Roles and Permissions
19.8.1 Roles and Permissions
19.8.2 System-Defined Roles
19.8.3 System-Defined Permissions
19.8.4 System-Defined Negative Permissions
19.8.5 Block Unless Code in ValueSet
19.9.0 Callback Scripts
19.9.1 Authentication Callback Scripts
19.9.2 Function: onAuthenticateSuccess
19.9.3 Function: onAuthenticateSuccessClientCredentials
19.9.4 Function: onSmartLoginPreContextSelection(theUserSession, theContextSelectionChoices)
19.9.5 Function: onSmartScopeAuthorityNarrowing
19.9.6 Function: onTokenGenerating(theUserSession, theAuthorizationRequestDetails, theClientDetails)
19.9.7 Function: onPostAuthorize(theDetails)
19.9.8 Function: authenticate(theRequest, theOutcomeFactory)
19.9.9 Function: getUserName(theOidcUserInfoMap, theServerInfo)
19.10.0 Anonymous Access
19.10.1 Anonymous Access
19.11.0 Consent Service
19.11.1 Consent Service
19.11.2 Enabling the Consent Service
19.12.0 Consent Service: JavaScript API
19.12.1 Consent Service: JavaScript API
19.12.2 Method: consentStartOperation
19.12.3 Method: consentCanSeeResource
19.12.4 Method: consentWillSeeResource
19.12.5 Method: completeOperationSuccess
19.12.6 Method: completeOperationFailure
19.12.7 Example: Tag-Based Consent Script
19.12.8 Example: Scope-Based Consent Script
19.13.0 Consent Service: Java API
19.13.1 Consent Service: Java API
19.13.2 Example
19.14.0 Consent Module: Overview
19.14.1 Consent Module: Overview
19.15.0 Consent Module: Examples
19.15.1 Consent Module: Examples
19.16.0 Security Recipes
19.16.1 Security Recipes
19.16.2 App: Local Users with HTTP Basic Authentication
19.16.3 Integrating SMART Apps With a 3rd-Party OIDC Server
19.17.0 Two Factor Authentication
19.17.1 Two Factor Authentication
19.17.2 User Activating TOTP
19.17.3 Enforcing Two Factor Authentication
19.18.0 Password Hashing Algorithms
19.18.1 Password Hashing Algorithms
19.18.2 Available Algorithms
19.19.0 JWT Signature Algorithms
19.19.1 JWT Signature Algorithms
19.20.0 Troubleshooting Security
19.20.1 Troubleshooting Security
20.0.0 SMART on FHIR
20.0.0 SMART on FHIR: Introduction
20.0.1 SMART on FHIR: Introduction
20.0.2 The SMART Launch Sequence
20.0.3 The Interactive Launch Process
20.1.0 SMART: Scopes
20.1.1 SMART on FHIR: Scopes
20.1.2 Picking Scopes
20.1.3 Launch Context Scopes
20.1.4 The OpenID and Profile Scopes
20.1.5 fhirContext
20.2.0 SMART: Auth Flows
20.2.1 Authorization Flows
20.2.2 Client Types
20.2.3 Launch Flow: Authorization Code
20.2.4 Security Option: private-key-jwt
20.2.5 Security Option: Proof Key for Code Exchange (PKCE)
20.2.6 Launch Flow: Implicit Grant
20.2.7 Launch Flow: Resource Owner Password Credentials
20.2.8 Non-Interactive User Flow: Cross-Organization Data Access Profile
20.2.9 System Flow: Client Credentials
20.2.10 System Flow: Client Credentials with JWT Credential
20.2.11 System Flow: Refresh Token
20.3.0 SMART: Endpoints
20.3.1 SMART on FHIR: Endpoints
20.3.2 Server Metadata Endpoint
20.3.3 UserInfo Endpoint
20.4.0 SMART: Smile CDR Support
20.4.1 SMART on FHIR: Smile CDR Support
20.4.2 Models for Using External OIDC Servers
20.4.3 Supported Scopes
20.4.4 Online / Offline Access
20.5.0 SMART Outbound Security: Module
20.5.1 SMART on FHIR Outbound Security Module
20.5.2 Setting Up This Module
20.5.3 Terms of Service
20.5.4 Plain-language Developer Attestation
20.5.5 Client Credentials Grant
20.5.6 Cross-Organization Data Access Profile Grant
20.5.7 SMART Callback Scripts
20.5.8 User Self Registration
20.6.0 SMART Outbound Security: Skinning
20.6.1 Skinning the SMART Outbound Security Module
20.6.2 Creating a Skin
20.6.3 Installing a Skin
20.6.4 HTML Template Files
20.6.5 Sample Skin Project
20.7.0 SMART Outbound Security: Context Selection
20.7.1 SMART on FHIR Outbound Security Module: Context Selection
20.8.0 SMART Outbound Security: SAML Bridging
20.8.1 SAML to SMART Bridging
20.8.2 Creating a SAML to SMART Bridge
20.9.0 SMART: Federated OAuth2/OIDC Login
20.9.1 Federated OAuth2/OIDC Login
20.9.2 Federated Flow
20.9.3 Considerations
20.9.4 Setting Up Federated OAuth2/OIDC Login
20.9.5 Client Authentication
20.9.6 Authorization Script
20.9.7 Server Selection Interceptor
20.10.0 SMART: Application Approval/Consent
20.10.1 SMART: Application Approval / Consent
20.10.2 Approval Overview
20.10.3 Auto-Approve / Auto-Grant Scopes
20.10.4 Approval Flow
20.10.5 Customizing Scope Names
20.10.6 Custom Security Scopes
20.10.7 Revocation Page
20.11.0 SMART Inbound Security Module
20.11.1 SMART on FHIR Inbound Security Module
20.11.2 Requirements
20.11.3 Setting Up This Module
20.11.4 Accepting Tokens
20.11.5 Accepting Internal Access Tokens
20.11.6 Accepting External Access Tokens
20.11.7 Validating Tokens
20.11.8 Creating a Server Definition
20.11.9 Assigning Permissions
20.11.10 Function: authenticate(...)
20.11.11 Function: getUserName(...)
20.11.12 Function: onSmartScopeAuthorityNarrowing(...)
20.12.0 SMART Client Definitions
20.12.1 SMART Client Definitions
20.12.2 Remembering Approved Scopes
20.12.3 Export and Import
20.12.4 Client Secrets
20.12.5 Client JWT Authentication
20.12.6 Requiring Client Authentication
20.12.7 Change Client Secret Endpoint
20.13.0 SMART Server Definitions
20.13.1 SMART Server Definitions
20.13.2 Creating a Server Definition
20.13.3 Issuer
20.13.4 Key
20.13.5 Client Authentication Mode
20.14.0 SMART OIDC Keystore Definitions
20.14.1 SMART OpenID Connect Keystores
20.15.0 SMART: Session Management
20.15.1 Session Management
20.15.2 Token Revocation Endpoint
20.15.3 User Logout Endpoint
20.16.0 SMART: Assigning Permissions
20.16.1 SMART on FHIR: Assigning Permissions
20.16.2 Scope Permission Model
20.16.3 User and Patient Resource Linkage
20.17.0 SMART: Access Tokens
20.17.1 Access Tokens
20.18.0 SMART: User Profile Information
20.18.1 SMART User Profile Information
20.19.0 FHIR Client Authentication
20.19.1 FHIR Client Authentication
20.19.2 Rejecting Unauthorized FHIR Calls
21.0.0 appSphere
21.0.0 Introduction
21.0.1 appSphere: Introduction
21.1.0 Getting Started
21.1.1 Getting Started
21.1.2 Setting-up a Sandbox Environment
21.1.3 Config Diagnostics
21.2.0 Associated Module Configurations
21.2.1 Associated Module Configurations
21.2.2 Configuration of JSON Admin API module
21.2.3 Configuration of FHIR Endpoint Module
21.2.4 Configuration of SMART Auth Module
21.2.5 Configuring SMART Auth modules to support multiple OIDC endpoints
21.2.6 Setting-up Federated OAuth to work with appSphere
21.3.0 Client Creation and Configuration
21.3.1 Client Creation and Configuration
21.4.0 Other Configurations
21.4.1 Other Configurations
21.4.2 Configuring NGINX for the Module
21.4.3 Configuring Different Users
21.5.0 Developer Portal
21.5.1 Developer Portal
21.5.2 API Documentation for Dev Portal
21.5.3 Developer Registration
21.5.4 Developer Portal: UI Description
21.5.5 Sandbox Testing: UI Description
21.5.6 Repository Partitions
21.5.7 App Registration
21.5.8 Managing 'Draft' App Registrations and Re-registrations
21.5.9 App Information Page
21.5.10 Attestation
21.5.11 New App versions
21.5.12 Backend Service Registration
21.5.13 Additional Considerations
21.6.0 App Management Console
21.6.1 App Management Console
21.6.2 Management Console: UI Description
21.6.3 App Review and Management
21.6.4 Backend Service Review and Management
21.6.5 Upgrading
21.6.6 Additional Considerations
21.7.0 App Gallery
21.7.1 App Gallery
21.7.2 App Gallery: UI Description
21.7.3 Gallery Functionality
21.8.0 Appendix
21.8.1 Appendix
21.8.2 Config Diagnostics
21.8.3 App Registration Help Text
21.8.4 Sign Up Help Text
21.8.5 Smile CDR Config
21.8.6 Attestation Creation
21.8.7 Current Software Versions --TRAIL--
21.8.8 Troubleshooting
21.8.9 Reference Documents
21.8.10 Glossary of Terms
22.0.0 FHIR Gateway
22.0.0 FHIR Gateway Introduction
22.0.1 FHIR Gateway Endpoint
22.0.2 Troubleshooting
22.0.3 Limitations
22.0.4 Configuring Consent Service
22.1.0 Configuration: Initial Setup
22.1.1 Gateway Setup
22.1.2 Server Configuration
22.1.3 Encryption JWKS (Keystore)
22.1.4 Configuration Document
22.1.5 Interceptors
22.1.6 Error Handling
22.2.0 Configuration: Document
22.2.1 FHIR Gateway Configuration Document
22.2.2 Defining Targets
22.2.3 Defining Search Routes
22.2.4 Defining Read, Create, Update, and Delete Routes
22.2.5 Defining Operation Routes
22.2.6 Defining a Retry Strategy
22.3.0 Custom Operations
22.3.1 Custom Operation Providers
22.3.2 Sample Custom System Operation Provider
22.3.3 Processing Target Invocation Responses
22.3.4 The Spring Context Config Class
22.3.5 Packaging Your Providers
22.3.6 Deploying Your Custom Providers
22.4.0 Caching
22.4.1 Caching
22.5.0 Pagination
22.5.1 Pagination
23.0.0 FHIR Hybrid Providers
23.0.0 Hybrid Providers
23.0.1 Hybrid Providers
23.0.2 Architecture
23.0.3 Resource Providers
23.0.4 CapabilityStatement
23.0.5 The Spring Context Config Class
23.0.6 Interceptor Loading
23.0.7 Building Your Hybrid Providers
23.0.8 Paging
23.0.9 Camel Services
23.0.10 Packaging Your Providers
23.0.11 Deploying Your Hybrid Providers
23.0.12 Accessing Security Attributes
23.0.13 Configuring Consent Service
23.0.14 Accessing Dao (Data Access Object)
23.0.15 Exceptions
23.0.16 Example Project
23.1.0 REST Custom Operations
23.1.1 REST Custom Operations
24.0.0 LiveBundle
24.0.0 LiveBundle Overview
24.0.1 LiveBundle
24.0.2 Configuration
24.0.3 Usage
24.0.4 LiveBundle Architecture
24.0.5 LiveBundle Aggregation
24.0.6 LiveBundle Retrieval
24.0.7 LiveBundle Seeding
24.0.8 LiveBundle Troubleshooting
24.1.0 LiveBundle API
24.1.1 LiveBundle API
24.1.2 Add a Subscriber to a Watchlist
24.1.3 Remove Subscriber from a Watchlist
24.1.4 View list of Subscribers to a Watchlist
24.1.5 Request a bundle of Subscribers to a watchlist
24.1.6 Reseed all bundles for a rule
24.1.7 Request a LiveBundle
24.2.0 LiveBundle Rule Definition
24.2.1 LiveBundle Rule Definition
24.2.2 Loading Rules
24.2.3 Example LiveBundle Javascript
24.2.4 LiveBundle Watchlist
24.2.5 LiveBundle Rule
24.2.6 LiveBundle Filter
24.2.7 Keeper Filters
24.2.8 LiveBundle Keeper
24.3.0 LiveBundle Keepers
24.3.1 LiveBundle Keepers
24.3.2 LiveBundle Keeper Examples
24.3.3 LatestByPath
24.3.4 LatestByParamPath
24.3.5 LatestByParamPathByMonth
24.3.6 ToggleByPath
24.3.7 ToggleBySearch
24.3.8 WatchlistPopulator
24.3.9 Optional Keeper Parameters
25.0.0 CDS Hooks
25.0.0 CDS Hooks
25.0.1 CDS Hooks
25.0.2 Auto Prefetch
25.0.3 Architecture
25.0.4 CDS Hooks Classes
25.0.5 The Spring Context Config Class
25.0.6 CDS Hooks Extensions
25.0.7 Building Your CDS Hooks
25.0.8 Deploying Your CDS Hooks
25.0.9 Accessing Security Attributes
25.0.10 Exceptions
25.0.11 Calling CDS Hooks
25.0.12 Example Project
25.0.13 CDS on FHIR
26.0.0 Master Data Management
26.0.0 MDM
26.0.1 Master Data Management (MDM)
26.0.2 Getting Started with Smile CDR MDM
26.0.3 Enabling and Configuring MDM within Smile CDR
26.0.4 MDM Search Expansion
26.0.5 Troubleshooting
26.0.6 MDM User Interface (MDM UI)
26.0.7 MDM Scenarios
26.1.0 MDM Rule Definition
26.1.1 MDM Rule Definition
26.1.2 Finding Candidates
26.1.3 Matching and Creating Links
26.2.0 Using EIDs in MDM Rule Definition
26.2.1 Using Enterprise Identifiers (EIDs) in MDM Rule Definition
26.2.2 Changing the way MDM is processing incoming resources
26.3.0 MDM Survivorship Rules
26.3.1 MDM Survivorship rules
26.4.0 Upgrading from the EMPI module
26.4.1 Upgrading from EMPI
26.5.0 MDM UI
26.5.1 Master Data Management User Interface (MDMUI)
26.5.2 Setup
26.6.0 MDM Blocklist Definition
26.6.1 MDM Block Rules
26.7.0 MDM Evaluate Operation
26.7.1 $mdm-evaluate operation
26.8.0 MDM Virtualized Endpoint
26.8.1 MDM Virtualized Endpoint
26.8.2 Architecture
27.0.0 Quality Improvement
27.0.0 Quality Improvement Overview
27.0.1 Table of Contents
27.0.2 Clinical Reasoning on Smile CDR
27.0.3 Clinical Reasoning Operations per Smile CDR Module
27.0.4 Clinical Quality Language (CQL)
27.0.5 Quality Measures
27.0.6 Clinical Decision Support
27.0.7 Additional Implementation Guides
27.1.0 Clinical Quality Language (CQL)
27.1.1 Table of Contents
27.1.2 Introduction
27.1.3 CQL Module
27.1.4 CQL Evaluate Operation
27.1.5 Library Evaluate Operation
27.1.6 Usage
27.2.0 Care Gaps
27.2.1 Care Gaps
27.2.2 Operation
27.2.3 Prospective Gap Status
27.2.4 Parameters
27.2.5 Example Request
27.2.6 Example 'Prospective Gap' Scenario
27.2.7 Example 'Open Gap' Scenario
27.2.8 Example 'Closed Gap' Scenario
27.2.9 Example 'Not Applicable' Scenario
27.2.10 Example Response
27.2.11 Example Resources
27.2.12 DQM Module Configurations
27.3.0 Evaluating Measures
27.3.1 Table of Contents
27.3.2 Measure Resource
27.3.3 Measure Evaluating Options
27.3.4 Operation
27.3.5 Operation Parameters
27.3.6 Headers with FHIR Requests
27.3.7 Measure Subject Types
27.3.8 Measure Report Resource
27.3.9 Measure Report Populations And Scores
27.3.10 Multiple Measure Evaluation
27.3.11 Multiple Measure Operation Parameters
27.3.12 Standard Evaluate Measure
27.3.13 Distributed Evaluate Measure
27.3.14 Batch Job Analytics Operation
27.3.15 Spark Evaluate-Measure
27.3.16 CMS Quality Reporting
27.3.17 Measure Data Requirements Operation
27.3.18 Measure Collect Data Operation
27.3.19 DQM Module
27.3.20 FAQs
27.4.0 Quality Payment Program (QPP)
27.4.1 Table of Contents
27.4.2 Overview
27.4.3 QPP on DQM UI
27.4.4 Operation
27.4.5 Operation Parameters
27.4.6 CDR DQM Module Configuration
27.4.7 Example Requests
27.5.0 ActivityDefinitions
27.5.1 ActivityDefinition
27.6.0 PlanDefinitions
27.6.1 PlanDefinition
27.7.0 Questionnaires
27.7.1 Questionnaires
28.0.0 IG Support
28.0.0 International Patient Summary (IPS)
28.0.1 International Patient Summary (IPS)
28.0.2 Generation Rules
29.0.0 EasyShare
29.0.0 EasyShare SMART Health Links (SHL)
29.0.1 EasyShare SMART Health Links
29.0.2 Understanding SMART Health Links
29.0.3 Architecture
29.0.4 Security
29.1.0 EasyShare SHL Public module
29.1.1 EasyShare SMART Health Links Public module
29.1.2 Installation
29.1.3 SHL Creation API
29.2.0 EasyShare SHL Admin module
29.2.1 EasyShare SMART Health Links Admin module
29.2.2 Installation
29.2.3 SHL Creation Application
30.0.0 Logging
30.0.0 Overview
30.0.1 Audit and Transaction Logs
30.1.0 Audit Log
30.1.1 Audit Log
30.1.2 Audit Log Configuration
30.1.3 Disabling the Audit Log
30.1.4 Broker Audit Log
30.1.5 Audit Module
30.2.0 Transaction Log
30.2.1 Transaction Log
30.2.2 What Does the Transaction Log Store?
30.2.3 Disabling the Transaction Log on the Cluster Manager
30.2.4 Transaction Log Configuration
30.2.5 Performance Tracing
30.2.6 Event Types and SubTypes
30.2.7 Realtime Reporting
30.2.8 Hiding Request Body
30.2.9 Changing Timezone
30.2.10 Using multiple Transaction Logs
30.3.0 System Logging
30.3.1 System Logging
30.3.2 Changing Logging Settings
30.3.3 Protected Health Information (PHI) in Logs
30.3.4 JVM Stats Logging
30.4.0 Troubleshooting Logs
30.4.1 Troubleshooting Logs
30.4.2 Docker Considerations
30.4.3 Troubleshooting Logs Endpoint
30.4.4 HL7V2 Troubleshooting Log
30.4.5 HTTP Troubleshooting Log
30.4.6 Security Troubleshooting Log
30.4.7 Subscription Troubleshooting Log
30.4.8 LiveBundle Troubleshooting Log
30.4.9 MDM Troubleshooting Log
30.4.10 Channel Import Troubleshooting Log
30.4.11 Realtime Export Troubleshooting Log
30.4.12 FHIR Gateway Troubleshooting Log
30.4.13 Connection Pool Troubleshooting Log
30.4.14 AWS HealthLake Export Troubleshooting Log
30.4.15 Batch Framework Troubleshooting Log
30.4.16 Narrative Generation Troubleshooting Log
30.4.17 Terminology Troubleshooting Log
30.4.18 MongoDB Troubleshooting Log
30.4.19 Custom Logging
30.5.0 Custom Logging
30.5.1 Custom Logging
31.0.0 HL7 v2.x Support
31.0.0 Introduction
31.0.1 HL7 v2.x Support
31.0.2 Inbound HL7 v2.x Support
31.0.3 Outbound HL7 v2.x Support
31.0.4 HL7 v2.x Versions
31.1.0 Inbound Messaging
31.1.1 HL7 v2.x Support: Inbound Messaging (to Smile CDR)
31.1.2 Security
31.1.3 Processing
31.1.4 Callback Scripts
31.1.5 Function: onPreConvertHl7V2ToFhir(theMessage, theConversionResult)
31.1.6 Function: onPostConvertHl7V2ToFhir(theMessage, theConversionResult)
31.1.7 Adding Processing Messages
31.1.8 Lookup message segments by type
31.1.9 Custom Processing Logic
31.1.10 Pointcuts
31.2.0 FHIR-Based Terminology Translation
31.2.1 FHIR-based Terminology Translation
31.2.2 Which ConceptMap do I want?
31.3.0 Outbound Messaging
31.3.1 HL7 v2.x Support: Outbound Messaging (from Smile CDR)
31.3.2 Getting Started
31.3.3 Message Generation Subscription Types
31.4.0 Outbound: Default Resource Conversion
31.4.1 Default Outbound Resource Conversion
31.4.2 ADT Workflow Mode
31.4.3 Enriching Message Conversion using Scripts
31.4.4 Function: onPostConvertFhirToHl7V2(theTriggerResource, theOutgoingMessage, theContext)
31.4.5 Using Persisted MessageHeader Resources
31.5.0 Outbound: Custom Resource Conversion
31.5.1 Custom Outbound Resource Conversion
31.5.2 Business Transaction Triggers with MessageHeader
31.5.3 Custom Mapper Class
31.5.4 Custom Mapper Subscription
31.6.0 Outbound: Verbatim Messaging
31.6.1 Verbatim Messaging Subscriptions
31.7.0 Outbound: Transport
31.7.1 Outbound HL7v2 Messaging: Transport
31.7.2 Customizing HL7 over HTTP Payload
31.8.0 Transactions
31.8.1 HL7 v2.x Transactions
31.8.2 ADT (Patient Administration) Domain
31.8.3 BAR (Billing) Domain
31.8.4 DFT (Financial) Domain
31.8.5 MDM (Document Management) Domain
31.8.6 OMG/ORM (Orders) Domain
31.8.7 ORU (Results) Domain
31.8.8 RDE/RAS (Pharmacy) Domain
31.8.9 SIU (Scheduling) Domain
31.8.10 VXU (Immunization / Vaccination) Domain
31.9.0 Structure Definitions
31.9.1 Structure Definitions
31.9.2 Structure: ADT_A01
31.9.3 Structure: ADT_A02
31.9.4 Structure: ADT_A03
31.9.5 Structure: ADT_A05
31.9.6 Structure: ADT_A06
31.9.7 Structure: ADT_A09
31.9.8 Structure: ADT_A10
31.9.9 Structure: ADT_A12
31.9.10 Structure: ADT_A17
31.9.11 Structure: ADT_A21
31.9.12 Structure: ADT_A30
31.9.13 Structure: ADT_A38
31.9.14 Structure: ADT_A39
31.9.15 Structure: ADT_A44
31.9.16 Structure: ADT_A45
31.9.17 Structure: ADT_A54
31.9.18 Structure: ADT_A60
31.9.19 Structure: ADT_A61
31.9.20 Structure: BAR_P12
31.9.21 Structure: DFT_P03
31.9.22 Structure: MDM_T01
31.9.23 Structure: MDM_T02
31.9.24 Structure: OMG_O19
31.9.25 Structure: ORM_O01
31.9.26 Structure: ORU_R01
31.9.27 Structure: RAS_O17
31.9.28 Structure: RDE_O11
31.9.29 Structure: SIU_S12
31.9.30 Structure: VXU_V04
31.10.0 Segment Definitions
31.10.1 Segment Definitions
31.10.2 Segment: MSH (Message Header)
31.10.3 Segment: EVN (Event)
31.10.4 Segment: PID (Patient)
31.10.5 Segment: PD1 (Patient Demographics Extended)
31.10.6 Segment: PV1 (Visit/Encounter)
31.10.7 Segment: PV2 (Visit/Encounter Additional)
31.10.8 Segment: ROL (Role)
31.10.9 Segment: DG1 (Diagnosis)
31.10.10 Segment: PR1 (Procedure)
31.10.11 Segment: MRG (Merge Patient Information)
31.10.12 Segment: GT1 (Guarantor)
31.10.13 Segment: IN1 (Insurance)
31.10.14 Segment: IN2 (Insurance Additional Information)
31.10.15 Segment: ORC (Order Control)
31.10.16 Segment: OBR (Observation Request)
31.10.17 Segment: OBX (Observation)
31.10.18 Segment: NK1 (Next of Kin / Patient Contact)
31.10.19 Segment: NTE (Note)
31.10.20 Segment: FT1 (Financial Transaction)
31.10.21 Segment: RXA (Pharmacy Administration)
31.10.22 Segment: RXC (Pharmacy Component)
31.10.23 Segment: ZXC (Pharmacy Component)
31.10.24 Segment: RXE (Pharmacy Encoded Order)
31.10.25 Segment: RXR (Pharmacy Route)
31.10.26 Segment: AL1 (Allergy Information)
31.10.27 Segment: IAM (Patient Adverse Reaction)
31.10.28 Segment: SCH (Scheduling)
31.10.29 Segment: RGS (Resource Group Segment)
31.10.30 Segment: AIL (Location Resource)
31.10.31 Segment: AIP (Personnel Resource)
31.10.32 Segment: TXA (Transcription Document Header)
31.10.33 Segment: ZXT (Non-Standard)
31.10.34 A Note about Extra Components
31.10.35 A Note about the XTN Data Type
31.10.36 A Note about DSTU3 Mode Mappings
31.11.0 Table Definitions
31.11.1 Table Definitions
31.11.2 Table 0001: Administrative Sex
31.11.3 Table 0002: Marital Status
31.11.4 Table 0004: Patient Class
31.11.5 Table 0007: Admission Type
31.11.6 Table 0009: Ambulatory Status
31.11.7 Table 0017: Transaction Type
31.11.8 Table 0018: Patient Type
31.11.9 Table 0038: Order Status
31.11.10 Table 0052: Diagnosis Type
31.11.11 Table 0063: Relationship
31.11.12 Table 0069: Hospital Service
31.11.13 Table 0074: Diagnostic Service Section ID
31.11.14 Table 0078: Observation Interpretation Codes
31.11.15 Table 0085: Observation Status
31.11.16 Table 0112: Discharge Disposition
31.11.17 Table 0117: Account Status
31.11.18 Table 0119: Order Control
31.11.19 Table 0123: Result Status
31.11.20 Table 0125: Observation Value Type
31.11.21 Table 0127: Allergen Type
31.11.22 Table 0128: Allergen Severity
31.11.23 Table 0129: Accommodation Code
31.11.24 Table 0131: Contact Role
31.11.25 Table 0136: Yes/No
31.11.26 Table 0166: RX Component Type
31.11.27 Table 0190: Address Type
31.11.28 Table 0191: Type of Referenced Data
31.11.29 Table 0200: Name Type Code
31.11.30 Table 0201: Telecom Use
31.11.31 Table 0202: Telecom Equipment Type
31.11.32 Table 0203: Identifier Type
31.11.33 Table 0270: Document Type
31.11.34 Table 0271: Document Completion Status
31.11.35 Table 0273: Document Availability Status
31.11.36 Table 0276: Appointment Reason Codes
31.11.37 Table 0278: Filler Status Code
31.11.38 Table 0291: Subtype of Referenced Data
31.11.39 Table 0299: Encoding
31.11.40 Table 0305: Person Location Type
31.11.41 Table 0322: Completion Status
31.11.42 Table 0438: Allergy Clinical Status Code
31.11.43 Table 0834: MIME Types
31.12.0 Naming System Mapping
31.12.1 Naming System Mapping
31.12.2 Default Mappings
31.12.3 Using NamingSystem for Mapping Identifiers
31.13.0 Processing Results Feeds
31.13.1 Processing ORU (Results) Messages
31.13.2 Unsolicited Observation Request (ORU^R01)
31.14.0 Protocol
31.14.1 HL7 v2.x Protocol
31.14.2 Encoding Format
31.14.3 ER7 (Pipe-Delimited) Format
31.14.4 Minimal Lower Layer Protocol (MLLP) Transport
31.14.5 HL7 over HTTP
31.14.6 Character Encoding / Charsets
32.0.0 CDA Exchange Module
32.0.0 Introduction
32.0.1 CDA Module Introduction
32.0.2 CDA Export
32.0.3 CDA Import
32.0.4 Implementation roadmap
32.1.0 JavaScript Templates
32.1.1 CDA JavaScript Templating System
32.1.2 The simplest CDA template script
32.1.3 Adding header information to our CDA template script
32.1.4 Adding and populating a section in our CDA template script
32.1.5 Using the Fhir.search() API to dynamically populate sections
32.1.6 Specifying input parameters
32.1.7 More complicated input parameters
32.1.8 Specifying section author participation
32.1.9 Putting it all together
32.1.10 Configuring the $docref CCD template
32.2.0 Rest API Operations
32.2.1 CDA REST Operations
32.2.2 Endpoints for configuring templates
32.2.3 Endpoints for applying templates
32.2.4 Endpoints for importing CDA documents
32.3.0 Available Document and Section Types for CDA Export
32.3.1 CDA Module Mappings for Export
32.3.2 Valid Document Types
32.3.3 Valid Resources for the header
32.3.4 Valid Section Types and Sources
32.3.5 Allergy and Intolerances Section
32.3.6 Dialysis Prescription Section
32.3.7 Encounters Section
32.3.8 Functional Status Section
32.3.9 Goals Section
32.3.10 Immunizations Section
32.3.11 Medical Equipment Section
32.3.12 Medications Section
32.3.13 Problem Section
32.3.14 Procedures Section
32.3.15 Reason for Referral Section
32.3.16 Results Section
32.3.17 Social History Section
32.3.18 Vital Signs Section
32.4.0 Available Document and Section Types for CDA Import
32.4.1 CDA Module Mappings for Import
32.4.2 Valid Document Types
32.4.3 Resources derived from the header
32.4.4 Valid Section Types and Sources
32.4.5 Allergy and Intolerances Section
32.4.6 Assessment Section
32.4.7 Care Team Section
32.4.8 Consultation Note Section
32.4.9 Encounters Section
32.4.10 Family History Section
32.4.11 Functional Status Section
32.4.12 Goals Section
32.4.13 Health Concerns Section
32.4.14 Immunizations Section
32.4.15 Medical Equipment Section
32.4.16 Medications Section
32.4.17 Nutrition Section
32.4.18 Plan of Care Section
32.4.19 Problem Section
32.4.20 Procedures Section
32.4.21 Results Section
32.4.22 Social History Section
32.4.23 Vital Signs Section
32.5.0 JavaScript Hooks on CDA Import / Export
32.5.1 JavaScript Hooks on CDA Import / Export
32.5.2 CDA Pre Import JavaScript Hook
32.5.3 CDA Post Import JavaScript Hook
32.5.4 CDA Post Export JavaScript Hook
32.5.5 Exposed APIs for use in JavaScript Execution Environment
32.5.6 Example Scripts
32.6.0 Further Reading
32.6.1 Additional Documentation for CDA
33.0.0 CDA Exchange+ Module
33.0.0 Introduction
33.0.1 CDA Exchange+ Module Introduction
33.0.2 CDA Export
33.0.3 CDA Import
33.0.4 Implementation roadmap
33.1.0 JavaScript Templates
33.1.1 CDA JavaScript Templating System
33.1.2 The simplest CDA template script
33.1.3 Adding header information to our CDA template script
33.1.4 Adding and populating a section in our CDA template script
33.1.5 Using the Fhir.search() API to dynamically populate sections
33.1.6 Specifying input parameters
33.1.7 More complicated input parameters
33.1.8 Specifying section author participation
33.1.9 Putting it all together
33.1.10 Configuring the $docref CCD template
33.2.0 Rest API Operations
33.2.1 CDA REST Operations
33.2.2 Endpoints for configuring templates
33.2.3 Endpoints for applying templates
33.2.4 Endpoints for importing CDA documents
33.2.5 Endpoints for exporting CDA documents
33.3.0 Available Document and Section Types for CDA Export
33.3.1 CDA Module Mappings for Export
33.3.2 Valid Document Types
33.3.3 Valid Resources for the header
33.3.4 Valid Section Types and Sources
33.3.5 Applicable To All Sections
33.3.6 Admission Diagnosis Section
33.3.7 Admission Medication Section
33.3.8 Allergy and Intolerances Section
33.3.9 Encounters Section
33.3.10 Care Plan Section
33.3.11 Care Team Section
33.3.12 Discharge Medication Section
33.3.13 Family History Section
33.3.14 Functional Status Section
33.3.15 Goals Section
33.3.16 Immunizations Section
33.3.17 Medical Equipment Section
33.3.18 Medications Section
33.3.19 Medications Administered Section
33.3.20 Mental Status Section
33.3.21 Past Medical History Section
33.3.22 Payer Section
33.3.23 Plan of Treatment Section
33.3.24 Problem Section
33.3.25 Procedures Section
33.3.26 Results Section
33.3.27 Social History Section
33.3.28 General Status Section
33.3.29 History of Present Illness Section
33.3.30 Review of Systems Section
33.3.31 Vital Signs Section
33.3.32 Note Section
33.3.33 Discharge Diagnosis Section
33.3.34 Admission Medications Section
33.3.35 Discharge Medications Section
33.4.0 Available Document and Section Types for CDA Import
33.4.1 CDA Module Mappings for Import
33.4.2 Valid Document Types
33.4.3 Resources derived from the header
33.4.4 Valid Section Types and Sources
33.4.5 Admission Diagnosis Section
33.4.6 Admission Medication Section
33.4.7 Allergy and Intolerances Section
33.4.8 Care Plan Section
33.4.9 Care Team Section
33.4.10 Discharge Diagnosis Section
33.4.11 Discharge Medication Section
33.4.12 Encounters Section
33.4.13 Family History Section
33.4.14 Functional Status Section
33.4.15 Goals Section
33.4.16 Health Concerns Section
33.4.17 Immunizations Section
33.4.18 Medical Equipment Section
33.4.19 Medications Section
33.4.20 Medications Administered Section
33.4.21 Mental Status Section
33.4.22 Past Medical History Section
33.4.23 Payer Section
33.4.24 General Status Section
33.4.25 History of Present Illness Section
33.4.26 Review of Systems Section
33.4.27 Plan of Treatment Section
33.4.28 Problem Section
33.4.29 Procedures Section
33.4.30 Results Section
33.4.31 Social History Section
33.4.32 Vital Signs Section
33.4.33 Note Section
33.4.34 Admission Medications Section
33.4.35 Discharge Medications Section
33.5.0 JavaScript Hooks on CDA Import / Export
33.5.1 JavaScript Hooks on CDA Import / Export
33.5.2 CDA Pre Import JavaScript Hook
33.5.3 CDA Post Import JavaScript Hook
33.5.4 CDA Post Export JavaScript Hook
33.5.5 Exposed APIs for use in JavaScript Execution Environment
33.5.6 Example Scripts
33.6.0 FHIR-Based Terminology Translation
33.6.1 FHIR-Based Terminology Translation
33.6.2 Default Mappings: DSTU3
33.6.3 Default Mappings: R4
33.7.0 CDA Section-level Narrative Generation
33.7.1 Narrative Generation
33.8.0 Further Reading
33.8.1 Additional Documentation for CDA
34.0.0 System to System Data Exchange
34.0.0 System to System Data Exchange Module
34.0.1 System to System Data Exchange Module
34.1.0 Smile CDR Payer to Payer Quickstart Guide
34.1.1 Smile CDR Payer to Payer Quickstart Guide
34.2.0 Custom Matching Script
34.2.1 Custom Matching Script
35.0.0 Bulk Operations
35.0.0 ETL Import Module
35.0.1 ETL Import (Extract/Transform/Load)
35.0.2 Importing CSV Data
35.0.3 Function: handleEtlImportRow(theInputMap, theContext)
35.0.4 Handling Multiple Import Formats
35.0.5 Initiating ETL Jobs
35.0.6 Performance and Concurrency
35.0.7 Locking Rows
35.0.8 Creating a Hashing Script
35.0.9 Asynchronous Execution
35.0.10 Performance
35.1.0 FHIR Bulk Import Operation
35.1.1 FHIR Bulk Import
35.1.2 Triggering a Bulk Import
35.1.3 Methodology
35.1.4 Performance
35.1.5 Limitations
35.2.0 FHIR Bulk Export Operation
35.2.1 FHIR Bulk Export Operation
35.2.2 Enabling Bulk Export
35.2.3 Types of Bulk Export Requests
35.2.4 Request Parameters
35.2.5 Requesting A Bulk Extract
35.2.6 Authorization for Bulk Export
35.2.7 Polling for Job Status
35.2.8 Accessing Bulk Export Files
36.0.0 Additional Features
36.0.0 Da Vinci Clinical Data Exchange (CDex)
36.0.1 Da Vinci Clinical Data Exchange (CDex)
36.1.0 Da Vinci Health Record Exchange (HRex)
36.1.1 Da Vinci Health Record Exchange (HRex)
37.0.0 Product Administration
37.0.0 Batch Job Management
37.0.1 Batch Job Management
37.1.0 Web Admin Console
37.1.1 Web Admin Console
38.0.0 JSON Admin Endpoints
38.0.0 JSON Admin API
38.0.1 JSON Admin API
38.0.2 Security
38.0.3 Format
38.0.4 Allowing Anonymous Access
38.0.5 MDM Endpoints Exposed in JSON Admin Module
38.1.0 Audit Log Endpoint
38.1.1 Audit Log Endpoint
38.1.2 Fetch Audit Log
38.1.3 Fetch Individual Event
38.2.0 Batch Job Endpoint
38.2.1 Batch Job Endpoint
38.2.2 Fetch All Batch Jobs
38.2.3 Fetch Batch Job Names
38.2.4 Fetch All Job Instances
38.2.5 Cancel Job Execution
38.3.0 Bulk Import Endpoint
38.3.1 Bulk Import Endpoint
38.3.2 Process ETL File
38.3.3 Smileutil: CSV Bulk Import File
38.4.0 CDA Exchange Endpoint
38.4.1 CDA Exchange Endpoint
38.4.2 Create CDA Template
38.4.3 Update CDA Template
38.4.4 Update CDA Template script via text
38.4.5 View CDA Template(s)
38.4.6 Delete CDA template
38.4.7 Example CDA Template
38.5.0 Metrics Endpoint
38.5.1 Metrics Endpoint
38.5.2 Fetch Local Metrics
38.5.3 Capture Thread Dump
38.6.0 Module Config Endpoint
38.6.1 Module Config Endpoint
38.6.2 Fetch Config: Module Property File
38.6.3 Fetch Config: All Modules
38.6.4 Fetch Config: Single Module
38.6.5 Create Module
38.6.6 Set Module Config
38.6.7 Start Module
38.6.8 Stop Module
38.6.9 Restart Module
38.6.10 Archive Module
38.6.11 Reinstate Module
38.6.12 System Restore
38.7.0 OpenID Connect Clients Endpoint
38.7.1 OpenID Connect Clients Endpoint
38.7.2 Fetch All OpenID Connect Client Definitions
38.7.3 Fetch Individual Client by Client ID
38.7.4 Create Client
38.7.5 Update Client
38.7.6 Create Client and generate secrets
38.8.0 OpenID Connect Keystores Endpoint
38.8.1 OpenID Connect Keystores Endpoint
38.8.2 Fetch All OpenID Connect Keystore Definitions
38.8.3 Fetch OpenID Connect Keystore Definition by ID
38.8.4 Create OpenID Connect Keystore Definition
38.8.5 Update OpenID Connect Keystore Definition
38.9.0 OpenID Connect Servers Endpoint
38.9.1 OpenID Connect Servers Endpoint
38.9.2 Fetch All OpenID Connect Server Definitions
38.9.3 Find OpenID Connect Server Definition
38.9.4 Create OpenID Connect Server Definition
38.9.5 Update OpenID Connect Server Definition
38.10.0 OpenID Connect Sessions Endpoint
38.10.1 OpenID Connect Sessions Endpoint
38.10.2 Fetch All Active Clients for User
38.10.3 Revoke Active Client for User
38.10.4 Revoke All Tokens
38.11.0 Runtime Status Endpoint
38.11.1 Runtime Status Endpoint
38.11.2 Fetch Complete Node Status Information
38.11.3 Fetch All Runtime Health Checks
38.12.0 System Config Endpoint
38.12.1 System Config Endpoint
38.13.0 Transaction Log Endpoint
38.13.1 Transaction Log Endpoint
38.13.2 Fetch Transaction Log
38.13.3 Fetch Individual Event
38.14.0 Troubleshooting Log Endpoint
38.14.1 Troubleshooting Log Endpoint
38.14.2 Fetch Troubleshooting Log Configuration
38.14.3 Update Troubleshooting Logger Level
38.14.4 Update Troubleshooting Log Configuration
38.15.0 User Management Endpoint
38.15.1 User Management Endpoint
38.15.2 Search for Users (All Modules)
38.15.3 Search for Users (Specific Module)
38.15.4 Create User
38.15.5 Update User
38.15.6 Update Password
38.15.7 Update Own Password
38.15.8 Update Own Default Launch Contexts
38.15.9 2FA: Create New Key
38.15.10 2FA: Generate QR Code
38.15.11 2FA: Confirm Key
38.15.12 2FA: Delete Key
38.15.13 Invalidate All Sessions
39.0.0 HFQL: Direct SQL Access
39.0.0 HFQL/SQL Overview
39.0.1 HFQL: Direct SQL Access to the FHIR Repository
39.0.2 Overview
39.0.3 Goals and Architecture
39.0.4 JDBC Driver
39.0.5 Enabling Server Support
39.1.0 SQL Syntax
39.1.1 HFQL SQL Syntax
39.1.2 Syntax Overview
39.2.0 SQL Syntax: Select
39.2.1 HFQL SQL Syntax: Selects
39.2.2 Selecting Columns
39.2.3 Column Name Aliases
39.2.4 Column Data Types and Choice Elements
39.2.5 Count and Group-By Expressions
39.2.6 Ordering Results
39.2.7 Select Data Manipulation and Concatenation
39.2.8 Limiting Results
39.3.0 SQL Syntax: Where
39.3.1 HFQL SQL Syntax: Where and Having
39.3.2 WHERE Clauses
39.3.3 Search Parameter WHERE Expressions
39.3.4 FHIRPath WHERE Expressions
39.4.0 SQL Syntax: Limitations
39.4.1 SQL Syntax Limitations
39.4.2 Syntax Limitations
39.5.0 SQL Syntax: Examples
39.5.1 HFQL Syntax Examples
39.5.2 Find Resources with Repeating Elements
40.0.0 Product Configuration
40.0.0 HTTP Server Setup
40.0.1 HTTP Server Setup
40.0.2 Respecting Forward Headers
40.0.3 Specifying a Custom Context Path
40.0.4 Access Logs
40.0.5 Frame Options
40.1.0 TLS and HTTPS Reference
40.1.1 TLS and HTTPS
40.1.2 Background
40.1.3 Creating a Self-Signed KeyStore
40.1.4 Importing a LetsEncrypt Certificate into a KeyStore
40.1.5 Selecting Ciphers and Protocol
40.1.6 Enabling TLS Mutual Authentication (Client Auth)
40.1.7 Programmatically Configuring a FHIR Endpoint KeyStore
40.1.8 Smile Util TLS JSON Authentication File
41.0.0 Java Execution Environment
41.0.0 Security Attributes
41.0.1 Security Attributes
41.1.0 Library Support
41.1.1 Library Support
41.2.0 Exception Handling
41.2.1 Exceptions
41.3.0 Javadocs
41.3.1 Smile CDR Javadocs
41.4.0 Examples
41.4.1 Java Execution Environment Examples
41.4.2 Database Access using JDBC
42.0.0 JavaScript Execution Environment
42.0.0 Introduction
42.0.1 JavaScript Execution Environment
42.0.2 Change Log
42.1.0 Specifying JavaScript in Configuration File
42.1.1 Specifying JavaScript in Configuration File
42.2.0 Remote Debugging
42.2.1 JavaScript Execution Environment Remote Debugging
42.3.0 ECMA Modules (import)
42.3.1 ECMA Modules
42.4.0 Converter API
42.4.1 Converter API
42.4.2 Method: hl7v2TsToFhirDate(dt);
42.4.3 Method: hl7v2TsToFhirDateTime(ts);
42.4.4 Method: hl7v2TsToFhirDateTime(ts, impliedTimeZone);
42.4.5 Method: urlDecodeString(string);
42.4.6 Method: urlEncodeString(string);
42.4.7 Method: base64Encode(string);
42.4.8 Method: base64Decode(string);
42.5.0 Environment API
42.5.1 Environment
42.5.2 Method: getProperty(name)
42.5.3 Method: getEnv(name)
42.6.0 Exceptions API
42.6.1 Exceptions
42.6.2 Method: Exceptions.newTrustedException(theMessage)
42.6.3 Method: Exceptions.newTrustedException(theStatusCode, theMessage)
42.7.0 OAuth2 Exceptions API
42.7.1 Oauth2 Exceptions
42.7.2 Method: OAuth2Exceptions.newUnauthorizedException(theMessage)
42.7.3 Method: OAuth2Exceptions.newForbiddenException(theMessage)
42.8.0 FHIR REST API
42.8.1 FHIR REST API
42.8.2 Method: create(resource)
42.8.3 Method: read(url)
42.8.4 Method: search().forResource(resourceType)
42.8.5 Method: transaction(IBundleBuilder theTransaction)
42.8.6 Method: translate()
42.8.7 Method: update(resource)
42.8.8 Method: patch(url, parameters)
42.8.9 Authentication
42.8.10 Tenant Selection
42.8.11 Concurrency Retry
42.8.12 Configuration Requirements for ONC (g)(10) Certification
42.9.0 FHIR Model API
42.9.1 FHIR Model API
42.9.2 Method: ResourceBuilder.build(resourceType)
42.9.3 Working with Resources
42.9.4 Working with Composition resources
42.9.5 Working with Bundle resources
42.9.6 Resource References
42.9.7 Contained Resources
42.9.8 Meta Elements
42.9.9 Patient Deceased Element
42.9.10 Removing Data
42.10.0 HL7 v2.x Mapping API
42.10.1 HL7 v2.x Mapping API
42.10.2 Path Syntax: Repetitions
42.10.3 Path Syntax: Groups and Nesting
42.10.4 Structure Interrogation
42.10.5 Content Clearing
42.10.6 Content Interrogation
42.10.7 Parsing Raw Field Values
42.10.8 Encoding
42.10.9 The Hl7V2 Object
42.10.10 Working with Variable Datatypes
42.10.11 Working with Z-Segments
42.11.0 HTTP API
42.11.1 HTTP API
42.11.2 Request Creation Methods
42.11.3 Request Execution Methods
42.11.4 Response Processing Methods
42.11.5 TLS / HTTPS
42.12.0 LDAP API
42.12.1 LDAP API
42.12.2 Method: searchByUsername(username)
42.12.3 Method: getStringAttributes(attributeName)
42.12.4 Method: isMemberOfGroup(groupDn)
42.13.0 Log API
42.13.1 Log API
42.13.2 Methods: debug(string), info(string), warn(string), error(string)
42.14.0 Composition Resource API
42.14.1 Composition Resource API
42.14.2 Method: set*(value)
42.14.3 Method: setDate(epoch)
42.14.4 Method: setType(documentType)
42.14.5 Method: addAttester(mode)
42.14.6 Method: addEvent()
42.14.7 Method: addSection(sectionType)
42.15.0 Composition Section API
42.15.1 Composition Section API
42.15.2 Method: populate(List resources)
42.15.3 Method: setTitle(title)
42.15.4 Method: setCode(system, code, display)
42.15.5 Method: addSection()
42.16.0 TransactionBuilder API
42.16.1 TransactionBuilder API
42.16.2 Method: newTransactionBuilder()
42.16.3 Method: withBundle(bundle)
42.16.4 Method: create(resource)
42.16.5 Method: update(resource)
42.16.6 Method: patch(resourceId, parameters)
42.16.7 Method Chain: createConditional(resource).onToken(parameter, system, value)
42.16.8 Method Chain: updateConditional(resource).onToken(parameter, system, value)
42.16.9 Methods: toXml(), toXml(prettyPrint), toJson(), toJson(prettyPrint)
42.16.10 Fhir.transaction(transaction)
42.17.0 Util API
42.17.1 Util API
42.17.2 Method: sleep(millis)
42.18.0 UUID API
42.18.1 UUID API
42.18.2 Method: newPlaceholderId()
42.19.0 XML API
42.19.1 XML API
42.19.2 Global function: XML.createDocument(str)
42.19.3 XPath Expressions
42.19.4 Traversing the Document
42.19.5 Function: toXMLString()
42.19.6 Manipulating the DOM
42.20.0 Callback Models
42.20.1 Callback Models
42.20.2 AssociatedResource
42.20.3 AuthenticationContext
42.20.4 AuthenticationFailure
42.20.5 AuthenticationRequest
42.20.6 ClientCredentialsAuthenticationRequest
42.20.7 CsvProcessorContext
42.20.8 FhirContextEntry
42.20.9 FhirEndpointTerminologyResponseMappingSpec
42.20.10 FhirEndpointTerminologyResponseMappingSpecSystem
42.20.11 GatewayConfiguration
42.20.12 GatewayCreateRoute
42.20.13 GatewayDeleteRoute
42.20.14 GatewayOperation
42.20.15 GatewayOperationRoute
42.20.16 GatewayReadRoute
42.20.17 GatewayRouteTarget
42.20.18 GatewaySearchRoute
42.20.19 GatewayTarget
42.20.20 GatewayTargetRetryStrategy
42.20.21 GatewayTransactionRoute
42.20.22 GatewayUpdateRoute
42.20.23 GrantedAuthority
42.20.24 Hl7V2GeneratedMessageContext
42.20.25 Hl7V2ReceivedMessage
42.20.26 Hl7V2ReceivedMessageConversionResult
42.20.27 LaunchContext
42.20.28 LaunchContextParameter
42.20.29 LaunchResourceId
42.20.30 MegaScaleCredentialRequest
42.20.31 MegaScaleCredentialResponse
42.20.32 OAuth2AuthorizationRequestDetails
42.20.33 OAuth2Client
42.20.34 OAuth2ClientSecret
42.20.35 OAuth2ClientSession
42.20.36 OAuth2Clients
42.20.37 OAuth2Keystore
42.20.38 OAuth2Keystores
42.20.39 OAuth2Server
42.20.40 OAuth2Servers
42.20.41 OAuth2SmartContextSelectionChoicePerson
42.20.42 OAuth2SmartContextSelectionChoices
42.20.43 Oauth2InvalidateTokensResponseJson
42.20.44 PackageInstallationSpec
42.20.45 PartitionDefinition
42.20.46 PartitionDefinitions
42.20.47 RequestDetailsJson
42.20.48 ScriptAuthenticationOutcomeFactory
42.20.49 ScriptConsentContextServices
42.20.50 SecurityInLdapAuthenticationContext
42.20.51 SecurityInSmartAuthenticationContext
42.20.52 SmartCodapAuthorizationRequest
42.20.53 SmartOnPostAuthorizeDetails
42.20.54 SmartScopeAuthorityNarrowingResult
42.20.55 UserDetails
42.20.56 UserDetailsChangeLaunchContextJson
42.20.57 UserDetailsList
42.20.58 UserDetailsOAuth2AllClientApprovals
42.20.59 UserDetailsOAuth2ClientApprovals
42.20.60 UserDetailsOAuth2ClientApprovalsApprovedScope
42.20.61 UserSessionDetails
43.0.0 Localization
43.0.0 Localization
43.0.1 Localization
43.1.0 Examples
43.1.1 Localization Customization Examples
43.1.2 Example: Unknown Search Parameter Message
43.1.3 Example: Custom SMART Scope Names
43.2.0 Available Localization Keys
43.2.1 Available Localization Keys
44.0.0 Smile CDR CLI (smileutil)
44.0.0 Introduction
44.0.1 Smile CLI Tool (smileutil)
44.0.2 Enabling Debug Logging
44.0.3 Memory Settings
44.1.0 Bulk Import
44.1.1 smileutil: Bulk Import
44.1.2 Usage
44.1.3 Options
44.2.0 Create FHIR Package
44.2.1 smileutil: Create FHIR Package
44.2.2 Usage
44.2.3 Options
44.3.0 Execute Script Function
44.3.1 smileutil: Test Script Function
44.3.2 Usage
44.3.3 Options
44.3.4 A Complete Example: Authenticate
44.3.5 Available Functions
44.3.6 Function: authenticate
44.4.0 Export ConceptMap to CSV
44.4.1 smileutil: Export ConceptMap to CSV
44.4.2 Usage
44.4.3 Options
44.5.0 HL7 v2.x Analyze Flat File
44.5.1 smileutil: HL7 v2.x Analyze Flat File
44.5.2 Usage
44.5.3 Options
44.6.0 HL7 v2.x Transmit Flat File
44.6.1 smileutil: HL7 v2.x Transmit Flat File
44.6.2 Usage
44.6.3 Options
44.6.4 Multiplex Paths
44.7.0 Import CSV to ConceptMap
44.7.1 smileutil: Import CSV to ConceptMap
44.7.2 Usage
44.7.3 Options
44.8.0 Map and Upload CSV Bulk Import File
44.8.1 Map and Upload CSV Bulk Import File
44.8.2 Usage
44.8.3 Options
44.9.0 Migrate Database
44.9.1 smileutil: Migrate Database
44.9.2 Options
44.9.3 Examples
44.10.0 Clear Database Migration Lock
44.10.1 smileutil: Clear Migration Lock
44.10.2 Example
44.10.3 Options
44.11.0 Module Config Properties Export
44.11.1 smileutil: Module Config Properties Export
44.11.2 Options
44.12.0 Reindex Terminology
44.12.1 smileutil: Reindex Terminology
44.12.2 Usage
44.12.3 Options
44.13.0 Synchronize FHIR Servers
44.13.1 smileutil: Synchronize FHIR Servers
44.13.2 Usage
44.13.3 Options
44.13.4 Selecting Resource Types to Synchronize
44.13.5 Using a Search as the Source
44.13.6 Using a Directory as the Source
44.13.7 Uploading Bundles as Transactions
44.13.8 Using Inline Match URLs
44.13.9 Prefixing Numeric IDs
44.13.10 Synchronization Modes
44.13.11 Uploading Synthea (Synthetic Generated) Resources
44.13.12 Setting up a Resource Gold Master
44.13.13 Load Balancing Target Servers
44.14.0 Upgrade H2 Database File
44.14.1 smileutil: Upgrade H2 Database File
44.14.2 Usage
44.14.3 Options
44.14.4 Example
44.15.0 Upload Bundle Files
44.15.1 smileutil: Upload Bundle Files
44.15.2 This Command Is Deprecated
44.15.3 Usage
44.15.4 Options
44.16.0 Upload CSV Bulk Import File
44.16.1 smileutil: Upload CSV Bulk Import File
44.16.2 Usage
44.16.3 Options
44.16.4 Sending Batches for a Single File
44.17.0 Upload Sample Dataset
44.17.1 smileutil: Upload Sample Dataset
44.17.2 Usage
44.17.3 Options
44.18.0 Upload Terminology
44.18.1 smileutil: Upload Terminology
44.18.2 Usage
44.18.3 Options
44.18.4 Example: Add Delta to Custom Terminology
44.19.0 Generate Realtime Export Schema
44.19.1 smileutil: Realtime Export Generation
44.19.2 Usage
44.19.3 Options
44.20.0 Validate FHIR Resources
44.20.1 smileutil: Validate FHIR Resources
44.20.2 Usage
44.20.3 Options
44.20.4 Profile Mode
44.20.5 Schema and Schematron Mode
45.0.0 Apache Camel Integration
45.0.0 Camel Module Overview
45.0.1 Camel Module Overview
45.0.2 Apache Camel Introduction
45.0.3 Apache Camel Data Formats
45.0.4 Smile Data Formats
45.0.5 Apache Camel Components
45.0.6 Smile Component
45.0.7 Camel Health Checks
45.0.8 The Spring Context Config Class
45.0.9 Packaging Your Camel Module Custom Classes
45.0.10 Deploying Your Camel Module Custom Classes
45.0.11 Example Project
45.1.0 Smile Camel Processors
45.1.1 Smile Processors Overview
45.1.2 Quick Reference
45.2.0 Processors: FHIR Storage module
45.2.1 FHIR Storage Processors
45.2.2 Resource Operation Processor
45.2.3 Transaction/Batch Bundle Processor
45.2.4 FHIR NDJSON Converter
45.3.0 Processors: ETL Import module
45.3.1 ETL Importer Processors
45.3.2 ETL Importer: CSV Processor
45.4.0 Processors: Camel module
45.4.1 Camel Processors
45.4.2 Channel Import Processor
45.4.3 Increment Retry Count Processor
45.5.0 Processors: Cluster Manager module
45.5.1 Cluster Manager Processors
45.5.2 Broker Consumer/Processor
45.5.3 Kafka Manual Commit
45.6.0 Processors: HL7v2 Inbound module
45.6.1 Hl7v2 Inbound Processors
45.6.2 Pre-Convert Script Processor
45.6.3 Pre-Convert Mapper Bean Processor
45.6.4 Pre-Convert Interceptor Processor
45.6.5 Convert HL7 v2.x to FHIR
45.6.6 Post-Convert Script Processor
45.6.7 Post-Convert Interceptor Processor
45.6.8 HL7v2 Inbound: Sample Route
45.7.0 Processors: CDA Exchange+ module
45.7.1 CDA Exchange+ Processors
45.7.2 CDA to FHIR Pre-Convert Script Processor
45.7.3 CDA to FHIR Pre-Convert Interceptor Processor
45.7.4 CDA to FHIR Conversion Processor
45.7.5 CDA to FHIR Post-Convert Script Processor
45.7.6 CDA to FHIR Post-Convert Interceptor Processor
45.7.7 Sample CDA Exchange+ route configuration
45.8.0 Processors: Transaction Logging
45.8.1 Transaction Logging Processors
45.8.2 Start Transaction Log Processor
45.8.3 Add Trabsaction Log Step Processor
45.9.0 Smile Camel Converters
45.9.1 Smile Camel Converters
46.0.0 Prior Auth CRD (Coverage Requirement Discovery)
46.0.0 Prior Auth CRD (Coverage Requirement Discovery) Module
46.0.1 Prior Auth CRD (Coverage Requirement Discovery) Module Overview
46.0.2 Prior Auth CRD (Coverage Requirement Discovery) Introduction
46.0.3 Prior Auth CRD (Coverage Requirement Discovery) Module Overview
47.0.0 Prior Auth DTR (Documentation Templates and Rules)
47.0.0 Prior Auth DTR (Documentation Templates and Rules) Module
47.0.1 Prior Auth DTR (Documentation Templates and Rules) Module Overview
48.0.0 Prior Auth Support
48.0.0 Prior Auth Support Module
48.0.1 Prior Auth Support Module Overview
48.0.2 Introduction
48.0.3 Operations
48.0.4 PAS Request Routing
49.0.0 Modules
49.0.0 JSON Admin API
49.0.1 JSON Admin API
49.0.2 Configuration Categories
49.0.3 Dependencies
49.1.0 Web Admin Console
49.1.1 Web Admin Console
49.1.2 Updated Web Admin Console UI
49.1.3 Configuration Categories
49.1.4 Dependencies
49.2.0 CDA Exchange
49.2.1 CDA Exchange
49.2.2 Configuration Categories
49.2.3 Dependencies
49.3.0 Channel Import
49.3.1 Channel Import
49.3.2 Configuration Categories
49.3.3 Dependencies
49.4.0 Cluster Manager
49.4.1 Cluster Manager
49.4.2 Configuration Categories
49.5.0 CQL
49.5.1 CQL
49.6.0 Audit Log Persistence
49.6.1 Audit Log Persistence
49.6.2 Configuration Categories
49.7.0 Transaction Log Persistence
49.7.1 Transaction Log Persistence
49.7.2 Configuration Categories
49.8.0 Digital Quality Measures (DQM)
49.8.1 Digital Quality Measures (DQM)
49.8.2 Operation and Feature Documentation
49.8.3 Premium Features
49.8.4 Required Modules
49.8.5 DQM UI
49.8.6 Configuration Categories
49.8.7 Dependencies
49.9.0 Documentation Templates and Rules (DTR)
49.9.1 Prior Auth DTR
49.9.2 Configuration Categories
49.9.3 Dependencies
49.10.0 Enterprise Master Patient Index
49.10.1 EMPI (deprecated)
49.10.2 Configuration Categories
49.11.0 CDS Hooks Endpoint
49.11.1 CDS Hooks REST Endpoint
49.11.2 Configuration Categories
49.11.3 Dependencies
49.12.0 FHIR Gateway Endpoint
49.12.1 FHIR Gateway REST Endpoint
49.12.2 Configuration Categories
49.12.3 Dependencies
49.13.0 FHIR REST Endpoint (All Versions)
49.13.1 FHIR REST Endpoint (All FHIR Versions)
49.13.2 Configuration Categories
49.13.3 Dependencies
49.14.0 FHIR REST Endpoint (DSTU2 - Deprecated)
49.14.1 FHIR REST Endpoint (DSTU2 - Deprecated)
49.14.2 Configuration Categories
49.14.3 Dependencies
49.15.0 FHIR REST Endpoint (DSTU3 - Deprecated)
49.15.1 FHIR REST Endpoint (R3 - Deprecated)
49.15.2 Configuration Categories
49.15.3 Dependencies
49.16.0 FHIR REST Endpoint (R4 - Deprecated)
49.16.1 FHIR REST Endpoint (R4 - Deprecated)
49.16.2 Configuration Categories
49.16.3 Dependencies
49.17.0 FHIRWeb Console
49.17.1 FHIRWeb Console
49.17.2 Configuration Categories
49.17.3 Dependencies
49.18.0 HL7 v2.x Listening Endpoint
49.18.1 HL7 v2.x Listening Endpoint
49.18.2 Configuration Categories
49.18.3 Dependencies
49.19.0 HL7 v2.x Listening Endpoint (Deprecated)
49.19.1 HL7 v2.x Listening Endpoint (Deprecated)
49.19.2 Configuration Categories
49.19.3 Dependencies
49.20.0 HL7 v2.x Sending Endpoint
49.20.1 HL7 v2.x Sending Endpoint
49.20.2 Configuration Categories
49.20.3 Dependencies
49.21.0 Hybrid Providers Endpoint
49.21.1 Hybrid Providers REST Endpoint
49.21.2 Configuration Categories
49.21.3 Dependencies
49.22.0 Package Registry Endpoint
49.22.1 Package Registry Endpoint
49.22.2 Configuration Categories
49.22.3 Dependencies
49.23.0 Subscription Websocket Endpoint
49.23.1 Subscription Websocket Endpoint
49.23.2 Configuration Categories
49.23.3 Dependencies
49.24.0 ETL Importer
49.24.1 ETL Importer
49.24.2 Configuration Categories
49.24.3 Dependencies
49.25.0 MDM
49.25.1 MDM
49.25.2 Configuration Categories
49.25.3 Plugins
49.26.0 MDM UI
49.26.1 MDM UI
49.26.2 Configuration Categories
49.26.3 Dependencies
49.27.0 Prior Auth CRD
49.27.1 Prior Auth CRD
49.27.2 Configuration Categories
49.27.3 Dependencies
49.28.0 Prior Auth Support
49.28.1 Prior Auth Support
49.28.2 Configuration Categories
49.28.3 Dependencies
49.29.0 Narrative Generator
49.29.1 Narrative Generator
49.29.2 Configuration Categories
49.30.0 FHIR Storage (DSTU2 RDBMS)
49.30.1 FHIR Storage (DSTU2 RDBMS)
49.30.2 Configuration Categories
49.30.3 Dependencies
49.31.0 FHIR Storage (R3 RDBMS)
49.31.1 FHIR Storage (R3 RDBMS)
49.31.2 Configuration Categories
49.31.3 Dependencies
49.32.0 FHIR Storage (R4 RDBMS)
49.32.1 FHIR Storage (R4 RDBMS)
49.32.2 Configuration Categories
49.32.3 Dependencies
49.33.0 FHIR Storage (R5 RDBMS)
49.33.1 FHIR Storage (R5 RDBMS)
49.33.2 Configuration Categories
49.33.3 Dependencies
49.34.0 FHIR Storage (Mongo)
49.34.1 FHIR Storage (MongoDB)
49.34.2 Configuration Categories
49.34.3 Dependencies
49.35.0 Realtime Export
49.35.1 Realtime Export
49.35.2 Configuration Categories
49.35.3 Plugins
49.36.0 LDAP Inbound Security
49.36.1 LDAP Inbound Security
49.36.2 Configuration Categories
49.36.3 Dependencies
49.37.0 Local Inbound Security
49.37.1 Local Inbound Security
49.37.2 Configuration Categories
49.37.3 Dependencies
49.38.0 SAML Inbound Security
49.38.1 SAML Inbound Security
49.38.2 Configuration Categories
49.38.3 Dependencies
49.39.0 Scripted Inbound Security
49.39.1 Scripted Inbound Security
49.39.2 Configuration Categories
49.39.3 Dependencies
49.40.0 SMART Inbound Security
49.40.1 SMART Inbound Security
49.40.2 Configuration Categories
49.40.3 Dependencies
49.41.0 SMART Outbound Security
49.41.1 SMART Outbound Security
49.41.2 Configuration Categories
49.41.3 Dependencies
49.42.0 Subscription Matcher (All FHIR Versions)
49.42.1 Subscription Matcher (All FHIR Versions)
49.42.2 Configuration Categories
49.42.3 Plugins
49.43.0 Subscription Matcher (DSTU2 - Deprecated)
49.43.1 Subscription Matcher (DSTU2 - Deprecated)
49.43.2 Configuration Categories
49.44.0 Subscription Matcher (DSTU3 - Deprecated)
49.44.1 Subscription Matcher (DSTU3 - Deprecated)
49.44.2 Configuration Categories
49.44.3 Plugins
49.45.0 Subscription Matcher (R4 - Deprecated)
49.45.1 Subscription Matcher (R4 - Deprecated)
49.45.2 Configuration Categories
49.45.3 Plugins
49.46.0 appSphere
49.46.1 appSphere
49.46.2 Configuration Categories
49.46.3 Dependencies
49.47.0 Payer to Payer
49.47.1 Payer to Payer
49.47.2 Configuration Categories
49.47.3 Dependencies
49.48.0 System to System Data Exchange
49.48.1 System to System Data Exchange
49.48.2 Configuration Categories
49.48.3 Plugins
49.49.0 Amazon HealthLake Outbound REST Connector
49.49.1 Amazon HealthLake Outbound REST Connector
49.49.2 Configuration Categories
49.49.3 Dependencies
49.50.0 License
49.50.1 License Manager
49.50.2 Configuration Categories
49.51.0 Camel
49.51.1 Camel
49.51.2 Configuration Categories
49.51.3 Dependencies
49.52.0 Consent Module
49.52.1 Consent
49.52.2 Configuration Categories
49.52.3 Dependencies
49.52.4 Dependencies
50.0.0 Amazon HealthLake Outbound REST Connector
50.0.0 Introduction
50.0.1 Amazon HealthLake Outbound REST Connector
50.1.0 Getting Started
50.1.1 Getting Started
50.1.2 Configuration
50.1.3 Subscription
50.1.4 Start/Stop/Restart Module
50.2.0 Data Management and Transfer
50.2.1 Data Management and Transfer
50.2.2 Security
50.2.3 Data Access and Transfer
50.2.4 Data Version Management
50.2.5 Historical Data Transfer
50.2.6 Logging
50.2.7 Error Handling
50.2.8 Troubleshooting
51.0.0 Appendix
51.0.0 Table of Contents
51.1.0 Demo Projects
52.0.0 Configuration Categories
52.0.0 Web Admin Console Settings
52.1.0 appSphere
52.2.0 Payer Config
52.3.0 Initial appSphere Seeding
52.4.0 Authentication Callback Scripts
52.5.0 Auth: General for APIs
52.6.0 User Authentication
52.7.0 Auth: HTTP Basic
52.8.0 Auth: OpenID Connect
52.9.0 Browser Syntax Highlighting
52.10.0 Camel
52.11.0 Capability Statement (metadata)
52.12.0 Care Gaps
52.13.0 CDA Export
52.14.0 CDA Generation
52.15.0 CDA Import
52.16.0 CDA Interceptors
52.17.0 CDA JavaScript Execution Scripts
52.18.0 CDA Terminology
52.19.0 CDS Hooks Definitions
52.20.0 CDS Hooks On FHIR
52.21.0 Channel Import
52.22.0 Channel Retry
52.23.0 Kafka
52.24.0 Cluster Manager Maintenance
52.25.0 Message Broker
52.26.0 Cluster Level Security
52.27.0 Consent
52.28.0 CQL
52.29.0 Credentials
52.30.0 Cross-Origin Resource Sharing (CORS)
52.31.0 Invoke Export
52.32.0 Member Match
52.33.0 Database
52.34.0 Da Vinci Health Record Exchange
52.35.0 EasyShare SMART Health Links
52.36.0 Email Configuration
52.37.0 MDM UI
52.38.0 ETL Import: CSV Properties
52.39.0 ETL Import: Source
52.40.0 Measure Evaluation
52.41.0 FHIR Binary Storage
52.42.0 FHIR Bulk Operations
52.43.0 Capability Statement
52.44.0 FHIR Configuration
52.45.0 Consent Service
52.46.0 FHIR Endpoint Conversion
52.47.0 FHIR Endpoint HFQL Support
52.48.0 FHIR Endpoint Partitioning
52.49.0 Resource Providers
52.50.0 FHIR Endpoint Security
52.51.0 Endpoint Terminology
52.52.0 FHIR Gateway Cache
52.53.0 FHIR Gateway Configuration
52.54.0 FHIR Interceptors
52.55.0 LiveBundle Service
52.56.0 FHIR MDM Server
52.57.0 FHIR Performance
52.58.0 FHIR Performance Tracing
52.59.0 FHIR Realtime Export
52.60.0 Repository Validation
52.61.0 FHIR Resource Types
52.62.0 FHIR REST Endpoint
52.63.0 FHIR Search
52.64.0 Custom Resource Types
52.65.0 IG Support
52.66.0 MegaScale
52.67.0 FHIR Storage Module Conditional Updates
52.68.0 FHIR Storage Module Scheduled Tasks
52.69.0 FHIR Validation Services
52.70.0 FHIR Validation Services Remote Terminology Client TLS / SSL (Encryption)
52.71.0 FHIR Storage Package Registry
52.72.0 FHIR Storage Partitioning
52.73.0 Versioned References
52.74.0 FHIR Subscription Delivery
52.75.0 FHIR Subscription Persistence
52.76.0 Full-Text Indexing
52.77.0 Amazon HealthLake REST Endpoint
52.78.0 HL7 v2.x Mapper - Contained Resource
52.79.0 HL7 v2.x Mapper - DG1
52.80.0 HL7 v2.x Mapper - Forced Namespace Mode
52.81.0 HL7 v2.x Mapper - General
52.82.0 HL7 v2.x Mapper - Medications
52.83.0 HL7 v2.x Mapper - OBR
52.84.0 HL7 v2.x to FHIR Mapper - OBSERVATION Group
52.85.0 HL7 v2.x Mapper - ORC
52.86.0 HL7 v2.x to FHIR Mapper - ORDER_OBSERVATION Group
52.87.0 HL7 v2.x Mapper - PID
52.88.0 HL7 v2.x Mapper - PV1
52.89.0 HL7 v2.x Mapper - TXA
52.90.0 Listener Interceptors
52.91.0 HL7 v2.x Listener Script
52.92.0 HL7 v2.x Listening Endpoint
52.93.0 HL7 v2.x MLLP Listener
52.94.0 HL7 v2.x MLLP Sender
52.95.0 FHIR to HL7 v2.x Mapper Script
52.96.0 HL7 v2.x Outbound Mapping
52.97.0 HTTP Access Log
52.98.0 HTTP Listener
52.99.0 HTTP Request Pool
52.100.0 HTTP Security
52.101.0 Hybrid Providers Definitions
52.102.0 IG Support
52.103.0 Initial User Seeding
52.104.0 JavaScript Execution Environment
52.105.0 JSON Web KeySet (JWKS)
52.106.0 LDAP Authentication
52.107.0 Smile CDR License
52.108.0 MDM
52.109.0 Migration
52.110.0 Narrative Generator
52.111.0 OpenID Connect Token Validation
52.112.0 OpenID Connect (OIDC)
52.113.0 Payer to Payer
52.114.0 Prior Authorization Coverage Requirement Discovery
52.115.0 Prior Authorization Documentation Templates and Requirements
52.116.0 Prior Authorization Support
52.117.0 Privacy Security Notice
52.118.0 Product Portal
52.119.0 Provenance Injection
52.120.0 Quality Payment Program (QPP)
52.121.0 Realtime Export
52.122.0 Endpoint Validation: Request Validating
52.123.0 Scheduler Configuration
52.124.0 Search Parameter Seeding
52.125.0 SAML Provider
52.126.0 Security Inbound Script
52.127.0 Inbound SMART on FHIR Authentication
52.128.0 Inbound SMART on FHIR Endpoints
52.129.0 OAuth2/OIDC Federation
52.130.0 SMART Callback Script
52.131.0 Cross-Organizational Data Access Profile
52.132.0 SMART Login Skin
52.133.0 SMART Login Terms of Service
52.134.0 SMART Authorization
52.135.0 SMART Definitions Seeding
52.136.0 Sessions
52.137.0 Two Factor Authentication
52.138.0 TLS / SSL (Encryption)
52.139.0 Transaction Log
52.140.0 Trusted Client
52.141.0 User Self Registration
52.142.0 Web Admin Console Settings
52.142.0 appSphere
52.142.0 Payer Config
52.142.0 Initial appSphere Seeding
52.142.0 Authentication Callback Scripts
52.142.0 Auth: General for APIs
52.142.0 User Authentication
52.142.0 Auth: HTTP Basic
52.142.0 Auth: OpenID Connect
52.142.0 Browser Syntax Highlighting
52.142.0 Camel
52.142.0 Capability Statement (metadata)
52.142.0 Care Gaps
52.142.0 CDA Export
52.142.0 CDA Generation
52.142.0 CDA Import
52.142.0 CDA Interceptors
52.142.0 CDA JavaScript Execution Scripts
52.142.0 CDA Terminology
52.142.0 CDS Hooks Definitions
52.142.0 CDS Hooks On FHIR
52.142.0 Channel Import
52.142.0 Channel Retry
52.142.0 Kafka
52.142.0 Cluster Manager Maintenance
52.142.0 Message Broker
52.142.0 Cluster Level Security
52.142.0 Consent
52.142.0 CQL
52.142.0 Credentials
52.142.0 Cross-Origin Resource Sharing (CORS)
52.142.0 Invoke Export
52.142.0 Member Match
52.142.0 Database
52.142.0 Da Vinci Health Record Exchange
52.142.0 EasyShare SMART Health Links
52.142.0 Email Configuration
52.142.0 MDM UI
52.142.0 ETL Import: CSV Properties
52.142.0 ETL Import: Source
52.142.0 Measure Evaluation
52.142.0 FHIR Binary Storage
52.142.0 FHIR Bulk Operations
52.142.0 Capability Statement
52.142.0 FHIR Configuration
52.142.0 Consent Service
52.142.0 FHIR Endpoint Conversion
52.142.0 FHIR Endpoint HFQL Support
52.142.0 FHIR Endpoint Partitioning
52.142.0 Resource Providers
52.142.0 FHIR Endpoint Security
52.142.0 Endpoint Terminology
52.142.0 FHIR Gateway Cache
52.142.0 FHIR Gateway Configuration
52.142.0 FHIR Interceptors
52.142.0 LiveBundle Service
52.142.0 FHIR MDM Server
52.142.0 FHIR Performance
52.142.0 FHIR Performance Tracing
52.142.0 FHIR Realtime Export
52.142.0 Repository Validation
52.142.0 FHIR Resource Types
52.142.0 FHIR REST Endpoint
52.142.0 FHIR Search
52.142.0 Custom Resource Types
52.142.0 IG Support
52.142.0 MegaScale
52.142.0 FHIR Storage Module Conditional Updates
52.142.0 FHIR Storage Module Scheduled Tasks
52.142.0 FHIR Validation Services
52.142.0 FHIR Validation Services Remote Terminology Client TLS / SSL (Encryption)
52.142.0 FHIR Storage Package Registry
52.142.0 FHIR Storage Partitioning
52.142.0 Versioned References
52.142.0 FHIR Subscription Delivery
52.142.0 FHIR Subscription Persistence
52.142.0 Full-Text Indexing
52.142.0 Amazon HealthLake REST Endpoint
52.142.0 HL7 v2.x Mapper - Contained Resource
52.142.0 HL7 v2.x Mapper - DG1
52.142.0 HL7 v2.x Mapper - Forced Namespace Mode
52.142.0 HL7 v2.x Mapper - General
52.142.0 HL7 v2.x Mapper - Medications
52.142.0 HL7 v2.x Mapper - OBR
52.142.0 HL7 v2.x to FHIR Mapper - OBSERVATION Group
52.142.0 HL7 v2.x Mapper - ORC
52.142.0 HL7 v2.x to FHIR Mapper - ORDER_OBSERVATION Group
52.142.0 HL7 v2.x Mapper - PID
52.142.0 HL7 v2.x Mapper - PV1
52.142.0 HL7 v2.x Mapper - TXA
52.142.0 Listener Interceptors
52.142.0 HL7 v2.x Listener Script
52.142.0 HL7 v2.x Listening Endpoint
52.142.0 HL7 v2.x MLLP Listener
52.142.0 HL7 v2.x MLLP Sender
52.142.0 FHIR to HL7 v2.x Mapper Script
52.142.0 HL7 v2.x Outbound Mapping
52.142.0 HTTP Access Log
52.142.0 HTTP Listener
52.142.0 HTTP Request Pool
52.142.0 HTTP Security
52.142.0 Hybrid Providers Definitions
52.142.0 IG Support
52.142.0 Initial User Seeding
52.142.0 JavaScript Execution Environment
52.142.0 JSON Web KeySet (JWKS)
52.142.0 LDAP Authentication
52.142.0 Smile CDR License
52.142.0 MDM
52.142.0 Migration
52.142.0 Narrative Generator
52.142.0 OpenID Connect Token Validation
52.142.0 OpenID Connect (OIDC)
52.142.0 Payer to Payer
52.142.0 Prior Authorization Coverage Requirement Discovery
52.142.0 Prior Authorization Documentation Templates and Requirements
52.142.0 Prior Authorization Support
52.142.0 Privacy Security Notice
52.142.0 Product Portal
52.142.0 Provenance Injection
52.142.0 Quality Payment Program (QPP)
52.142.0 Realtime Export
52.142.0 Endpoint Validation: Request Validating
52.142.0 Scheduler Configuration
52.142.0 Search Parameter Seeding
52.142.0 SAML Provider
52.142.0 Security Inbound Script
52.142.0 Inbound SMART on FHIR Authentication
52.142.0 Inbound SMART on FHIR Endpoints
52.142.0 OAuth2/OIDC Federation
52.142.0 SMART Callback Script
52.142.0 Cross-Organizational Data Access Profile
52.142.0 SMART Login Skin
52.142.0 SMART Login Terms of Service
52.142.0 SMART Authorization
52.142.0 SMART Definitions Seeding
52.142.0 Sessions
52.142.0 Two Factor Authentication
52.142.0 TLS / SSL (Encryption)
52.142.0 Transaction Log
52.142.0 Trusted Client
52.142.0 User Self Registration
53.0.0 Module Dependencies
53.0.0 Module Dependencies
54.0.0 Product Reference
54.0.0 Enumerated Types