Smile CDR v2023.11.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 Development Forecast
1.4.1 November 2023 Release Forecast
1.4.2 February 2024 Release Forecast
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 Variable Substitution
3.0.9 Fetching Configuration Using Scripts
3.0.10 Configuring Your Database
3.0.11 Starting the CDR
3.0.12 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.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 SMART on FHIR Apps
4.1.1 Accessing the Web Admin Console
4.1.2 Creating a Client Definition
4.1.3 Enabling SMART on FHIR Requests
4.1.4 Install Growth Chart App
4.1.5 Create Some Test Data
4.1.6 Enable SMART Authorization on FHIR Endpoint
4.1.7 Install a Launch Context Script
4.1.8 Launch SMART on FHIR Growth Chart App
4.2.0 Processing HL7 v2.x Feeds
4.2.1 Transmitting to Smile CDR
4.2.2 ORU (Observation Result) Messages
4.2.3 ADT (Admission/Discharge/Transfer) Messages
4.3.0 Federated OAuth2/OIDC Setup
4.3.1 Setting up Smile CDR - SMART Outbound Security Module
4.3.2 Setting up Smile CDR - OIDC Client Definition
4.3.3 Setting up Smile CDR - OIDC Server Definition
4.3.4 Setting up the IDP
4.3.5 Starting the Federated Flow
4.3.6 Token Signature Algorithms
4.3.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.1.2 Practical Limitations
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.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
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 Troubleshooting
17.8.7 Reference Documents
17.8.8 Glossary of Terms
18.0.0 FHIR Gateway
18.0.0 FHIR Gateway Introduction
18.0.1 Troubleshooting
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.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
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 Deploying Your Hybrid Providers
19.0.9 Accessing Security Attributes
19.0.10 Accessing Dao (Data Access Object)
19.0.11 Exceptions
19.0.12 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 Troubleshooting
22.0.4 MDM User Interface (MDM UI)
22.0.5 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 HL7V2 Troubleshooting Log
26.4.3 HTTP Troubleshooting Log
26.4.4 Security Troubleshooting Log
26.4.5 Subscription Troubleshooting Log
26.4.6 LiveBundle Troubleshooting Log
26.4.7 MDM Troubleshooting Log
26.4.8 Channel Import Troubleshooting Log
26.4.9 Realtime Export Troubleshooting Log
26.4.10 FHIR Gateway Troubleshooting Log
26.4.11 Connection Pool Troubleshooting Log
26.4.12 AWS HealthLake Export Troubleshooting Log
26.4.13 Batch Framework Troubleshooting Log
26.4.14 Narrative Generation Troubleshooting Log
26.4.15 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 Processing
27.1.2 Callback Scripts
27.1.3 Function: onPreConvertHl7V2ToFhir(theMessage, theConversionResult)
27.1.4 Function: onPostConvertHl7V2ToFhir(theMessage, theConversionResult)
27.1.5 Adding Processing Messages
27.1.6 Lookup message segments by type
27.1.7 Custom Processing Logic
27.1.8 Pointcuts
27.1.9 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 FHIR-Based Terminology Translation
28.6.1 Default Mappings: DSTU3
28.6.2 Default Mappings: R4
28.7.0 Further Reading
29.0.0 Bulk Operations
29.0.0 ETL Import Module
29.0.1 Importing CSV Data
29.0.2 Function: handleEtlImportRow(theInputMap, theContext)
29.0.3 Handling Multiple Import Formats
29.0.4 Initiating ETL Jobs
29.0.5 Performance and Concurrency
29.0.6 Locking Rows
29.0.7 Creating a Hashing Script
29.0.8 Asynchronous Execution
29.0.9 Performance
29.1.0 FHIR Bulk Import Operation
29.1.1 Triggering a Bulk Import
29.1.2 Methodology
29.1.3 Performance
29.2.0 FHIR Bulk Export Operation
29.2.1 Enabling Bulk Export
29.2.2 Types of Bulk Export Requests
29.2.3 Request Parameters
29.2.4 Requesting A Bulk Extract
29.2.5 Authorization for Bulk Export
29.2.6 Polling for Job Status
29.2.7 Accessing Bulk Export Files
30.0.0 Additional Features
30.0.0 Da Vinci Clinical Data Exchange (CDex)
30.1.0 Da Vinci Health Record Exchange (HRex)
31.0.0 Monitoring
31.0.0 Monitoring Basics
31.0.1 HTTP Endpoint Health Check
31.0.2 Runtime Health Checks
31.0.3 Runtime Monitoring Statistics
31.1.0 Elastic APM Basics
31.1.1 What is APM?
31.1.2 Setting Up an APM Server
31.1.3 Instrumenting Smile CDR and the JVM
31.1.4 Accessing the User Interface
31.1.5 Configuring Settings for the Agent
31.1.6 Securing the Agent
31.2.0 Externalized Metrics
31.2.1 Step 1 - Install Prometheus
31.2.2 Step 2 - Install Grafana
31.2.3 Step 3 - Creating a Prometheus data source on Grafana
31.2.4 Step 4 - Configure Smile CDR
31.2.5 Step 5 - Creating a Grafana Dashboard  
32.0.0 Product Administration
32.0.0 Batch Job Management
32.1.0 Web Admin Console
33.0.0 JSON Admin Endpoints
33.0.0 JSON Admin API
33.0.1 Security
33.0.2 Format
33.0.3 Allowing Anonymous Access
33.0.4 MDM Endpoints Exposed in JSON Admin Module
33.1.0 Audit Log Endpoint
33.1.1 Fetch Audit Log
33.1.2 Fetch Individual Event
33.2.0 Batch Job Endpoint
33.2.1 Fetch All Batch Jobs
33.2.2 Fetch Batch Job Names
33.2.3 Fetch All Job Instances
33.2.4 Cancel Job Execution
33.3.0 Bulk Import Endpoint
33.3.1 Process ETL File
33.3.2 Smileutil: CSV Bulk Import File
33.4.0 CDA Exchange Endpoint
33.4.1 Create CDA Template
33.4.2 Update CDA Template
33.4.3 Update CDA Template script via text
33.4.4 View CDA Template(s)
33.4.5 Delete CDA template
33.4.6 Use / Apply CDA Template
33.4.7 Create CDA from Composition/Bundle
33.4.8 Example CDA Template
33.5.0 Metrics Endpoint
33.5.1 Fetch Local Metrics
33.5.2 Capture Thread Dump
33.6.0 Module Config Endpoint
33.6.1 Fetch Config: Module Property File
33.6.2 Fetch Config: All Modules
33.6.3 Fetch Config: Single Module
33.6.4 Create Module
33.6.5 Set Module Config
33.6.6 Start Module
33.6.7 Stop Module
33.6.8 Restart Module
33.6.9 Archive Module
33.7.0 OpenID Connect Clients Endpoint
33.7.1 Fetch All OpenID Connect Client Definitions
33.7.2 Fetch Individual Client by Client ID
33.7.3 Create Client
33.7.4 Update Client
33.7.5 Create Client and generate secrets
33.8.0 OpenID Connect Servers Endpoint
33.8.1 Fetch All OpenID Connect Server Definitions
33.8.2 Find OpenID Connect Server Definition
33.8.3 Create OpenID Connect Server Definition
33.8.4 Update OpenID Connect Server Definition
33.9.0 OpenID Connect Sessions Endpoint
33.9.1 Fetch All Active Clients for User
33.9.2 Revoke Active Client for User
33.9.3 Revoke All Tokens
33.10.0 Runtime Status Endpoint
33.10.1 Fetch Complete Node Status Information
33.10.2 Fetch All Runtime Health Checks
33.11.0 System Config Endpoint
33.12.0 Transaction Log Endpoint
33.12.1 Fetch Transaction Log
33.12.2 Fetch Individual Event
33.13.0 User Management Endpoint
33.13.1 Search for Users (All Modules)
33.13.2 Search for Users (Specific Module)
33.13.3 Create User
33.13.4 Update User
33.13.5 Update Password
33.13.6 Update Own Password
33.13.7 Update Own Default Launch Contexts
33.13.8 2FA: Create New Key
33.13.9 2FA: Generate QR Code
33.13.10 2FA: Confirm Key
33.13.11 2FA: Delete Key
33.13.12 Invalidate All Sessions
34.0.0 HFQL: Direct SQL Access
34.0.0 HFQL/SQL Overview
34.0.1 Overview
34.0.2 Goals and Architecture
34.0.3 JDBC Driver
34.0.4 Enabling Server Support
34.1.0 SQL Syntax
34.1.1 Syntax Overview
34.2.0 SQL Syntax: Select
34.2.1 Selecting Columns
34.2.2 Column Name Aliases
34.2.3 Column Data Types and Choice Elements
34.2.4 Count and Group-By Expressions
34.2.5 Ordering Results
34.2.6 Select Data Manipulation and Concatenation
34.2.7 Limiting Results
34.3.0 SQL Syntax: Where
34.3.1 WHERE Clauses
34.3.2 Search Parameter WHERE Expressions
34.3.3 FHIRPath WHERE Expressions
34.4.0 SQL Syntax: Limitations
34.4.1 Syntax Limitations
34.5.0 SQL Syntax: Examples
34.5.1 Find Resources with Repeating Elements
35.0.0 Product Configuration
35.0.0 HTTP Server Setup
35.0.1 Respecting Forward Headers
35.0.2 Specifying a Custom Context Path
35.0.3 Access Logs
35.0.4 Frame Options
35.1.0 TLS and HTTPS Reference
35.1.1 Background
35.1.2 Creating a Self-Signed KeyStore
35.1.3 Importing a LetsEncrypt Certificate into a KeyStore
35.1.4 Selecting Ciphers and Protocol
35.1.5 Enabling TLS Mutual Authentication (Client Auth)
35.1.6 Programmatically Configuring a FHIR Endpoint KeyStore
35.1.7 Smile Util TLS JSON Authentication File
36.0.0 Java Execution Environment
36.0.0 Security Attributes
36.1.0 Library Support
36.2.0 Exception Handling
36.3.0 Javadocs
37.0.0 JavaScript Execution Environment
37.0.0 Introduction
37.0.1 Change Log
37.1.0 Specifying JavaScript in Configuration File
37.2.0 Remote Debugging
37.3.0 ECMA Modules (import)
37.4.0 Converter API
37.4.1 Method: hl7v2TsToFhirDate(dt);
37.4.2 Method: hl7v2TsToFhirDateTime(ts);
37.4.3 Method: hl7v2TsToFhirDateTime(ts, impliedTimeZone);
37.4.4 Method: urlDecode(string);
37.4.5 Method: urlEncode(string);
37.4.6 Method: base64Encode(string);
37.4.7 Method: base64Decode(string);
37.5.0 Environment API
37.5.1 Method: getProperty(name)
37.5.2 Method: getEnv(name)
37.6.0 Exceptions API
37.6.1 Method: Exceptions.newTrustedException(theMessage)
37.6.2 Method: Exceptions.newTrustedException(theStatusCode, theMessage)
37.7.0 OAuth2 Exceptions API
37.7.1 Method: OAuth2Exceptions.newUnauthorizedException(theMessage)
37.7.2 Method: OAuth2Exceptions.newForbiddenException(theMessage)
37.8.0 FHIR REST API
37.8.1 Method: create(resource)
37.8.2 Method: read(url)
37.8.3 Method: search().forResource(resourceType)
37.8.4 Method: transaction(IBundleBuilder theTransaction)
37.8.5 Method: translate()
37.8.6 Method: update(resource)
37.8.7 Method: patch(url, parameters)
37.8.8 Authentication
37.8.9 Tenant Selection
37.8.10 Concurrency Retry
37.8.11 Configuration Requirements for ONC (g)(10) Certification
37.9.0 FHIR Model API
37.9.1 Method: ResourceBuilder.build(resourceType)
37.9.2 Working with Resources
37.9.3 Working with Composition resources
37.9.4 Working with Bundle resources
37.9.5 Contained Resources
37.9.6 Meta Elements
37.9.7 Removing Data
37.10.0 HL7 v2.x Mapping API
37.10.1 Path Syntax: Repetitions
37.10.2 Path Syntax: Groups and Nesting
37.10.3 Structure Interrogation
37.10.4 Content Clearing
37.10.5 Content Interrogation
37.10.6 Parsing Raw Field Values
37.10.7 Encoding
37.10.8 The Hl7V2 Object
37.10.9 Working with Variable Datatypes
37.10.10 Working with Z-Segments
37.11.0 HTTP API
37.11.1 Request Creation Methods
37.11.2 Request Execution Methods
37.11.3 Response Processing Methods
37.11.4 TLS / HTTPS
37.12.0 LDAP API
37.12.1 Method: searchByUsername(username)
37.12.2 Method: getStringAttributes(attributeName)
37.12.3 Method: isMemberOfGroup(groupDn)
37.13.0 Log API
37.13.1 Methods: debug(string), info(string), warn(string), error(string)
37.14.0 Composition Resource API
37.14.1 Method: set*(value)
37.14.2 Method: setDate(epoch)
37.14.3 Method: setType(documentType)
37.14.4 Method: addSection(sectionType)
37.15.0 Composition Section API
37.15.1 Method: populate(List resources)
37.15.2 Method: setTitle(title)
37.15.3 Method: setCode(system, code, display)
37.15.4 Method: addSection()
37.16.0 TransactionBuilder API
37.16.1 Method: newTransactionBuilder()
37.16.2 Method: withBundle(bundle)
37.16.3 Method: create(resource)
37.16.4 Method: update(resource)
37.16.5 Method: patch(resourceId, parameters)
37.16.6 Method Chain: createConditional(resource).onToken(parameter, system, value)
37.16.7 Method Chain: updateConditional(resource).onToken(parameter, system, value)
37.16.8 Methods: toXml(), toXml(prettyPrint), toJson(), toJson(prettyPrint)
37.16.9 Fhir.transaction(transaction)
37.17.0 Util API
37.17.1 Method: sleep(millis)
37.18.0 UUID API
37.18.1 Method: newPlaceholderId()
37.19.0 XML API
37.19.1 Global function: XML.createDocument(str)
37.19.2 XPath Expressions
37.19.3 Traversing the Document
37.19.4 Function: toXMLString()
37.19.5 Manipulating the DOM
37.20.0 Callback Models
37.20.1 AssociatedResource
37.20.2 AuthenticationContext
37.20.3 AuthenticationFailure
37.20.4 AuthenticationRequest
37.20.5 ClientSessionJson
37.20.6 CsvProcessorContext
37.20.7 FhirContextEntry
37.20.8 FhirEndpointTerminologyResponseMappingSpec
37.20.9 FhirEndpointTerminologyResponseMappingSpecSystem
37.20.10 GatewayConfiguration
37.20.11 GatewayCreateRoute
37.20.12 GatewayDeleteRoute
37.20.13 GatewayOperation
37.20.14 GatewayOperationRoute
37.20.15 GatewayReadRoute
37.20.16 GatewayRouteTarget
37.20.17 GatewaySearchRoute
37.20.18 GatewayTarget
37.20.19 GatewayTargetRetryStrategy
37.20.20 GatewayUpdateRoute
37.20.21 GrantedAuthority
37.20.22 Hl7V2GeneratedMessageContext
37.20.23 Hl7V2ReceivedMessage
37.20.24 Hl7V2ReceivedMessageConversionResult
37.20.25 LaunchContext
37.20.26 LaunchContextParameter
37.20.27 LaunchResourceId
37.20.28 MegaScaleCredentialRequest
37.20.29 MegaScaleCredentialResponse
37.20.30 OAuth2AuthorizationRequestDetails
37.20.31 OAuth2Client
37.20.32 OAuth2ClientSecret
37.20.33 OAuth2Clients
37.20.34 OAuth2Server
37.20.35 OAuth2Servers
37.20.36 OAuth2SmartContextSelectionChoicePerson
37.20.37 OAuth2SmartContextSelectionChoices
37.20.38 Oauth2InvalidateTokensResponseJson
37.20.39 PackageInstallationSpec
37.20.40 PartitionDefinition
37.20.41 PartitionDefinitions
37.20.42 RequestDetailsJson
37.20.43 ScriptAuthenticationOutcomeFactory
37.20.44 ScriptConsentContextServices
37.20.45 SecurityInLdapAuthenticationContext
37.20.46 SecurityInSmartAuthenticationContext
37.20.47 SmartCodapAuthorizationRequest
37.20.48 SmartOnPostAuthorizeDetails
37.20.49 UserDetails
37.20.50 UserDetailsChangeLaunchContextJson
37.20.51 UserDetailsList
37.20.52 UserDetailsOAuth2AllClientApprovals
37.20.53 UserDetailsOAuth2ClientApprovals
37.20.54 UserDetailsOAuth2ClientApprovalsApprovedScope
37.20.55 UserSessionDetails
38.0.0 Database Administration
38.0.0 Database Design
38.0.1 Cluster Manager Database
38.0.2 FHIR Relational Storage
38.0.3 FHIR MongoDB (Non-Relational) Storage
38.1.0 Database Connection Pool
38.2.0 Setting Up PostgreSQL
38.2.1 Supported Versions
38.2.2 Creating a Database for Smile CDR
38.2.3 Database Connection Properties
38.2.4 Inline Resource Storage
38.2.5 Setting up a Cluster Manager Database
38.2.6 Setting up a FHIR Storage (Relational) Database
38.3.0 Troubleshooting PostgreSQL
38.3.1 Host Name Verification Error
38.3.2 Network Timeouts
38.3.3 Managing FHIR Resource Body Storage
38.4.0 Setting Up MySQL
38.4.1 Supported Versions
38.4.2 Creating a Database for Smile CDR
38.4.3 Database Connection Properties
38.4.4 Setting up a Cluster Manager Database
38.4.5 Setting up a FHIR Storage (Relational) Database
38.5.0 Setting Up MariaDB
38.5.1 Supported Versions
38.5.2 Creating a Database for Smile CDR
38.5.3 Database Connection Properties
38.5.4 Setting up a Cluster Manager Database
38.5.5 Setting up a FHIR Storage (Relational) Database
38.6.0 Setting Up Oracle
38.6.1 Supported Versions
38.6.2 Setting up a Cluster Manager Database
38.6.3 Setting up a FHIR Storage (Relational) Database
38.7.0 Setting Up SQL Server (MSSQL)
38.7.1 Supported Versions
38.7.2 Creating a Database for Smile CDR
38.7.3 Preparing an SQL Server Database for Smile CDR
38.7.4 Database Connection Properties
38.7.5 Setting up a Cluster Manager Database
38.7.6 Setting up a FHIR Storage (Relational) Database
38.8.0 AWS IAM Authentication
39.0.0 Localization
39.0.0 Localization
39.1.0 Examples
39.1.1 Example: Unknown Search Parameter Message
39.1.2 Example: Custom SMART Scope Names
39.2.0 Available Localization Keys
40.0.0 Smile CDR CLI (smileutil)
40.0.0 Introduction
40.0.1 Enabling Debug Logging
40.0.2 Memory Settings
40.1.0 Bulk Import
40.1.1 Usage
40.1.2 Options
40.2.0 Create FHIR Package
40.2.1 Usage
40.2.2 Options
40.3.0 Execute Script Function
40.3.1 Usage
40.3.2 Options
40.3.3 A Complete Example: Authenticate
40.3.4 Available Functions
40.3.5 Function: authenticate
40.4.0 Export ConceptMap to CSV
40.4.1 Usage
40.4.2 Options
40.5.0 HL7 v2.x Analyze Flat File
40.5.1 Usage
40.5.2 Options
40.6.0 HL7 v2.x Transmit Flat File
40.6.1 Usage
40.6.2 Options
40.6.3 Multiplex Paths
40.7.0 Import CSV to ConceptMap
40.7.1 Usage
40.7.2 Options
40.8.0 Map and Upload CSV Bulk Import File
40.8.1 Usage
40.8.2 Options
40.9.0 Migrate Database
40.9.1 Options
40.9.2 Examples
40.10.0 Clear Database Migration Lock
40.10.1 Example
40.10.2 Options
40.11.0 Module Config Properties Export
40.11.1 Options
40.12.0 Reindex Terminology
40.12.1 Usage
40.12.2 Options
40.13.0 Synchronize FHIR Servers
40.13.1 Usage
40.13.2 Options
40.13.3 Selecting Resource Types to Synchronize
40.13.4 Using a Search as the Source
40.13.5 Using a Directory as the Source
40.13.6 Uploading Bundles as Transactions
40.13.7 Using Inline Match URLs
40.13.8 Prefixing Numeric IDs
40.13.9 Synchronization Modes
40.13.10 Uploading Synthea (Synthetic Generated) Resources
40.13.11 Setting up a Resource Gold Master
40.13.12 Load Balancing Target Servers
40.14.0 Upgrade H2 Database File
40.14.1 Usage
40.14.2 Options
40.14.3 Example
40.15.0 Upload Bundle Files
40.15.1 This Command Is Deprecated
40.15.2 Usage
40.15.3 Options
40.16.0 Upload CSV Bulk Import File
40.16.1 Usage
40.16.2 Options
40.16.3 Sending Batches for a Single File
40.17.0 Upload Sample Dataset
40.17.1 Usage
40.17.2 Options
40.18.0 Upload Terminology
40.18.1 Usage
40.18.2 Options
40.18.3 Example: Add Delta to Custom Terminology
40.19.0 Generate Realtime Export Schema
40.19.1 Usage
40.19.2 Options
40.20.0 Validate FHIR Resources
40.20.1 Usage
40.20.2 Options
40.20.3 Profile Mode
40.20.4 Schema and Schematron Mode
41.0.0 Apache Camel Integration
41.0.0 Camel Module Overview
41.0.1 Apache Camel Introduction
41.0.2 Apache Camel Data Formats
41.0.3 Smile Data Formats
41.0.4 Apache Camel Components
41.0.5 Smile Component
41.0.6 The Spring Context Config Class
41.0.7 Packaging Your Camel Module Custom Classes
41.0.8 Deploying Your Camel Module Custom Classes
41.0.9 Example Project
41.1.0 Smile Camel Processors
41.1.1 Smile Hl7v2 Camel Processors
41.2.0 Smile Camel Converters
42.0.0 Modules
42.0.0 JSON Admin API
42.0.1 Configuration Categories
42.1.0 Web Admin Console
42.1.1 Updated Web Admin Console UI
42.1.2 Configuration Categories
42.2.0 CDA Exchange
42.2.1 Configuration Categories
42.3.0 Channel Import
42.3.1 Configuration Categories
42.4.0 Cluster Manager
42.4.1 Configuration Categories
42.5.0 CQL
42.6.0 Audit Log Persistence
42.6.1 Configuration Categories
42.7.0 Transaction Log Persistence
42.7.1 Configuration Categories
42.8.0 Digital Quality Measures (DQM)
42.8.1 Async Evaluation
42.8.2 Setting Chunk Size
42.8.3 Multi-Threaded Evaluation
42.8.4 Configuration Categories
42.9.0 Documentation Templates and Rules (DTR)
42.10.0 Enterprise Master Patient Index
42.10.1 Configuration Categories
42.11.0 CDS Hooks Endpoint
42.11.1 Configuration Categories
42.12.0 FHIR Gateway Endpoint
42.12.1 Configuration Categories
42.13.0 FHIR REST Endpoint (All Versions)
42.13.1 Configuration Categories
42.14.0 FHIR REST Endpoint (DSTU2 - Deprecated)
42.14.1 Configuration Categories
42.15.0 FHIR REST Endpoint (DSTU3 - Deprecated)
42.15.1 Configuration Categories
42.16.0 FHIR REST Endpoint (R4 - Deprecated)
42.16.1 Configuration Categories
42.17.0 FHIRWeb Console
42.17.1 Configuration Categories
42.18.0 HL7 v2.x Listening Endpoint
42.18.1 Configuration Categories
42.19.0 HL7 v2.x Sending Endpoint
42.19.1 Configuration Categories
42.20.0 Hybrid Providers Endpoint
42.20.1 Configuration Categories
42.21.0 Package Registry Endpoint
42.21.1 Configuration Categories
42.22.0 Subscription Websocket Endpoint
42.22.1 Configuration Categories
42.23.0 ETL Importer
42.23.1 Configuration Categories
42.24.0 MDM
42.24.1 Configuration Categories
42.25.0 MDM UI
42.25.1 Configuration Categories
42.26.0 Prior Auth CRD
42.26.1 Configuration Categories
42.27.0 Narrative Generator
42.27.1 Configuration Categories
42.28.0 FHIR Storage (DSTU2 RDBMS)
42.28.1 Configuration Categories
42.29.0 FHIR Storage (R3 RDBMS)
42.29.1 Configuration Categories
42.30.0 FHIR Storage (R4 RDBMS)
42.30.1 Configuration Categories
42.31.0 FHIR Storage (R5 RDBMS)
42.31.1 Configuration Categories
42.32.0 FHIR Storage (Mongo)
42.32.1 Configuration Categories
42.33.0 Realtime Export
42.33.1 Configuration Categories
42.34.0 LDAP Inbound Security
42.34.1 Configuration Categories
42.35.0 Local Inbound Security
42.35.1 Configuration Categories
42.36.0 SAML Inbound Security
42.36.1 Configuration Categories
42.37.0 Scripted Inbound Security
42.37.1 Configuration Categories
42.38.0 SMART Inbound Security
42.38.1 Configuration Categories
42.39.0 SMART Outbound Security
42.39.1 Configuration Categories
42.40.0 SMART App Host
42.40.1 Configuration Categories
42.41.0 Subscription Matcher (All FHIR Versions)
42.41.1 Configuration Categories
42.42.0 Subscription Matcher (DSTU2 - Deprecated)
42.42.1 Configuration Categories
42.43.0 Subscription Matcher (DSTU3 - Deprecated)
42.43.1 Configuration Categories
42.44.0 Subscription Matcher (R4 - Deprecated)
42.44.1 Configuration Categories
42.45.0 appSphere
42.45.1 Configuration Categories
42.46.0 Payer to Payer
42.46.1 Configuration Categories
42.47.0 Amazon HealthLake Outbound REST Connector
42.47.1 Configuration Categories
42.48.0 License
42.48.1 Configuration Categories
42.49.0 Camel
42.49.1 Configuration Categories
43.0.0 Configuration Categories
43.0.0 Web Admin Console Settings
43.0.1 Property: Prometheus Datasource ID
43.0.2 Property: Transaction Log - Event Body Display Mode
43.1.0 appSphere
43.1.1 Property: JSON URL
43.1.2 Property: Auth URL
43.1.3 Property: Client ID
43.1.4 Property: Legal Company Name
43.1.5 Property: Admin Console Name
43.1.6 Property: Contact Helpdesk
43.1.7 Property: Contact Us URL
43.1.8 Property: FHIR Sandbox URL
43.1.9 Property: FHIR URL
43.1.10 Property: Application Gallery Name
43.1.11 Property: Hero Image, Large Format URL
43.1.12 Property: Hero Image, Small Format URL
43.1.13 Property: Company Logo Small URL
43.1.14 Property: Company Logo Large URL
43.1.15 Property: PHI Warning URL
43.1.16 Property: Developer Portal Name
43.1.17 Property: Privacy Policy URL
43.1.18 Property: Request app mail-to
43.1.19 Property: Terms of Use URL
43.2.0 Payer Config
43.2.1 Property: Payer Auto-Grant Scopes
43.2.2 Property: Enable Payer Functionality
43.3.0 Initial appSphere Seeding
43.3.1 Property: Default Attestation (Legal)
43.3.2 Property: Default Attestation (Plain)
43.3.3 Property: Default Attestation Title
43.4.0 Authentication Callback Scripts
43.4.1 Property: Authentication Callback Script (File)
43.4.2 Property: Authentication Callback Script (Text)
43.5.0 Auth: General for APIs
43.5.1 Property: Anonymous Account Username
43.5.2 Property: Allow Anonymous Access
43.6.0 User Authentication
43.6.1 Property: Anonymous Account Username
43.6.2 Property: Allow Anonymous Access
43.6.3 Property: SAML Authentication Enabled
43.7.0 Auth: HTTP Basic
43.7.1 Property: HTTP Basic Security
43.7.2 Property: HTTP Basic Realm
43.8.0 Auth: OpenID Connect
43.8.1 Property: OpenID Connect Security
43.9.0 Browser Syntax Highlighting
43.9.1 Property: Browser Syntax Highlighting Enabled
43.9.2 Property: Show Request Headers
43.9.3 Property: Show Response Headers
43.10.0 Camel
43.10.1 Property: Spring Context Config Class(es)
43.10.2 Property: Camel Functions (File)
43.10.3 Property: Camel Functions (Text)
43.10.4 Property: Camel Routes (File)
43.10.5 Property: Camel Routes (Text)
43.11.0 Capability Statement (metadata)
43.11.1 Property: Cache Resource Counts (Mins)
43.11.2 Property: Include Resource Counts
43.12.0 Care Gaps
43.12.1 Property: Reporter
43.12.2 Property: Section Author
43.13.0 CDA Generation
43.13.1 Property: Base URL for Local Resources
43.14.0 CDA Import
43.14.1 Property: Assembly Device ID
43.14.2 Property: Target Implementation Guide
43.15.0 CDA Interceptors
43.15.1 Property: Interceptor Bean Types
43.16.0 CDA JavaScript Execution Scripts
43.16.1 Property: CDA Processing Script (File)
43.16.2 Property: CDA Processing Script (Text)
43.17.0 CDA Terminology
43.17.1 Property: Prefer user-supplied terminology translations
43.18.0 CDS Hooks Definitions
43.18.1 Property: FHIR Version
43.18.2 Property: Spring Context Config Class
43.19.0 Channel Import
43.19.1 Property: Concurrent Consumers
43.19.2 Property: Concurrent Retry Consumers
43.19.3 Property: Channel Name
43.19.4 Property: Default mediaType
43.19.5 Property: Channel Import ETL Script (File)
43.19.6 Property: Channel Import ETL Script (Text)
43.19.7 Property: Interceptor Bean Types
43.20.0 Channel Retry
43.20.1 Property: Failure Channel Name
43.20.2 Property: Retry Delay(ms)
43.20.3 Property: Maximum amount of retry attempts.
43.20.4 Property: Maximum Delay(ms) between attempts.
43.20.5 Property: Retry Channel Name
43.20.6 Property: Retriable Exceptions
43.20.7 Property: Retry Strategy
43.21.0 Kafka
43.21.1 Property: Kafka Consumer Ack Mode
43.21.2 Property: Kafka Consumer Auto Commit Enabled
43.21.3 Property: Kafka Bootstrap Address
43.21.4 Property: Kafka Consumer Config Properties (File)
43.21.5 Property: Kafka Consumer Config Properties (Text)
43.21.6 Property: Kafka Subscription Matcher Consumer Group Id
43.21.7 Property: Kafka Producer Config Properties (File)
43.21.8 Property: Kafka Producer Config Properties (Text)
43.21.9 Property: Kafka Replace Hyphens With Periods
43.21.10 Property: Kafka SASL JAAS Config
43.21.11 Property: Kafka SASL Mechanism
43.21.12 Property: Kafka Security Protocol
43.21.13 Property: Kafka Broker SSL Enabled
43.21.14 Property: Kafka SSL Key Password
43.21.15 Property: Kafka SSL Keystore Location
43.21.16 Property: Kafka Keystore Password
43.21.17 Property: Kafka SSL TrustStore File Location
43.21.18 Property: Kafka SSL Truststore Password
43.21.19 Property: Validate Kafka Topics Exist Before Use
43.22.0 Cluster Manager Maintenance
43.22.1 Property: Audit Log Broker Channel Name
43.22.2 Property: Audit Log Broker Enabled
43.22.3 Property: Always Write to Cluster Manager Log
43.22.4 Property: Audit Log Database Async Writes
43.22.5 Property: Audit Log Database Enabled
43.22.6 Property: Request headers to store
43.22.7 Property: Reload Scripts on Module Config Save
43.22.8 Property: Stats Retention (Days) - Day Level
43.22.9 Property: Stats Retention (Days) - Hour Level
43.22.10 Property: Stats Retention (Days) - Minute Level
43.22.11 Property: Transaction Log Retention (Days)
43.22.12 Property: Scheduler Thread Count
43.22.13 Property: Persist Runtime Monitoring Statistics Enabled
43.22.14 Property: Heartbeat Persist Frequency MS
43.22.15 Property: Stats Cleanup Frequency MS
43.22.16 Property: Stats Persist Frequency MS
43.23.0 Message Broker
43.23.1 Property: Message Broker Address
43.23.2 Property: (Deprecated)Channel Naming Prefix
43.23.3 Property: Message Broker Password
43.23.4 Property: Message Broker Type
43.23.5 Property: Message Broker Username
43.24.0 Cluster Level Security
43.24.1 Property: OpenId Connect Keystores Pre-Seed File
43.25.0 CQL
43.25.1 Property: Data Analysis
43.25.2 Property: Collapse Data Analysis
43.25.3 Property: CQL Language Level
43.25.4 Property: Default Model Info
43.25.5 Property: Disable List Demotion
43.25.6 Property: Disable List Promotion
43.25.7 Property: Disable List Traversal
43.25.8 Property: Disable Method Invocation
43.25.9 Property: Annotations
43.25.10 Property: Date Range Optimization
43.25.11 Property: Detailed Errors
43.25.12 Property: Enable Interval Demotion
43.25.13 Property: Enable Interval Promotion
43.25.14 Property: Locators
43.25.15 Property: Results Type
43.25.16 Property: Error Level
43.25.17 Property: Require From Keyword
43.25.18 Property: Signature Level
43.25.19 Property: Format for ELM
43.25.20 Property: Validate units
43.25.21 Property: Semantic Analysis
43.25.22 Property: Debug Logging
43.25.23 Property: Enable Expression Caching
43.25.24 Property: Enable Validation
43.25.25 Property: Use Embedded Libraries
43.26.0 Credentials
43.26.1 Property: Authentication Cache Duration (millis)
43.26.2 Property: Cache Successful Credentials
43.26.3 Property: Create Unknown Users
43.26.4 Property: Lock After Failed Attempts
43.26.5 Property: Case-Sensitive Passwords
43.26.6 Property: Password Encoding Scheme
43.26.7 Property: Password Mismatch Error
43.26.8 Property: Minimum Password Requirements
43.26.9 Property: Case-Sensitive Usernames
43.27.0 Cross-Origin Resource Sharing (CORS)
43.27.1 Property: CORS Allowed Request Headers
43.27.2 Property: CORS Enabled
43.27.3 Property: CORS Origins
43.28.0 Database
43.28.1 Property: Use IAM Authentication
43.28.2 Property: Default Query Timeout (Seconds)
43.28.3 Property: Log Abandoned
43.28.4 Property: Max Idle Connections
43.28.5 Property: Connection Max Lifetime (millis)
43.28.6 Property: Max Total Connections
43.28.7 Property: Max Wait (Seconds)
43.28.8 Property: Min Idle Connections
43.28.9 Property: Pool Prepared Statements
43.28.10 Property: Remove Abandoned on Borrow
43.28.11 Property: Remove Abandoned Timeout Seconds
43.28.12 Property: Test Connections on Return
43.28.13 Property: Database Type
43.28.14 Property: Expect database to be writable
43.28.15 Property: Database Password
43.28.16 Property: Database Update Mode
43.28.17 Property: DB Secrets Manager
43.28.18 Property: SQL Parameter Bind Mode
43.28.19 Property: Database Connection URL
43.28.20 Property: Database Username
43.28.21 Property: Default Page Size
43.28.22 Property: FHIR Version
43.28.23 Property: Maximum Page Size
43.28.24 Property: Use ordinal date values for day precision searches.
43.29.0 Da Vinci Health Record Exchange
43.29.1 Property: Native Consent Handling.
43.30.0 DQM
43.30.1 Property: Chunk Size
43.30.2 Property: Threaded Batch Size
43.30.3 Property: Number of Threads
43.30.4 Property: Enabled Threading
43.31.0 DTR
43.31.1 Property: Enable $questionnaire-package
43.32.0 Email Configuration
43.32.1 Property: Email From Address
43.32.2 Property: Notification Emails
43.32.3 Property: Email SMTP Hostname
43.32.4 Property: Email SMTP Password
43.32.5 Property: Email SMTP Port
43.32.6 Property: Use STARTTLS for connection security
43.32.7 Property: Email SMTP Username
43.33.0 Encounter Start CDS hook configuration
43.33.1 Property: Main ValueSet URL
43.33.2 Property: Prior Authorization not required ValueSet URL
43.33.3 Property: Prior Authorization required ValueSet URL
43.34.0 MDM UI
43.34.1 Property: JSON Admin URL
43.34.2 Property: OIDC Client ID
43.34.3 Property: OIDC Issuer URL
43.34.4 Property: OIDC Logout URL
43.34.5 Property: OIDC Redirect URI
43.34.6 Property: OIDC scopes
43.34.7 Property: Organization Identifier
43.35.0 ETL Import: CSV Properties
43.35.1 Property: CSV File Delimiter
43.35.2 Property: Parse Quotes
43.36.0 ETL Import: Source
43.36.1 Property: Async Mode Batch Size
43.36.2 Property: Asynchronous Mode Enabled
43.36.3 Property: Async Mode File Size
43.36.4 Property: Import Source
43.36.5 Property: Mapping Script (Text)
43.36.6 Property: Mapping Script (File)
43.36.7 Property: Worker Row Hashing Function (Text)
43.36.8 Property: Worker Row Hashing Function (File)
43.36.9 Property: Worker Thread Count
43.36.10 Property: Synchronous Mode: Continue On Failure
43.36.11 Property: Enable Transaction Log
43.37.0 FHIR Binary Storage
43.37.1 Property: Binary Access Operations Enabled
43.37.2 Property: Automatically inflate binaries.
43.37.3 Property: Binary inflation maximum size (bytes)
43.37.4 Property: Blob service S3 access key
43.37.5 Property: Blob service Azure account name
43.37.6 Property: Blob service Azure client / application ID
43.37.7 Property: Blob service Azure access key / client secret (app password) / Account-level SAS token
43.37.8 Property: Blob service Azure tenant ID
43.37.9 Property: Blob service bucket / container name.
43.37.10 Property: Endpoint URL for S3-compatible service
43.37.11 Property: Blob Service Region
43.37.12 Property: Blob service secret key
43.37.13 Property: Filesystem Mode: Base Directory
43.37.14 Property: Binary Storage Mode
43.37.15 Property: Maximum Size (bytes)
43.37.16 Property: Minimum Size (bytes)
43.38.0 FHIR Bulk Operations
43.38.1 Property: Enable Bulk Export batch job reuse
43.38.2 Property: FHIR Bulk Export Enabled
43.38.3 Property: Maximum Bulk Export file capacity
43.38.4 Property: Bulk Export file retention (hours)
43.38.5 Property: Normalize Terminology on Bulk Export
43.38.6 Property: Restrict Download to Initiating User
43.38.7 Property: FHIR Bulk Import Enabled
43.39.0 Capability Statement
43.39.1 Property: Copyright Message
43.39.2 Property: Implementation Description
43.39.3 Property: Include Partition Name
43.39.4 Property: Enable OpenAPI / Swagger Support
43.39.5 Property: Swagger-UI Custom CSS (Text)
43.39.6 Property: Swagger-UI Logo URL
43.39.7 Property: Swagger-UI Uses Resource Pages
43.39.8 Property: Software Name
43.39.9 Property: Software Version
43.40.0 FHIR Configuration
43.40.1 Property: Cascading Deletes Enabled
43.40.2 Property: Allow External References Enabled
43.40.3 Property: Allow Inline Match URL References Enabled
43.40.4 Property: Allow Multiple Delete Enabled
43.40.5 Property: Allow storing all bundle types
43.40.6 Property: Auto-Create Placeholder Reference Targets
43.40.7 Property: Client ID Mode
43.40.8 Property: Delete Child Resource Count
43.40.9 Property: Delete Expunge Enabled
43.40.10 Property: Enforce Reference Target Types
43.40.11 Property: Disable Deletion Ref Checks for Paths
43.40.12 Property: Enforce Referential Integrity on Delete
43.40.13 Property: Enforce Referential Integrity on Write
43.40.14 Property: Expunge Operation Enabled
43.40.15 Property: History Rewrite
43.40.16 Property: Batch Job Fasttracking Enabled
43.40.17 Property: Mark Resources for Reindexing after SearchParameter change
43.40.18 Property: Preserve request ID in resource body.
43.40.19 Property: Preserve Resource History
43.40.20 Property: Reindex Enabled
43.40.21 Property: Server ID Mode
43.40.22 Property: Store Meta.source information
43.40.23 Property: Tag Storage Mode
43.40.24 Property: Read Only Mode Enabled
43.40.25 Property: Seed Base Validation Resources
43.41.0 Consent Service
43.41.1 Property: Consent Service Enabled
43.41.2 Property: Java Consent Service Types
43.41.3 Property: Consent Service Script (File)
43.41.4 Property: Consent Service Script (Text)
43.42.0 FHIR Endpoint Conversion
43.42.1 Property: Versioned API Mode
43.43.0 FHIR Endpoint HFQL Support
43.43.1 Property: HFQL/SQL Endpoint Enabled
43.44.0 Interceptors
43.44.1 Property: Can Replace Authorization Interceptor
43.44.2 Property: Interceptor Bean Types
43.45.0 FHIR Endpoint Partitioning
43.45.1 Property: Tenant Identification Strategy
43.45.2 Property: Tenant Name
43.46.0 Resource Providers
43.46.1 Property: Allowed Interactions
43.46.2 Property: Resource Provider Bean Types
43.47.0 FHIR Endpoint Security
43.47.1 Property: Allow Searches With Compartment Access
43.47.2 Property: Automatically Narrow Search Scope
43.47.3 Property: Reject Insufficient Permissions with HTTP 401
43.47.4 Property: Watermark Responses Enabled
43.47.5 Property: Scopes Supported
43.48.0 Endpoint Terminology
43.48.1 Property: Populate Response Coding Displays
43.48.2 Property: Response Mapping
43.48.3 Property: Mapping Spec (Text)
43.49.0 FHIR Gateway Configuration
43.49.1 Property: FHIR Version
43.49.2 Property: Gateway Configuration (File)
43.49.3 Property: Show Underlying Errors
43.49.4 Property: Gateway Configuration (Text)
43.49.5 Property: Encryption JWKS (File)
43.49.6 Property: Encryption JWKS (Text)
43.49.7 Property: The default page size
43.49.8 Property: The maximum page size
43.49.9 Property: Cache Expiration Seconds
43.49.10 Property: Pagination cache provider
43.50.0 FHIR Interceptors
43.50.1 Property: FHIR storage Callback Script (File)
43.50.2 Property: FHIR storage Callback Script (Text)
43.50.3 Property: Interceptor Bean Types
43.51.0 LiveBundle Service
43.51.1 Property: LiveBundle Enabled
43.51.2 Property: LiveBundle Rule Definition Script (File)
43.51.3 Property: LiveBundle Rule Definition Script (Text)
43.51.4 Property: LiveBundle Thread Count
43.51.5 Property: LiveBundle Watchlist Cache Enabled
43.52.0 FHIR MDM Server
43.52.1 Property: MDM Mode Enabled (Experimental)
43.52.2 Property: Search Expanding Interceptor Enabled (Experimental)
43.53.0 FHIR Performance
43.53.1 Property: Default Total Calculation Mode
43.53.2 Property: Delete Enabled
43.53.3 Property: Expire Search Results After Minutes
43.53.4 Property: Expunge Batch Size
43.53.5 Property: Expunge Thread Count
43.53.6 Property: Inline Resource Storage Below Size (chars)
43.53.7 Property: Internal Synchronous Search Size
43.53.8 Property: Mass Ingestion Mode
43.53.9 Property: Match URL Cache Enabled
43.53.10 Property: Maximum Transaction Bundle Size
43.53.11 Property: Only Allow IN-MEMORY Subscriptions
43.53.12 Property: Reindex Thread Count
43.53.13 Property: Reuse Cached Results Timeout (Millis)
43.53.14 Property: Index Missing Search Params
43.53.15 Property: Keep history for MDM links and other non-FHIR-resource DB history.
43.53.16 Property: Suppress Scheduled Maintenance Jobs
43.53.17 Property: Write-Semaphore Mode: Enabled
43.53.18 Property: Write-Semaphore Mode: Log Waits
43.54.0 FHIR Performance Tracing
43.54.1 Property: Capture Raw SQL or Equivalent
43.54.2 Property: Trigger
43.54.3 Property: Performance Tracing Enabled
43.54.4 Property: Output to Response Headers
43.54.5 Property: Output to System Log
43.54.6 Property: Output to Transaction Log
43.55.0 FHIR Realtime Export
43.55.1 Property: Pointcut-based Realtime Export Mode Enabled
43.56.0 Repository Validation
43.56.1 Property: Repository Validation Javascript (File)
43.56.2 Property: Repository Validation Javascript (Text)
43.57.0 FHIR Resource Types
43.57.1 Property: Instance/Type History Enabled
43.57.2 Property: Server History Enabled
43.57.3 Property: Resource Types (whitelist)
43.58.0 FHIR REST Endpoint
43.58.1 Property: Fixed Value for Endpoint Base URL
43.58.2 Property: Default Encoding
43.58.3 Property: Default Prefer Return
43.58.4 Property: Pretty-Print by Default
43.58.5 Property: Process Header: Request Source
43.58.6 Property: Serve Raw Media Resources
43.59.0 FHIR Search
43.59.1 Property: Always use Offset Searches
43.59.2 Property: Allow :contains Searches
43.59.3 Property: Maximum number of codes to expand
43.59.4 Property: Fetch Size (Default Maximum)
43.59.5 Property: Index Contained Resources
43.59.6 Property: Index Contained Resources Recursively
43.59.7 Property: Index Uplifted Refchains
43.59.8 Property: Legacy Date Index Mode
43.59.9 Property: Max Includes per Page
43.59.10 Property: Use ordinal date values for day precision searches.
43.59.11 Property: Filter Search Parameter Enabled
43.59.12 Property: GraphQL Enabled
43.59.13 Property: Index Identifier.type (:of-type modifier) Enabled
43.59.14 Property: Language Search Parameter Enabled
43.59.15 Property: Custom names file
43.59.16 Property: Normalized Unit Searching
43.59.17 Property: Page Size (Default)
43.59.18 Property: Page Size (Maximum)
43.59.19 Property: Nickname enabled
43.59.20 Property: Phonetic Encoder
43.59.21 Property: Infinispan Cache Name
43.59.22 Property: Infinispan Hot Rod Protocol Version
43.59.23 Property: Infinispan Servers
43.59.24 Property: Search Cache Storage
43.59.25 Property: Stale Search Cleanup Interval (seconds)
43.59.26 Property: Suppress String Indexing In Tokens
43.60.0 Custom Resource Types
43.60.1 Property: Custom Resource Classes
43.61.0 IG Support
43.61.1 Property: International Patient Summary (IPS) Enabled
43.61.2 Property: IPS Generation Strategy Class Name
43.62.0 MegaScale
43.62.1 Property: MegaScale Enabled
43.63.0 FHIR Storage Module Conditional Updates
43.63.1 Property: Prevent Conditional Update from Invalidating Match Criteria
43.64.0 FHIR Storage Module Scheduled Tasks
43.64.1 Property: Batch job retention days.
43.64.2 Property: Scheduler Thread Count
43.64.3 Property: Resource Submission Interval (Millis)
43.64.4 Property: Batch Job Executor: Maximum Thread Count
43.64.5 Property: Bulk Export Task Enabled
43.64.6 Property: Bulk Import Task Enabled
43.64.7 Property: Delete Stale Searches Task Enabled
43.64.8 Property: Pre-Expand ValueSets Task Enabled
43.64.9 Property: Resource Reindexing Task Enabled
43.65.0 FHIR Validation Services
43.65.1 Property: Concurrent Bundle Validation Thread Count
43.65.2 Property: Concurrent Bundle Validation
43.65.3 Property: Remote Terminology Service: Base URL
43.65.4 Property: Terminology Basic Auth Password
43.65.5 Property: Terminology Basic Auth Username
43.65.6 Property: Remote Terminology Service: Enabled
43.65.7 Property: Remote Terminology Service: Log HTTP Calls
43.65.8 Property: Accept All Codings Only
43.65.9 Property: Code Display Mismatch Policy
43.65.10 Property: Local Reference Policy
43.65.11 Property: Skip Contained Resource Validation
43.65.12 Property: Suppress Validation Message Patterns
43.65.13 Property: Unknown CodeSystem Validation Policy
43.66.0 FHIR Storage Package Registry
43.66.1 Property: Load Pre-Seed Installation Spec Files Asynchronously
43.66.2 Property: Package Pre-Seed Installation Spec Files
43.67.0 FHIR Storage Partitioning
43.67.1 Property: Cross-Partition Reference Mode
43.67.2 Property: Default Partition ID
43.67.3 Property: Partitioning Enabled
43.67.4 Property: Partition Naming Mode
43.67.5 Property: Partition Selection Mode
43.67.6 Property: Partition Seed File
43.67.7 Property: Partitioning Security Enabled
43.68.0 Versioned References
43.68.1 Property: Allow Versioned References at All Paths
43.68.2 Property: Allow Versioned References at Paths
43.68.3 Property: Automatically Version References at Paths
43.68.4 Property: Respect Versioned References for _include
43.69.0 FHIR Subscription Delivery
43.69.1 Property: Subscription Delivery Queue Naming
43.69.2 Property: Email From Address
43.70.0 FHIR Subscription Persistence
43.70.1 Property: Consumers Per Delivery Queue
43.70.2 Property: Matching Queue Consumers
43.70.3 Property: Cross-Partition Subscription Enabled
43.70.4 Property: Email Subscription Enabled
43.70.5 Property: Message Subscription Enabled
43.70.6 Property: Qualify subscription matching channel name
43.70.7 Property: REST Hook Subscription Enabled
43.70.8 Property: Trigger Subscriptions on Non-Versioning Changes
43.70.9 Property: Websocket Subscription Enabled
43.71.0 Amazon HealthLake REST Endpoint
43.71.1 Property: HealthLake Endpoint URL
43.71.2 Property: HealthLake Region Name
43.71.3 Property: HealthLake role ARN
43.71.4 Property: Auto-Manage Subscription Resource
43.71.5 Property: Auto-Managed Subscription Criteria
43.71.6 Property: Maximum amount of retry attempts for subscription
43.72.0 HL7 v2.x Mapper - Contained Resource
43.72.1 Property: Use standalone Related Person
43.72.2 Property: Use standalone Associated Party
43.72.3 Property: Use standalone Patient Account
43.73.0 HL7 v2.x Mapper - DG1
43.73.1 Property: Use DG1.1 as Condition.identifier.value` suffix.
43.74.0 HL7 v2.x Mapper - Forced Namespace Mode
43.74.1 Property: Forced Namespace Mode: Encounter System
43.74.2 Property: Forced Namespace Mode: Patient System
43.75.0 HL7 v2.x Mapper - General
43.75.1 Property: Create MessageHeader for Each Message
43.75.2 Property: Creation Mode - Practitioner
43.75.3 Property: Escape Markdown Punctuation: NTE-3
43.75.4 Property: Patient Primary Identifier Search Parameter
43.75.5 Property: Inferred TimeZone When Not Present
43.75.6 Property: Map Identifiers using NamingSystem
43.75.7 Property: Mapper Bean Types
43.75.8 Property: MessageHeader Hardcoded Destination Name
43.75.9 Property: Process AL1 Segments
43.75.10 Property: Store Original HL7v2 message
43.76.0 HL7 v2.x Mapper - Medications
43.76.1 Property: Use Standalone Medications with Administered Code
43.76.2 Property: Use Standalone Medications with Component Code
43.76.3 Property: Use Standalone Medications with Give Code
43.77.0 HL7 v2.x Mapper - OBR
43.77.1 Property: Observation Identification Mode
43.77.2 Property: Use OBR-2 as Primary Identifier
43.77.3 Property: Use OBR-3 as Primary Identifier
43.78.0 HL7 v2.x to FHIR Mapper - OBSERVATION Group
43.78.1 Property: OBSERVATION Group Text Delimiter - NTE
43.78.2 Property: OBSERVATION Group Text Delimiter - OBX
43.79.0 HL7 v2.x to FHIR Mapper - ORDER_OBSERVATION Group
43.79.1 Property: ORDER_OBSERVATION Group Text Delimiter - NTE
43.80.0 HL7 v2.x Mapper - PID
43.80.1 Property: Patient Primary Identifier Type
43.81.0 HL7 v2.x Mapper - PV1
43.81.1 Property: Coding System for PV1-4 Admission Type
43.81.2 Property: Parse Encounter Providers
43.81.3 Property: Treat PV1-3 and PV1-6 Patient Locations as Single Atomic Locations
43.82.0 Listener Interceptors
43.82.1 Property: Interceptor Bean Types
43.83.0 HL7 v2.x Listener Script
43.83.1 Property: Listener Processing Script (File)
43.83.2 Property: Listener Processing Script (Text)
43.84.0 HL7 v2.x MLLP Listener
43.84.1 Property: Charset: Forced
43.84.2 Property: Charset: Respect MSH-18
43.84.3 Property: Intermediate Logging Enabled
43.84.4 Property: Non-standard segment behaviour
43.84.5 Property: HL7 v2.x Listener Port
43.84.6 Property: Socket Timeout (Millis)
43.84.7 Property: Storage Tenant Name
43.84.8 Property: Transport Protocol
43.84.9 Property: Unprocessable Message Handling
43.85.0 HL7 v2.x MLLP Sender
43.85.1 Property: Delay Between Failed Deliveries (millis)
43.85.2 Property: Forward Persisted Messages
43.85.3 Property: HL7 v2.x Destination Host
43.85.4 Property: Request Path
43.85.5 Property: HL7 v2.x Destination Port
43.85.6 Property: Retry message on NAK
43.85.7 Property: Send Timeout (millis)
43.85.8 Property: Transport Protocol
43.86.0 FHIR to HL7 v2.x Mapper Script
43.86.1 Property: HL7 v2.x Conversion Mapper Script (File)
43.86.2 Property: HL7 v2.x Conversion Mapper Script (Text)
43.87.0 HL7 v2.x Outbound Mapping
43.87.1 Property: Coding System for PV1-4 Admission Type
43.87.2 Property: Map Identifiers using NamingSystem
43.87.3 Property: Populate AL1 Segments
43.87.4 Property: Populate Encounter Participants in PV1
43.87.5 Property: Use Persisted Message Headers
43.88.0 Da Vinci Health Record Exchange (HRex)
43.88.1 Property: Member Match Operation
43.88.2 Property: Consent policy filter
43.89.0 HTTP Access Log
43.89.1 Property: Appenders
43.90.0 HTTP Listener
43.90.1 Property: Bind Address
43.90.2 Property: Context Path
43.90.3 Property: Endpoint Health Path
43.90.4 Property: Unhealthy Status Code
43.90.5 Property: HTTPS Forwarding Assumed
43.90.6 Property: Listener Port
43.90.7 Property: Respect Forward Headers
43.91.0 HTTP Request Pool
43.91.1 Property: Maximum Request Header Size (KB)
43.91.2 Property: Maximum Response Header Size (KB)
43.91.3 Property: Read Idle Timeout (millis)
43.91.4 Property: Thread Pool Accept Queue Size
43.91.5 Property: Thread Pool Maximum Size
43.91.6 Property: Thread Pool Minimum Size
43.92.0 HTTP Security
43.92.1 Property: Block HTTP HEAD
43.92.2 Property: Block HTTP OPTIONS
43.92.3 Property: Custom Headers
43.92.4 Property: Frame Options (Allow From)
43.92.5 Property: Pin Host
43.92.6 Property: Suppress Error Details
43.92.7 Property: Suppress Platform Information
43.93.0 Hybrid Providers Definitions
43.93.1 Property: Search Bundle Inclusion Rule
43.93.2 Property: FHIR Version
43.93.3 Property: Spring Context Config Class
43.94.0 Initial User Seeding
43.94.1 Property: Users Seed File
43.95.0 JavaScript Execution Environment
43.95.1 Property: Debug Enabled
43.95.2 Property: Debug Host Address
43.95.3 Property: Path
43.95.4 Property: Port
43.95.5 Property: Secure
43.95.6 Property: Suspend
43.95.7 Property: ECMAScript Module
43.96.0 JSON Web KeySet (JWKS)
43.96.1 Property: Signing JWKS (File)
43.96.2 Property: Signing JWKS (Text)
43.96.3 Property: Signing Key ID
43.96.4 Property: Keystore ID
43.97.0 LDAP Authentication
43.97.1 Property: Authentication: User Attributes to query
43.97.2 Property: Authentication: User Base DN
43.97.3 Property: Authentication: User Query
43.97.4 Property: Require Group DN
43.97.5 Property: Base DN for Groups
43.97.6 Property: Search Groups Recursively
43.97.7 Property: System User DN
43.97.8 Property: System User Password
43.97.9 Property: LDAP Server URL
43.97.10 Property: Global Permissions
43.97.11 Property: Native Permission User Attribute
43.97.12 Property: User Attribute: Family Name
43.97.13 Property: User Attribute: Given Name
43.98.0 Smile CDR License
43.98.1 Property: License JWT File
43.98.2 Property: License JWT Text
43.99.0 Lucene FullText Indexing
43.99.1 Property: Lucene Index Directory
43.99.2 Property: Elasticsearch/OpenSearch AWS Region.
43.99.3 Property: Elasticsearch Index Prefix
43.99.4 Property: ElasticSearch Password
43.99.5 Property: ElasticSearch URL protocol. Either http or https
43.99.6 Property: ElasticSearch Host URLs.
43.99.7 Property: ElasticSearch Username
43.99.8 Property: Enable FullText Content Index
43.99.9 Property: Enable Indexing of Search Parameters (experimental)
43.99.10 Property: Store resource bodies in Lucene (experimental)
43.99.11 Property: Lucene Indexing Provider
43.99.12 Property: Lucene Indexing Enabled
43.100.0 MDM
43.100.1 Property: Auto Delete Golden Resources
43.100.2 Property: Block List Rules File
43.100.3 Property: Block List Rules
43.100.4 Property: MDM Consumer Thread Count
43.100.5 Property: Golden Resource Partition
43.100.6 Property: Interceptor Bean Types
43.100.7 Property: MDM Partition Key Generator Script (File)
43.100.8 Property: MDM Partition Key Generator Script (Text)
43.100.9 Property: MDM Identifier Code
43.100.10 Property: MDM Identifier CodeSystem URL
43.100.11 Property: MDM Partition Key generator type
43.100.12 Property: Prevent modification of External EIDs
43.100.13 Property: Prevent multiple EIDs from existing simultaneously on a target resource
43.100.14 Property: MDM Rule Definition Script (File)
43.100.15 Property: MDM Rule Definition Script (Text)
43.100.16 Property: Search All Partitions For Matches
43.100.17 Property: MDM Survivorship Script (File)
43.100.18 Property: MDM Survivorship Script (Text)
43.101.0 Narrative Generator
43.101.1 Property: Narrative Template Manifest File
43.102.0 OpenID Connect Token Validation
43.102.1 Property: OIDC HTTP Client: JWKS Cache Timeout (mins)
43.102.2 Property: OIDC HTTP Client: Truststore File
43.102.3 Property: OIDC HTTP Client: Truststore Password
43.103.0 OpenID Connect (OIDC)
43.103.1 Property: Cache Authorizations (millis)
43.103.2 Property: Client Secret Encoding
43.103.3 Property: Smile CDR generated Client Secret expiry duration in days
43.103.4 Property: Issuer URL
43.103.5 Property: PKCE Plain Challenge Supported
43.103.6 Property: PKCE Required
43.103.7 Property: Rotate Refresh Token After Use
43.103.8 Property: Smart Capabilities List
43.104.0 Order Sign CDS hook configuration
43.104.1 Property: ConceptMap URL for Prior-Auth Codes
43.104.2 Property: ValueSet URL for Prior-Auth Codes
43.104.3 Property: ConceptMap URL for Routine Codes
43.104.4 Property: ValueSet URL for Routine Codes
43.105.0 Payer to Payer
43.105.1 Property: Organization Identifier CodeSystem URL
43.106.0 Prior Authorization Coverage Requirement Discovery
43.106.1 Property: Coverage identifier system
43.106.2 Property: DTR application URL
43.106.3 Property: Payer source label
43.106.4 Property: Payer source URL
43.106.5 Property: Practitioner identifier system
43.106.6 Property: Accepted CodeSystems URLs
43.106.7 Property: System Action Questionnaire URL
43.107.0 Privacy Security Notice
43.107.1 Property: Privacy Text
43.107.2 Property: Expiry time (days)
43.107.3 Property: Version
43.108.0 Provenance Injection
43.108.1 Property: Agent Type
43.108.2 Property: Agent Who
43.108.3 Property: $everything operation
43.108.4 Property: Profile
43.108.5 Property: _revinclude=Provenance:target
43.109.0 Realtime Export
43.109.1 Property: Concurrent Consumers
43.109.2 Property: Import Channel Name
43.109.3 Property: Channel Name Prefix
43.109.4 Property: Realtime Export Script (File)
43.109.5 Property: Realtime Export Script (Text)
43.109.6 Property: Published Data source
43.109.7 Property: Transaction-Based Processing
43.110.0 Endpoint Validation: Request Validating
43.110.1 Property: Request Validating Bean Types
43.110.2 Property: Request Validating Enabled
43.110.3 Property: Fail On Severity
43.110.4 Property: Validation Response Headers Enabled
43.110.5 Property: Validation Tags Enabled
43.111.0 Scheduler Configuration
43.111.1 Property: Persistence Clustered Scheduler Name
43.112.0 Search Parameter Seeding
43.112.1 Property: Disable Patterns
43.112.2 Property: Enable Patterns
43.112.3 Property: Support Default SearchParameters
43.113.0 SAML Provider
43.113.1 Property: Relying Party Entity ID Template
43.113.2 Property: Issuer ID
43.113.3 Property: Keystore File
43.113.4 Property: Keystore Password
43.113.5 Property: Registration ID
43.113.6 Property: Sign Auth Request
43.113.7 Property: Signing Key Alias
43.113.8 Property: Signing Key Password
43.113.9 Property: Verification Certificate Alias
43.113.10 Property: Web SSO URL
43.114.0 Security Inbound Script
43.114.1 Property: Script (File)
43.114.2 Property: HTTP Headers
43.114.3 Property: Script (Text)
43.115.0 Inbound SMART on FHIR Authentication
43.115.1 Property: Authentication Cache Timeout (Seconds)
43.115.2 Property: Prevent Token KeyID Reuse
43.115.3 Property: Require Key Expiry
43.115.4 Property: Scopes Supported
43.115.5 Property: Trust Intra-Cluster SMART Tokens from Module(s)
43.116.0 Inbound SMART on FHIR Endpoints
43.116.1 Property: Authorization Endpoint
43.116.2 Property: Introspection Endpoint
43.116.3 Property: Management Endpoint
43.116.4 Property: Revocation Endpoint
43.116.5 Property: Token Endpoint
43.117.0 OAuth2/OIDC Federation
43.117.1 Property: Federated OAuth2/OIDC Login
43.118.0 SMART Callback Script
43.118.1 Property: Authorization Request Details (whitelist)
43.118.2 Property: Post Authorization Script (File)
43.118.3 Property: Post Authorization Script (Text)
43.119.0 Cross-Organizational Data Access Profile
43.119.1 Property: CODAP Authorization Script (File)
43.119.2 Property: CODAP Authorization Script (Text)
43.119.3 Property: Enable Cross-Organization Data Access Profile
43.120.0 SMART Login Skin
43.120.1 Property: Approval Page Template
43.120.2 Property: Context Selection Page Template
43.120.3 Property: Error Page Template
43.120.4 Property: User Self Registration Forgot Password (Step 1)
43.120.5 Property: User Self Registration Forgot Password (Step 2)
43.120.6 Property: User Self Registration Forgot Password (Step 3)
43.120.7 Property: Login Page (Federated OAuth2/OIDC) Template
43.120.8 Property: Login Page Template
43.120.9 Property: User Self Registration Template (Step 1)
43.120.10 Property: User Self Registration Template (Step 2)
43.120.11 Property: Session Management Page Template
43.120.12 Property: Two Factor Authentication Page Template
43.120.13 Property: Terms-of-service click-wrap Page Template
43.120.14 Property: WebJar ID
43.121.0 SMART Login Terms of Service
43.121.1 Property: Current version of terms.
43.122.0 SMART Authorization
43.122.1 Property: Allowed Audience List
43.122.2 Property: Email From Address
43.122.3 Property: Enforce Approved Scopes to Restrict Permissions
43.122.4 Property: Scopes Supported
43.123.0 SMART Definitions Seeding
43.123.1 Property: OpenID Connect Client Pre-Seed File
43.123.2 Property: OpenID Connect Server Pre-Seed File
43.124.0 Sessions
43.124.1 Property: Use In-Memory Sessions
43.124.2 Property: Maximum concurrent session per user
43.124.3 Property: Session Scavenger Interval (Millis)
43.124.4 Property: Session Timeout (Mins)
43.125.0 Two Factor Authentication
43.125.1 Property: TOTP Issuer Name
43.125.2 Property: Lock After Failed Attempts
43.126.0 TLS / SSL (Encryption)
43.126.1 Property: TLS Client Authentication
43.126.2 Property: TLS Enabled
43.126.3 Property: TLS KeyStore Filename
43.126.4 Property: TLS KeyStore Key Alias
43.126.5 Property: TLS KeyStore Key Password
43.126.6 Property: TLS KeyStore Password
43.126.7 Property: TLS Cipher Blacklist
43.126.8 Property: TLS Cipher Whitelist
43.126.9 Property: TLS Protocol Blacklist
43.126.10 Property: TLS Protocol Whitelist
43.126.11 Property: TLS TrustStore Filename
43.126.12 Property: TLS TrustStore Password
43.126.13 Property: TLS: Disable SNI checking for debugging
43.127.0 Transaction Log
43.127.1 Property: Transaction Log Step Body Serialization Mode
43.127.2 Property: Transaction Log Broker Channel Name
43.127.3 Property: Transaction Log Broker Enabled
43.127.4 Property: Transaction Log Database Storage Enabled
43.127.5 Property: Event Blacklist
43.127.6 Property: Event Whitelist
43.127.7 Property: Persist Transaction Bodies (Global)
43.127.8 Property: Persist Transaction Bodies: Incoming Request
43.127.9 Property: Persist Transaction Bodies: Incoming Response
43.127.10 Property: Transaction Log Show Request Body Enabled
43.127.11 Property: Truncate Transaction Bodies (bytes)
43.128.0 Trusted Client
43.128.1 Property: Assert Permissions
43.128.2 Property: Trusted Client Mode Enabled
43.129.0 User Self Registration
43.129.1 Property: User Self Registration Script (File)
43.129.2 Property: User Self Registration Script (Text)
43.129.3 Property: User Self Registration Enabled
43.129.4 Property: Referer URL List (Text)
44.0.0 Product Reference
44.0.0 Enumerated Types
44.0.1 Node And Module Status
44.0.2 Transaction Log Outcomes
44.0.3 Module Types
45.0.0 Amazon HealthLake Outbound REST Connector
45.0.0 Introduction
45.1.0 Getting Started
45.1.1 Configuration
45.1.2 Subscription
45.1.3 Start/Stop/Restart Module
45.2.0 Data Management and Transfer
45.2.1 Security
45.2.2 Data Access and Transfer
45.2.3 Data Version Management
45.2.4 Historical Data Transfer
45.2.5 Logging
45.2.6 Error Handling
45.2.7 Troubleshooting
46.0.0 Appendix
46.0.0 Preparing a Linux Host
46.0.1 Ubuntu Host with PostgreSQL / NGINX / Letsencrypt
46.0.2 Install letsencrypt and obtain Certs (optional)
46.0.3 Install nginx And Configure it to Front the Server
46.0.4 Red Hat Enterprise Linux (RHEL) or CentOS
46.1.0 Installing Smile CDR, NGINX and PostgreSQL in a Docker Stack
46.1.1 Initial Setup of Docker and Context
46.1.2 Prepare Configuration for Smile CDR Docker Service
46.1.3 Prepare Configuration for NGINX Docker Service
46.1.4 Prepare Configuration for PostgreSQL Docker Service
46.1.5 Create Docker compose file for Smile CDR Docker stack
46.1.6 Build and Launch Smile CDR Stack
46.2.0 Deploying a Kubernetes Managed Cluster
46.2.1 Overview of Smile CDR Kubernetes Deployment Process
46.2.2 Pre-requisite Steps
46.2.3 Configuring Kubernetes
46.2.4 Kubernetes and Smile CDR Database Connections
46.2.5 Service Definitions
46.2.6 ConfigMap Definitions
46.2.7 Deployment Definitions
46.2.8 Deploying Smile CDR in a Kubernetes Cluster
46.2.9 Configuring Reverse Proxy and Load Balancer
46.2.10 Considerations When Deploying Smile CDR Using OpenShift
46.3.0 Password Hashing Algorithms
46.3.1 Available Algorithms
46.4.0 Resource Paths
46.5.0 JWT Signature Algorithms
46.6.0 Inferno Considerations