On this page:

1.0Table 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 Changelog (2021 Releases)
1.1.1 Smile CDR 2021.08.R01 (Pre-Release)
1.1.2 Smile CDR 2021.05.R03 (Pangolin)
1.1.3 Smile CDR 2021.05.R02 (Pangolin)
1.1.4 Smile CDR 2021.05.R01 (Pangolin)
1.1.5 Smile CDR 2021.02.R05 (Odyssey)
1.1.6 Smile CDR 2021.02.R04 (Odyssey)
1.1.7 Smile CDR 2021.02.R03 (Odyssey)
1.1.8 Smile CDR 2021.02.R02 (Odyssey)
1.1.9 Smile CDR 2021.02.R01 (Odyssey)
1.1.10 Smile CDR 2020.11.R02 (Numbat)
1.2.0 Changelog (2020 Releases)
1.2.1 Smile CDR 2020.11.R01 (Numbat)
1.2.2 Smile CDR 2020.08.R03 (Manticore)
1.2.3 Smile CDR 2020.08.R02 (Manticore)
1.2.4 Smile CDR 2020.08.R01 (Manticore)
1.2.5 Smile CDR 2020.05.R02 (Labrador)
1.2.6 Smile CDR 2020.05.R01 (Labrador)
1.2.7 Smile CDR 2020.02.R01 (Koala)
1.3.0 Changelog (2019 Releases)
1.3.1 Smile CDR 2019.11.R01 (Jitterbug)
1.3.2 Smile CDR 2019.08.R01 (Igloo)
1.3.3 Smile CDR 2019.05.R01 (Hippo)
1.3.4 Smile CDR 2019.02.R01 (Gale)
1.4.0 Changelog (2018 Releases)
1.4.1 Smile CDR 2018.11.R01 (Food)
1.4.2 Smile CDR 2018.09.R01 (Economist)
1.4.3 Smile CDR 2018.05.R01 (Dromedário)
1.4.4 Smile CDR 2018.03.R01 (Crouton)
1.5.0 Changelog (2017 Releases)
1.5.1 Smile CDR 2017.11.R01 (Buccaneer)
1.5.2 Smile CDR 2017.09.R01 (Aardvark)
1.5.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 Network Infrastructure
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 Module Property Source
3.0.7 Variable Substitution
3.0.8 Fetching Configuration Using Scripts
3.0.9 Configuring Your Database
3.0.10 Starting the CDR
3.0.11 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: ActiveMQ
3.6.1 Resource Limits
3.7.0 Message Broker: Kafka
3.7.1 Kafka Topic Names
3.8.0 Pre-Seeding Configuration and Data
3.8.1 Pre-Seeding Module Configuration
3.8.2 Pre-Seeding Users
3.8.3 Pre-Seeding OpenID Connect Servers
3.8.4 Pre-Seeding OpenID Connect Clients
3.8.5 Pre-Seeding Packages and FHIR Resources
3.9.0 Upgrading Smile CDR
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 FHIR Basics
4.1.1 Resources
4.1.2 Datatypes
4.1.3 Parts of a Resource
4.1.4 Encodings (MIME Types, Wire Formats)
4.2.0 FHIR Search Queries
4.2.1 How Searching Works
4.2.2 Basic Searching: Finding Patients
4.2.3 References: Finding Encounters
4.2.4 Quantities: Finding Laboratory Values
4.2.5 Dates and Times: Narrowing Your Search Window
4.2.6 Paging Search Results
4.2.7 Sorting Search Results
4.2.8 Fulltext Searching
4.2.9 The Patient $everything Search (Across Patient Chart)
4.3.0 FHIR CRUD Operations
4.3.1 Testing Tools
4.3.2 FHIR Create
4.3.3 FHIR Update
4.3.4 FHIR Patch
4.3.5 FHIR Read / vRead
4.3.6 FHIR Delete
4.4.0 SMART on FHIR Apps
4.4.1 Accessing the Web Admin Console
4.4.2 Creating a Client Definition
4.4.3 Enabling SMART on FHIR Requests
4.4.4 Install Growth Chart App
4.4.5 Create Some Test Data
4.4.6 Enable SMART Authorization on FHIR Endpoint
4.4.7 Install a Launch Context Script
4.4.8 Launch SMART on FHIR Growth Chart App
4.5.0 Processing HL7 v2.x Feeds
4.5.1 Transmitting to Smile CDR
4.5.2 ORU (Observation Result) Messages
4.5.3 ADT (Admission/Discharge/Transfer) Messages
4.6.0 FHIRPath Expressions
4.6.1 Testing FHIRPath Expressions
4.6.2 Expression: Extension With Reference Value
4.6.3 Expression: Contained Resource
4.6.4 Expression: Bundle (FHIR Message) Entry Resource
4.6.5 Expression: Bundle (FHIR Document) Entry Resource
4.6.6 Expression: Multiple Paths
4.7.0 Federated OAuth2/OIDC Setup
4.7.1 Setting up Smile CDR - SMART Outbound Security Module
4.7.2 Setting up Smile CDR - OIDC Client Definition
4.7.3 Setting up Smile CDR - OIDC Server Definition
4.7.4 Setting up the IDP
4.7.5 Starting the Federated Flow
4.7.6 Token Signature Algorithms
4.7.7 Considerations
5.0.0 FHIR Storage
5.0.0 Concepts in Smile CDR
5.0.1 The FHIR Storage Module
5.0.2 The FHIR REST Endpoint Module
5.0.3 Clustering
5.1.0 FHIR Storage (Relational) Module
5.1.1 Preparing for a New Installation
5.1.2 Creating the Module
5.1.3 Database Schema
5.1.4 Scheduled Tasks
5.1.5 Configuration
5.2.0 FHIR Storage (MongoDB) Module
5.2.1 Preparing for a New Installation
5.2.2 Creating the Module
5.2.3 MongoDB Document Schema
5.2.4 MongoDB Uplift Search Parameter Extensions
5.2.5 Uplifting Tokens
5.2.6 Uplifting Reference Chains
5.2.7 Configuration
5.2.8 MongoDB vs RDBMS Support Comparison
5.3.0 FHIR Endpoint Module
5.3.1 Creating the Module
5.3.2 Capturing Source Information
5.3.3 Validation
5.3.4 Configuration
5.4.0 FHIRWeb Console
5.4.1 Architecture
5.4.2 Security
5.4.3 Creating the Module
5.4.4 Using the Console
5.4.5 Configuration
5.5.0 OpenAPI / Swagger Support
5.5.1 Swagger UI
5.5.2 Limitations
5.6.0 Lucene Indexing
5.6.1 Lucene Disk Provider
5.6.2 Elasticsearch Provider
5.7.0 Performance and Caching
5.7.1 The Query Cache
5.7.2 Search Counts
5.7.3 Improving Write Performance
5.8.0 Resource IDs
5.8.1 Server Assigned IDs
5.8.2 Client Assigned IDs
5.9.0 Search Parameters
5.9.1 Search Parameter Concepts
5.9.2 Default Search Parameters
5.9.3 Managing Search Parameters
5.9.4 Search Parameter Statistics
5.9.5 Filter Search Parameter
5.9.6 Manual Reindexing
5.10.0 Search Parameter Features
5.10.1 Index Missing Search Parameters (:missing)
5.10.2 Suppress Text Index on Tokens (:text)
5.10.3 Index Contained Resources (_contained)
5.11.0 Phonetic Search Parameters
5.12.0 Custom Search Parameters
5.12.1 An Example Search Parameter
5.12.2 Search Parameter Expressions
5.12.3 Combo Search Index Parameters
5.12.4 Enforcing Uniqueness
5.13.0 Search Parameter Tuning
5.13.1 Checking Active Parameters
5.13.2 Seeding Search Parameters
5.14.0 Partitioning and Multitenancy
5.14.1 Enabling Partitioning in Smile CDR
5.14.2 Request Partition Selection Mode
5.14.3 Request Partition Security
5.14.4 Tenant Identification Strategies
5.14.5 Seeding Partitions
5.14.6 Patient ID Partition Mode
5.14.7 Cross-Partition References
5.15.0 Searching for Data
5.15.1 FHIR Search Extensions
5.15.2 Unsupported Search Parameters
5.16.0 Creating Data
5.16.1 Transactions and Submitting Bundles
5.16.2 Auto-Creating Reference Targets
5.16.3 Transaction With Conditional Create
5.16.4 Auto-Create Placeholder Reference Targets
5.16.5 Auto-Create Placeholder Reference Targets with Identifier
5.16.6 Auto-Created Placeholder Extension
5.16.7 Searching for Auto-Created Resources
5.16.8 Auto-Creating Reference Targets and Enforcing Uniqueness
5.16.9 Mass Ingestion Mode
5.17.0 Reading Data
5.17.1 Diff Operation
5.17.2 Diff Instance
5.17.3 Diff Type
5.18.0 Updating Data
5.18.1 Patching Data
5.18.2 Tag Retention
5.18.3 Concurrent Write Errors
5.19.0 Deleting Data
5.19.1 Deletes and Referential Integrity
5.19.2 Transactional Delete
5.19.3 Referential Integrity
5.19.4 Cascading Deletes
5.19.5 The $expunge Operation
5.20.0 Binary Data
5.20.1 Externalized Binary Storage
5.20.2 Binary Access Operations
5.20.3 Serving Raw Media Resources
5.21.0 Request Tracing and Provenance
5.21.1 Request Tracing
5.21.2 Performance Tracing
5.21.3 Storing Source Information
5.22.0 FHIR Versions
5.23.0 Versioned Resource References
5.23.1 Allow Versioned References
5.23.2 Automatically Version References
5.24.0 Tags, Profiles, and Security Labels
5.24.1 Search Parameters
5.25.0 Clinical Quality Language (CQL)
5.25.1 Evaluate Measure
6.0.0 Validation and Conformance
6.0.0 Introduction
6.0.1 Validation Modes
6.1.0 Validation Support Repository
6.1.1 Potential Architectures
6.1.2 Single FHIR Repository (RDBMS)
6.1.3 Dedicated Validation Support Repository
6.1.4 Non-Repository Models
6.2.0 Validation Support Repository Options
6.2.1 Validating References
6.2.2 Handling Missing CodeSystems
6.3.0 Conformance Data
6.3.1 StructureDefinition resources
6.3.2 CodeSystem Resources
6.3.3 ValueSet Resources
6.4.0 Repository Validation
6.4.1 Validation Support Repository
6.4.2 Methods
6.5.0 Repository Validation: Java
6.6.0 Repository Validation: Javascript
6.6.1 Function: repositoryValidationProvideRules(theRuleBuilder)
6.6.2 Example: Require a Specific Profile
6.6.3 Example: Allow Several Profiles for a Resource Type
6.6.4 Example: Require Profile and Validate
6.7.0 Repository Validation: Validation Bean
6.8.0 Endpoint Validation
6.9.0 Packages and Implementation Guides
6.9.1 Background: Implementation Guides
6.9.2 Background: Packages
6.9.3 Ingesting Packages into Smile CDR
6.9.4 Package Pre-Seed Installation
6.9.5 Pre-Seeding Resources into the Repository
6.9.6 Package Registry Endpoint module
6.9.7 Creating Packages
6.10.0 Remote Terminology Services
6.10.1 Scope
6.10.2 Remote Server Requirements
6.11.0 Suppressing Messages
7.0.0 Terminology
7.0.0 Terminology Introduction
7.1.0 Uploading Codes
7.1.1 Uploading External CodeSystems
7.1.2 Uploading ICD-10-CM
7.1.3 Uploading LOINC
7.1.4 Uploading SNOMED CT
7.1.5 Uploading Custom Vocabularies
7.1.6 Applying Deltas to External CodeSystems
7.1.7 Delta Add Operation: $apply-codesystem-delta-add
7.1.8 Delta Remove Operation: $apply-codesystem-delta-remove
7.1.9 Reference: CSV Vocabulary Input Files
7.2.0 Terminology and Lucene Indexing
7.2.1 Terminology Index
7.2.2 Validation
7.2.3 Operations
7.3.0 ValueSet Expansion
7.3.1 ValueSet Expansion Pre-Calculation
7.3.2 Expanding Hierarchical CodeSystems and ValueSets
7.3.3 Searching for Codes
7.4.0 FHIR Response Terminology Mapping
7.4.1 Response Terminology Mapping
7.4.2 Response Coding Displays
8.0.0 Subscription
8.0.0 Introduction
8.0.1 The Subscription Resource
8.0.2 Subscription Activation
8.0.3 Criteria
8.0.4 Troubleshooting Subscriptions
8.1.0 Architecture
8.1.1 Enabling and Configuring Subscription Processing
8.2.0 Channel Types
8.2.1 Channel Type: rest-hook
8.2.2 Channel Type: email
8.2.3 Channel Type: websocket
8.2.4 Channel Type: message
8.3.0 Delivery Options
8.3.1 Payload Search Result Mode
8.3.2 Replication Mode
8.3.3 Strip Version IDs
8.3.4 Delivering Latest Version
8.3.5 Custom Delivery Class
8.3.6 Delivery to Site-defined External Queue
8.4.0 Manual Triggering
9.0.0 Interceptors
9.0.0 Interceptors
9.0.1 HAPI FHIR and Smile CDR Pointcuts
9.0.2 Deploying Interceptors to Smile CDR Modules
9.1.0 Starter Project
9.1.1 Using the Starter Project
9.2.0 Examples: FHIR Endpoints
9.2.1 Example: Override CapabilityStatement Generation
9.3.0 Examples: FHIR Storage
9.3.1 Example: Response Attribute Enhancement
9.4.0 Examples: FHIR Gateway
9.4.1 Example: Direct Search based on Parameter Value
9.4.2 Example: Modify Target Search based on Previous Target Search
9.4.3 Example: Modify Target Search Results
9.4.4 Example: Modify Target Search Uri
9.4.5 Example: Search Using Alternate Patient ID
10.0.0 Channel Import
10.0.0 Channel Import Overview
10.0.1 Enabling and Configuring Channel Import
11.0.0 Realtime Export
11.0.0 Realtime Export Overview
11.0.1 Operational Overview
11.0.2 Limitations
11.0.3 Troubleshooting
11.1.0 Realtime Export Rules Definition
11.1.1 Transformers
11.1.2 Named Transformers
11.1.3 Managing high-cardinality elements
11.2.0 Using FHIRPath
11.2.1 Collection Subsetting
11.2.2 Self-referral
11.2.3 Conditionals
11.3.0 Debezium
12.0.0 Security
12.0.0 Security in Smile CDR
12.0.1 Inbound Security Module
12.0.2 FHIR Listener Module
12.0.3 Admin Modules
12.0.4 Auth Directory
12.0.5 Audit Database
12.0.6 Outbound Security Modules
12.1.0 Authentication Protocols
12.1.1 HTTP Basic
12.1.2 OpenID Connect (OIDC) and SMART on FHIR
12.1.3 Security Access Markup Language (SAML)
12.2.0 Authorization and Consent
12.2.1 Authorization Service
12.2.2 Consent Service
12.3.0 Inbound Security Module
12.3.1 Permissions
12.3.2 Callback Script
12.4.0 Local Inbound Security Module
12.4.1 Configuration: Credentials
12.4.2 Caching
12.4.3 User Self Registration
12.5.0 LDAP Inbound Security Module
12.5.1 Requirements
12.5.2 Permissions
12.5.3 Callback Scripts
12.5.4 Configuration
12.6.0 Scripted Inbound Security Module
12.6.1 Script Format
12.6.2 Script Examples
12.7.0 SAML Inbound Security Module
12.7.1 SAML 2.0 Authentication Request Protocol
12.7.2 Enabling SAML Authentication
12.7.3 Entity ID Template
12.7.4 Authentication Scripts
12.7.5 Function: authenticate(theRequest, theOutcomeFactory)
12.8.0 Trusted Client Mode
12.8.1 Configuring Trusted Client Mode
12.8.2 Making Trusted Client Requests
12.8.3 Automatically Creating Users
12.9.0 Roles and Permissions
12.9.1 System-Defined Roles
12.9.2 System-Defined Permissions
12.10.0 Callback Scripts
12.10.1 Function: onAuthenticateSuccess
12.10.2 Function: onSmartLoginPreContextSelection(theUserSession, theContextSelectionChoices)
12.10.3 Example Script
12.10.4 Function: onTokenGenerating(theUserSession, theAuthorizationRequestDetails)
12.10.5 Function: onPostAuthorize(theDetails)
12.10.6 Function: authenticate(theRequest, theOutcomeFactory)
12.11.0 Anonymous Access
12.12.0 Consent Service
12.12.1 Enabling the Consent Service
12.12.2 Method: consentStartOperation
12.12.3 Method: consentCanSeeResource
12.12.4 Method: consentWillSeeResource
12.12.5 Method: completeOperationSuccess
12.12.6 Method: completeOperationFailure
12.12.7 Example: Tag-Based Consent Script
12.12.8 Example: Scope-Based Consent Script
12.13.0 Security Recipes
12.13.1 App: Local Users with HTTP Basic Authentication
12.13.2 Integrating SMART Apps With a 3rd-Party OIDC Server
12.14.0 Two Factor Authentication
12.14.1 User Activating TOTP
12.14.2 Enforcing Two Factor Authentication
12.15.0 Troubleshooting Security
13.0.0 SMART on FHIR
13.0.0 SMART on FHIR: Introduction
13.0.1 The SMART Launch Sequence
13.0.2 The Interactive Launch Process
13.1.0 SMART: Scopes
13.1.1 Picking Scopes
13.1.2 Launch Context Scopes
13.1.3 The OpenID and Profile Scopes
13.2.0 SMART: Auth Flows
13.2.1 Launch Flow: Authorization Code
13.2.2 Security Option: Proof Key for Code Exchange (PKCE)
13.2.3 Launch Flow: Implicit Grant
13.2.4 Launch Flow: Resource Owner Password Credentials
13.2.5 Non-Interactive User Flow: Cross-Organization Data Access Profile
13.2.6 System Flow: Client Credentials
13.2.7 System Flow: Client Credentials with JWT Credential
13.2.8 System Flow: Refresh Token
13.3.0 SMART: Endpoints
13.3.1 Server Metadata Endpoint
13.3.2 UserInfo Endpoint
13.4.0 Client Management
13.4.1 Remembering Approved Scopes
13.4.2 Client Secrets
13.5.0 SMART: Smile CDR Support
13.5.1 Models for Using External OIDC Servers
13.5.2 Supported Scopes
13.5.3 Online / Offline Access
13.6.0 SMART Outbound Security: Module
13.6.1 Setting Up This Module
13.6.2 Terms of Service
13.6.3 Plain-language Developer Attestation
13.6.4 Client Credentials Grant
13.6.5 Cross-Organization Data Access Profile Grant
13.6.6 SMART Callback Scripts
13.6.7 User Self Registration
13.7.0 SMART Outbound Security: Skinning
13.7.1 Creating a Skin
13.7.2 Installing a Skin
13.7.3 HTML Template Files
13.7.4 Sample Skin Project
13.8.0 SMART Outbound Security: Context Selection
13.9.0 SMART: Federated OAuth2/OIDC Login
13.9.1 Federated Flow
13.9.2 Considerations
13.9.3 Setting Up Federated OAuth2/OIDC Login
13.9.4 Authorization Script
13.10.0 SMART: Application Approval/Consent
13.10.1 Approval Overview
13.10.2 Auto-Approve / Auto-Grant Scopes
13.10.3 Approval Flow
13.10.4 Customizing Scope Names
13.10.5 Custom Security Scopes
13.10.6 Revocation Page
13.11.0 SMART Inbound Security Module
13.11.1 Requirements
13.11.2 Setting Up This Module
13.11.3 Accepting Tokens
13.11.4 Accepting Internal Access Tokens
13.11.5 Accepting External Access Tokens
13.11.6 Validating Tokens
13.11.7 Creating a Server Definition
13.11.8 Assigning Permissions
13.11.9 Function: authenticate(...)
13.12.0 SMART: Session Management
13.12.1 Token Revocation Endpoint
13.12.2 User Logout Endpoint
13.13.0 SMART: Assigning Permissions
13.13.1 Scope Permission Model
13.13.2 User and Patient Resource Linkage
13.14.0 SMART: Access Tokens
13.15.0 SMART: User Profile Information
13.16.0 FHIR Client Authentication
13.16.1 Rejecting Unauthorized FHIR Calls
14.0.0 App Management Tools
14.0.0 Introduction
14.1.0 Getting Started
14.2.0 Associated Module Configurations
14.2.1 Configuration of JSON Admin API module
14.2.2 Configuration of FHIR Endpoint Module
14.2.3 Configuration of SMART Auth Module
14.2.4 Setting-up Federated OAuth to work with the App Management Tools
14.3.0 Client Creation and Configuration
14.4.0 Other Configurations
14.4.1 Configuring NGINX for the Module
14.4.2 Configuring Different Users
14.5.0 Developer Portal
14.5.1 API Documentation for Dev Portal
14.5.2 Developer Registration
14.5.3 Developer Portal: UI Description
14.5.4 App Registration
14.5.5 Attestation
14.5.6 New App versions
14.5.7 Additional Considerations
14.6.0 App Management Console
14.6.1 Management Console: UI Description
14.6.2 Permissions
14.6.3 App review and management
14.6.4 Additional Considerations
14.7.0 App Gallery
14.7.1 App Gallery: UI Description
14.7.2 Gallery Functionality
14.8.0 Appendix
14.8.1 App Registration Help Text
14.8.2 Sign Up Help Text
14.8.3 Smile CDR Config
14.8.4 Attestation Creation
14.8.5 Troubleshooting
14.8.6 Reference Documents
14.8.7 Glossary of Terms
15.0.0 FHIR Gateway
15.0.0 FHIR Gateway Introduction
15.0.1 Smile CDR 2020.02 Gateway Redesign
15.1.0 Configuration: Initial Setup
15.1.1 Server Configuration
15.1.2 Encryption JWKS (Keystore)
15.1.3 Configuration Document
15.1.4 Interceptors
15.2.0 Configuration: Document
15.2.1 Defining Targets
15.2.2 Defining Search Routes
15.2.3 Defining Read Routes
15.2.4 Defining Operation Routes
16.0.0 FHIR Hybrid Providers
16.0.0 Hybrid Providers
16.0.1 Architecture
16.0.2 Resource Providers
16.0.3 CapabilityStatement
16.0.4 The Spring Context Config Class
16.0.5 Building Your Hybrid Providers
16.0.6 Paging
16.0.7 Deploying Your Hybrid Providers
16.0.8 Accessing Security Attributes
16.0.9 Exceptions
16.0.10 Example Project
17.0.0 LiveBundle
17.0.0 LiveBundle Overview
17.0.1 Configuration
17.0.2 Usage
17.0.3 LiveBundle Architecture
17.0.4 LiveBundle Aggregation
17.0.5 LiveBundle Retrieval
17.0.6 LiveBundle Seeding
17.0.7 LiveBundle Troubleshooting
17.1.0 LiveBundle API
17.1.1 Add a Subscriber to a Watchlist
17.1.2 Remove Subscriber from a Watchlist
17.1.3 View list of Subscribers to a Watchlist
17.1.4 Request a bundle of Subscribers to a watchlist
17.1.5 Reseed all bundles for a rule
17.1.6 Request a LiveBundle
17.2.0 LiveBundle Rule Definition
17.2.1 Loading Rules
17.2.2 Example LiveBundle Javascript
17.2.3 LiveBundle Watchlist
17.2.4 LiveBundle Rule
17.2.5 LiveBundle Filter
17.2.6 Keeper Filters
17.2.7 LiveBundle Keeper
17.3.0 LiveBundle Keepers
17.3.1 LiveBundle Keeper Examples
17.3.2 LatestByPath
17.3.3 LatestByParamPath
17.3.4 LatestByParamPathByMonth
17.3.5 ToggleByPath
17.3.6 ToggleBySearch
17.3.7 WatchlistPopulator
17.3.8 Optional Keeper Parameters
18.0.0 CDS-Hooks
18.0.0 CDS-Hooks
18.0.1 Auto Prefetch
18.0.2 Architecture
18.0.3 CDS-Hooks classes
18.0.4 The Spring Context Config Class
18.0.5 Building Your CDS-Hooks
18.0.6 Deploying Your CDS-Hooks
18.0.7 Accessing Security Attributes
18.0.8 Exceptions
18.0.9 Calling CDS-Hooks
18.0.10 Example Project
19.0.0 Master Data Management
19.0.0 MDM
19.0.1 Getting Started with Smile CDR MDM
19.0.2 Enabling and Configuring MDM within Smile CDR
19.0.3 Troubleshooting
19.0.4 MDM User Interface
19.0.5 MDM Scenarios
19.1.0 MDM Quickstart Guide
19.2.0 MDM Survivorship Rules
19.3.0 Upgrading from the EMPI module
20.0.0 Clustering
20.0.0 Designing a Cluster
20.0.1 Node and Module Design
20.0.2 Process IDs
20.0.3 Adding and Removing Processes
20.0.4 Multi-Node Clusters
20.0.5 Sample Architecture
20.1.0 Migration To 2020.02
20.1.1 Migrating Existing Clusters
21.0.0 Logging
21.0.0 Overview
21.1.0 Audit Log
21.1.1 Audit Log Configuration
21.1.2 Disabling the Audit Log
21.1.3 Broker Audit Log
21.2.0 Transaction Log
21.2.1 Disabling the Transaction Log
21.2.2 Transaction Log Configuration
21.2.3 Event Types and SubTypes
21.3.0 System Logging
21.3.1 Changing Logging Settings
21.4.0 Troubleshooting Logs
21.4.1 HTTP Troubleshooting Log
21.4.2 Security Troubleshooting Log
21.4.3 Subscription Troubleshooting Log
21.4.4 LiveBundle Troubleshooting Log
21.4.5 MDM Troubleshooting Log
21.4.6 Channel Import Troubleshooting Log
21.4.7 Realtime Export Troubleshooting Log
22.0.0 HL7 v2.x Support
22.0.0 Introduction
22.0.1 Inbound HL7 v2.x Support
22.0.2 Outbound HL7 v2.x Support
22.0.3 HL7 v2.x Versions
22.1.0 Inbound Messaging
22.1.1 Processing
22.1.2 Callback Scripts
22.1.3 Function: onPreConvertHl7V2ToFhir(theMessage, theConversionResult)
22.1.4 Function: onPostConvertHl7V2ToFhir(theMessage, theConversionResult)
22.1.5 Adding Processing Messages
22.2.0 Outbound Messaging
22.2.1 ADT Workflow Mode
22.2.2 Enriching Message Conversion using Scripts
22.2.3 Function: onPostConvertFhirToHl7V2(theTriggerResource, theOutgoingMessage, theContext)
22.2.4 Using Persisted MessageHeader Resources
22.3.0 Transactions
22.3.1 ADT (Patient Administration) Domain
22.3.2 OMG (Orders) Domain
22.3.3 ORU (Results) Domain
22.3.4 RDE/RAS (Pharmacy) Domain
22.3.5 SIU (Scheduling) Domain
22.3.6 VXU (Immunization / Vaccination) Domain
22.3.7 DFT (Financial) Domain
22.4.0 Structure Definitions
22.4.1 Structure: ADT_A01
22.4.2 Structure: ADT_A02
22.4.3 Structure: ADT_A03
22.4.4 Structure: ADT_A05
22.4.5 Structure: ADT_A06
22.4.6 Structure: ADT_A09
22.4.7 Structure: ADT_A12
22.4.8 Structure: ADT_A17
22.4.9 Structure: ADT_A21
22.4.10 Structure: ADT_A30
22.4.11 Structure: ADT_A38
22.4.12 Structure: ADT_A39
22.4.13 Structure: ADT_A44
22.4.14 Structure: ADT_A45
22.4.15 Structure: ADT_A54
22.4.16 Structure: ADT_A60
22.4.17 Structure: ADT_A61
22.4.18 Structure: DFT_P03
22.4.19 Structure: OMG_O19
22.4.20 Structure: ORM_O01
22.4.21 Structure: ORU_R01
22.4.22 Structure: RAS_O17
22.4.23 Structure: RDE_O11
22.4.24 Structure: SIU_S12
22.4.25 Structure: VXU_V04
22.5.0 Segment Definitions
22.5.1 Segment: MSH (Message Header)
22.5.2 Segment: EVN (Event)
22.5.3 Segment: PID (Patient)
22.5.4 Segment: PD1 (Patient Demographics Extended)
22.5.5 Segment: PV1 (Visit/Encounter)
22.5.6 Segment: PV2 (Visit/Encounter Additional)
22.5.7 Segment: ROL (Role)
22.5.8 Segment: DG1 (Diagnosis)
22.5.9 Segment: PR1 (Procedure)
22.5.10 Segment: MRG (Merge Patient Information)
22.5.11 Segment: GT1 (Guarantor)
22.5.12 Segment: IN1 (Insurance)
22.5.13 Segment: IN2 (Insurance Additional Information)
22.5.14 Segment: ORC (Order Control)
22.5.15 Segment: OBR (Observation Request)
22.5.16 Segment: OBX (Observation)
22.5.17 Segment: NK1 (Next of Kin / Patient Contact)
22.5.18 Segment: NTE (Note)
22.5.19 Segment: FT1 (Financial Transaction)
22.5.20 Segment: RXA (Pharmacy Administration)
22.5.21 Segment: RXC (Pharmacy Component)
22.5.22 Segment: ZXC (Pharmacy Component)
22.5.23 Segment: RXE (Pharmacy Encoded Order)
22.5.24 Segment: RXR (Pharmacy Route)
22.5.25 Segment: AL1 (Allergy Information)
22.5.26 Segment: IAM (Patient Adverse Reaction)
22.5.27 Segment: SPM (Specimen)
22.5.28 Segment: SCH (Scheduling)
22.5.29 Segment: RGS (Resource Group Segment)
22.5.30 Segment: AIL (Location Resource)
22.5.31 Segment: AIP (Personnel Resource)
22.5.32 Segment: ZXT (Non-Standard)
22.5.33 A Note about Extra Components
22.6.0 Table Definitions
22.6.1 Table 0001: Administrative Sex
22.6.2 Table 0002: Marital Status
22.6.3 Table 0004: Patient Class
22.6.4 Table 0007: Admission Type
22.6.5 Table 0009: Ambulatory Status
22.6.6 Table 0017: Transaction Type
22.6.7 Table 0018: Patient Type
22.6.8 Table 0038: Order Status
22.6.9 Table 0052: Diagnosis Type
22.6.10 Table 0063: v2 Relationship
22.6.11 Table 0069: Hospital Service
22.6.12 Table 0074: Dianostic Service Section ID
22.6.13 Table 0078: Observation Interpretation Codes
22.6.14 Table 0085: Observation Status
22.6.15 Table 0112: Discharge Disposition
22.6.16 Table 0119: Order Control
22.6.17 Table 0123: Result Status
22.6.18 Table 0125: Observation Value Type
22.6.19 Table 0127: Allergen Type
22.6.20 Table 0128: Allergen Severity
22.6.21 Table 0129: Accommodation Code
22.6.22 Table 0131: v2 Contact Role
22.6.23 Table 0136: Yes/No
22.6.24 Table 0166: RX Component Type
22.6.25 Table 0190: Address Type
22.6.26 Table 0200: Name Type Code
22.6.27 Table 0201: Telecom Use
22.6.28 Table 0202: Telecom Equipment Type
22.6.29 Table 0203: Identifier Type
22.6.30 Table 0276: Appointment Reason Codes
22.6.31 Table 0278: Filler Status Code
22.6.32 Table 0305: Person Location Type
22.6.33 Table 0322: Completion Status
22.6.34 Table 0438: Allergy Clinical Status Code
22.7.0 Naming System Mapping
22.7.1 Default Mappings
22.7.2 Using NamingSystem for Mapping Identifiers
22.8.0 Processing Results Feeds
22.8.1 Unsolicited Observation Request (ORU^R01)
22.9.0 Protocol
22.9.1 Encoding Format
22.9.2 ER7 (Pipe-Delimited) Format
22.9.3 Minimal Lower Layer Protocol (MLLP) Transport
22.9.4 HL7 over HTTP
22.9.5 Character Encoding / Charsets
23.0.0 CDA Exchange Module
23.0.0 Introduction
23.1.0 JavaScript Templates
23.1.1 The simplest CDA template script
23.1.2 Adding header information to our CDA template script
23.1.3 Adding and populating a section in our CDA template script
23.1.4 Using the Fhir.search() API to dynamically populate sections
23.1.5 Specifying input parameters
23.1.6 More complicated input parameters
23.1.7 Putting it all together
23.2.0 Rest API Operations
23.2.1 Endpoints for configuring templates
23.2.2 Endpoints for applying templates
23.3.0 Available Document and Section Types
23.3.1 Valid Document Types
23.3.2 Valid Resources for the header
23.3.3 Valid Section Types and Sources
23.3.4 Allergy and Intolerances Section
23.3.5 Medications Section
23.3.6 Problem Section
23.3.7 Results Section
23.3.8 Social History Section
23.3.9 Vital Signs Section
23.3.10 Dialysis Prescription Section
23.3.11 Reason for Referral Section
23.3.12 Goals Section
23.4.0 Further Reading
24.0.0 Bulk Operations
24.0.0 ETL Import Module
24.0.1 Importing CSV Data
24.0.2 Function: handleEtlImportRow(theInputMap, theContext)
24.0.3 Handling Multiple Import Formats
24.0.4 Initiating ETL Jobs
24.0.5 Performance and Concurrency
24.0.6 Locking Rows
24.0.7 Creating a Hashing Script
24.0.8 Asynchronous Execution
24.0.9 Performance
24.1.0 FHIR Bulk Export Operation
24.1.1 Enabling Bulk Export
24.1.2 Types of Bulk Export Requests
24.1.3 Request Parameters
24.1.4 Requesting A Bulk Extract
24.1.5 Retrieving Data
24.1.6 Authorization for Bulk Export
25.0.0 Monitoring
25.0.0 Monitoring Basics
25.0.1 HTTP Endpoint Health Check
25.0.2 Runtime Health Checks
25.1.0 Elastic APM Basics
25.1.1 What is APM?
25.1.2 Setting Up an APM Server
25.1.3 Instrumenting Smile CDR and the JVM
25.1.4 Accessing the User Interface
25.1.5 Configuring Settings for the Agent
25.1.6 Securing the Agent
26.0.0 Product Administration
26.0.0 Batch Job Management
27.0.0 JSON Admin Endpoints
27.0.0 JSON Admin API
27.0.1 Security
27.0.2 Format
27.0.3 Allowing Anonymous Access
27.1.0 Audit Log Endpoint
27.1.1 Fetch Audit Log
27.1.2 Fetch Individual Event
27.2.0 Batch Job Endpoint
27.2.1 Fetch Batch Job Names
27.2.2 Fetch All Instances
27.2.3 Stop Job Execution
27.2.4 Restart Job Execution
27.3.0 Bulk Import Endpoint
27.3.1 Process ETL File
27.3.2 Smileutil: CSV Bulk Import File
27.4.0 CDA Exchange Endpoint
27.4.1 Create CDA Template
27.4.2 Update CDA Template
27.4.3 Update CDA Template script via text
27.4.4 View CDA Template(s)
27.4.5 Delete CDA template
27.4.6 Use / Apply CDA Template
27.4.7 Create CDA from Composition/Bundle
27.4.8 Example CDA Template
27.5.0 Metrics Endpoint
27.5.1 Fetch Local Metrics
27.5.2 Capture Thread Dump
27.6.0 Module Config Endpoint
27.6.1 Fetch Config: Module Property File
27.6.2 Fetch Config: All Modules
27.6.3 Fetch Config: Single Module
27.6.4 Create Module
27.6.5 Set Module Config
27.6.6 Start Module
27.6.7 Stop Module
27.6.8 Restart Module
27.6.9 Archive Module
27.7.0 OpenID Connect Clients Endpoint
27.7.1 Fetch All OpenID Connect Client Definitions
27.7.2 Fetch Individual Client by Client ID
27.7.3 Create Client
27.7.4 Update Client
27.7.5 Create Client and generate secrets
27.8.0 OpenID Connect Servers Endpoint
27.8.1 Fetch All OpenID Connect Server Definitions
27.8.2 Find OpenID Connect Server Definition
27.8.3 Create OpenID Connect Server Definition
27.8.4 Update OpenID Connect Server Definition
27.9.0 OpenID Connect Sessions Endpoint
27.9.1 Fetch All Active Clients for User
27.9.2 Revoke Active Client for User
27.10.0 Runtime Status Endpoint
27.10.1 Fetch Complete Node Status Information
27.10.2 Fetch All Runtime Health Checks
27.11.0 System Config Endpoint
27.12.0 Transaction Log Endpoint
27.12.1 Fetch Transaction Log
27.12.2 Fetch Individual Event
27.13.0 User Management Endpoint
27.13.1 Search for Users (All Modules)
27.13.2 Search for Users (Specific Module)
27.13.3 Create User
27.13.4 Update User
27.13.5 Update Password
27.13.6 Update Own Password
27.13.7 Update Own Default Launch Contexts
27.13.8 2FA: Create New Key
27.13.9 2FA: Generate QR Code
27.13.10 2FA: Confirm Key
27.13.11 2FA: Delete Key
27.13.12 Invalidate All Sessions
28.0.0 Product Configuration
28.0.0 HTTP Server Setup
28.0.1 Respecting Forward Headers
28.0.2 Specifying a Custom Context Path
28.0.3 Access Logs
28.0.4 Frame Options
28.1.0 TLS and HTTPS Reference
28.1.1 Background
28.1.2 Creating a Self-Signed KeyStore
28.1.3 Importing a LetsEncrypt Certificate into a KeyStore
28.1.4 Selecting Ciphers and Protocol
28.1.5 Enabling TLS Mutual Authentication (Client Auth)
29.0.0 Java Execution Environment
29.0.0 Security Attributes
29.1.0 Library Support
29.2.0 Exception Handling
29.3.0 Javadocs
30.0.0 JavaScript Execution Environment
30.0.0 Introduction
30.1.0 Specifying JavaScript in Configuration File
30.2.0 Converter API
30.2.1 Method: hl7v2TsToFhirDate(dt);
30.2.2 Method: hl7v2TsToFhirDateTime(ts);
30.2.3 Method: hl7v2TsToFhirDateTime(ts, impliedTimeZone);
30.2.4 Method: urlDecode(string);
30.2.5 Method: urlEncode(string);
30.3.0 Environment API
30.4.0 Exceptions API
30.4.1 Method: Exceptions.newTrustedException(theMessage)
30.4.2 Method: Exceptions.newTrustedException(theStatusCode, theMessage)
30.5.0 OAuth2 Exceptions API
30.5.1 Method: OAuth2Exceptions.newUnauthorizedException(theMessage)
30.5.2 Method: OAuth2Exceptions.newForbiddenException(theMessage)
30.6.0 FHIR REST API
30.6.1 Method: create(resource)
30.6.2 Method: read(url)
30.6.3 Method: search().forResource(resourceType)
30.6.4 Method: transaction(IBundleBuilder theTransaction)
30.6.5 Method: translate()
30.6.6 Method: update(resource)
30.6.7 Method: patch(url, parameters)
30.6.8 Authentication
30.6.9 Tenant Selection
30.6.10 Concurrency Retry
30.7.0 FHIR Model API
30.7.1 Method: ResourceBuilder.build(resourceType)
30.7.2 Working with Resources
30.7.3 Working with Composition resources
30.7.4 Working with Bundle resources
30.7.5 Contained Resources
30.7.6 Meta Elements
30.7.7 Removing Data
30.8.0 HL7 v2.x Mapping API
30.8.1 Repetitions
30.8.2 Structure Interrogation
30.8.3 Content Clearing
30.8.4 Content Interrogation
30.8.5 Parsing Raw Field Values
30.8.6 Encoding
30.8.7 The Hl7V2 Object
30.8.8 Working with Variable Datatypes
30.8.9 Working with Z-Segments
30.9.0 HTTP API
30.9.1 Request Creation Methods
30.9.2 Request Execution Methods
30.9.3 Response Processing Methods
30.9.4 TLS / HTTPS
30.10.0 LDAP API
30.10.1 Method: searchByUsername(username)
30.10.2 Method: getStringAttributes(attributeName)
30.10.3 Method: isMemberOfGroup(groupDn)
30.11.0 Log API
30.11.1 Methods: debug(string), info(string), warn(string), error(string)
30.12.0 Composition Resource API
30.12.1 Method: set*(value)
30.12.2 Method: setDate(epoch)
30.12.3 Method: setType(documentType)
30.12.4 Method: addSection(sectionType)
30.13.0 Composition Section API
30.13.1 Method: populate(List resources)
30.13.2 Method: setTitle(title)
30.13.3 Method: setCode(system, code, display)
30.14.0 TransactionBuilder API
30.14.1 Method: newTransactionBuilder()
30.14.2 Method: withBundle(bundle)
30.14.3 Method: create(resource)
30.14.4 Method: update(resource)
30.14.5 Method: patch(resourceId, parameters)
30.14.6 Method Chain: createConditional(resource).onToken(parameter, system, value)
30.14.7 Method Chain: updateConditional(resource).onToken(parameter, system, value)
30.14.8 Methods: toXml(), toXml(prettyPrint), toJson(), toJson(prettyPrint)
30.14.9 Fhir.transaction(transaction)
30.15.0 Util API
30.15.1 Method: sleep(millis)
30.16.0 UUID API
30.16.1 Method: newPlaceholderId()
30.17.0 XML API
30.17.1 XPath Expressions
30.17.2 Function: getXPathValue(xpath)
30.17.3 Function: getXPathValues(xpath)
30.17.4 Function: getXPathElements(xpath)
30.18.0 Callback Models
30.18.1 AssociatedResource
30.18.2 AuthenticationContext
30.18.3 AuthenticationFailure
30.18.4 AuthenticationRequest
30.18.5 CsvProcessorContext
30.18.6 FhirEndpointTerminologyResponseMappingSpec
30.18.7 FhirEndpointTerminologyResponseMappingSpecSystem
30.18.8 GatewayConfiguration
30.18.9 GatewayOperation
30.18.10 GatewayOperationRoute
30.18.11 GatewayReadRoute
30.18.12 GatewayRouteTarget
30.18.13 GatewaySearchRoute
30.18.14 GatewayTarget
30.18.15 GrantedAuthority
30.18.16 Hl7V2GeneratedMessageContext
30.18.17 Hl7V2ReceivedMessage
30.18.18 Hl7V2ReceivedMessageConversionResult
30.18.19 LaunchContext
30.18.20 LaunchResourceId
30.18.21 OAuth2AuthorizationRequestDetails
30.18.22 OAuth2Client
30.18.23 OAuth2ClientSecret
30.18.24 OAuth2Clients
30.18.25 OAuth2Server
30.18.26 OAuth2Servers
30.18.27 OAuth2SmartContextSelectionChoicePerson
30.18.28 OAuth2SmartContextSelectionChoices
30.18.29 Oauth2InvalidateTokensResponseJson
30.18.30 PackageInstallationSpec
30.18.31 PartitionDefinition
30.18.32 PartitionDefinitions
30.18.33 RequestDetailsJson
30.18.34 ScriptAuthenticationOutcomeFactory
30.18.35 ScriptConsentContextServices
30.18.36 SecurityInLdapAuthenticationContext
30.18.37 SecurityInSmartAuthenticationContext
30.18.38 SmartCodapAuthorizationRequest
30.18.39 SmartOnPostAuthorizeDetails
30.18.40 UserDetails
30.18.41 UserDetailsChangeLaunchContextJson
30.18.42 UserDetailsList
30.18.43 UserDetailsOAuth2AllClientApprovals
30.18.44 UserDetailsOAuth2ClientApprovals
30.18.45 UserDetailsOAuth2ClientApprovalsApprovedScope
30.18.46 UserSessionDetails
31.0.0 Database Administration
31.0.0 Database Design
31.0.1 Cluster Manager Database
31.0.2 FHIR Relational Storage
31.0.3 FHIR MongoDB (Non-Relational) Storage
31.1.0 Setting Up PostgreSQL
31.1.1 Supported Versions
31.1.2 Creating a Database for Smile CDR
31.1.3 Database Connection Properties
31.1.4 Setting up a Cluster Manager Database
31.1.5 Setting up a FHIR Storage (Relational) Database
31.2.0 Troubleshooting PostgreSQL
31.2.1 Host Name Verification Error
31.3.0 Setting Up MySQL
31.3.1 Supported Versions
31.3.2 Creating a Database for Smile CDR
31.3.3 Database Connection Properties
31.3.4 Setting up a Cluster Manager Database
31.3.5 Setting up a FHIR Storage (Relational) Database
31.4.0 Setting Up MariaDB
31.4.1 Supported Versions
31.4.2 Creating a Database for Smile CDR
31.4.3 Database Connection Properties
31.4.4 Setting up a Cluster Manager Database
31.4.5 Setting up a FHIR Storage (Relational) Database
31.5.0 Setting Up Oracle
31.5.1 Supported Versions
31.5.2 Setting up a Cluster Manager Database
31.5.3 Setting up a FHIR Storage (Relational) Database
31.6.0 Setting Up SQL Server (MSSQL)
31.6.1 Supported Versions
31.6.2 Creating a Database for Smile CDR
31.6.3 Preparing an SQL Server Database for Smile CDR
31.6.4 Database Connection Properties
31.6.5 Setting up a Cluster Manager Database
31.6.6 Setting up a FHIR Storage (Relational) Database
32.0.0 Localization
32.0.0 Localization
32.1.0 Examples
32.1.1 Example: Unknown Search Parameter Message
32.1.2 Example: Custom SMART Scope Names
32.2.0 Available Localization Keys
33.0.0 Smile CDR CLI (smileutil)
33.0.0 Introduction
33.0.1 Enabling Debug Logging
33.0.2 Memory Settings
33.1.0 Execute Script Function
33.1.1 Usage
33.1.2 Options
33.1.3 A Complete Example: Authenticate
33.1.4 Available Functions
33.1.5 Function: authenticate
33.2.0 Create FHIR Package
33.2.1 Usage
33.2.2 Options
33.3.0 Export ConceptMap to CSV
33.3.1 Usage
33.3.2 Options
33.4.0 HL7 v2.x Analyze Flat File
33.4.1 Usage
33.4.2 Options
33.5.0 HL7 v2.x Transmit Flat File
33.5.1 Usage
33.5.2 Options
33.5.3 Multiplex Paths
33.6.0 Import CSV to ConceptMap
33.6.1 Usage
33.6.2 Options
33.7.0 Map and Upload CSV Bulk Import File
33.7.1 Usage
33.7.2 Options
33.8.0 Migrate Database
33.8.1 Options
33.8.2 Examples
33.8.3 Disabling Flyway
33.9.0 Synchronize FHIR Servers
33.9.1 Usage
33.9.2 Options
33.9.3 Selecting Resource Types to Synchronize
33.9.4 Using a Search as the Source
33.9.5 Using a Directory as the Source
33.9.6 Uploading Bundles as Transactions
33.9.7 Using Inline Match URLs
33.9.8 Prefixing Numeric IDs
33.9.9 Synchronization Modes
33.9.10 Uploading Synthea (Synthetic Generated) Resources
33.9.11 Setting up a Resource Gold Master
33.10.0 Upload Bundle Files
33.10.1 This Command Is Deprecated
33.10.2 Usage
33.10.3 Options
33.11.0 Upload CSV Bulk Import File
33.11.1 Usage
33.11.2 Options
33.11.3 Sending Batches for a Single File
33.12.0 Upload Sample Dataset
33.12.1 Usage
33.12.2 Options
33.13.0 Upload Terminology
33.13.1 Usage
33.13.2 Options
33.13.3 Example: Add Delta to Custom Terminology
33.14.0 Validate FHIR Resources
33.14.1 Usage
33.14.2 Options
33.14.3 Profile Mode
33.14.4 Schema and Schematron Mode
34.0.0 Modules
34.0.0 JSON Admin API
34.0.1 Configuration Categories
34.1.0 Web Admin Console
34.1.1 Configuration Categories
34.2.0 CDA Exchange
34.2.1 Configuration Categories
34.3.0 Channel Import
34.3.1 Configuration Categories
34.4.0 Cluster Manager
34.4.1 Configuration Categories
34.5.0 Enterprise Master Patient Index
34.5.1 Configuration Categories
34.6.0 CDS Hooks Endpoint
34.6.1 Configuration Categories
34.7.0 FHIR Gateway Endpoint
34.7.1 Configuration Categories
34.8.0 FHIR REST Endpoint (DSTU2)
34.8.1 Configuration Categories
34.9.0 FHIR REST Endpoint (DSTU3)
34.9.1 Configuration Categories
34.10.0 FHIR REST Endpoint (R4)
34.10.1 Configuration Categories
34.11.0 FHIRWeb Console
34.11.1 Configuration Categories
34.12.0 HL7 v2.x Listening Endpoint
34.12.1 Configuration Categories
34.13.0 HL7 v2.x Sending Endpoint
34.13.1 Configuration Categories
34.14.0 Hybrid Providers Endpoint
34.14.1 Configuration Categories
34.15.0 Package Registry Endpoint
34.15.1 Configuration Categories
34.16.0 Subscription Websocket Endpoint
34.16.1 Configuration Categories
34.17.0 ETL Importer
34.17.1 Configuration Categories
34.18.0 MDM
34.18.1 Configuration Categories
34.19.0 Narrative Generator
34.19.1 Configuration Categories
34.20.0 FHIR Storage (DSTU2 Relational)
34.20.1 Configuration Categories
34.21.0 FHIR Storage (R3 Relational)
34.21.1 Configuration Categories
34.22.0 FHIR Storage (Mongo)
34.22.1 Configuration Categories
34.23.0 FHIR Storage (R4 Relational)
34.23.1 Configuration Categories
34.24.0 Realtime Export
34.24.1 Configuration Categories
34.25.0 LDAP Inbound Security
34.25.1 Configuration Categories
34.26.0 Local Inbound Security
34.26.1 Configuration Categories
34.27.0 SAML Inbound Security
34.27.1 Configuration Categories
34.28.0 Scripted Inbound Security
34.28.1 Configuration Categories
34.29.0 SMART Inbound Security
34.29.1 Configuration Categories
34.30.0 SMART Outbound Security
34.30.1 Configuration Categories
34.31.0 SMART App Host
34.31.1 Configuration Categories
34.32.0 Subscription Matcher (All FHIR Versions)
34.32.1 Configuration Categories
34.33.0 Subscription Matcher (DSTU2 - Deprecated)
34.33.1 Configuration Categories
34.34.0 Subscription Matcher (DSTU3 - Deprecated)
34.34.1 Configuration Categories
34.35.0 Subscription Matcher (R4 - Deprecated)
34.35.1 Configuration Categories
34.36.0 App Management Tools
34.36.1 Configuration Categories
35.0.0 Configuration Categories
35.0.0 Web Admin Console Settings
35.0.1 Property: Transaction Log - Event Body Display Mode
35.1.0 App Management Tools
35.1.1 Property: JSON URL
35.1.2 Property: Auth URL
35.1.3 Property: Client ID
35.1.4 Property: Legal Company Name
35.1.5 Property: Admin Console Name
35.1.6 Property: Contact Helpdesk
35.1.7 Property: Contact Us URL
35.1.8 Property: FHIR URL
35.1.9 Property: Application Gallery Name
35.1.10 Property: Hero Image, Large Format URL
35.1.11 Property: Hero Image, Small Format URL
35.1.12 Property: Company Logo Small URL
35.1.13 Property: Company Logo Large URL
35.1.14 Property: PHI Warning URL
35.1.15 Property: Developer Portal Name
35.1.16 Property: Privacy Policy URL
35.1.17 Property: Request app mail-to
35.1.18 Property: Terms of Use URL
35.2.0 Initial App Management Tools Seeding
35.2.1 Property: Default Attestation (Legal)
35.2.2 Property: Default Attestation (Plain)
35.2.3 Property: Default Attestation Title
35.3.0 App Management Tools Email Server
35.3.1 Property: Email From Address
35.3.2 Property: Email SMTP Hostname
35.3.3 Property: Email SMTP Password
35.3.4 Property: Email SMTP Port
35.3.5 Property: Use STARTTLS for connection security
35.3.6 Property: Email SMTP Username
35.4.0 Authentication Callback Scripts
35.4.1 Property: Authentication Callback Script (File)
35.4.2 Property: Authentication Callback Script (Text)
35.5.0 Auth: General for APIs
35.5.1 Property: Anonymous Account Username
35.5.2 Property: Allow Anonymous Access
35.6.0 User Authentication
35.6.1 Property: Anonymous Account Username
35.6.2 Property: Allow Anonymous Access
35.6.3 Property: SAML Authentication Enabled
35.7.0 Auth: HTTP Basic
35.7.1 Property: HTTP Basic Security
35.7.2 Property: HTTP Basic Realm
35.8.0 Auth: OpenID Connect
35.8.1 Property: OpenID Connect Security
35.9.0 Browser Syntax Highlighting
35.9.1 Property: Browser Syntax Highlighting Enabled
35.9.2 Property: Show Request Headers
35.9.3 Property: Show Response Headers
35.10.0 Capability Statement (metadata)
35.10.1 Property: Cache Resource Counts (Mins)
35.10.2 Property: Include Resource Counts
35.11.0 CDA Generation
35.11.1 Property: Base URL for Local Resources
35.12.0 CDS Hooks
35.12.1 Property: FHIR Version
35.12.2 Property: Spring Context Config Class
35.13.0 Channel Import
35.13.1 Property: Concurrent Consumers
35.13.2 Property: Concurrent Retry Consumers
35.13.3 Property: Channel Name
35.13.4 Property: Default mediaType
35.13.5 Property: Channel Import ETL Script (File)
35.13.6 Property: Channel Import ETL Script (Text)
35.14.0 Channel Retry
35.14.1 Property: Failure Channel Name
35.14.2 Property: Retry Delay(ms)
35.14.3 Property: Maximum amount of retry attempts.
35.14.4 Property: Maximum Delay(ms) between attempts.
35.14.5 Property: Retry Channel Name
35.14.6 Property: Retriable Exceptions
35.14.7 Property: Retry Strategy
35.15.0 Cluster Manager Maintenance
35.15.1 Property: Audit Log Broker Enabled
35.15.2 Property: Audit Log Database Async Writes
35.15.3 Property: Audit Log Database Enabled
35.15.4 Property: Request headers to store
35.15.5 Property: Stats Retention (Days) - Day Level
35.15.6 Property: Stats Retention (Days) - Hour Level
35.15.7 Property: Stats Retention (Days) - Minute Level
35.15.8 Property: Transaction Log Retention (Days)
35.15.9 Property: Scheduler Thread Count
35.15.10 Property: Heartbeat Persist Frequency MS
35.15.11 Property: Stats Cleanup Frequency MS
35.15.12 Property: Stats Persist Frequency MS
35.16.0 Cluster Manager Message Broker
35.16.1 Property: Message Broker Address
35.16.2 Property: Channel Naming Prefix
35.16.3 Property: Message Broker Password
35.16.4 Property: Message Broker Type
35.16.5 Property: Message Broker Username
35.17.0 Cluster Manager Kafka
35.17.1 Property: Kafka Consumer Ack Mode
35.17.2 Property: Kafka Consumer Auto Commit Enabled
35.17.3 Property: Kafka Bootstrap Address
35.17.4 Property: Kafka Consumer Config Properties (File)
35.17.5 Property: Kafka Consumer Config Properties (Text)
35.17.6 Property: Kafka Subscription Matcher Consumer Group Id
35.17.7 Property: Kafka Producer Config Properties (File)
35.17.8 Property: Kafka Producer Config Properties (Text)
35.17.9 Property: Kafka SASL JAAS Config
35.17.10 Property: Kafka SASL Mechanism
35.17.11 Property: Kafka Security Protocol
35.17.12 Property: Kafka Broker SSL Enabled
35.17.13 Property: Kafka SSL Key Password
35.17.14 Property: Kafka SSL Keystore Location
35.17.15 Property: Kafka Keystore Password
35.17.16 Property: Kafka SSL TrustStore File Location
35.17.17 Property: Kafka SSL Truststore Password
35.17.18 Property: Validate Kafka Topics Exist Before Use
35.18.0 Credentials
35.18.1 Property: Cache Successful Credentials
35.18.2 Property: Create Unknown Users
35.18.3 Property: Lock After Failed Attempts
35.18.4 Property: Case-Sensitive Passwords
35.18.5 Property: Password Encoding Scheme
35.18.6 Property: Password Mismatch Error
35.18.7 Property: Minimum Password Requirements
35.18.8 Property: Case-Sensitive Usernames
35.19.0 Cross-Origin Resource Sharing (CORS)
35.19.1 Property: CORS Enabled
35.19.2 Property: CORS Origins
35.20.0 Database
35.20.1 Property: Default Query Timeout (Seconds)
35.20.2 Property: Max Idle Connections
35.20.3 Property: Connection Max Lifetime (millis)
35.20.4 Property: Max Total Connections
35.20.5 Property: Max Wait (Seconds)
35.20.6 Property: Min Idle Connections
35.20.7 Property: Pool Prepared Statements
35.20.8 Property: Test Connections on Return
35.20.9 Property: Database Type
35.20.10 Property: Expect database to be writable
35.20.11 Property: Database Password
35.20.12 Property: Database Update Mode
35.20.13 Property: DB Secrets Manager
35.20.14 Property: SQL Parameter Bind Mode
35.20.15 Property: Database Connection URL
35.20.16 Property: Database Username
35.20.17 Property: Default Page Size
35.20.18 Property: FHIR Version
35.20.19 Property: Maximum Page Size
35.20.20 Property: Use ordinal date values for day precision searches.
35.21.0 ETL Import: CSV Properties
35.21.1 Property: CSV File Delimiter
35.21.2 Property: Parse Quotes
35.22.0 ETL Import: Source
35.22.1 Property: Async Mode Batch Size
35.22.2 Property: Asynchronous Mode Enabled
35.22.3 Property: Async Mode File Size
35.22.4 Property: Import Source
35.22.5 Property: Mapping Script
35.22.6 Property: Worker Row Hashing Function
35.22.7 Property: Worker Thread Count
35.22.8 Property: Synchronous Mode: Continue On Failure
35.22.9 Property: Enable Transaction Log
35.23.0 FHIR Binary Storage
35.23.1 Property: Binary Access Operations Enabled
35.23.2 Property: Filesystem Mode: Base Directory
35.23.3 Property: Binary Storage Mode
35.23.4 Property: Maximum Size (bytes)
35.23.5 Property: Minimum Size (bytes)
35.24.0 FHIR Bulk Operations
35.24.1 Property: FHIR Bulk Export Enabled
35.24.2 Property: Bulk Import Auto-Retry Maximum Count
35.25.0 FHIR Configuration
35.25.1 Property: Cascading Deletes Enabled
35.25.2 Property: Allow External References Enabled
35.25.3 Property: Allow Inline Match URL References Enabled
35.25.4 Property: Allow Multiple Delete Enabled
35.25.5 Property: Allow storing all bundle types
35.25.6 Property: Auto-Create Placeholder Reference Targets
35.25.7 Property: Client ID Mode
35.25.8 Property: Delete Child Resource Count
35.25.9 Property: Delete Expunge Enabled
35.25.10 Property: Enforce Reference Target Types
35.25.11 Property: Disable Deletion Ref Checks for Paths
35.25.12 Property: Enforce Referential Integrity on Delete
35.25.13 Property: Enforce Referential Integrity on Write
35.25.14 Property: Expunge Operation Enabled
35.25.15 Property: Mark Resources for Reindexing after SearchParameter change
35.25.16 Property: Server ID Mode
35.25.17 Property: Store Meta.source information
35.25.18 Property: Tag Storage Mode
35.25.19 Property: Seed Base Validation Resources
35.26.0 FHIR Capability Statement
35.26.1 Property: Copyright Message
35.26.2 Property: Implementation Description
35.26.3 Property: Enable OpenAPI / Swagger Support
35.27.0 FHIR Consent Service
35.27.1 Property: Consent Service Enabled
35.27.2 Property: Consent Service Script (File)
35.27.3 Property: Consent Service Script (Text)
35.28.0 FHIR Endpoint Terminology
35.28.1 Property: Populate Response Coding Displays
35.28.2 Property: Response Mapping
35.28.3 Property: Mapping Spec (Text)
35.29.0 FHIR LiveBundle Service
35.29.1 Property: LiveBundle Enabled
35.29.2 Property: LiveBundle Rule Definition Script (File)
35.29.3 Property: LiveBundle Rule Definition Script (Text)
35.29.4 Property: LiveBundle Thread Count
35.29.5 Property: LiveBundle Watchlist Cache Enabled
35.30.0 FHIR Endpoint Conversion
35.30.1 Property: Versioned API Mode
35.31.0 FHIR Endpoint Security
35.31.1 Property: Automatically Narrow Search Scope
35.31.2 Property: Reject Insufficient Permissions with HTTP 401
35.32.0 Interceptors
35.32.1 Property: Can Replace Authorization Interceptor
35.32.2 Property: Interceptor Bean Types
35.33.0 FHIR Endpoint Partitioning and Multitenancy
35.33.1 Property: Tenant Identification Strategy
35.33.2 Property: Tenant Name
35.34.0 FHIR Gateway Config
35.34.1 Property: FHIR Version
35.34.2 Property: Gateway Configuration (File)
35.34.3 Property: Gateway Configuration (Text)
35.34.4 Property: Encryption JWKS (File)
35.34.5 Property: Encryption JWKS (Text)
35.35.0 FHIR MDM Server
35.35.1 Property: MDM Mode Enabled (Experimental)
35.35.2 Property: Search Expanding Interceptor Enabled (Experimental)
35.36.0 FHIR Storage Partitioning and Multitenancy
35.36.1 Property: Cross-Partition Reference Mode
35.36.2 Property: Default Partition ID
35.36.3 Property: Partitioning Enabled
35.36.4 Property: Partition Naming Mode
35.36.5 Property: Partition Selection Mode
35.36.6 Property: Partition Seed File
35.37.0 FHIR Storage Package Registry
35.37.1 Property: Package Pre-Seed Installation Spec Files
35.38.0 Versioned References
35.38.1 Property: Allow Versioned References at All Paths
35.38.2 Property: Allow Versioned References at Paths
35.38.3 Property: Automatically Version References at Paths
35.38.4 Property: Respect Versioned References for _include
35.39.0 FHIR Performance
35.39.1 Property: Default Total Calculation Mode
35.39.2 Property: Delete Enabled
35.39.3 Property: Expire Search Results After Minutes
35.39.4 Property: Expunge Batch Size
35.39.5 Property: Expunge Thread Count
35.39.6 Property: Internal Synchronous Search Size
35.39.7 Property: Mass Ingestion Mode
35.39.8 Property: Match URL Cache Enabled
35.39.9 Property: Maximum Transaction Bundle Size
35.39.10 Property: Reindex Thread Count
35.39.11 Property: Reuse Cached Results Timeout (Millis)
35.39.12 Property: Index Missing Search Params
35.39.13 Property: Suppress Scheduled Maintenance Jobs
35.39.14 Property: Write-Semaphore Mode: Enabled
35.39.15 Property: Write-Semaphore Mode: Log Waits
35.40.0 FHIR Performance Tracing
35.40.1 Property: Capture Raw SQL or Equivalent
35.40.2 Property: Trigger
35.40.3 Property: Performance Tracing Enabled
35.40.4 Property: Output to Response Headers
35.40.5 Property: Output to System Log
35.40.6 Property: Output to Transaction Log
35.41.0 FHIR Storage Scheduled Tasks
35.41.1 Property: Batch Job Executor: Maximum Thread Count
35.41.2 Property: Bulk Export Task Enabled
35.41.3 Property: Bulk Import Task Enabled
35.41.4 Property: Delete Stale Searches Task Enabled
35.41.5 Property: Pre-Expand ValueSets Task Enabled
35.41.6 Property: Resource Reindexing Task Enabled
35.42.0 FHIR Realtime Export
35.42.1 Property: Pointcut-based Realtime Export Mode Enabled
35.43.0 FHIR Resource Types
35.43.1 Property: Resource Types (whitelist)
35.44.0 FHIR REST Endpoint
35.44.1 Property: Fixed Value for Endpoint Base URL
35.44.2 Property: Default Encoding
35.44.3 Property: Default Prefer Return
35.44.4 Property: Pretty-Print by Default
35.44.5 Property: Process Header: Request Source
35.44.6 Property: Serve Raw Media Resources
35.45.0 FHIR Search
35.45.1 Property: Always use Offset Searches
35.45.2 Property: Allow :contains Searches
35.45.3 Property: Fetch Size (Default Maximum)
35.45.4 Property: Index Contained Resources
35.45.5 Property: Legacy Date Index Mode
35.45.6 Property: Max Includes per Page
35.45.7 Property: Use New Search SQL Builder (2020)
35.45.8 Property: Use ordinal date values for day precision searches.
35.45.9 Property: Filter Search Parameter Enabled
35.45.10 Property: GraphQL Enabled
35.45.11 Property: Page Size (Default)
35.45.12 Property: Page Size (Maximum)
35.45.13 Property: Phonetic Encoder
35.45.14 Property: Infinispan Cache Name
35.45.15 Property: Infinispan Hot Rod Protocol Version. Note that you will need to include an appropriate driver client JAR in the customer_lib directory of your installation.
35.45.16 Property: Infinispan Servers
35.45.17 Property: Search Cache Storage
35.45.18 Property: Suppress String Indexing In Tokens
35.46.0 FHIR Interceptors
35.46.1 Property: FHIR storage Callback Script (File)
35.46.2 Property: FHIR storage Callback Script (Text)
35.46.3 Property: Interceptor Bean Types
35.47.0 FHIR Repository Validation
35.47.1 Property: Repository Validation Javascript (File)
35.47.2 Property: Repository Validation Javascript (Text)
35.48.0 FHIR Subscription Persistence
35.48.1 Property: Consumers Per Delivery Queue
35.48.2 Property: Matching Queue Consumers
35.48.3 Property: Email Subscription Enabled
35.48.4 Property: Message Subscription Enabled
35.48.5 Property: REST Hook Subscription Enabled
35.48.6 Property: Trigger Subscriptions on Non-Versioning Changes
35.48.7 Property: Websocket Subscription Enabled
35.49.0 FHIR Subscription Delivery
35.49.1 Property: Subscription Delivery Queue Naming
35.49.2 Property: Email SMTP Hostname
35.49.3 Property: Email SMTP Password
35.49.4 Property: Email SMTP Port
35.49.5 Property: Use STARTTLS for connection security
35.49.6 Property: Email SMTP Username
35.49.7 Property: Email From Address
35.50.0 FHIR Validation Services
35.50.1 Property: Remote Terminology Service: Base URL
35.50.2 Property: Remote Terminology Service: Enabled
35.50.3 Property: Remote Terminology Service: Log HTTP Calls
35.50.4 Property: Local Reference Policy
35.50.5 Property: Suppress Validation Message Patterns
35.50.6 Property: Unknown CodeSystem Validation Policy
35.51.0 HL7 v2.x to FHIR Mapper - Forced Namespace Mode
35.51.1 Property: Forced Namespace Mode: Encounter System
35.51.2 Property: Forced Namespace Mode: Patient System
35.52.0 HL7 v2.x to FHIR Mapper - General
35.52.1 Property: Create MessageHeader for Each Message
35.52.2 Property: Creation Mode - Practitioner
35.52.3 Property: Patient Primary Identifier Search Parameter
35.52.4 Property: Inferred TimeZone When Not Present
35.52.5 Property: Mapper Bean Types
35.52.6 Property: MessageHeader Hardcoded Destination Name
35.52.7 Property: Process AL1 Segments
35.53.0 HL7 v2.x Mapper - Medications
35.53.1 Property: Use Standalone Medications with Administered Code
35.53.2 Property: Use Standalone Medications with Component Code
35.53.3 Property: Use Standalone Medications with Give Code
35.54.0 HL7 v2.x to FHIR Mapper - OBR
35.54.1 Property: Observation Identification Mode
35.54.2 Property: Use OBR-2 as Primary Identifier
35.54.3 Property: Use OBR-3 as Primary Identifier
35.55.0 HL7 v2.x to FHIR Mapper - OBSERVATION Group
35.55.1 Property: OBSERVATION Group Text Delimiter - NTE
35.55.2 Property: OBSERVATION Group Text Delimiter - OBX
35.56.0 HL7 v2.x to FHIR Mapper - ORDER_OBSERVATION Group
35.56.1 Property: ORDER_OBSERVATION Group Text Delimiter - NTE
35.57.0 HL7 v2.x to FHIR Mapper - PV1
35.57.1 Property: Parse Encounter Providers
35.57.2 Property: Treat PV1-3 and PV1-6 Patient Locations as Single Atomic Locations
35.58.0 HL7 v2.x Listener Script
35.58.1 Property: Listener Processing Script (File)
35.58.2 Property: Listener Processing Script (Text)
35.59.0 HL7 v2.x MLLP Listener
35.59.1 Property: Charset: Forced
35.59.2 Property: Charset: Respect MSH-18
35.59.3 Property: HL7 v2.x Listener Port
35.59.4 Property: Socket Timeout (Millis)
35.59.5 Property: Storage Tenant Name
35.59.6 Property: Transport Protocol
35.59.7 Property: Unprocessable Message Handling
35.60.0 FHIR to HL7 v2.x Mapper Script
35.60.1 Property: HL7 v2.x Conversion Mapper Script (File)
35.60.2 Property: HL7 v2.x Conversion Mapper Script (Text)
35.61.0 HL7 v2.x Outbound Mapping
35.61.1 Property: Map Identifiers using NamingSystem
35.61.2 Property: Populate AL1 Segments
35.61.3 Property: Populate Encounter Participants in PV1
35.61.4 Property: Use Persisted Message Headers
35.62.0 HL7 v2.x MLLP Sender
35.62.1 Property: Delay Between Failed Deliveries (millis)
35.62.2 Property: HL7 v2.x Destination Host
35.62.3 Property: Request Path
35.62.4 Property: HL7 v2.x Destination Port
35.62.5 Property: Retry message on NAK
35.62.6 Property: Send Timeout (millis)
35.62.7 Property: Transport Protocol
35.63.0 HTTP Access Log
35.63.1 Property: Appenders
35.64.0 HTTP Listener
35.64.1 Property: Bind Address
35.64.2 Property: Context Path
35.64.3 Property: Endpoint Health Path
35.64.4 Property: HTTPS Forwarding Assumed
35.64.5 Property: Listener Port
35.64.6 Property: Respect Forward Headers
35.65.0 HTTP Request Pool
35.65.1 Property: Maximum Request Header Size (KB)
35.65.2 Property: Maximum Response Header Size (KB)
35.65.3 Property: Read Idle Timeout (millis)
35.65.4 Property: Thread Pool Accept Queue Size
35.65.5 Property: Thread Pool Maximum Size
35.65.6 Property: Thread Pool Minimum Size
35.66.0 HTTP Security
35.66.1 Property: Block HTTP HEAD
35.66.2 Property: Block HTTP OPTIONS
35.66.3 Property: Frame Options (Allow From)
35.66.4 Property: Pin Host
35.66.5 Property: Suppress Error Details
35.66.6 Property: Suppress Platform Information
35.67.0 Hybrid Providers Definitions
35.67.1 Property: Search Bundle Inclusion Rule
35.67.2 Property: FHIR Version
35.67.3 Property: Spring Context Config Class
35.68.0 Initial User Seeding
35.68.1 Property: Users Seed File
35.69.0 JSON Web KeySet (JWKS)
35.69.1 Property: Signing JWKS (File)
35.69.2 Property: Signing JWKS (Text)
35.69.3 Property: Signing Key ID
35.70.0 LDAP Authentication
35.70.1 Property: Authentication: User Attributes to query
35.70.2 Property: Authentication: User Base DN
35.70.3 Property: Authentication: User Query
35.70.4 Property: Require Group DN
35.70.5 Property: Base DN for Groups
35.70.6 Property: Search Groups Recursively
35.70.7 Property: System User DN
35.70.8 Property: System User Password
35.70.9 Property: LDAP Server URL
35.70.10 Property: Global Permissions
35.70.11 Property: Native Permission User Attribute
35.70.12 Property: User Attribute: Family Name
35.70.13 Property: User Attribute: Given Name
35.71.0 Lucene FullText Indexing
35.71.1 Property: Lucene Index Directory
35.71.2 Property: ElasticSearch Password
35.71.3 Property: ElasticSearch URL protocol. Either http or https
35.71.4 Property: ElasticSearch URL
35.71.5 Property: ElasticSearch Username
35.71.6 Property: Enable FullText Content Index
35.71.7 Property: Enable Terminology Index
35.71.8 Property: Lucene Indexing Provider
35.71.9 Property: Lucene Indexing Enabled
35.72.0 Narrative Generator
35.72.1 Property: Narrative Template Manifest File
35.73.0 Master Data Management
35.73.1 Property: MDM Consumer Thread Count
35.73.2 Property: Prevent modification of External EIDs
35.73.3 Property: Prevent multiple EIDs from existing simultaneously on a target resource
35.73.4 Property: MDM Rule Definition Script (File)
35.73.5 Property: MDM Rule Definition Script (Text)
35.73.6 Property: MDM Survivorship Script (File)
35.73.7 Property: MDM Survivorship Script (Text)
35.74.0 OpenID Connect (OIDC)
35.74.1 Property: Cache Authorizations (millis)
35.74.2 Property: Client Secret Encoding
35.74.3 Property: Smile CDR generated Client Secret expiry duration in days
35.74.4 Property: Issuer URL
35.74.5 Property: PKCE Plain Challenge Supported
35.74.6 Property: PKCE Required
35.74.7 Property: Rotate Refresh Token After Use
35.74.8 Property: Smart Capabilities List
35.75.0 Realtime Export
35.75.1 Property: Concurrent Consumers
35.75.2 Property: Import Channel Name
35.75.3 Property: Channel Name Prefix
35.75.4 Property: Realtime Export Script (File)
35.75.5 Property: Realtime Export Script (Text)
35.75.6 Property: Published Data source
35.75.7 Property: Transaction-Based Processing
35.76.0 Request Validating
35.76.1 Property: Request Validating Bean Types
35.76.2 Property: Request Validating Enabled
35.76.3 Property: Fail On Severity
35.76.4 Property: Validation Response Headers Enabled
35.76.5 Property: Validation Tags Enabled
35.77.0 Search Parameter Seeding
35.77.1 Property: Disable Patterns
35.77.2 Property: Enable Patterns
35.78.0 Security Inbound Script
35.78.1 Property: Script (File)
35.78.2 Property: HTTP Headers
35.78.3 Property: Script (Text)
35.79.0 Inbound SMART on FHIR Authentication
35.79.1 Property: Authentication Cache Timeout (Seconds)
35.79.2 Property: Prevent Token KeyID Reuse
35.79.3 Property: Require Key Expiry
35.79.4 Property: Scopes Supported
35.79.5 Property: Trust Intra-Cluster SMART Tokens from Module(s)
35.80.0 Inbound SMART on FHIR Endpoints
35.80.1 Property: Authorization Endpoint
35.80.2 Property: Token Endpoint
35.81.0 OpenID Connect Token Validation
35.81.1 Property: Token Introspection Client: Truststore File
35.81.2 Property: Token Introspection Client: Truststore Password
35.82.0 SAML Provider
35.82.1 Property: Relying Party Entity ID Template
35.82.2 Property: Issuer ID
35.82.3 Property: Keystore File
35.82.4 Property: Keystore Password
35.82.5 Property: Registration ID
35.82.6 Property: Sign Auth Request
35.82.7 Property: Signing Key Alias
35.82.8 Property: Signing Key Password
35.82.9 Property: Verification Certificate Alias
35.82.10 Property: Web SSO URL
35.83.0 OAuth2/OIDC Federation
35.83.1 Property: Federated OAuth2/OIDC Login
35.84.0 SMART Authorization
35.84.1 Property: Enforce Approved Scopes to Restrict Permissions
35.84.2 Property: Scopes Supported
35.85.0 SMART Definitions Seeding
35.85.1 Property: OpenID Connect Client Pre-Seed File
35.85.2 Property: OpenID Connect Server Pre-Seed File
35.86.0 Sessions
35.86.1 Property: Use In-Memory Sessions
35.86.2 Property: Session Scavenger Interval (Millis)
35.86.3 Property: Session Timeout (Mins)
35.87.0 SMART Outbound Security: Callback Script
35.87.1 Property: Post Authorization Script (File)
35.87.2 Property: Post Authorization Script (Text)
35.88.0 SMART Outbound Security: CODAP
35.88.1 Property: CODAP Authorization Script (File)
35.88.2 Property: CODAP Authorization Script (Text)
35.88.3 Property: Enable Cross-Organization Data Access Profile
35.89.0 SMART Outbound Security: Login Skin
35.89.1 Property: Approval Page Template
35.89.2 Property: Error Page Template
35.89.3 Property: Login Page (Federated OAuth2/OIDC) Template
35.89.4 Property: Login Page Template
35.89.5 Property: User Self Registration Template (Step 1)
35.89.6 Property: User Self Registration Template (Step 2)
35.89.7 Property: Session Management Page Template
35.89.8 Property: Two Factor Authentication Page Template
35.89.9 Property: Terms-of-service click-wrap Page Template
35.89.10 Property: WebJar ID
35.90.0 SMART Outbound Security: Terms of Service
35.90.1 Property: Current version of terms.
35.91.0 Two Factor Authentication
35.91.1 Property: TOTP Issuer Name
35.91.2 Property: Lock After Failed Attempts
35.92.0 TLS / SSL (Encryption)
35.92.1 Property: TLS Client Authentication
35.92.2 Property: TLS Enabled
35.92.3 Property: TLS KeyStore Filename
35.92.4 Property: TLS KeyStore Key Alias
35.92.5 Property: TLS KeyStore Key Password
35.92.6 Property: TLS KeyStore Password
35.92.7 Property: TLS Cipher Blacklist
35.92.8 Property: TLS Cipher Whitelist
35.92.9 Property: TLS Protocol Blacklist
35.92.10 Property: TLS Protocol Whitelist
35.92.11 Property: TLS TrustStore Filename
35.92.12 Property: TLS TrustStore Password
35.93.0 Trusted Client
35.93.1 Property: Assert Permissions
35.93.2 Property: Trusted Client Mode Enabled
35.94.0 Transaction Log
35.94.1 Property: Transaction Log Enabled
35.94.2 Property: Event Blacklist
35.94.3 Property: Event Whitelist
35.94.4 Property: Persist Transaction Bodies (Global)
35.94.5 Property: Persist Transaction Bodies: Incoming Request
35.94.6 Property: Persist Transaction Bodies: Incoming Response
35.94.7 Property: Truncate Transaction Bodies (bytes)
35.95.0 User Self Registration
35.95.1 Property: User Self Registration Script (File)
35.95.2 Property: User Self Registration Script (Text)
35.95.3 Property: User Self Registration Enabled
36.0.0 Product Reference
36.0.0 Enumerated Types
36.0.1 Node And Module Status
36.0.2 Transaction Log Outcomes
36.0.3 Module Types
37.0.0 Appendix
37.0.0 Preparing a Linux Host
37.0.1 Ubuntu Host with PostgreSQL / NGINX / Letsencrypt
37.0.2 Install letsencrypt and obtain Certs (optional)
37.0.3 Install nginx And Configure it to Front the Server
37.0.4 Red Hat Enterprise Linux (RHEL) or CentOS
37.1.0 Production Checklist
37.1.1 Host Server Setup
37.1.2 Network Infrastructure
37.1.3 CDR Process Settings
37.1.4 FHIR Server Performance
37.1.5 Monitoring
37.1.6 Security
37.1.7 Message Broker
37.1.8 Cluster Design
37.2.0 Installing Smile CDR, NGINX and PostgreSQL in a Docker Stack
37.2.1 Initial Setup of Docker and Context
37.2.2 Prepare Configuration for Smile CDR Docker Service
37.2.3 Prepare Configuration for NGINX Docker Service
37.2.4 Prepare Configuration for PostgreSQL Docker Service
37.2.5 Create Docker compose file for Smile CDR Docker stack
37.2.6 Build and Launch Smile CDR Stack
37.3.0 Deploying a Kubernetes Managed Cluster
37.3.1 Overview of Smile CDR Kubernetes Deployment Process
37.3.2 Pre-requisite Steps
37.3.3 Configuring Kubernetes
37.3.4 Service Definitions
37.3.5 ConfigMap Definitions
37.3.6 Deployment Definitions
37.3.7 Deploying Smile CDR in a Kubernetes Cluster
37.3.8 Configuring Reverse Proxy and Load Balancer
37.3.9 Considerations When Deploying Smile CDR Using OpenShift
37.4.0 Password Hashing Algorithms
37.4.1 Available Algorithms
37.5.0 Resource Paths
37.6.0 JWT Signature Algorithms
37.7.0 Inferno Considerations