Smile CDR v2024.05.PRE
On this page:

1.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.


1.0.0 Welcome to Smile CDR
1.0.0 Table of Contents
1.1.0 Smile CDR Maturity Model
1.1.1 List of Levels
1.1.2 Stable Features
1.1.3 Experimental Features
1.1.4 Trial Features
1.1.5 Deprecated Features
1.2.0 Smile CDR Premium Solutions
1.3.0 List of Features by Maturity
1.3.1 Experimental Features
1.3.2 Trial Features
1.3.3 Deprecated Features
1.4.0 Changelog (2024 Releases)
1.4.1 Smile CDR 2024.05.R01 (Borealis)
1.4.2 Smile CDR 2024.02.R01 (Apollo)
1.5.0 Changelog (2023 Releases)
1.5.1 Smile CDR 2023.11.R01 (TBD)
1.5.2 Smile CDR 2023.08.R03 (Yucatán)
1.5.3 Smile CDR 2023.08.R02 (Yucatán)
1.5.4 Smile CDR 2023.08.R01 (Yucatán)
1.5.5 Smile CDR 2023.05.R02 (Xenon)
1.5.6 Smile CDR 2023.05.R01 (Xenon)
1.5.7 Smile CDR 2023.02.R01 (Wizard)
1.5.8 Smile CDR 2022.11.R05 (Vishwa)
1.5.9 Smile CDR 2022.11.R04 (Vishwa)
1.5.10 Smile CDR 2022.11.R03 (Vishwa)
1.6.0 Changelog (2022 Releases)
1.6.1 Smile CDR 2022.11.R02 (Vishwa)
1.6.2 Smile CDR 2022.11.R01 (Vishwa)
1.6.3 Smile CDR 2022.08.R05 (Unicorn)
1.6.4 Smile CDR 2022.08.R04 (Unicorn)
1.6.5 Smile CDR 2022.08.R03 (Unicorn)
1.6.6 Smile CDR 2022.08.R02 (Unicorn)
1.6.7 Smile CDR 2022.08.R01 (Unicorn)
1.6.8 Smile CDR 2022.05.R07 (Tanuki)
1.6.9 Smile CDR 2022.05.R06 (Tanuki)
1.6.10 Smile CDR 2022.05.R05 (Tanuki)
1.6.11 Smile CDR 2022.05.R04 (Tanuki)
1.6.12 Smile CDR 2022.05.R03 (Tanuki)
1.6.13 Smile CDR 2022.05.R02 (Tanuki)
1.6.14 Smile CDR 2022.05.R01 (Tanuki)
1.6.15 Smile CDR 2022.02.R08 (Sojourner)
1.6.16 Smile CDR 2022.02.R07 (Sojourner)
1.6.17 Smile CDR 2022.02.R06 (Sojourner)
1.6.18 Smile CDR 2022.02.R05 (Sojourner)
1.6.19 Smile CDR 2022.02.R04 (Sojourner)
1.6.20 Smile CDR 2022.02.R03 (Sojourner)
1.6.21 Smile CDR 2022.02.R02 (Sojourner)
1.6.22 Smile CDR 2022.02.R01 (Sojourner)
1.6.23 Smile CDR 2021.11.R07 (Raccoon)
1.6.24 Smile CDR 2021.11.R06 (Raccoon)
1.6.25 Smile CDR 2021.11.R05 (Raccoon)
1.6.26 Smile CDR 2021.11.R04 (Raccoon)
1.6.27 Smile CDR 2021.08.R09 (Quasar)
1.6.28 Smile CDR 2021.08.R08 (Quasar)
1.7.0 Changelog (2021 Releases)
1.7.1 Smile CDR 2021.11.R03 (Raccoon)
1.7.2 Smile CDR 2021.11.R02 (Raccoon)
1.7.3 Smile CDR 2021.11.R01 (Raccoon)
1.7.4 Smile CDR 2021.08.R06 (Quasar)
1.7.5 Smile CDR 2021.08.R05 (Quasar)
1.7.6 Smile CDR 2021.08.R04 (Quasar)
1.7.7 Smile CDR 2021.08.R03 (Quasar)
1.7.8 Smile CDR 2021.08.R02 (Quasar)
1.7.9 Smile CDR 2021.08.R01 (Quasar)
1.7.10 Smile CDR 2021.05.R03 (Pangolin)
1.7.11 Smile CDR 2021.05.R02 (Pangolin)
1.7.12 Smile CDR 2021.05.R01 (Pangolin)
1.7.13 Smile CDR 2021.02.R05 (Odyssey)
1.7.14 Smile CDR 2021.02.R04 (Odyssey)
1.7.15 Smile CDR 2021.02.R03 (Odyssey)
1.7.16 Smile CDR 2021.02.R02 (Odyssey)
1.7.17 Smile CDR 2021.02.R01 (Odyssey)
1.7.18 Smile CDR 2020.11.R02 (Numbat)
1.8.0 Changelog (2020 Releases)
1.8.1 Smile CDR 2020.11.R01 (Numbat)
1.8.2 Smile CDR 2020.08.R03 (Manticore)
1.8.3 Smile CDR 2020.08.R02 (Manticore)
1.8.4 Smile CDR 2020.08.R01 (Manticore)
1.8.5 Smile CDR 2020.05.R02 (Labrador)
1.8.6 Smile CDR 2020.05.R01 (Labrador)
1.8.7 Smile CDR 2020.02.R01 (Koala)
1.9.0 Changelog (2019 Releases)
1.9.1 Smile CDR 2019.11.R01 (Jitterbug)
1.9.2 Smile CDR 2019.08.R01 (Igloo)
1.9.3 Smile CDR 2019.05.R02 (Hippo)
1.9.4 Smile CDR 2019.05.R01 (Hippo)
1.9.5 Smile CDR 2019.02.R01 (Gale)
1.10.0 Changelog (2018 Releases)
1.10.1 Smile CDR 2018.11.R01 (Food)
1.10.2 Smile CDR 2018.09.R01 (Economist)
1.10.3 Smile CDR 2018.05.R01 (Dromedário)
1.10.4 Smile CDR 2018.03.R01 (Crouton)
1.11.0 Changelog (2017 Releases)
1.11.1 Smile CDR 2017.11.R01 (Buccaneer)
1.11.2 Smile CDR 2017.09.R01 (Aardvark)
1.11.3 Smile CDR 2017.07.R01
2.0.0 Getting Started
2.0.0 Basic Concepts
2.0.1 Nodes and Modules
2.0.2 The Cluster Manager Module
2.0.3 Module Dependencies
2.1.0 Platform Requirements
2.1.1 Server Requirements
2.1.2 Java Requirements
2.1.3 Database Requirements
2.1.4 Database Testing Matrix
2.1.5 Support for AWS Secrets Manager JDBC Connections
2.1.6 Network Infrastructure
2.1.7 Event Streaming
3.0.0 Installation
3.0.0 Installing Smile CDR
3.0.1 Installing to Linux / OSX
3.0.2 Basic Configuration
3.0.3 Quick Start
3.0.4 The Initial Configuration
3.0.5 The Node Configuration Properties File
3.0.6 Node Configuration Properties
3.0.7 Module Property Source
3.0.8 Maintaining Module Configuration
3.0.9 Variable Substitution
3.0.10 Fetching Configuration Using Scripts
3.0.11 Configuring Your Database
3.0.12 Starting the CDR
3.0.13 API Gateways
3.1.0 Docker Container Installation
3.1.1 Quick Start
3.1.2 Basic Configuration
3.1.3 Customizing Smile CDR in Docker Container
3.1.4 Using System Environment for Variable Substitution
3.1.5 Configuring Databases for Smile CDR Installed in Container
3.2.0 Unix Service Installation
3.2.1 Testing the Service
3.2.2 Starting Automatically on Boot
3.3.0 Tuning your Installation
3.3.1 Memory Settings
3.4.0 Message Brokers
3.4.1 Subscription Channels
3.4.2 Subscription Channel Names
3.4.3 Modules Dependent On Message Brokers
3.5.0 Message Broker Failure Management
3.6.0 Message Broker: Kafka
3.6.1 Kafka Topic Names
3.6.2 Kafka - Overriding Default Configuration Settings
3.7.0 Message Broker: ActiveMQ
3.7.1 Resource Limits
3.8.0 Pre-Seeding Configuration and Data
3.8.1 Pre-Seeding Module Configuration
3.8.2 Variable Substitution for Pre-Seeding files
3.8.3 Pre-Seeding Users
3.8.4 Pre-Seeding OpenID Connect Servers
3.8.5 Pre-Seeding OpenID Connect Clients
3.8.6 Pre-Seeding OpenID Connect Keystores
3.8.7 Pre-Seeding Packages and FHIR Resources
3.9.0 Upgrading Smile CDR
3.9.1 Simple Upgrade Process - Upgrading the Binary on a Single Server
3.9.2 Upgrade Docker Container as Non-root
3.9.3 Upgrading a Cluster of Servers with Zero Downtime
3.9.4 Subscriptions
3.9.5 Recommended Upgrade Strategy
3.10.0 Production Checklist
3.10.1 Host Server Setup
3.10.2 Network Infrastructure
3.10.3 CDR Process Settings
3.10.4 FHIR Server Performance
3.10.5 Monitoring
3.10.6 Security
3.10.7 Message Broker
3.10.8 Cluster Design
3.11.0 Module Licensing
4.0.0 Tutorial and Tour
4.0.0 Preamble and Setup
4.0.1 Getting Up to Speed
4.0.2 Preparing Your Instance
4.0.3 Accessing the Web Admin Console
4.0.4 Enabling Anonymous Access to the FHIR Endpoint
4.0.5 Uploading Sample FHIR Resources
4.1.0 Processing HL7 v2.x Feeds
4.1.1 Transmitting to Smile CDR
4.1.2 ORU (Observation Result) Messages
4.1.3 ADT (Admission/Discharge/Transfer) Messages
4.2.0 Federated OAuth2/OIDC Setup
4.2.1 Setting up Smile CDR - SMART Outbound Security Module
4.2.2 Setting up Smile CDR - OIDC Client Definition
4.2.3 Setting up Smile CDR - OIDC Server Definition
4.2.4 Setting up the IDP
4.2.5 Starting the Federated Flow
4.2.6 Token Signature Algorithms
4.2.7 Considerations
5.0.0 The FHIR Standard
5.0.0 FHIR Introduction
5.0.1 Resources
5.0.2 Datatypes
5.0.3 Parts of a Resource
5.0.4 Encodings (MIME Types, Wire Formats)
5.0.5 The JSON Format
5.0.6 The XML Format
5.1.0 FHIR CRUD Operations
5.1.1 Testing Tools
5.1.2 FHIR Create
5.1.3 FHIR Read / vRead
5.1.4 FHIR Update
5.1.5 FHIR Patch
5.1.6 FHIR Delete
5.1.7 Controlling the Response Payload
5.1.8 Storage Outcome Status Codes
5.2.0 FHIR Searching Basics
5.2.1 How Searching Works
5.2.2 Basic Searching: Finding Patients
5.2.3 Quantities: Finding Laboratory Values
5.2.4 Dates and Times: Narrowing Your Search Window
5.2.5 Paging Search Results
5.2.6 Sorting Search Results
5.2.7 Fulltext Searching
5.2.8 The Patient $everything Search (Across Patient Chart)
5.3.0 FHIR Search: References and Includes
5.3.1 References Example
5.3.2 Searching By Reference
5.3.3 Chained References
5.3.4 Reverse Chained References
5.3.5 Including Reference Targets
5.3.6 Reverse Includes
5.3.7 Chaining into Contained Resources
5.3.8 Example: Using subject Group Membership to Filter Results
5.4.0 FHIR Search: Custom Search Parameters
5.4.1 An Example Search Parameter
5.4.2 Search Parameter Expressions
5.4.3 Combo Search Index Parameters
5.4.4 Enforcing Uniqueness
5.5.0 FHIR Transactions and Batches
5.5.1 A Basic Transaction
5.5.2 Creating Multiple Related Resources
5.5.3 Placeholder IDs and References
5.5.4 Conditional Creates
5.5.5 Conditional Updates
5.5.6 Example: Conditional Create Patient and Create Other Data
5.5.7 Deletes
5.5.8 Patching
5.5.9 Example: Conditional Create + Patch On Same Resource
5.6.0 FHIRPath Expressions
5.6.1 Testing FHIRPath Expressions
5.6.2 Expression: Extension With Reference Value
5.6.3 Expression: Nested Extension
5.6.4 Expression: Contained Resource
5.6.5 Expression: Bundle (FHIR Message) Entry Resource
5.6.6 Expression: Bundle (FHIR Document) Entry Resource
5.6.7 Expression: Multiple Paths
6.0.0 FHIR Storage
6.0.0 Concepts in Smile CDR
6.0.1 The FHIR Storage Module
6.0.2 The FHIR REST Endpoint Module
6.0.3 Clustering
6.1.0 FHIR Storage Modules
6.1.1 Feature Comparison Summary
6.1.2 Features
6.1.3 FHIR Operations
6.1.4 Search Parameters
6.1.5 Search Parameter Types
6.2.0 FHIR Endpoint Module
6.2.1 Creating the Module
6.2.2 Request Transaction IDs
6.2.3 Capturing Source Information
6.2.4 Response Watermarking
6.2.5 Validation
6.2.6 Configuration
6.3.0 FHIRWeb Console
6.3.1 Architecture
6.3.2 Security
6.3.3 Creating the Module
6.3.4 Using the Console
6.3.5 Configuration
6.4.0 OpenAPI / Swagger Support
6.4.1 Swagger UI
6.4.2 OpenID Connect Support
6.4.3 Limitations
6.5.0 FHIR Endpoint Customization
6.5.1 Customizing Available Interactions
6.5.2 Customizing CapabilityStatement and OpenApi
6.6.0 Resource IDs
6.6.1 Server Assigned IDs
6.6.2 Client Assigned IDs
6.7.0 Search Parameters
6.7.1 Search Parameter Concepts
6.7.2 Default Search Parameters
6.7.3 Managing Search Parameters
6.7.4 Search Parameter Statistics
6.7.5 Filter Search Parameter
6.8.0 Search Parameter Features
6.8.1 Searching by English nickname (:nickname)
6.8.2 Index Missing Search Parameters (:missing)
6.8.3 Suppress Text Index on Tokens (:text)
6.8.4 Index Contained Resources
6.9.0 Phonetic Search Parameters
6.10.0 Search Parameter Tuning
6.10.1 Checking Active Parameters
6.10.2 Seeding Search Parameters
6.11.0 Search Parameter Reindexing
6.11.1 $reindex Operation (Server)
6.11.2 $reindex Operation (Instance)
6.11.3 $reindex-dryrun Operation (Instance)
6.11.4 Legacy Manual Reindex Operation
6.12.0 Searching for Data
6.12.1 FHIR Search Extensions
6.12.2 Unsupported Search Parameters
6.12.3 Limitations
6.13.0 Creating Data
6.13.1 Validating References and Referential Integrity
6.13.2 Transactions and Submitting Bundles
6.13.3 Auto-Creating Reference Targets
6.13.4 Auto-Create Placeholder Reference Targets
6.13.5 Auto-Create Placeholder Reference Targets with Identifier
6.13.6 Auto-Created Placeholder Extension
6.13.7 Searching for Auto-Created Resources
6.13.8 Auto-Creating Reference Targets and Enforcing Uniqueness
6.13.9 Mass Ingestion Mode
6.14.0 Reading Data
6.14.1 Diff Operation
6.14.2 Diff Instance
6.14.3 Diff Type
6.14.4 $everything operation
6.15.0 Updating Data
6.15.1 Patching Data
6.15.2 Tag Retention
6.15.3 Concurrent Write Errors
6.16.0 Deleting Data
6.16.1 Deletes and Referential Integrity
6.16.2 Transactional Delete
6.16.3 Referential Integrity
6.16.4 Cascading Deletes
6.16.5 The $expunge Operation
6.16.6 Delete Expunge
6.17.0 Binary Data
6.17.1 Externalized Binary Storage
6.17.2 Binary Access Operations
6.17.3 Serving Raw Media Resources
6.17.4 Serving binary data within a FHIR Resource
6.18.0 Request Tracing and Provenance
6.18.1 Request Tracing
6.18.2 Performance Tracing
6.18.3 Storing Source Information
6.19.0 FHIR Versions
6.20.0 Resource Versions and Versioned References
6.20.1 Disabling Resource History
6.20.2 Rewriting Resource History
6.20.3 Versioned Resource References
6.20.4 Allow Versioned References
6.20.5 Automatically Version References
6.21.0 Tags, Profiles, and Security Labels
6.21.1 Search Parameters
6.22.0 Clinical Quality Language (CQL)
6.22.1 Evaluate Measure
6.23.0 Partitioning and Multitenancy
6.23.1 Storage Module Support
6.23.2 Enabling Partitioning in Smile CDR
6.23.3 Request Partition Selection Mode
6.23.4 Request Partition Security
6.23.5 Tenant Identification Strategies
6.23.6 Seeding Partitions
6.23.7 Patient ID Partition Mode
6.23.8 Cross-Partition References
6.23.9 Disabling Partition Security
6.23.10 Supported Modules
6.24.0 Custom Resource Types
6.24.1 Defining Custom Resource Type Classes
6.24.2 Packaging and Deploying Your Custom Resource Types
6.24.3 Search Parameters
6.25.0 Batch and Scheduled Jobs
6.25.1 Batch Jobs
6.25.2 Architecture
6.25.3 Optimizing Batch Job Performance
6.25.4 Clustered Scheduled Jobs
6.25.5 Local Scheduled Jobs
6.25.6 Scheduler Performance
7.0.0 FHIR Storage (Relational)
7.0.0 FHIR Storage (Relational) Module
7.0.1 Preparing for a New Installation
7.0.2 Creating the Module
7.0.3 Database Schema
7.0.4 Multi-Node Architectures
7.0.5 Configuration
7.1.0 Resource Storage Mode
7.1.1 Resource Body Storage
7.2.0 Performance Tuning
7.2.1 Improving Write Performance
7.2.2 Example Properties File
7.2.3 Disabling Non Resource DB History
7.3.0 Lucene Indexing
7.3.1 Lucene Disk Provider
7.3.2 Elasticsearch/OpenSearch Provider
7.4.0 Performance and Caching
7.4.1 The Query Cache
7.4.2 Search Counts
7.5.0 Chained Searching and Sorting
7.5.1 Uplifted Refchains and Chaining Performance
7.5.2 Document and Message Search Parameters
7.5.3 Chained Sorting
7.6.0 MegaScale
7.6.1 Architecture
7.6.2 Limitations
7.6.3 Configuration
7.6.4 Connection Provider Interceptor
8.0.0 FHIR Storage (MongoDB)
8.0.0 FHIR Storage (MongoDB) Module
8.0.1 Preparing for a New Installation
8.0.2 Creating the Module
8.0.3 MongoDB Document Schema
8.0.4 MongoDB Uplift Search Parameter Extensions
8.0.5 Uplifting Tokens
8.0.6 Uplifting Reference Chains
8.0.7 Configuration
8.1.0 MongoDB Sharding / Partitioning
8.1.1 Scope and Limitations
8.1.2 Enabling Sharding
8.1.3 Architecture
9.0.0 Validation and Conformance
9.0.0 Introduction
9.0.1 Validation Modes
9.1.0 Validation Support Repository
9.1.1 Potential Architectures
9.1.2 Single FHIR Repository (RDBMS)
9.1.3 Dedicated Validation Support Repository
9.1.4 Non-Repository Models
9.2.0 Validation Support Repository Options
9.2.1 Validating References
9.2.2 Handling Missing CodeSystems
9.2.3 Handling Multiple Codings
9.2.4 Code Display Mismatch Policy
9.3.0 Conformance Data
9.3.1 StructureDefinition resources
9.3.2 CodeSystem Resources
9.3.3 ValueSet Resources
9.4.0 Repository Validation
9.4.1 Validation Support Repository
9.4.2 Methods
9.5.0 Repository Validation: Java
9.6.0 Repository Validation: Javascript
9.6.1 Function: repositoryValidationProvideRules(theRuleBuilder)
9.6.2 Example: Require a Specific Profile
9.6.3 Example: Allow Several Profiles for a Resource Type
9.6.4 Example: Require Profile and Validate
9.7.0 Repository Validation: Validation Bean
9.8.0 Endpoint Validation
9.9.0 Packages and Implementation Guides
9.9.1 Background: Implementation Guides
9.9.2 Background: Packages
9.9.3 Ingesting Packages into Smile CDR
9.9.4 Package Pre-Seed Installation
9.9.5 Pre-Seeding Resources into the Repository
9.9.6 Creating Packages
9.10.0 Package Registry Endpoint Module
9.10.1 Swagger UI
9.10.2 Operation: Fetch Metadata By Package ID
9.10.3 Operation: Fetch Package
9.10.4 Operation: Search For Packages
9.10.5 Operation: Install By Param
9.10.6 Operation: Install By Spec
9.10.7 Operation: Delete By Spec
9.11.0 Remote Terminology Services
9.11.1 Scope
9.11.2 Remote Terminology Server Requirements
9.12.0 Suppressing Messages
9.13.0 Validation Performance
9.14.0 Automatic Provenance Injection
9.14.1 Provenance Injection Feature
9.14.2 Provenance Injection Data
10.0.0 Terminology
10.0.0 Terminology Introduction
10.0.1 Unsupported Operations
10.1.0 Uploading Codes
10.1.1 Uploading External CodeSystems
10.1.2 Uploading ICD-10-CM
10.1.3 Uploading LOINC
10.1.4 Uploading SNOMED CT
10.1.5 Uploading Custom Vocabularies
10.1.6 Applying Deltas to External CodeSystems
10.1.7 Delta Add Operation: $apply-codesystem-delta-add
10.1.8 Delta Remove Operation: $apply-codesystem-delta-remove
10.1.9 Reference: CSV Vocabulary Input Files
10.2.0 Terminology and Lucene Indexing
10.2.1 Validation
10.2.2 Operations
10.3.0 ValueSet Expansion
10.3.1 ValueSet Expansion Pre-Calculation
10.3.2 Expanding Hierarchical CodeSystems and ValueSets
10.3.3 Searching for Codes
10.4.0 FHIR Response Terminology Mapping
10.4.1 Response Terminology Mapping
10.4.2 Response Coding Displays
11.0.0 Subscription
11.0.0 Introduction
11.0.1 The Subscription Resource
11.0.2 Subscription Activation
11.0.3 Delivery Retry Handling
11.0.4 MultiTenancy and Subscriptions
11.0.5 Criteria
11.0.6 Synchronization of Subscription updates
11.0.7 Troubleshooting Subscriptions
11.1.0 Architecture
11.1.1 Enabling and Configuring Subscription Processing
11.2.0 Channel Types
11.2.1 Channel Type: rest-hook
11.2.2 Channel Type: email
11.2.3 Channel Type: websocket
11.2.4 Channel Type: message
11.3.0 Delivery Options
11.3.1 Payload Search Result Mode
11.3.2 Replication Mode
11.3.3 Strip Version IDs
11.3.4 Delivering Latest Version
11.3.5 Delivering Delete Events
11.3.6 Custom Delivery Class
11.3.7 Kafka Record Header Delivery
11.3.8 DEPRECATED: Delivery to Site-defined External Queue
11.4.0 Manual Triggering
11.5.0 Topic Subscriptions
12.0.0 Interceptors
12.0.0 Interceptors
12.0.1 HAPI FHIR and Smile CDR Pointcuts
12.0.2 Deploying Interceptors to Smile CDR Modules
12.0.3 Registering a Client Interceptor
12.1.0 Pointcuts
12.2.0 Starter Project
12.2.1 Using the Starter Project
12.2.2 Interceptor Template classes
12.3.0 Examples: FHIR Endpoints
12.3.1 Example: Override CapabilityStatement Generation
12.3.2 Example: Starter Server interceptor for all SERVER_xxx pointcuts
12.4.0 Examples: HL7v2 Endpoints
12.4.1 Example: Starter Server interceptor for all HL7v2 pointcuts
12.5.0 Examples: FHIR Storage
12.5.1 Example: Response Attribute Enhancement
12.5.2 Example: Server-Reserved Tags
12.5.3 Example: JavaScript Storage Interceptor
12.5.4 Example: MegaScale Connection Provider
12.5.5 Example: Starter Storage interceptor for all STORAGE_xxx pointcuts
12.6.0 Examples: FHIR Gateway
12.6.1 Pointcuts
12.6.2 Example: Direct Search based on Parameter Value
12.6.3 Example: Modify Target Search based on Previous Target Search
12.6.4 Example: Modify Target Search Results
12.6.5 Example: Modify Target Search Uri
12.6.6 Example: Search Using Alternate Patient ID
12.6.7 Example: Starter Gateway interceptor for all FHIRGW_xxx pointcuts
12.7.0 Examples: FHIR Client
12.7.1 Example: Starter Client interceptor for all CLIENT_xxx pointcuts
12.8.0 Examples: MDM
12.8.1 Example: Operate on resources analyzed by MDM, before and after analysis
12.8.2 Example: Starter MDM interceptor for all MDM_xxx pointcuts
12.9.0 Examples: Subscription
12.9.1 Example: Adding Authorization header
12.9.2 Example: Starter Subscription interceptor for all SUBSCRIPTION_xxx pointcuts
12.10.0 Examples: Channel Import
12.10.1 Example: Starter Channel Import interceptor for CHANNEL_IMPORT_MESSAGE_PRE_PROCESSED pointcut
12.11.0 Examples: Cluster Manager
12.11.1 Example: Starter Server interceptor for all appSphere Pointcuts
12.12.0 2024.02.01 Migration Guide
13.0.0 Channel Import
13.0.0 Channel Import Overview
13.0.1 Enabling and Configuring Channel Import
13.0.2 Channel Import With Partitioning Enabled
14.0.0 Realtime Export
14.0.0 Realtime Export Overview
14.0.1 Operational Overview
14.0.2 Limitations
14.0.3 Troubleshooting
14.1.0 Realtime Export Rules Definition
14.1.1 Transformers
14.1.2 Named Transformers
14.1.3 Managing high-cardinality elements
14.2.0 Using FHIRPath
14.2.1 Collection Subsetting
14.2.2 Self-referral
14.2.3 Conditionals
14.3.0 Debezium
15.0.0 Security
15.0.0 Security in Smile CDR
15.0.1 Inbound Security Module
15.0.2 FHIR Listener Module
15.0.3 Admin Modules
15.0.4 Auth Directory
15.0.5 Audit Database
15.0.6 Outbound Security Modules
15.1.0 Authentication Protocols
15.1.1 HTTP Basic
15.1.2 OpenID Connect (OIDC) and SMART on FHIR
15.1.3 Security Access Markup Language (SAML)
15.2.0 Authorization and Consent
15.2.1 Authorization Service
15.2.2 Consent Service
15.3.0 Inbound Security Module
15.3.1 Permissions
15.3.2 Callback Script
15.4.0 Local Inbound Security Module
15.4.1 Configuration: Credentials
15.4.2 Caching
15.4.3 User Self Registration
15.5.0 LDAP Inbound Security Module
15.5.1 Requirements
15.5.2 Permissions
15.5.3 Callback Scripts
15.5.4 Configuration
15.6.0 Scripted Inbound Security Module
15.6.1 Script Format
15.6.2 Script Examples
15.7.0 SAML Inbound Security Module
15.7.1 SAML 2.0 Authentication Request Protocol
15.7.2 Enabling SAML Authentication
15.7.3 Entity ID Template
15.7.4 Authentication Scripts
15.7.5 Function: authenticate(theRequest, theOutcomeFactory)
15.7.6 Authorizing SMART on FHIR Apps using SAML
15.8.0 Trusted Client Mode
15.8.1 Configuring Trusted Client Mode
15.8.2 Making Trusted Client Requests
15.8.3 Automatically Creating Users
15.9.0 Roles and Permissions
15.9.1 System-Defined Roles
15.9.2 System-Defined Permissions
15.9.3 System-Defined Negative Permissions
15.9.4 Block Unless Code in ValueSet
15.10.0 Callback Scripts
15.10.1 Function: onAuthenticateSuccess
15.10.2 Function: onSmartLoginPreContextSelection(theUserSession, theContextSelectionChoices)
15.10.3 Function: onTokenGenerating(theUserSession, theAuthorizationRequestDetails)
15.10.4 Function: onPostAuthorize(theDetails)
15.10.5 Function: authenticate(theRequest, theOutcomeFactory)
15.10.6 Function: getUserName(theOidcUserInfoMap, theServerInfo)
15.11.0 Anonymous Access
15.12.0 Consent Service
15.12.1 Enabling the Consent Service
15.13.0 Consent Service: JavaScript API
15.13.1 Method: consentStartOperation
15.13.2 Method: consentCanSeeResource
15.13.3 Method: consentWillSeeResource
15.13.4 Method: completeOperationSuccess
15.13.5 Method: completeOperationFailure
15.13.6 Example: Tag-Based Consent Script
15.13.7 Example: Scope-Based Consent Script
15.14.0 Consent Service: Java API
15.14.1 Example
15.15.0 Security Recipes
15.15.1 App: Local Users with HTTP Basic Authentication
15.15.2 Integrating SMART Apps With a 3rd-Party OIDC Server
15.16.0 Two Factor Authentication
15.16.1 User Activating TOTP
15.16.2 Enforcing Two Factor Authentication
15.17.0 Troubleshooting Security
16.0.0 SMART on FHIR
16.0.0 SMART on FHIR: Introduction
16.0.1 The SMART Launch Sequence
16.0.2 The Interactive Launch Process
16.1.0 SMART: Scopes
16.1.1 Picking Scopes
16.1.2 Launch Context Scopes
16.1.3 The OpenID and Profile Scopes
16.1.4 fhirContext
16.2.0 SMART: Auth Flows
16.2.1 Launch Flow: Authorization Code
16.2.2 Security Option: Proof Key for Code Exchange (PKCE)
16.2.3 Launch Flow: Implicit Grant
16.2.4 Launch Flow: Resource Owner Password Credentials
16.2.5 Non-Interactive User Flow: Cross-Organization Data Access Profile
16.2.6 System Flow: Client Credentials
16.2.7 System Flow: Client Credentials with JWT Credential
16.2.8 System Flow: Refresh Token
16.3.0 SMART: Endpoints
16.3.1 Server Metadata Endpoint
16.3.2 UserInfo Endpoint
16.4.0 Client Management
16.4.1 Remembering Approved Scopes
16.4.2 Client Secrets
16.5.0 OIDC Keystores
16.6.0 SMART: Smile CDR Support
16.6.1 Models for Using External OIDC Servers
16.6.2 Supported Scopes
16.6.3 Online / Offline Access
16.7.0 SMART Outbound Security: Module
16.7.1 Setting Up This Module
16.7.2 Terms of Service
16.7.3 Plain-language Developer Attestation
16.7.4 Client Credentials Grant
16.7.5 Cross-Organization Data Access Profile Grant
16.7.6 SMART Callback Scripts
16.7.7 User Self Registration
16.8.0 SMART Outbound Security: Skinning
16.8.1 Creating a Skin
16.8.2 Installing a Skin
16.8.3 HTML Template Files
16.8.4 Sample Skin Project
16.9.0 SMART Outbound Security: Context Selection
16.10.0 SMART Outbound Security: SAML Bridging
16.10.1 Creating a SAML to SMART Bridge
16.11.0 SMART: Federated OAuth2/OIDC Login
16.11.1 Federated Flow
16.11.2 Considerations
16.11.3 Setting Up Federated OAuth2/OIDC Login
16.11.4 Authorization Script
16.11.5 Server Selection Interceptor
16.12.0 SMART: Application Approval/Consent
16.12.1 Approval Overview
16.12.2 Auto-Approve / Auto-Grant Scopes
16.12.3 Approval Flow
16.12.4 Customizing Scope Names
16.12.5 Custom Security Scopes
16.12.6 Revocation Page
16.13.0 SMART Inbound Security Module
16.13.1 Requirements
16.13.2 Setting Up This Module
16.13.3 Accepting Tokens
16.13.4 Accepting Internal Access Tokens
16.13.5 Accepting External Access Tokens
16.13.6 Validating Tokens
16.13.7 Creating a Server Definition
16.13.8 Assigning Permissions
16.13.9 Function: authenticate(...)
16.13.10 Function: getUserName(...)
16.14.0 SMART: Session Management
16.14.1 Token Revocation Endpoint
16.14.2 User Logout Endpoint
16.15.0 SMART: Assigning Permissions
16.15.1 Scope Permission Model
16.15.2 User and Patient Resource Linkage
16.16.0 SMART: Access Tokens
16.17.0 SMART: User Profile Information
16.18.0 FHIR Client Authentication
16.18.1 Rejecting Unauthorized FHIR Calls
17.0.0 appSphere
17.0.0 Introduction
17.1.0 Getting Started
17.1.1 Setting-up a Sandbox Environment
17.1.2 Config Diagnostics
17.2.0 Associated Module Configurations
17.2.1 Configuration of JSON Admin API module
17.2.2 Configuration of FHIR Endpoint Module
17.2.3 Configuration of SMART Auth Module
17.2.4 Configuring SMART Auth modules to support multiple OIDC endpoints
17.2.5 Setting-up Federated OAuth to work with appSphere
17.3.0 Client Creation and Configuration
17.4.0 Other Configurations
17.4.1 Configuring NGINX for the Module
17.4.2 Configuring Different Users
17.5.0 Developer Portal
17.5.1 API Documentation for Dev Portal
17.5.2 Developer Registration
17.5.3 Developer Portal: UI Description
17.5.4 Sandbox Testing: UI Description
17.5.5 Repository Partitions
17.5.6 App Registration
17.5.7 Managing 'Draft' App Registrations and Re-registrations
17.5.8 App Information Page
17.5.9 Attestation
17.5.10 New App versions
17.5.11 Backend Service Registration
17.5.12 Additional Considerations
17.6.0 App Management Console
17.6.1 Management Console: UI Description
17.6.2 App Review and Management
17.6.3 Backend Service Review and Management
17.6.4 Additional Considerations
17.7.0 App Gallery
17.7.1 App Gallery: UI Description
17.7.2 Gallery Functionality
17.8.0 Appendix
17.8.1 Config Diagnostics
17.8.2 App Registration Help Text
17.8.3 Sign Up Help Text
17.8.4 Smile CDR Config
17.8.5 Attestation Creation
17.8.6 Current Software Versions --TRAIL--
17.8.7 Troubleshooting
17.8.8 Reference Documents
17.8.9 Glossary of Terms
18.0.0 FHIR Gateway
18.0.0 FHIR Gateway Introduction
18.0.1 Troubleshooting
18.0.2 Configuring Consent Service
18.1.0 Configuration: Initial Setup
18.1.1 Server Configuration
18.1.2 Encryption JWKS (Keystore)
18.1.3 Configuration Document
18.1.4 Interceptors
18.1.5 Error Handling
18.2.0 Configuration: Document
18.2.1 Defining Targets
18.2.2 Defining Search Routes
18.2.3 Defining Read, Create, Update, and Delete Routes
18.2.4 Defining Operation Routes
18.2.5 Defining a Retry Strategy
18.3.0 Custom Operations
18.3.1 Sample Custom System Operation Provider
18.3.2 Processing Target Invocation Responses
18.3.3 The Spring Context Config Class
18.3.4 Packaging Your Providers
18.3.5 Deploying Your Custom Providers
18.4.0 Caching
19.0.0 FHIR Hybrid Providers
19.0.0 Hybrid Providers
19.0.1 Architecture
19.0.2 Resource Providers
19.0.3 CapabilityStatement
19.0.4 The Spring Context Config Class
19.0.5 Interceptor Loading
19.0.6 Building Your Hybrid Providers
19.0.7 Paging
19.0.8 Camel Services
19.0.9 Packaging Your Providers
19.0.10 Deploying Your Hybrid Providers
19.0.11 Accessing Security Attributes
19.0.12 Configuring Consent Service
19.0.13 Accessing Dao (Data Access Object)
19.0.14 Exceptions
19.0.15 Example Project
19.1.0 REST Custom Operations
20.0.0 LiveBundle
20.0.0 LiveBundle Overview
20.0.1 Configuration
20.0.2 Usage
20.0.3 LiveBundle Architecture
20.0.4 LiveBundle Aggregation
20.0.5 LiveBundle Retrieval
20.0.6 LiveBundle Seeding
20.0.7 LiveBundle Troubleshooting
20.1.0 LiveBundle API
20.1.1 Add a Subscriber to a Watchlist
20.1.2 Remove Subscriber from a Watchlist
20.1.3 View list of Subscribers to a Watchlist
20.1.4 Request a bundle of Subscribers to a watchlist
20.1.5 Reseed all bundles for a rule
20.1.6 Request a LiveBundle
20.2.0 LiveBundle Rule Definition
20.2.1 Loading Rules
20.2.2 Example LiveBundle Javascript
20.2.3 LiveBundle Watchlist
20.2.4 LiveBundle Rule
20.2.5 LiveBundle Filter
20.2.6 Keeper Filters
20.2.7 LiveBundle Keeper
20.3.0 LiveBundle Keepers
20.3.1 LiveBundle Keeper Examples
20.3.2 LatestByPath
20.3.3 LatestByParamPath
20.3.4 LatestByParamPathByMonth
20.3.5 ToggleByPath
20.3.6 ToggleBySearch
20.3.7 WatchlistPopulator
20.3.8 Optional Keeper Parameters
21.0.0 CDS Hooks
21.0.0 CDS Hooks
21.0.1 Auto Prefetch
21.0.2 Architecture
21.0.3 CDS Hooks Classes
21.0.4 The Spring Context Config Class
21.0.5 Building Your CDS Hooks
21.0.6 Deploying Your CDS Hooks
21.0.7 Accessing Security Attributes
21.0.8 Exceptions
21.0.9 Calling CDS Hooks
21.0.10 Example Project
21.0.11 CDS on FHIR
22.0.0 Master Data Management
22.0.0 MDM
22.0.1 Getting Started with Smile CDR MDM
22.0.2 Enabling and Configuring MDM within Smile CDR
22.0.3 MDM Search Expansion
22.0.4 Troubleshooting
22.0.5 MDM User Interface (MDM UI)
22.0.6 MDM Scenarios
22.1.0 MDM Quickstart Guide
22.2.0 MDM Rule Definition
22.2.1 Finding Candidates
22.2.2 Matching and Creating Links
22.3.0 Using EIDs in MDM Rule Definition
22.3.1 Changing the way MDM is processing incoming resources
22.4.0 MDM Survivorship Rules
22.5.0 Upgrading from the EMPI module
22.6.0 MDM UI
22.6.1 Setup
22.7.0 MDM Blocklist Definition
23.0.0 Clinical Reasoning
23.0.0 Overview
23.1.0 CQL
23.2.0 Care Gaps
23.3.0 Measures
23.4.0 QPP Report Builder
23.5.0 PlanDefinitions
23.6.0 Questionnaires
24.0.0 IG Support
24.0.0 International Patient Summary (IPS)
24.0.1 Generation Rules
25.0.0 Clustering
25.0.0 Designing a Cluster
25.0.1 Node and Module Design
25.0.2 Process IDs
25.0.3 Adding and Removing Processes
25.0.4 Multi-Node Clusters
25.0.5 Sample Architecture
25.1.0 Migration To 2020.02
25.1.1 Migrating Existing Clusters
26.0.0 Logging
26.0.0 Overview
26.1.0 Audit Log
26.1.1 Audit Log Configuration
26.1.2 Disabling the Audit Log
26.1.3 Broker Audit Log
26.1.4 Audit Module
26.2.0 Transaction Log
26.2.1 What Does the Transaction Log Store?
26.2.2 Disabling the Transaction Log on the Cluster Manager
26.2.3 Transaction Log Configuration
26.2.4 Performance Tracing
26.2.5 Event Types and SubTypes
26.2.6 Realtime Reporting
26.2.7 Hiding Request Body
26.2.8 Changing Timezone
26.2.9 Using multiple Transaction Logs
26.3.0 System Logging
26.3.1 Changing Logging Settings
26.3.2 Protected Health Information (PHI) in Logs
26.3.3 JVM Stats Logging
26.4.0 Troubleshooting Logs
26.4.1 Docker Considerations
26.4.2 Troubleshooting Logs Endpoint
26.4.3 HL7V2 Troubleshooting Log
26.4.4 HTTP Troubleshooting Log
26.4.5 Security Troubleshooting Log
26.4.6 Subscription Troubleshooting Log
26.4.7 LiveBundle Troubleshooting Log
26.4.8 MDM Troubleshooting Log
26.4.9 Channel Import Troubleshooting Log
26.4.10 Realtime Export Troubleshooting Log
26.4.11 FHIR Gateway Troubleshooting Log
26.4.12 Connection Pool Troubleshooting Log
26.4.13 AWS HealthLake Export Troubleshooting Log
26.4.14 Batch Framework Troubleshooting Log
26.4.15 Narrative Generation Troubleshooting Log
26.4.16 Terminology Troubleshooting Log
26.4.17 MongoDB Troubleshooting Log
26.4.18 Custom Logging
26.5.0 Custom Logging
27.0.0 HL7 v2.x Support
27.0.0 Introduction
27.0.1 Inbound HL7 v2.x Support
27.0.2 Outbound HL7 v2.x Support
27.0.3 HL7 v2.x Versions
27.1.0 Inbound Messaging
27.1.1 Security
27.1.2 Processing
27.1.3 Callback Scripts
27.1.4 Function: onPreConvertHl7V2ToFhir(theMessage, theConversionResult)
27.1.5 Function: onPostConvertHl7V2ToFhir(theMessage, theConversionResult)
27.1.6 Adding Processing Messages
27.1.7 Lookup message segments by type
27.1.8 Custom Processing Logic
27.1.9 Pointcuts
27.1.10 Java Pre-Convert and Post-Convert Interceptor Example Project
27.2.0 FHIR-Based Terminology Translation
27.2.1 Which ConceptMap do I want?
27.3.0 Outbound Messaging
27.3.1 Getting Started
27.3.2 Message Generation Subscription Types
27.4.0 Outbound: Default Resource Conversion
27.4.1 ADT Workflow Mode
27.4.2 Enriching Message Conversion using Scripts
27.4.3 Function: onPostConvertFhirToHl7V2(theTriggerResource, theOutgoingMessage, theContext)
27.4.4 Using Persisted MessageHeader Resources
27.5.0 Outbound: Custom Resource Conversion
27.5.1 Business Transaction Triggers with MessageHeader
27.5.2 Custom Mapper Class
27.5.3 Custom Mapper Subscription
27.6.0 Outbound: Verbatim Messaging
27.7.0 Outbound: Transport
27.7.1 Customizing HL7 over HTTP Payload
27.8.0 Transactions
27.8.1 ADT (Patient Administration) Domain
27.8.2 OMG/ORM (Orders) Domain
27.8.3 ORU (Results) Domain
27.8.4 RDE/RAS (Pharmacy) Domain
27.8.5 SIU (Scheduling) Domain
27.8.6 VXU (Immunization / Vaccination) Domain
27.8.7 DFT (Financial) Domain
27.8.8 BAR (Billing) Domain
27.9.0 Structure Definitions
27.9.1 Structure: ADT_A01
27.9.2 Structure: ADT_A02
27.9.3 Structure: ADT_A03
27.9.4 Structure: ADT_A05
27.9.5 Structure: ADT_A06
27.9.6 Structure: ADT_A09
27.9.7 Structure: ADT_A12
27.9.8 Structure: ADT_A17
27.9.9 Structure: ADT_A21
27.9.10 Structure: ADT_A30
27.9.11 Structure: ADT_A38
27.9.12 Structure: ADT_A39
27.9.13 Structure: ADT_A44
27.9.14 Structure: ADT_A45
27.9.15 Structure: ADT_A54
27.9.16 Structure: ADT_A60
27.9.17 Structure: ADT_A61
27.9.18 Structure: DFT_P03
27.9.19 Structure: OMG_O19
27.9.20 Structure: ORM_O01
27.9.21 Structure: ORU_R01
27.9.22 Structure: RAS_O17
27.9.23 Structure: RDE_O11
27.9.24 Structure: SIU_S12
27.9.25 Structure: VXU_V04
27.9.26 Structure: BAR_P12
27.10.0 Segment Definitions
27.10.1 Segment: MSH (Message Header)
27.10.2 Segment: EVN (Event)
27.10.3 Segment: PID (Patient)
27.10.4 Segment: PD1 (Patient Demographics Extended)
27.10.5 Segment: PV1 (Visit/Encounter)
27.10.6 Segment: PV2 (Visit/Encounter Additional)
27.10.7 Segment: ROL (Role)
27.10.8 Segment: DG1 (Diagnosis)
27.10.9 Segment: PR1 (Procedure)
27.10.10 Segment: MRG (Merge Patient Information)
27.10.11 Segment: GT1 (Guarantor)
27.10.12 Segment: IN1 (Insurance)
27.10.13 Segment: IN2 (Insurance Additional Information)
27.10.14 Segment: ORC (Order Control)
27.10.15 Segment: OBR (Observation Request)
27.10.16 Segment: OBX (Observation)
27.10.17 Segment: NK1 (Next of Kin / Patient Contact)
27.10.18 Segment: NTE (Note)
27.10.19 Segment: FT1 (Financial Transaction)
27.10.20 Segment: RXA (Pharmacy Administration)
27.10.21 Segment: RXC (Pharmacy Component)
27.10.22 Segment: ZXC (Pharmacy Component)
27.10.23 Segment: RXE (Pharmacy Encoded Order)
27.10.24 Segment: RXR (Pharmacy Route)
27.10.25 Segment: AL1 (Allergy Information)
27.10.26 Segment: IAM (Patient Adverse Reaction)
27.10.27 Segment: SPM (Specimen)
27.10.28 Segment: SCH (Scheduling)
27.10.29 Segment: RGS (Resource Group Segment)
27.10.30 Segment: AIL (Location Resource)
27.10.31 Segment: AIP (Personnel Resource)
27.10.32 Segment: ZXT (Non-Standard)
27.10.33 A Note about Extra Components
27.10.34 A Note about the XTN Data Type
27.10.35 A Note about DSTU3 Mode Mappings
27.11.0 Table Definitions
27.11.1 Table 0001: Administrative Sex
27.11.2 Table 0002: Marital Status
27.11.3 Table 0004: Patient Class
27.11.4 Table 0007: Admission Type
27.11.5 Table 0009: Ambulatory Status
27.11.6 Table 0017: Transaction Type
27.11.7 Table 0018: Patient Type
27.11.8 Table 0038: Order Status
27.11.9 Table 0052: Diagnosis Type
27.11.10 Table 0063: v2 Relationship
27.11.11 Table 0069: Hospital Service
27.11.12 Table 0074: Diagnostic Service Section ID
27.11.13 Table 0078: Observation Interpretation Codes
27.11.14 Table 0085: Observation Status
27.11.15 Table 0112: Discharge Disposition
27.11.16 Table 0117: Account Status
27.11.17 Table 0119: Order Control
27.11.18 Table 0123: Result Status
27.11.19 Table 0125: Observation Value Type
27.11.20 Table 0127: Allergen Type
27.11.21 Table 0128: Allergen Severity
27.11.22 Table 0129: Accommodation Code
27.11.23 Table 0131: v2 Contact Role
27.11.24 Table 0136: Yes/No
27.11.25 Table 0166: RX Component Type
27.11.26 Table 0190: Address Type
27.11.27 Table 0200: Name Type Code
27.11.28 Table 0201: Telecom Use
27.11.29 Table 0202: Telecom Equipment Type
27.11.30 Table 0203: Identifier Type
27.11.31 Table 0276: Appointment Reason Codes
27.11.32 Table 0278: Filler Status Code
27.11.33 Table 0291: Subtype of Referenced Data
27.11.34 Table 0299: Encoding
27.11.35 Table 0305: Person Location Type
27.11.36 Table 0322: Completion Status
27.11.37 Table 0438: Allergy Clinical Status Code
27.11.38 Table 0834: Mime Types
27.12.0 Naming System Mapping
27.12.1 Default Mappings
27.12.2 Using NamingSystem for Mapping Identifiers
27.13.0 Processing Results Feeds
27.13.1 Unsolicited Observation Request (ORU^R01)
27.14.0 Protocol
27.14.1 Encoding Format
27.14.2 ER7 (Pipe-Delimited) Format
27.14.3 Minimal Lower Layer Protocol (MLLP) Transport
27.14.4 HL7 over HTTP
27.14.5 Character Encoding / Charsets
28.0.0 CDA Exchange Module
28.0.0 Introduction
28.0.1 CDA Export
28.0.2 CDA Import
28.0.3 Implementation roadmap
28.1.0 JavaScript Templates
28.1.1 The simplest CDA template script
28.1.2 Adding header information to our CDA template script
28.1.3 Adding and populating a section in our CDA template script
28.1.4 Using the Fhir.search() API to dynamically populate sections
28.1.5 Specifying input parameters
28.1.6 More complicated input parameters
28.1.7 Specifying section author participation
28.1.8 Putting it all together
28.1.9 Configuring the $docref CCD template
28.2.0 Rest API Operations
28.2.1 Endpoints for configuring templates
28.2.2 Endpoints for applying templates
28.2.3 Endpoints for importing CDA documents
28.3.0 Available Document and Section Types for CDA Export
28.3.1 Valid Document Types
28.3.2 Valid Resources for the header
28.3.3 Valid Section Types and Sources
28.3.4 Allergy and Intolerances Section
28.3.5 Dialysis Prescription Section
28.3.6 Encounters Section
28.3.7 Functional Status Section
28.3.8 Goals Section
28.3.9 Immunizations Section
28.3.10 Medical Equipment Section
28.3.11 Medications Section
28.3.12 Problem Section
28.3.13 Procedures Section
28.3.14 Reason for Referral Section
28.3.15 Results Section
28.3.16 Social History Section
28.3.17 Vital Signs Section
28.4.0 Available Document and Section Types for CDA Import
28.4.1 Valid Document Types
28.4.2 Resources derived from the header
28.4.3 Valid Section Types and Sources
28.4.4 Allergy and Intolerances Section
28.4.5 Assessment Section
28.4.6 Care Team Section
28.4.7 Consultation Note Section
28.4.8 Encounters Section
28.4.9 Family History Section
28.4.10 Functional Status Section
28.4.11 Goals Section
28.4.12 Health Concerns Section
28.4.13 Immunizations Section
28.4.14 Medical Equipment Section
28.4.15 Medications Section
28.4.16 Nutrition Section
28.4.17 Plan of Care Section
28.4.18 Problem Section
28.4.19 Procedures Section
28.4.20 Results Section
28.4.21 Social History Section
28.4.22 Vital Signs Section
28.5.0 JavaScript Hooks on CDA Import / Export
28.5.1 CDA Pre Import JavaScript Hook
28.5.2 CDA Post Import JavaScript Hook
28.5.3 CDA Post Export JavaScript Hook
28.5.4 Exposed APIs for use in JavaScript Execution Environment
28.5.5 Example Scripts
28.6.0 Further Reading
29.0.0 CDA Exchange+ Module
29.0.0 Introduction
29.0.1 CDA Export
29.0.2 CDA Import
29.0.3 Implementation roadmap
29.1.0 JavaScript Templates
29.1.1 The simplest CDA template script
29.1.2 Adding header information to our CDA template script
29.1.3 Adding and populating a section in our CDA template script
29.1.4 Using the Fhir.search() API to dynamically populate sections
29.1.5 Specifying input parameters
29.1.6 More complicated input parameters
29.1.7 Specifying section author participation
29.1.8 Putting it all together
29.1.9 Configuring the $docref CCD template
29.2.0 Rest API Operations
29.2.1 Endpoints for configuring templates
29.2.2 Endpoints for applying templates
29.2.3 Endpoints for importing CDA documents
29.3.0 Available Document and Section Types for CDA Export
29.3.1 Valid Document Types
29.3.2 Valid Resources for the header
29.3.3 Valid Section Types and Sources
29.3.4 Allergy and Intolerances Section
29.3.5 Encounters Section
29.3.6 Care Plan Section
29.3.7 Care Team Section
29.3.8 Family History Section
29.3.9 Functional Status Section
29.3.10 Goals Section
29.3.11 Immunizations Section
29.3.12 Medical Equipment Section
29.3.13 Medications Section
29.3.14 Problem Section
29.3.15 Procedures Section
29.3.16 Results Section
29.3.17 Social History Section
29.3.18 Vital Signs Section
29.3.19 Note Section
29.4.0 Available Document and Section Types for CDA Import
29.4.1 Valid Document Types
29.4.2 Resources derived from the header
29.4.3 Valid Section Types and Sources
29.4.4 Allergy and Intolerances Section
29.4.5 Care Plan Section
29.4.6 Care Team Section
29.4.7 Encounters Section
29.4.8 Family History Section
29.4.9 Functional Status Section
29.4.10 Goals Section
29.4.11 Health Concerns Section
29.4.12 Immunizations Section
29.4.13 Medical Equipment Section
29.4.14 Medications Section
29.4.15 Plan of Treatment Section
29.4.16 Problem Section
29.4.17 Procedures Section
29.4.18 Results Section
29.4.19 Social History Section
29.4.20 Vital Signs Section
29.4.21 Note Section
29.5.0 JavaScript Hooks on CDA Import / Export
29.5.1 CDA Pre Import JavaScript Hook
29.5.2 CDA Post Import JavaScript Hook
29.5.3 CDA Post Export JavaScript Hook
29.5.4 Exposed APIs for use in JavaScript Execution Environment
29.5.5 Example Scripts
29.6.0 FHIR-Based Terminology Translation
29.6.1 Default Mappings: DSTU3
29.6.2 Default Mappings: R4
29.7.0 Further Reading
30.0.0 System to System Data Exchange
30.0.0 System to System Data Exchange Module
30.1.0 Smile CDR Payer to Payer Quickstart Guide
30.2.0 Custom Matching Script
31.0.0 Bulk Operations
31.0.0 ETL Import Module
31.0.1 Importing CSV Data
31.0.2 Function: handleEtlImportRow(theInputMap, theContext)
31.0.3 Handling Multiple Import Formats
31.0.4 Initiating ETL Jobs
31.0.5 Performance and Concurrency
31.0.6 Locking Rows
31.0.7 Creating a Hashing Script
31.0.8 Asynchronous Execution
31.0.9 Performance
31.1.0 FHIR Bulk Import Operation
31.1.1 Triggering a Bulk Import
31.1.2 Methodology
31.1.3 Performance
31.2.0 FHIR Bulk Export Operation
31.2.1 Enabling Bulk Export
31.2.2 Types of Bulk Export Requests
31.2.3 Request Parameters
31.2.4 Requesting A Bulk Extract
31.2.5 Authorization for Bulk Export
31.2.6 Polling for Job Status
31.2.7 Accessing Bulk Export Files
32.0.0 Additional Features
32.0.0 Da Vinci Clinical Data Exchange (CDex)
32.1.0 Da Vinci Health Record Exchange (HRex)
33.0.0 Monitoring
33.0.0 Monitoring Basics
33.0.1 HTTP Endpoint Health Check
33.0.2 Runtime Health Checks
33.1.0 Elastic APM Basics
33.1.1 What is APM?
33.1.2 Setting Up an APM Server
33.1.3 Instrumenting Smile CDR and the JVM
33.1.4 Accessing the User Interface
33.1.5 Configuring Settings for the Agent
33.1.6 Securing the Agent
33.2.0 Externalized Metrics
33.2.1 Step 1 - Install Prometheus
33.2.2 Step 2 - Install Grafana
33.2.3 Step 3 - Creating a Prometheus data source on Grafana
33.2.4 Step 4 - Configure Smile CDR
33.2.5 Step 5 - Creating a Grafana Dashboard  
33.3.0 OpenTelemetry Integration
34.0.0 Product Administration
34.0.0 Batch Job Management
34.1.0 Web Admin Console
35.0.0 JSON Admin Endpoints
35.0.0 JSON Admin API
35.0.1 Security
35.0.2 Format
35.0.3 Allowing Anonymous Access
35.0.4 MDM Endpoints Exposed in JSON Admin Module
35.1.0 Audit Log Endpoint
35.1.1 Fetch Audit Log
35.1.2 Fetch Individual Event
35.2.0 Batch Job Endpoint
35.2.1 Fetch All Batch Jobs
35.2.2 Fetch Batch Job Names
35.2.3 Fetch All Job Instances
35.2.4 Cancel Job Execution
35.3.0 Bulk Import Endpoint
35.3.1 Process ETL File
35.3.2 Smileutil: CSV Bulk Import File
35.4.0 CDA Exchange Endpoint
35.4.1 Create CDA Template
35.4.2 Update CDA Template
35.4.3 Update CDA Template script via text
35.4.4 View CDA Template(s)
35.4.5 Delete CDA template
35.4.6 Use / Apply CDA Template
35.4.7 Create CDA from Composition/Bundle
35.4.8 Example CDA Template
35.5.0 Metrics Endpoint
35.5.1 Fetch Local Metrics
35.5.2 Capture Thread Dump
35.6.0 Module Config Endpoint
35.6.1 Fetch Config: Module Property File
35.6.2 Fetch Config: All Modules
35.6.3 Fetch Config: Single Module
35.6.4 Create Module
35.6.5 Set Module Config
35.6.6 Start Module
35.6.7 Stop Module
35.6.8 Restart Module
35.6.9 Archive Module
35.6.10 System Restore
35.7.0 OpenID Connect Clients Endpoint
35.7.1 Fetch All OpenID Connect Client Definitions
35.7.2 Fetch Individual Client by Client ID
35.7.3 Create Client
35.7.4 Update Client
35.7.5 Create Client and generate secrets
35.8.0 OpenID Connect Servers Endpoint
35.8.1 Fetch All OpenID Connect Server Definitions
35.8.2 Find OpenID Connect Server Definition
35.8.3 Create OpenID Connect Server Definition
35.8.4 Update OpenID Connect Server Definition
35.9.0 OpenID Connect Sessions Endpoint
35.9.1 Fetch All Active Clients for User
35.9.2 Revoke Active Client for User
35.9.3 Revoke All Tokens
35.10.0 Runtime Status Endpoint
35.10.1 Fetch Complete Node Status Information
35.10.2 Fetch All Runtime Health Checks
35.11.0 System Config Endpoint
35.12.0 Transaction Log Endpoint
35.12.1 Fetch Transaction Log
35.12.2 Fetch Individual Event
35.13.0 Troubleshooting Log Endpoint
35.13.1 Fetch Troubleshooting Log Configuration
35.13.2 Update Troubleshooting Logger Level
35.13.3 Update Troubleshooting Log Configuration
35.14.0 User Management Endpoint
35.14.1 Search for Users (All Modules)
35.14.2 Search for Users (Specific Module)
35.14.3 Create User
35.14.4 Update User
35.14.5 Update Password
35.14.6 Update Own Password
35.14.7 Update Own Default Launch Contexts
35.14.8 2FA: Create New Key
35.14.9 2FA: Generate QR Code
35.14.10 2FA: Confirm Key
35.14.11 2FA: Delete Key
35.14.12 Invalidate All Sessions
36.0.0 HFQL: Direct SQL Access
36.0.0 HFQL/SQL Overview
36.0.1 Overview
36.0.2 Goals and Architecture
36.0.3 JDBC Driver
36.0.4 Enabling Server Support
36.1.0 SQL Syntax
36.1.1 Syntax Overview
36.2.0 SQL Syntax: Select
36.2.1 Selecting Columns
36.2.2 Column Name Aliases
36.2.3 Column Data Types and Choice Elements
36.2.4 Count and Group-By Expressions
36.2.5 Ordering Results
36.2.6 Select Data Manipulation and Concatenation
36.2.7 Limiting Results
36.3.0 SQL Syntax: Where
36.3.1 WHERE Clauses
36.3.2 Search Parameter WHERE Expressions
36.3.3 FHIRPath WHERE Expressions
36.4.0 SQL Syntax: Limitations
36.4.1 Syntax Limitations
36.5.0 SQL Syntax: Examples
36.5.1 Find Resources with Repeating Elements
37.0.0 Product Configuration
37.0.0 HTTP Server Setup
37.0.1 Respecting Forward Headers
37.0.2 Specifying a Custom Context Path
37.0.3 Access Logs
37.0.4 Frame Options
37.1.0 TLS and HTTPS Reference
37.1.1 Background
37.1.2 Creating a Self-Signed KeyStore
37.1.3 Importing a LetsEncrypt Certificate into a KeyStore
37.1.4 Selecting Ciphers and Protocol
37.1.5 Enabling TLS Mutual Authentication (Client Auth)
37.1.6 Programmatically Configuring a FHIR Endpoint KeyStore
37.1.7 Smile Util TLS JSON Authentication File
38.0.0 Java Execution Environment
38.0.0 Security Attributes
38.1.0 Library Support
38.2.0 Exception Handling
38.3.0 Javadocs
39.0.0 JavaScript Execution Environment
39.0.0 Introduction
39.0.1 Change Log
39.1.0 Specifying JavaScript in Configuration File
39.2.0 Remote Debugging
39.3.0 ECMA Modules (import)
39.4.0 Converter API
39.4.1 Method: hl7v2TsToFhirDate(dt);
39.4.2 Method: hl7v2TsToFhirDateTime(ts);
39.4.3 Method: hl7v2TsToFhirDateTime(ts, impliedTimeZone);
39.4.4 Method: urlDecodeString(string);
39.4.5 Method: urlEncodeString(string);
39.4.6 Method: base64Encode(string);
39.4.7 Method: base64Decode(string);
39.5.0 Environment API
39.5.1 Method: getProperty(name)
39.5.2 Method: getEnv(name)
39.6.0 Exceptions API
39.6.1 Method: Exceptions.newTrustedException(theMessage)
39.6.2 Method: Exceptions.newTrustedException(theStatusCode, theMessage)
39.7.0 OAuth2 Exceptions API
39.7.1 Method: OAuth2Exceptions.newUnauthorizedException(theMessage)
39.7.2 Method: OAuth2Exceptions.newForbiddenException(theMessage)
39.8.0 FHIR REST API
39.8.1 Method: create(resource)
39.8.2 Method: read(url)
39.8.3 Method: search().forResource(resourceType)
39.8.4 Method: transaction(IBundleBuilder theTransaction)
39.8.5 Method: translate()
39.8.6 Method: update(resource)
39.8.7 Method: patch(url, parameters)
39.8.8 Authentication
39.8.9 Tenant Selection
39.8.10 Concurrency Retry
39.8.11 Configuration Requirements for ONC (g)(10) Certification
39.9.0 FHIR Model API
39.9.1 Method: ResourceBuilder.build(resourceType)
39.9.2 Working with Resources
39.9.3 Working with Composition resources
39.9.4 Working with Bundle resources
39.9.5 Contained Resources
39.9.6 Meta Elements
39.9.7 Removing Data
39.10.0 HL7 v2.x Mapping API
39.10.1 Path Syntax: Repetitions
39.10.2 Path Syntax: Groups and Nesting
39.10.3 Structure Interrogation
39.10.4 Content Clearing
39.10.5 Content Interrogation
39.10.6 Parsing Raw Field Values
39.10.7 Encoding
39.10.8 The Hl7V2 Object
39.10.9 Working with Variable Datatypes
39.10.10 Working with Z-Segments
39.11.0 HTTP API
39.11.1 Request Creation Methods
39.11.2 Request Execution Methods
39.11.3 Response Processing Methods
39.11.4 TLS / HTTPS
39.12.0 LDAP API
39.12.1 Method: searchByUsername(username)
39.12.2 Method: getStringAttributes(attributeName)
39.12.3 Method: isMemberOfGroup(groupDn)
39.13.0 Log API
39.13.1 Methods: debug(string), info(string), warn(string), error(string)
39.14.0 Composition Resource API
39.14.1 Method: set*(value)
39.14.2 Method: setDate(epoch)
39.14.3 Method: setType(documentType)
39.14.4 Method: addSection(sectionType)
39.15.0 Composition Section API
39.15.1 Method: populate(List resources)
39.15.2 Method: setTitle(title)
39.15.3 Method: setCode(system, code, display)
39.15.4 Method: addSection()
39.16.0 TransactionBuilder API
39.16.1 Method: newTransactionBuilder()
39.16.2 Method: withBundle(bundle)
39.16.3 Method: create(resource)
39.16.4 Method: update(resource)
39.16.5 Method: patch(resourceId, parameters)
39.16.6 Method Chain: createConditional(resource).onToken(parameter, system, value)
39.16.7 Method Chain: updateConditional(resource).onToken(parameter, system, value)
39.16.8 Methods: toXml(), toXml(prettyPrint), toJson(), toJson(prettyPrint)
39.16.9 Fhir.transaction(transaction)
39.17.0 Util API
39.17.1 Method: sleep(millis)
39.18.0 UUID API
39.18.1 Method: newPlaceholderId()
39.19.0 XML API
39.19.1 Global function: XML.createDocument(str)
39.19.2 XPath Expressions
39.19.3 Traversing the Document
39.19.4 Function: toXMLString()
39.19.5 Manipulating the DOM
39.20.0 Callback Models
39.20.1 AssociatedResource
39.20.2 AuthenticationContext
39.20.3 AuthenticationFailure
39.20.4 AuthenticationRequest
39.20.5 ClientSessionJson
39.20.6 CsvProcessorContext
39.20.7 FhirContextEntry
39.20.8 FhirEndpointTerminologyResponseMappingSpec
39.20.9 FhirEndpointTerminologyResponseMappingSpecSystem
39.20.10 GatewayConfiguration
39.20.11 GatewayCreateRoute
39.20.12 GatewayDeleteRoute
39.20.13 GatewayOperation
39.20.14 GatewayOperationRoute
39.20.15 GatewayReadRoute
39.20.16 GatewayRouteTarget
39.20.17 GatewaySearchRoute
39.20.18 GatewayTarget
39.20.19 GatewayTargetRetryStrategy
39.20.20 GatewayTransactionRoute
39.20.21 GatewayUpdateRoute
39.20.22 GrantedAuthority
39.20.23 Hl7V2GeneratedMessageContext
39.20.24 Hl7V2ReceivedMessage
39.20.25 Hl7V2ReceivedMessageConversionResult
39.20.26 LaunchContext
39.20.27 LaunchContextParameter
39.20.28 LaunchResourceId
39.20.29 MegaScaleCredentialRequest
39.20.30 MegaScaleCredentialResponse
39.20.31 OAuth2AuthorizationRequestDetails
39.20.32 OAuth2Client
39.20.33 OAuth2ClientSecret
39.20.34 OAuth2Clients
39.20.35 OAuth2Server
39.20.36 OAuth2Servers
39.20.37 OAuth2SmartContextSelectionChoicePerson
39.20.38 OAuth2SmartContextSelectionChoices
39.20.39 Oauth2InvalidateTokensResponseJson
39.20.40 PackageInstallationSpec
39.20.41 PartitionDefinition
39.20.42 PartitionDefinitions
39.20.43 RequestDetailsJson
39.20.44 ScriptAuthenticationOutcomeFactory
39.20.45 ScriptConsentContextServices
39.20.46 SecurityInLdapAuthenticationContext
39.20.47 SecurityInSmartAuthenticationContext
39.20.48 SmartCodapAuthorizationRequest
39.20.49 SmartOnPostAuthorizeDetails
39.20.50 UserDetails
39.20.51 UserDetailsChangeLaunchContextJson
39.20.52 UserDetailsList
39.20.53 UserDetailsOAuth2AllClientApprovals
39.20.54 UserDetailsOAuth2ClientApprovals
39.20.55 UserDetailsOAuth2ClientApprovalsApprovedScope
39.20.56 UserSessionDetails
40.0.0 Database Administration
40.0.0 Database Design
40.0.1 Cluster Manager Database
40.0.2 FHIR Relational Storage
40.0.3 FHIR MongoDB (Non-Relational) Storage
40.1.0 Database Connection Pool
40.2.0 Setting Up PostgreSQL
40.2.1 Supported Versions
40.2.2 Creating a Database for Smile CDR
40.2.3 Database Connection Properties
40.2.4 Setting up a Cluster Manager Database
40.2.5 Setting up a FHIR Storage (Relational) Database
40.3.0 Troubleshooting PostgreSQL
40.3.1 Host Name Verification Error
40.3.2 Network Timeouts
40.4.0 Setting Up MySQL
40.4.1 Supported Versions
40.4.2 Creating a Database for Smile CDR
40.4.3 Database Connection Properties
40.4.4 Setting up a Cluster Manager Database
40.4.5 Setting up a FHIR Storage (Relational) Database
40.5.0 Setting Up MariaDB
40.5.1 Supported Versions
40.5.2 Creating a Database for Smile CDR
40.5.3 Database Connection Properties
40.5.4 Setting up a Cluster Manager Database
40.5.5 Setting up a FHIR Storage (Relational) Database
40.6.0 Setting Up Oracle
40.6.1 Supported Versions
40.6.2 Setting up a Cluster Manager Database
40.6.3 Setting up a FHIR Storage (Relational) Database
40.7.0 Setting Up SQL Server (MSSQL)
40.7.1 Supported Versions
40.7.2 Creating a Database for Smile CDR
40.7.3 Preparing an SQL Server Database for Smile CDR
40.7.4 Database Connection Properties
40.7.5 Setting up a Cluster Manager Database
40.7.6 Setting up a FHIR Storage (Relational) Database
40.8.0 AWS IAM Authentication
41.0.0 Localization
41.0.0 Localization
41.1.0 Examples
41.1.1 Example: Unknown Search Parameter Message
41.1.2 Example: Custom SMART Scope Names
41.2.0 Available Localization Keys
42.0.0 Smile CDR CLI (smileutil)
42.0.0 Introduction
42.0.1 Enabling Debug Logging
42.0.2 Memory Settings
42.1.0 Bulk Import
42.1.1 Usage
42.1.2 Options
42.2.0 Create FHIR Package
42.2.1 Usage
42.2.2 Options
42.3.0 Execute Script Function
42.3.1 Usage
42.3.2 Options
42.3.3 A Complete Example: Authenticate
42.3.4 Available Functions
42.3.5 Function: authenticate
42.4.0 Export ConceptMap to CSV
42.4.1 Usage
42.4.2 Options
42.5.0 HL7 v2.x Analyze Flat File
42.5.1 Usage
42.5.2 Options
42.6.0 HL7 v2.x Transmit Flat File
42.6.1 Usage
42.6.2 Options
42.6.3 Multiplex Paths
42.7.0 Import CSV to ConceptMap
42.7.1 Usage
42.7.2 Options
42.8.0 Map and Upload CSV Bulk Import File
42.8.1 Usage
42.8.2 Options
42.9.0 Migrate Database
42.9.1 Options
42.9.2 Examples
42.10.0 Clear Database Migration Lock
42.10.1 Example
42.10.2 Options
42.11.0 Module Config Properties Export
42.11.1 Options
42.12.0 Reindex Terminology
42.12.1 Usage
42.12.2 Options
42.13.0 Synchronize FHIR Servers
42.13.1 Usage
42.13.2 Options
42.13.3 Selecting Resource Types to Synchronize
42.13.4 Using a Search as the Source
42.13.5 Using a Directory as the Source
42.13.6 Uploading Bundles as Transactions
42.13.7 Using Inline Match URLs
42.13.8 Prefixing Numeric IDs
42.13.9 Synchronization Modes
42.13.10 Uploading Synthea (Synthetic Generated) Resources
42.13.11 Setting up a Resource Gold Master
42.13.12 Load Balancing Target Servers
42.14.0 Upgrade H2 Database File
42.14.1 Usage
42.14.2 Options
42.14.3 Example
42.15.0 Upload Bundle Files
42.15.1 This Command Is Deprecated
42.15.2 Usage
42.15.3 Options
42.16.0 Upload CSV Bulk Import File
42.16.1 Usage
42.16.2 Options
42.16.3 Sending Batches for a Single File
42.17.0 Upload Sample Dataset
42.17.1 Usage
42.17.2 Options
42.18.0 Upload Terminology
42.18.1 Usage
42.18.2 Options
42.18.3 Example: Add Delta to Custom Terminology
42.19.0 Generate Realtime Export Schema
42.19.1 Usage
42.19.2 Options
42.20.0 Validate FHIR Resources
42.20.1 Usage
42.20.2 Options
42.20.3 Profile Mode
42.20.4 Schema and Schematron Mode
43.0.0 Apache Camel Integration
43.0.0 Camel Module Overview
43.0.1 Apache Camel Introduction
43.0.2 Apache Camel Data Formats
43.0.3 Smile Data Formats
43.0.4 Apache Camel Components
43.0.5 Smile Component
43.0.6 The Spring Context Config Class
43.0.7 Packaging Your Camel Module Custom Classes
43.0.8 Deploying Your Camel Module Custom Classes
43.0.9 Example Project
43.1.0 Smile Camel Processors
43.1.1 Persistence Processors
43.1.2 ETL Importer Processors
43.1.3 Camel Processors
43.1.4 Cluster Manager Processors
43.1.5 Hl7v2 Inbound Processors
43.1.6 Quick Reference
43.2.0 Smile Camel Converters
44.0.0 Modules
44.0.0 JSON Admin API
44.0.1 Configuration Categories
44.1.0 Web Admin Console
44.1.1 Updated Web Admin Console UI
44.1.2 Configuration Categories
44.2.0 CDA Exchange
44.2.1 Configuration Categories
44.3.0 Channel Import
44.3.1 Configuration Categories
44.4.0 Cluster Manager
44.4.1 Configuration Categories
44.5.0 CQL
44.6.0 Audit Log Persistence
44.6.1 Configuration Categories
44.7.0 Transaction Log Persistence
44.7.1 Configuration Categories
44.8.0 Digital Quality Measures (DQM)
44.8.1 Async Evaluation
44.8.2 Setting Chunk Size
44.8.3 Multi-Threaded Evaluation
44.8.4 Configuration Categories
44.9.0 Documentation Templates and Rules (DTR)
44.10.0 Enterprise Master Patient Index
44.10.1 Configuration Categories
44.11.0 CDS Hooks Endpoint
44.11.1 Configuration Categories
44.12.0 FHIR Gateway Endpoint
44.12.1 Configuration Categories
44.13.0 FHIR REST Endpoint (All Versions)
44.13.1 Configuration Categories
44.14.0 FHIR REST Endpoint (DSTU2 - Deprecated)
44.14.1 Configuration Categories
44.15.0 FHIR REST Endpoint (DSTU3 - Deprecated)
44.15.1 Configuration Categories
44.16.0 FHIR REST Endpoint (R4 - Deprecated)
44.16.1 Configuration Categories
44.17.0 FHIRWeb Console
44.17.1 Configuration Categories
44.18.0 HL7 v2.x Listening Endpoint
44.18.1 Configuration Categories
44.19.0 HL7 v2.x Listening Endpoint (Deprecated)
44.19.1 Configuration Categories
44.20.0 HL7 v2.x Sending Endpoint
44.20.1 Configuration Categories
44.21.0 Hybrid Providers Endpoint
44.21.1 Configuration Categories
44.22.0 Package Registry Endpoint
44.22.1 Configuration Categories
44.23.0 Subscription Websocket Endpoint
44.23.1 Configuration Categories
44.24.0 ETL Importer
44.24.1 Configuration Categories
44.25.0 MDM
44.25.1 Configuration Categories
44.26.0 MDM UI
44.26.1 Configuration Categories
44.27.0 Prior Auth CRD
44.27.1 Configuration Categories
44.28.0 Prior Auth Support
44.28.1 Configuration Categories
44.29.0 Narrative Generator
44.29.1 Configuration Categories
44.30.0 FHIR Storage (DSTU2 RDBMS)
44.30.1 Configuration Categories
44.31.0 FHIR Storage (R3 RDBMS)
44.31.1 Configuration Categories
44.32.0 FHIR Storage (R4 RDBMS)
44.32.1 Configuration Categories
44.33.0 FHIR Storage (R5 RDBMS)
44.33.1 Configuration Categories
44.34.0 FHIR Storage (Mongo)
44.34.1 Configuration Categories
44.35.0 Realtime Export
44.35.1 Configuration Categories
44.36.0 LDAP Inbound Security
44.36.1 Configuration Categories
44.37.0 Local Inbound Security
44.37.1 Configuration Categories
44.38.0 SAML Inbound Security
44.38.1 Configuration Categories
44.39.0 Scripted Inbound Security
44.39.1 Configuration Categories
44.40.0 SMART Inbound Security
44.40.1 Configuration Categories
44.41.0 SMART Outbound Security
44.41.1 Configuration Categories
44.42.0 Subscription Matcher (All FHIR Versions)
44.42.1 Configuration Categories
44.43.0 Subscription Matcher (DSTU2 - Deprecated)
44.43.1 Configuration Categories
44.44.0 Subscription Matcher (DSTU3 - Deprecated)
44.44.1 Configuration Categories
44.45.0 Subscription Matcher (R4 - Deprecated)
44.45.1 Configuration Categories
44.46.0 appSphere
44.46.1 Configuration Categories
44.47.0 Payer to Payer
44.47.1 Configuration Categories
44.48.0 System to System Data Exchange
44.48.1 Configuration Categories
44.49.0 Amazon HealthLake Outbound REST Connector
44.49.1 Configuration Categories
44.50.0 License
44.50.1 Configuration Categories
44.51.0 Camel
44.51.1 Configuration Categories
45.0.0 Configuration Categories
45.0.0 Web Admin Console Settings
45.0.1 Property: Prometheus Datasource ID
45.0.2 Property: Transaction Log - Event Body Display Mode
45.1.0 appSphere
45.1.1 Property: JSON URL
45.1.2 Property: Auth URL
45.1.3 Property: Client ID
45.1.4 Property: Legal Company Name
45.1.5 Property: Admin Console Name
45.1.6 Property: Contact Helpdesk
45.1.7 Property: Contact Us URL
45.1.8 Property: FHIR Sandbox URL
45.1.9 Property: FHIR URL
45.1.10 Property: Application Gallery Name
45.1.11 Property: Hero Image, Large Format URL
45.1.12 Property: Hero Image, Small Format URL
45.1.13 Property: Company Logo Small URL
45.1.14 Property: Company Logo Large URL
45.1.15 Property: PHI Warning URL
45.1.16 Property: Developer Portal Name
45.1.17 Property: Privacy Policy URL
45.1.18 Property: Request app mail-to
45.1.19 Property: Terms of Use URL
45.2.0 Payer Config
45.2.1 Property: Payer Auto-Grant Scopes
45.2.2 Property: Enable Payer Functionality
45.3.0 Initial appSphere Seeding
45.3.1 Property: Default Attestation (Legal)
45.3.2 Property: Default Attestation (Plain)
45.3.3 Property: Default Attestation Title
45.4.0 Authentication Callback Scripts
45.4.1 Property: Authentication Callback Script (File)
45.4.2 Property: Authentication Callback Script (Text)
45.5.0 Auth: General for APIs
45.5.1 Property: Anonymous Account Username
45.5.2 Property: Allow Anonymous Access
45.6.0 User Authentication
45.6.1 Property: Anonymous Account Username
45.6.2 Property: Allow Anonymous Access
45.6.3 Property: SAML Authentication Enabled
45.7.0 Auth: HTTP Basic
45.7.1 Property: HTTP Basic Security
45.7.2 Property: HTTP Basic Realm
45.8.0 Auth: OpenID Connect
45.8.1 Property: OpenID Connect Security
45.9.0 Browser Syntax Highlighting
45.9.1 Property: Browser Syntax Highlighting Enabled
45.9.2 Property: Show Request Headers
45.9.3 Property: Show Response Headers
45.10.0 Camel
45.10.1 Property: Spring Context Config Class(es)
45.10.2 Property: Camel Functions (File)
45.10.3 Property: Camel Functions (Text)
45.10.4 Property: Camel Routes (File)
45.10.5 Property: Camel Routes (Text)
45.11.0 Capability Statement (metadata)
45.11.1 Property: Cache Resource Counts (Mins)
45.11.2 Property: Include Resource Counts
45.12.0 Care Gaps
45.12.1 Property: Reporter
45.12.2 Property: Section Author
45.13.0 CDA Generation
45.13.1 Property: Base URL for Local Resources
45.14.0 CDA Import
45.14.1 Property: Assembly Device ID
45.14.2 Property: Store Original CCD
45.15.0 CDA Interceptors
45.15.1 Property: Interceptor Bean Types
45.16.0 CDA JavaScript Execution Scripts
45.16.1 Property: CDA Processing Script (File)
45.16.2 Property: CDA Processing Script (Text)
45.17.0 CDA Terminology
45.17.1 Property: Prefer user-supplied terminology translations
45.18.0 CDS Hooks Definitions
45.18.1 Property: FHIR Version
45.18.2 Property: Spring Context Config Class
45.19.0 CDS Hooks On FHIR
45.19.1 Property: Client Id Header Name
45.19.2 Property: Enable CDS on FHIR
45.20.0 Channel Import
45.20.1 Property: Concurrent Consumers
45.20.2 Property: Concurrent Retry Consumers
45.20.3 Property: Channel Name
45.20.4 Property: Default mediaType
45.20.5 Property: Channel Import ETL Script (File)
45.20.6 Property: Channel Import ETL Script (Text)
45.20.7 Property: Interceptor Bean Types
45.21.0 Channel Retry
45.21.1 Property: Failure Channel Name
45.21.2 Property: Retry Delay(ms)
45.21.3 Property: Maximum amount of retry attempts.
45.21.4 Property: Maximum Delay(ms) between attempts.
45.21.5 Property: Retry Channel Name
45.21.6 Property: Retriable Exceptions
45.21.7 Property: Retry Strategy
45.22.0 Kafka
45.22.1 Property: Kafka Consumer Ack Mode
45.22.2 Property: Kafka Consumer Auto Commit Enabled
45.22.3 Property: Kafka Bootstrap Address
45.22.4 Property: Kafka Consumer Config Properties (File)
45.22.5 Property: Kafka Consumer Config Properties (Text)
45.22.6 Property: Kafka Subscription Matcher Consumer Group Id
45.22.7 Property: Kafka Producer Config Properties (File)
45.22.8 Property: Kafka Producer Config Properties (Text)
45.22.9 Property: Kafka Replace Hyphens With Periods
45.22.10 Property: Kafka SASL JAAS Config
45.22.11 Property: Kafka SASL Mechanism
45.22.12 Property: Kafka Security Protocol
45.22.13 Property: Kafka Broker SSL Enabled
45.22.14 Property: Kafka SSL Key Password
45.22.15 Property: Kafka SSL Keystore Location
45.22.16 Property: Kafka Keystore Password
45.22.17 Property: Kafka SSL TrustStore File Location
45.22.18 Property: Kafka SSL Truststore Password
45.22.19 Property: Validate Kafka Topics Exist Before Use
45.23.0 Cluster Manager Maintenance
45.23.1 Property: Audit Log Broker Channel Name
45.23.2 Property: Audit Log Broker Enabled
45.23.3 Property: Always Write to Cluster Manager Log
45.23.4 Property: Audit Log Database Async Writes
45.23.5 Property: Audit Log Database Enabled
45.23.6 Property: Request headers to store
45.23.7 Property: Reload Scripts on Module Config Save
45.23.8 Property: Stats Retention (Days) - Day Level
45.23.9 Property: Stats Retention (Days) - Hour Level
45.23.10 Property: Stats Retention (Days) - Minute Level
45.23.11 Property: Transaction Log Retention (Days)
45.23.12 Property: Scheduler Thread Count
45.23.13 Property: Heartbeat Persist Frequency MS
45.23.14 Property: Stats Cleanup Frequency MS
45.23.15 Property: Stats Persist Frequency MS
45.24.0 Message Broker
45.24.1 Property: Message Broker Address
45.24.2 Property: (Deprecated)Channel Naming Prefix
45.24.3 Property: Message Broker Password
45.24.4 Property: Message Broker Type
45.24.5 Property: Message Broker Username
45.25.0 Cluster Level Security
45.25.1 Property: OpenId Connect Keystores Pre-Seed File
45.26.0 CQL
45.26.1 Property: Data Analysis
45.26.2 Property: Collapse Data Analysis
45.26.3 Property: CQL Language Level
45.26.4 Property: Default Model Info
45.26.5 Property: Disable List Demotion
45.26.6 Property: Disable List Promotion
45.26.7 Property: Disable List Traversal
45.26.8 Property: Disable Method Invocation
45.26.9 Property: Annotations
45.26.10 Property: Date Range Optimization
45.26.11 Property: Detailed Errors
45.26.12 Property: Enable Interval Demotion
45.26.13 Property: Enable Interval Promotion
45.26.14 Property: Locators
45.26.15 Property: Results Type
45.26.16 Property: Error Level
45.26.17 Property: Require From Keyword
45.26.18 Property: Signature Level
45.26.19 Property: Format for ELM
45.26.20 Property: Validate units
45.26.21 Property: Semantic Analysis
45.26.22 Property: Profile Mode
45.26.23 Property: Search Filter Mode
45.26.24 Property: Terminology Filter Mode
45.26.25 Property: Debug Logging
45.26.26 Property: Enable Expression Caching
45.26.27 Property: Enable Validation
45.26.28 Property: ValueSet Code Lookup Mode
45.26.29 Property: ValueSet Expansion Mode
45.26.30 Property: ValueSet Membership Mode
45.26.31 Property: ValueSet Pre-Expansion Mode
45.26.32 Property: Use Embedded Libraries
45.27.0 Credentials
45.27.1 Property: Authentication Cache Duration (millis)
45.27.2 Property: Cache Successful Credentials
45.27.3 Property: Create Unknown Users
45.27.4 Property: Lock After Failed Attempts
45.27.5 Property: Case-Sensitive Passwords
45.27.6 Property: Password Encoding Scheme
45.27.7 Property: Password Mismatch Error
45.27.8 Property: Minimum Password Requirements
45.27.9 Property: Case-Sensitive Usernames
45.28.0 Cross-Origin Resource Sharing (CORS)
45.28.1 Property: CORS Allowed Request Headers
45.28.2 Property: CORS Enabled
45.28.3 Property: CORS Origins
45.29.0 System to System Data Exchange
45.29.1 Property: Reference System used by Target Patient
45.29.2 Property: Responder Identifier System
45.29.3 Property: Member Match Patient Matching Script (File)
45.29.4 Property: Member Match Patient Matching Script (Text)
45.29.5 Property: Support Consent Filtering
45.30.0 Database
45.30.1 Property: Use IAM Authentication
45.30.2 Property: Default Query Timeout (Seconds)
45.30.3 Property: Log Abandoned
45.30.4 Property: Max Idle Connections
45.30.5 Property: Connection Max Lifetime (millis)
45.30.6 Property: Max Total Connections
45.30.7 Property: Max Wait (Seconds)
45.30.8 Property: Min Idle Connections
45.30.9 Property: Pool Prepared Statements
45.30.10 Property: Remove Abandoned on Borrow
45.30.11 Property: Remove Abandoned Timeout Seconds
45.30.12 Property: Test Connections on Return
45.30.13 Property: Database Type
45.30.14 Property: Expect database to be writable
45.30.15 Property: Database Password
45.30.16 Property: Database Update Mode
45.30.17 Property: DB Secrets Manager
45.30.18 Property: SQL Parameter Bind Mode
45.30.19 Property: Database Connection URL
45.30.20 Property: Database Username
45.30.21 Property: Default Page Size
45.30.22 Property: FHIR Version
45.30.23 Property: Maximum Page Size
45.30.24 Property: Use ordinal date values for day precision searches.
45.31.0 Da Vinci Health Record Exchange
45.31.1 Property: Native Consent Handling.
45.32.0 DQM
45.32.1 Property: Chunk Size
45.32.2 Property: Measure Report default reporter
45.32.3 Property: Threaded Batch Size
45.32.4 Property: Number of Threads
45.32.5 Property: Enabled Threading
45.32.6 Property: Use Group resource managingEntity reference instead of default reporter
45.33.0 DTR
45.33.1 Property: Enable $questionnaire-package
45.34.0 Email Configuration
45.34.1 Property: Email From Address
45.34.2 Property: Notification Emails
45.34.3 Property: Email SMTP Hostname
45.34.4 Property: Email SMTP Password
45.34.5 Property: Email SMTP Port
45.34.6 Property: Use STARTTLS for connection security
45.34.7 Property: Email SMTP Username
45.35.0 Encounter Start CDS hook configuration
45.35.1 Property: Main ValueSet URL
45.35.2 Property: Prior Authorization not required ValueSet URL
45.35.3 Property: Prior Authorization required ValueSet URL
45.36.0 MDM UI
45.36.1 Property: JSON Admin URL
45.36.2 Property: OIDC Client ID
45.36.3 Property: OIDC Issuer URL
45.36.4 Property: OIDC Logout URL
45.36.5 Property: OIDC Redirect URI
45.36.6 Property: OIDC scopes
45.36.7 Property: Organization Identifier
45.37.0 ETL Import: CSV Properties
45.37.1 Property: CSV File Delimiter
45.37.2 Property: Parse Quotes
45.38.0 ETL Import: Source
45.38.1 Property: Async Mode Batch Size
45.38.2 Property: Asynchronous Mode Enabled
45.38.3 Property: Async Mode File Size
45.38.4 Property: Import Source
45.38.5 Property: Mapping Script (Text)
45.38.6 Property: Mapping Script (File)
45.38.7 Property: Worker Row Hashing Function (Text)
45.38.8 Property: Worker Row Hashing Function (File)
45.38.9 Property: Worker Thread Count
45.38.10 Property: Synchronous Mode: Continue On Failure
45.38.11 Property: Enable Transaction Log
45.39.0 FHIR Binary Storage
45.39.1 Property: Binary Access Operations Enabled
45.39.2 Property: Automatically inflate binaries.
45.39.3 Property: Binary inflation maximum size (bytes)
45.39.4 Property: Blob service S3 access key
45.39.5 Property: Blob service Azure account name
45.39.6 Property: Blob service Azure client / application ID
45.39.7 Property: Blob service Azure access key / client secret (app password) / Account-level SAS token
45.39.8 Property: Blob service Azure tenant ID
45.39.9 Property: Blob service bucket / container name.
45.39.10 Property: Endpoint URL for S3-compatible service
45.39.11 Property: Blob Service Region
45.39.12 Property: Blob service secret key
45.39.13 Property: Filesystem Mode: Base Directory
45.39.14 Property: Binary Storage Mode
45.39.15 Property: Maximum Size (bytes)
45.39.16 Property: Minimum Size (bytes)
45.40.0 FHIR Bulk Operations
45.40.1 Property: Enable Bulk Export batch job reuse
45.40.2 Property: FHIR Bulk Export Enabled
45.40.3 Property: Maximum Bulk Export file capacity
45.40.4 Property: Bulk Export file retention (hours)
45.40.5 Property: Normalize Terminology on Bulk Export
45.40.6 Property: Restrict Download to Initiating User
45.40.7 Property: FHIR Bulk Import Enabled
45.41.0 Capability Statement
45.41.1 Property: Copyright Message
45.41.2 Property: Implementation Description
45.41.3 Property: Include Partition Name
45.41.4 Property: Enable OpenAPI / Swagger Support
45.41.5 Property: Swagger-UI Custom CSS (Text)
45.41.6 Property: Swagger-UI Logo URL
45.41.7 Property: Swagger-UI Uses Resource Pages
45.41.8 Property: Software Name
45.41.9 Property: Software Version
45.42.0 FHIR Configuration
45.42.1 Property: Cascading Deletes Enabled
45.42.2 Property: Allow External References Enabled
45.42.3 Property: Allow Inline Match URL References Enabled
45.42.4 Property: Allow Multiple Delete Enabled
45.42.5 Property: Allow storing all bundle types
45.42.6 Property: Auto-Create Placeholder Reference Targets
45.42.7 Property: Client ID Mode
45.42.8 Property: Delete Child Resource Count
45.42.9 Property: Delete Expunge Enabled
45.42.10 Property: Enforce Reference Target Types
45.42.11 Property: Disable Deletion Ref Checks for Paths
45.42.12 Property: Enforce Referential Integrity on Delete
45.42.13 Property: Enforce Referential Integrity on Write
45.42.14 Property: Expunge Operation Enabled
45.42.15 Property: History Rewrite
45.42.16 Property: Batch Job Fasttracking Enabled
45.42.17 Property: Mark Resources for Reindexing after SearchParameter change
45.42.18 Property: Preserve request ID in resource body.
45.42.19 Property: Preserve Resource History
45.42.20 Property: Reindex Enabled
45.42.21 Property: Server ID Mode
45.42.22 Property: Store Meta.source information
45.42.23 Property: Tag Storage Mode
45.42.24 Property: Read Only Mode Enabled
45.42.25 Property: Seed Base Validation Resources
45.43.0 Consent Service
45.43.1 Property: Consent Service Enabled
45.43.2 Property: Java Consent Service Types
45.43.3 Property: Consent Service Script (File)
45.43.4 Property: Consent Service Script (Text)
45.44.0 FHIR Endpoint Conversion
45.44.1 Property: Versioned API Mode
45.45.0 FHIR Endpoint HFQL Support
45.45.1 Property: HFQL/SQL Endpoint Enabled
45.46.0 FHIR Endpoint Partitioning
45.46.1 Property: Tenant Identification Strategy
45.46.2 Property: Tenant Name
45.47.0 Resource Providers
45.47.1 Property: Allowed Interactions
45.47.2 Property: Resource Provider Bean Types
45.48.0 FHIR Endpoint Security
45.48.1 Property: Allow Searches With Compartment Access
45.48.2 Property: Automatically Narrow Search Scope
45.48.3 Property: Narrow Conditional URL Search Scope
45.48.4 Property: Reject Insufficient Permissions with HTTP 401
45.48.5 Property: Watermark Responses Enabled
45.48.6 Property: Scopes Supported
45.49.0 Endpoint Terminology
45.49.1 Property: Populate Response Coding Displays
45.49.2 Property: Response Mapping
45.49.3 Property: Mapping Spec (Text)
45.50.0 FHIR Gateway Cache
45.50.1 Property: Cache Expiration Seconds
45.50.2 Property: Cache Maximum Entries
45.50.3 Property: Cache Provider
45.51.0 FHIR Gateway Configuration
45.51.1 Property: Spring Context Config Class
45.51.2 Property: FHIR Version
45.51.3 Property: Gateway Configuration (File)
45.51.4 Property: Show Underlying Errors
45.51.5 Property: Gateway Configuration (Text)
45.51.6 Property: Encryption JWKS (File)
45.51.7 Property: Encryption JWKS (Text)
45.51.8 Property: The default page size
45.51.9 Property: The maximum page size
45.52.0 FHIR Interceptors
45.52.1 Property: FHIR storage Callback Script (File)
45.52.2 Property: FHIR storage Callback Script (Text)
45.52.3 Property: Can Replace Authorization Interceptor
45.52.4 Property: Secure Application Context For Customer-Provided Beans
45.52.5 Property: Interceptor Bean Types
45.53.0 LiveBundle Service
45.53.1 Property: LiveBundle Enabled
45.53.2 Property: LiveBundle Rule Definition Script (File)
45.53.3 Property: LiveBundle Rule Definition Script (Text)
45.53.4 Property: LiveBundle Thread Count
45.53.5 Property: LiveBundle Watchlist Cache Enabled
45.54.0 FHIR MDM Server
45.54.1 Property: MDM Mode Enabled (Experimental)
45.54.2 Property: Search Expanding Interceptor Enabled (Experimental)
45.55.0 FHIR Performance
45.55.1 Property: Default Total Calculation Mode
45.55.2 Property: Delete Enabled
45.55.3 Property: Expire Search Results After Minutes
45.55.4 Property: Expunge Batch Size
45.55.5 Property: Expunge Thread Count
45.55.6 Property: Internal Synchronous Search Size
45.55.7 Property: Mass Ingestion Mode
45.55.8 Property: Match URL Cache Enabled
45.55.9 Property: Maximum Transaction Bundle Size
45.55.10 Property: Only Allow IN-MEMORY Subscriptions
45.55.11 Property: Reindex Thread Count
45.55.12 Property: Reuse Cached Results Timeout (Millis)
45.55.13 Property: Index Missing Search Params
45.55.14 Property: Keep history for MDM links and other non-FHIR-resource DB history.
45.55.15 Property: Suppress Scheduled Maintenance Jobs
45.55.16 Property: Write-Semaphore Mode: Enabled
45.55.17 Property: Write-Semaphore Mode: Log Waits
45.56.0 FHIR Performance Tracing
45.56.1 Property: Capture Raw SQL or Equivalent
45.56.2 Property: Trigger
45.56.3 Property: Performance Tracing Enabled
45.56.4 Property: Output to Response Headers
45.56.5 Property: Output to System Log
45.56.6 Property: Output to Transaction Log
45.57.0 FHIR Realtime Export
45.57.1 Property: Pointcut-based Realtime Export Mode Enabled
45.58.0 Repository Validation
45.58.1 Property: Repository Validation Javascript (File)
45.58.2 Property: Repository Validation Javascript (Text)
45.59.0 FHIR Resource Types
45.59.1 Property: Instance/Type History Enabled
45.59.2 Property: Server History Enabled
45.59.3 Property: Resource Types (whitelist)
45.60.0 FHIR REST Endpoint
45.60.1 Property: Fixed Value for Endpoint Base URL
45.60.2 Property: Default Encoding
45.60.3 Property: Default Prefer Return
45.60.4 Property: Pretty-Print by Default
45.60.5 Property: Process Header: Request Source
45.60.6 Property: Serve Raw Media Resources
45.61.0 FHIR Search
45.61.1 Property: Always use Offset Searches
45.61.2 Property: Allow :contains Searches
45.61.3 Property: Maximum number of codes to expand
45.61.4 Property: Fetch Size (Default Maximum)
45.61.5 Property: Index Contained Resources
45.61.6 Property: Index Contained Resources Recursively
45.61.7 Property: Index Uplifted Refchains
45.61.8 Property: Legacy Date Index Mode
45.61.9 Property: Max Includes per Page
45.61.10 Property: Use ordinal date values for day precision searches.
45.61.11 Property: Filter Search Parameter Enabled
45.61.12 Property: GraphQL Enabled
45.61.13 Property: Index Identifier.type (:of-type modifier) Enabled
45.61.14 Property: Language Search Parameter Enabled
45.61.15 Property: Custom names file
45.61.16 Property: Normalized Unit Searching
45.61.17 Property: Page Size (Default)
45.61.18 Property: Page Size (Maximum)
45.61.19 Property: Nickname enabled
45.61.20 Property: Phonetic Encoder
45.61.21 Property: Infinispan Cache Name
45.61.22 Property: Infinispan Hot Rod Protocol Version
45.61.23 Property: Infinispan Servers
45.61.24 Property: Search Cache Storage
45.61.25 Property: Stale Search Cleanup Interval (seconds)
45.61.26 Property: Suppress String Indexing In Tokens
45.62.0 Custom Resource Types
45.62.1 Property: Custom Resource Classes
45.63.0 IG Support
45.63.1 Property: International Patient Summary (IPS) Enabled
45.63.2 Property: IPS Generation Strategy Class Name
45.64.0 MegaScale
45.64.1 Property: MegaScale Enabled
45.65.0 FHIR Storage Module Conditional Updates
45.65.1 Property: Prevent Conditional Update from Invalidating Match Criteria
45.66.0 FHIR Storage Module Scheduled Tasks
45.66.1 Property: Batch job retention days.
45.66.2 Property: Scheduler Thread Count
45.66.3 Property: Resource Submission Interval (Millis)
45.66.4 Property: Batch Job Executor: Maximum Thread Count
45.66.5 Property: Bulk Export Task Enabled
45.66.6 Property: Bulk Import Task Enabled
45.66.7 Property: Delete Stale Searches Task Enabled
45.66.8 Property: Pre-Expand ValueSets Task Enabled
45.66.9 Property: Resource Reindexing Task Enabled
45.67.0 FHIR Validation Services
45.67.1 Property: Concurrent Bundle Validation Thread Count
45.67.2 Property: Concurrent Bundle Validation
45.67.3 Property: Remote Terminology Service: Base URL
45.67.4 Property: Terminology Basic Auth Password
45.67.5 Property: Terminology Basic Auth Username
45.67.6 Property: Remote Terminology Service: Enabled
45.67.7 Property: Remote Terminology Service: Log HTTP Calls
45.67.8 Property: Accept All Codings Only
45.67.9 Property: Code Display Mismatch Policy
45.67.10 Property: Local Reference Policy
45.67.11 Property: Skip Contained Resource Validation
45.67.12 Property: Suppress Validation Message Patterns
45.67.13 Property: Unknown CodeSystem Validation Policy
45.68.0 FHIR Storage Package Registry
45.68.1 Property: Load Pre-Seed Installation Spec Files Asynchronously
45.68.2 Property: Enable Validation of Resource Status for Package Installation
45.68.3 Property: Package Pre-Seed Installation Spec Files
45.69.0 FHIR Storage Partitioning
45.69.1 Property: Block resource updates changing Patient compartment
45.69.2 Property: Cross-Partition Reference Mode
45.69.3 Property: Default Partition ID
45.69.4 Property: Partitioning Enabled
45.69.5 Property: Partition Naming Mode
45.69.6 Property: Partition Selection Mode
45.69.7 Property: Partition Seed File
45.69.8 Property: Partitioning Security Enabled
45.70.0 Versioned References
45.70.1 Property: Allow Versioned References at All Paths
45.70.2 Property: Allow Versioned References at Paths
45.70.3 Property: Automatically Version References at Paths
45.70.4 Property: Respect Versioned References for _include
45.71.0 FHIR Subscription Delivery
45.71.1 Property: Subscription Delivery Queue Naming
45.71.2 Property: Email From Address
45.72.0 FHIR Subscription Persistence
45.72.1 Property: Consumers Per Delivery Queue
45.72.2 Property: Matching Queue Consumers
45.72.3 Property: Cross-Partition Subscription Enabled
45.72.4 Property: Email Subscription Enabled
45.72.5 Property: Message Subscription Enabled
45.72.6 Property: Qualify subscription matching channel name
45.72.7 Property: REST Hook Subscription Enabled
45.72.8 Property: Trigger Subscriptions on Non-Versioning Changes
45.72.9 Property: Websocket Subscription Enabled
45.73.0 Amazon HealthLake REST Endpoint
45.73.1 Property: HealthLake Endpoint URL
45.73.2 Property: HealthLake Region Name
45.73.3 Property: HealthLake role ARN
45.73.4 Property: Auto-Manage Subscription Resource
45.73.5 Property: Auto-Managed Subscription Criteria
45.73.6 Property: Maximum amount of retry attempts for subscription
45.74.0 HL7 v2.x Mapper - Contained Resource
45.74.1 Property: Use standalone Related Person
45.74.2 Property: Use standalone Associated Party
45.74.3 Property: Use standalone Patient Account
45.75.0 HL7 v2.x Mapper - DG1
45.75.1 Property: Use DG1.1 as Condition.identifier.value` suffix.
45.76.0 HL7 v2.x Mapper - Forced Namespace Mode
45.76.1 Property: Forced Namespace Mode: Encounter System
45.76.2 Property: Forced Namespace Mode: Patient System
45.77.0 HL7 v2.x Mapper - General
45.77.1 Property: Create MessageHeader for Each Message
45.77.2 Property: Creation Mode - Practitioner
45.77.3 Property: Escape Markdown Punctuation: NTE-3
45.77.4 Property: Patient Primary Identifier Search Parameter
45.77.5 Property: Inferred TimeZone When Not Present
45.77.6 Property: Map Identifiers using NamingSystem
45.77.7 Property: Mapper Bean Types
45.77.8 Property: MessageHeader Hardcoded Destination Name
45.77.9 Property: Process AL1 Segments
45.77.10 Property: Store Original HL7v2 message
45.78.0 HL7 v2.x Mapper - Medications
45.78.1 Property: Use Standalone Medications with Administered Code
45.78.2 Property: Use Standalone Medications with Component Code
45.78.3 Property: Use Standalone Medications with Give Code
45.79.0 HL7 v2.x Mapper - OBR
45.79.1 Property: Observation Identification Mode
45.79.2 Property: Use OBR-2 as Primary Identifier
45.79.3 Property: Use OBR-3 as Primary Identifier
45.80.0 HL7 v2.x to FHIR Mapper - OBSERVATION Group
45.80.1 Property: OBSERVATION Group Text Delimiter - NTE
45.80.2 Property: OBSERVATION Group Text Delimiter - OBX
45.81.0 HL7 v2.x Mapper - ORC
45.81.1 Property: Use ORC-3 as Primary Identifier
45.82.0 HL7 v2.x to FHIR Mapper - ORDER_OBSERVATION Group
45.82.1 Property: ORDER_OBSERVATION Group Text Delimiter - NTE
45.83.0 HL7 v2.x Mapper - PID
45.83.1 Property: Patient Primary Identifier Type
45.84.0 HL7 v2.x Mapper - PV1
45.84.1 Property: Coding System for PV1-4 Admission Type
45.84.2 Property: Parse Encounter Providers
45.84.3 Property: Treat PV1-3 and PV1-6 Patient Locations as Single Atomic Locations
45.85.0 Listener Interceptors
45.85.1 Property: Interceptor Bean Types
45.86.0 HL7 v2.x Listener Script
45.86.1 Property: Listener Processing Script (File)
45.86.2 Property: Listener Processing Script (Text)
45.87.0 HL7 v2.x Listening Endpoint
45.87.1 Property: Intermediate Logging Enabled
45.87.2 Property: Non-standard segment behaviour
45.87.3 Property: Storage Tenant Name
45.87.4 Property: Transport Protocol
45.87.5 Property: Unprocessable Message Handling
45.88.0 HL7 v2.x MLLP Listener
45.88.1 Property: Charset: Forced
45.88.2 Property: Charset: Respect MSH-18
45.88.3 Property: Intermediate Logging Enabled
45.88.4 Property: HL7 v2.x MLLP Listener Port
45.88.5 Property: Non-standard segment behaviour
45.88.6 Property: HL7 v2.x Listener Port
45.88.7 Property: Socket Timeout (Millis)
45.88.8 Property: Storage Tenant Name
45.88.9 Property: Transport Protocol
45.88.10 Property: Unprocessable Message Handling
45.89.0 HL7 v2.x MLLP Sender
45.89.1 Property: Delay Between Failed Deliveries (millis)
45.89.2 Property: Forward Persisted Messages
45.89.3 Property: HL7 v2.x Destination Host
45.89.4 Property: Request Path
45.89.5 Property: HL7 v2.x Destination Port
45.89.6 Property: Retry message on NAK
45.89.7 Property: Send Timeout (millis)
45.89.8 Property: Transport Protocol
45.90.0 FHIR to HL7 v2.x Mapper Script
45.90.1 Property: HL7 v2.x Conversion Mapper Script (File)
45.90.2 Property: HL7 v2.x Conversion Mapper Script (Text)
45.91.0 HL7 v2.x Outbound Mapping
45.91.1 Property: Coding System for PV1-4 Admission Type
45.91.2 Property: Map Identifiers using NamingSystem
45.91.3 Property: Populate AL1 Segments
45.91.4 Property: Populate Encounter Participants in PV1
45.91.5 Property: Use Persisted Message Headers
45.92.0 HTTP Access Log
45.92.1 Property: Appenders
45.93.0 HTTP Listener
45.93.1 Property: Bind Address
45.93.2 Property: Context Path
45.93.3 Property: Endpoint Health Path
45.93.4 Property: Unhealthy Status Code
45.93.5 Property: HTTPS Forwarding Assumed
45.93.6 Property: Listener Port
45.93.7 Property: Respect Forward Headers
45.94.0 HTTP Request Pool
45.94.1 Property: Maximum Request Header Size (KB)
45.94.2 Property: Maximum Response Header Size (KB)
45.94.3 Property: Read Idle Timeout (millis)
45.94.4 Property: Thread Pool Accept Queue Size
45.94.5 Property: Thread Pool Maximum Size
45.94.6 Property: Thread Pool Minimum Size
45.95.0 HTTP Security
45.95.1 Property: Block HTTP HEAD
45.95.2 Property: Block HTTP OPTIONS
45.95.3 Property: Custom Headers
45.95.4 Property: Frame Options (Allow From)
45.95.5 Property: Pin Host
45.95.6 Property: Suppress Error Details
45.95.7 Property: Suppress Platform Information
45.96.0 Hybrid Providers Definitions
45.96.1 Property: Search Bundle Inclusion Rule
45.96.2 Property: FHIR Version
45.96.3 Property: Spring Context Config Class
45.97.0 IG Support
45.97.1 Property: Target Implementation Guide
45.98.0 Initial User Seeding
45.98.1 Property: Users Seed File
45.99.0 JavaScript Execution Environment
45.99.1 Property: Debug Enabled
45.99.2 Property: Debug Host Address
45.99.3 Property: Path
45.99.4 Property: Port
45.99.5 Property: Secure
45.99.6 Property: Suspend
45.99.7 Property: ECMAScript Module
45.100.0 JSON Web KeySet (JWKS)
45.100.1 Property: Signing JWKS (File)
45.100.2 Property: Signing JWKS (Text)
45.100.3 Property: Signing Key ID
45.100.4 Property: Keystore ID
45.101.0 LDAP Authentication
45.101.1 Property: Authentication: User Attributes to query
45.101.2 Property: Authentication: User Base DN
45.101.3 Property: Authentication: User Query
45.101.4 Property: Require Group DN
45.101.5 Property: Base DN for Groups
45.101.6 Property: Search Groups Recursively
45.101.7 Property: System User DN
45.101.8 Property: System User Password
45.101.9 Property: LDAP Server URL
45.101.10 Property: Global Permissions
45.101.11 Property: Native Permission User Attribute
45.101.12 Property: User Attribute: Family Name
45.101.13 Property: User Attribute: Given Name
45.102.0 Smile CDR License
45.102.1 Property: License JWT File
45.102.2 Property: License JWT Text
45.103.0 Lucene FullText Indexing
45.103.1 Property: Lucene Index Directory
45.103.2 Property: Elasticsearch/OpenSearch AWS Region.
45.103.3 Property: Elasticsearch Index Prefix
45.103.4 Property: ElasticSearch Password
45.103.5 Property: ElasticSearch URL protocol. Either http or https
45.103.6 Property: ElasticSearch Host URLs.
45.103.7 Property: ElasticSearch Username
45.103.8 Property: Enable FullText Content Index
45.103.9 Property: Enable Indexing of Search Parameters (experimental)
45.103.10 Property: Store resource bodies in Lucene (experimental)
45.103.11 Property: Lucene Indexing Provider
45.103.12 Property: Lucene Indexing Enabled
45.104.0 MDM
45.104.1 Property: Auto Delete Golden Resources
45.104.2 Property: Block List Rules File
45.104.3 Property: Block List Rules
45.104.4 Property: MDM Consumer Thread Count
45.104.5 Property: Golden Resource Partition
45.104.6 Property: Interceptor Bean Types
45.104.7 Property: MDM Partition Key Generator Script (File)
45.104.8 Property: MDM Partition Key Generator Script (Text)
45.104.9 Property: MDM Identifier Code
45.104.10 Property: MDM Identifier CodeSystem URL
45.104.11 Property: MDM Partition Key generator type
45.104.12 Property: Prevent modification of External EIDs
45.104.13 Property: Prevent multiple EIDs from existing simultaneously on a target resource
45.104.14 Property: MDM Rule Definition Script (File)
45.104.15 Property: MDM Rule Definition Script (Text)
45.104.16 Property: Search All Partitions For Matches
45.104.17 Property: MDM Survivorship Script (File)
45.104.18 Property: MDM Survivorship Script (Text)
45.105.0 Narrative Generator
45.105.1 Property: Narrative Template Manifest File
45.106.0 OpenID Connect Token Validation
45.106.1 Property: OIDC HTTP Client: JWKS Cache Timeout (mins)
45.106.2 Property: OIDC HTTP Client: Truststore File
45.106.3 Property: OIDC HTTP Client: Truststore Password
45.107.0 OpenID Connect (OIDC)
45.107.1 Property: Cache Authorizations (millis)
45.107.2 Property: Client Secret Encoding
45.107.3 Property: Smile CDR generated Client Secret expiry duration in days
45.107.4 Property: Issuer URL
45.107.5 Property: New Session for Each Flow
45.107.6 Property: PKCE Plain Challenge Supported
45.107.7 Property: PKCE Required
45.107.8 Property: Rotate Refresh Token After Use
45.107.9 Property: Smart Capabilities List
45.108.0 Order Sign CDS hook configuration
45.108.1 Property: ConceptMap URL for Prior-Auth Codes
45.108.2 Property: ValueSet URL for Prior-Auth Codes
45.108.3 Property: ConceptMap URL for Routine Codes
45.108.4 Property: ValueSet URL for Routine Codes
45.109.0 Payer to Payer
45.109.1 Property: Organization Identifier CodeSystem URL
45.110.0 Prior Authorization Coverage Requirement Discovery
45.110.1 Property: Coverage identifier system
45.110.2 Property: DTR application URL
45.110.3 Property: Payer source label
45.110.4 Property: Payer source URL
45.110.5 Property: Practitioner identifier system
45.110.6 Property: Accepted CodeSystems URLs
45.110.7 Property: System Action Questionnaire URL
45.111.0 Prior Authorization Support
45.111.1 Property: Prior Authorization Support identifier code system
45.111.2 Property: Payer Organization Reference
45.112.0 Privacy Security Notice
45.112.1 Property: Privacy Text
45.112.2 Property: Expiry time (days)
45.112.3 Property: Version
45.113.0 Provenance Injection
45.113.1 Property: Agent Type
45.113.2 Property: Agent Who
45.113.3 Property: $everything operation
45.113.4 Property: Profile
45.113.5 Property: _revinclude=Provenance:target
45.114.0 Quality Payment Program (QPP)
45.114.1 Property: CMS Quality Payment Program Submission Method
45.115.0 Realtime Export
45.115.1 Property: Concurrent Consumers
45.115.2 Property: Import Channel Name
45.115.3 Property: Channel Name Prefix
45.115.4 Property: Realtime Export Script (File)
45.115.5 Property: Realtime Export Script (Text)
45.115.6 Property: Published Data source
45.115.7 Property: Transaction-Based Processing
45.116.0 Endpoint Validation: Request Validating
45.116.1 Property: Request Validating Bean Types
45.116.2 Property: Request Validating Enabled
45.116.3 Property: Fail On Severity
45.116.4 Property: Validation Response Headers Enabled
45.116.5 Property: Validation Tags Enabled
45.117.0 Scheduler Configuration
45.117.1 Property: Persistence Clustered Scheduler Name
45.118.0 Search Parameter Seeding
45.118.1 Property: Disable Patterns
45.118.2 Property: Enable Patterns
45.118.3 Property: Support Default SearchParameters
45.119.0 SAML Provider
45.119.1 Property: Relying Party Entity ID Template
45.119.2 Property: Issuer ID
45.119.3 Property: Keystore File
45.119.4 Property: Keystore Password
45.119.5 Property: Registration ID
45.119.6 Property: Sign Auth Request
45.119.7 Property: Signing Key Alias
45.119.8 Property: Signing Key Password
45.119.9 Property: Verification Certificate Alias
45.119.10 Property: Web SSO URL
45.120.0 Security Inbound Script
45.120.1 Property: Script (File)
45.120.2 Property: HTTP Headers
45.120.3 Property: Script (Text)
45.121.0 Inbound SMART on FHIR Authentication
45.121.1 Property: Authentication Cache Timeout (Seconds)
45.121.2 Property: Prevent Token KeyID Reuse
45.121.3 Property: Require Key Expiry
45.121.4 Property: Scopes Supported
45.121.5 Property: Trust Intra-Cluster SMART Tokens from Module(s)
45.122.0 Inbound SMART on FHIR Endpoints
45.122.1 Property: Authorization Endpoint
45.122.2 Property: Introspection Endpoint
45.122.3 Property: Management Endpoint
45.122.4 Property: Revocation Endpoint
45.122.5 Property: Token Endpoint
45.123.0 OAuth2/OIDC Federation
45.123.1 Property: Federated OAuth2/OIDC Login
45.124.0 SMART Callback Script
45.124.1 Property: Authorization Request Details (whitelist)
45.124.2 Property: Post Authorization Script (File)
45.124.3 Property: Post Authorization Script (Text)
45.125.0 Cross-Organizational Data Access Profile
45.125.1 Property: CODAP Authorization Script (File)
45.125.2 Property: CODAP Authorization Script (Text)
45.125.3 Property: Enable Cross-Organization Data Access Profile
45.126.0 SMART Login Skin
45.126.1 Property: Approval Page Template
45.126.2 Property: Context Selection Page Template
45.126.3 Property: Error Page Template
45.126.4 Property: User Self Registration Forgot Password (Step 1)
45.126.5 Property: User Self Registration Forgot Password (Step 2)
45.126.6 Property: User Self Registration Forgot Password (Step 3)
45.126.7 Property: Login Page (Federated OAuth2/OIDC) Template
45.126.8 Property: Login Page Template
45.126.9 Property: User Self Registration Template (Step 1)
45.126.10 Property: User Self Registration Template (Step 2)
45.126.11 Property: Session Management Page Template
45.126.12 Property: Two Factor Authentication Page Template
45.126.13 Property: Terms-of-service click-wrap Page Template
45.126.14 Property: WebJar ID
45.127.0 SMART Login Terms of Service
45.127.1 Property: Current version of terms.
45.128.0 SMART Authorization
45.128.1 Property: Allowed Audience List
45.128.2 Property: Email From Address
45.128.3 Property: Enforce Approved Scopes to Restrict Permissions
45.128.4 Property: Scopes Supported
45.129.0 SMART Definitions Seeding
45.129.1 Property: OpenID Connect Client Pre-Seed File
45.129.2 Property: OpenID Connect Server Pre-Seed File
45.130.0 Sessions
45.130.1 Property: Use In-Memory Sessions
45.130.2 Property: Maximum concurrent session per user
45.130.3 Property: Session Scavenger Interval (Millis)
45.130.4 Property: Session Timeout (Mins)
45.131.0 Two Factor Authentication
45.131.1 Property: TOTP Issuer Name
45.131.2 Property: Lock After Failed Attempts
45.132.0 TLS / SSL (Encryption)
45.132.1 Property: TLS Client Authentication
45.132.2 Property: TLS Enabled
45.132.3 Property: TLS KeyStore Filename
45.132.4 Property: TLS KeyStore Key Alias
45.132.5 Property: TLS KeyStore Key Password
45.132.6 Property: TLS KeyStore Password
45.132.7 Property: TLS Cipher Blacklist
45.132.8 Property: TLS Cipher Whitelist
45.132.9 Property: TLS Protocol Blacklist
45.132.10 Property: TLS Protocol Whitelist
45.132.11 Property: TLS TrustStore Filename
45.132.12 Property: TLS TrustStore Password
45.132.13 Property: TLS: Disable SNI checking for debugging
45.133.0 Transaction Log
45.133.1 Property: Transaction Log Step Body Serialization Mode
45.133.2 Property: Transaction Log Broker Channel Name
45.133.3 Property: Transaction Log Broker Enabled
45.133.4 Property: Transaction Log Database Storage Enabled
45.133.5 Property: Event Blacklist
45.133.6 Property: Event Whitelist
45.133.7 Property: Persist Transaction Bodies (Global)
45.133.8 Property: Persist Transaction Bodies: Incoming Request
45.133.9 Property: Persist Transaction Bodies: Incoming Response
45.133.10 Property: Transaction Log Show Request Body Enabled
45.133.11 Property: Truncate Transaction Bodies (bytes)
45.134.0 Trusted Client
45.134.1 Property: Assert Permissions
45.134.2 Property: Trusted Client Mode Enabled
45.135.0 User Self Registration
45.135.1 Property: User Self Registration Script (File)
45.135.2 Property: User Self Registration Script (Text)
45.135.3 Property: User Self Registration Enabled
45.135.4 Property: Referer URL List (Text)
46.0.0 Product Reference
46.0.0 Enumerated Types
46.0.1 Node And Module Status
46.0.2 Transaction Log Outcomes
46.0.3 Module Types
47.0.0 Amazon HealthLake Outbound REST Connector
47.0.0 Introduction
47.1.0 Getting Started
47.1.1 Configuration
47.1.2 Subscription
47.1.3 Start/Stop/Restart Module
47.2.0 Data Management and Transfer
47.2.1 Security
47.2.2 Data Access and Transfer
47.2.3 Data Version Management
47.2.4 Historical Data Transfer
47.2.5 Logging
47.2.6 Error Handling
47.2.7 Troubleshooting
48.0.0 Appendix
48.0.0 Preparing a Linux Host
48.0.1 Ubuntu Host with PostgreSQL / NGINX / Letsencrypt
48.0.2 Install letsencrypt and obtain Certs (optional)
48.0.3 Install nginx And Configure it to Front the Server
48.0.4 Red Hat Enterprise Linux (RHEL) or CentOS
48.1.0 Installing Smile CDR, NGINX and PostgreSQL in a Docker Stack
48.1.1 Initial Setup of Docker and Context
48.1.2 Prepare Configuration for Smile CDR Docker Service
48.1.3 Prepare Configuration for NGINX Docker Service
48.1.4 Prepare Configuration for PostgreSQL Docker Service
48.1.5 Create Docker compose file for Smile CDR Docker stack
48.1.6 Build and Launch Smile CDR Stack
48.2.0 Deploying a Kubernetes Managed Cluster
48.2.1 Overview of Smile CDR Kubernetes Deployment Process
48.2.2 Pre-requisite Steps
48.2.3 Configuring Kubernetes
48.2.4 Kubernetes and Smile CDR Database Connections
48.2.5 Service Definitions
48.2.6 ConfigMap Definitions
48.2.7 Deployment Definitions
48.2.8 Deploying Smile CDR in a Kubernetes Cluster
48.2.9 Configuring Reverse Proxy and Load Balancer
48.2.10 Considerations When Deploying Smile CDR Using OpenShift
48.3.0 Password Hashing Algorithms
48.3.1 Available Algorithms
48.4.0 Resource Paths
48.5.0 JWT Signature Algorithms
48.6.0 Inferno Considerations