Smile CDR v2022.08.PRE
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 Smile CDR Maturity Model
1.1.1 List of Levels
1.1.2 Experimental Features
1.1.3 Trial Features
1.1.4 Deprecated Features
1.2.0 List of Features by Maturity
1.2.1 Experimental Features
1.2.2 Trial Features
1.2.3 Deprecated Features
1.3.0 Changelog (2022 Releases)
1.3.1 Smile CDR 2022.08.R01 (Pre-Release)
1.3.2 Smile CDR 2022.05.R01
1.3.3 Smile CDR 2022.02.R04 (Sojourner)
1.3.4 Smile CDR 2022.02.R03 (Sojourner)
1.3.5 Smile CDR 2022.02.R02 (Sojourner)
1.3.6 Smile CDR 2022.02.R01 (Sojourner)
1.3.7 Smile CDR 2021.11.R05 (Raccoon)
1.3.8 Smile CDR 2021.11.R04 (Raccoon)
1.3.9 Smile CDR 2021.08.R08
1.4.0 Changelog (2021 Releases)
1.4.1 Smile CDR 2021.11.R03 (Raccoon)
1.4.2 Smile CDR 2021.11.R02 (Raccoon)
1.4.3 Smile CDR 2021.11.R01 (Raccoon)
1.4.4 Smile CDR 2021.08.R05 (Quasar)
1.4.5 Smile CDR 2021.08.R04 (Quasar)
1.4.6 Smile CDR 2021.08.R03 (Quasar)
1.4.7 Smile CDR 2021.08.R02 (Quasar)
1.4.8 Smile CDR 2021.08.R01 (Quasar)
1.4.9 Smile CDR 2021.05.R03 (Pangolin)
1.4.10 Smile CDR 2021.05.R02 (Pangolin)
1.4.11 Smile CDR 2021.05.R01 (Pangolin)
1.4.12 Smile CDR 2021.02.R05 (Odyssey)
1.4.13 Smile CDR 2021.02.R04 (Odyssey)
1.4.14 Smile CDR 2021.02.R03 (Odyssey)
1.4.15 Smile CDR 2021.02.R02 (Odyssey)
1.4.16 Smile CDR 2021.02.R01 (Odyssey)
1.4.17 Smile CDR 2020.11.R02 (Numbat)
1.5.0 Changelog (2020 Releases)
1.5.1 Smile CDR 2020.11.R01 (Numbat)
1.5.2 Smile CDR 2020.08.R03 (Manticore)
1.5.3 Smile CDR 2020.08.R02 (Manticore)
1.5.4 Smile CDR 2020.08.R01 (Manticore)
1.5.5 Smile CDR 2020.05.R02 (Labrador)
1.5.6 Smile CDR 2020.05.R01 (Labrador)
1.5.7 Smile CDR 2020.02.R01 (Koala)
1.6.0 Changelog (2019 Releases)
1.6.1 Smile CDR 2019.11.R01 (Jitterbug)
1.6.2 Smile CDR 2019.08.R01 (Igloo)
1.6.3 Smile CDR 2019.05.R01 (Hippo)
1.6.4 Smile CDR 2019.02.R01 (Gale)
1.7.0 Changelog (2018 Releases)
1.7.1 Smile CDR 2018.11.R01 (Food)
1.7.2 Smile CDR 2018.09.R01 (Economist)
1.7.3 Smile CDR 2018.05.R01 (Dromedário)
1.7.4 Smile CDR 2018.03.R01 (Crouton)
1.8.0 Changelog (2017 Releases)
1.8.1 Smile CDR 2017.11.R01 (Buccaneer)
1.8.2 Smile CDR 2017.09.R01 (Aardvark)
1.8.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
2.1.5 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: ActiveMQ
3.6.1 Resource Limits
3.7.0 Message Broker: Kafka
3.7.1 Kafka Topic Names
3.7.2 Kafka - Overriding Default Configuration Settings
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
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 Modules
5.1.1 Feature Comparison Summary
5.1.2 Features
5.1.3 FHIR Operations
5.1.4 Search Parameters
5.1.5 Search Parameter Types
5.2.0 FHIR Endpoint Module
5.2.1 Creating the Module
5.2.2 Capturing Source Information
5.2.3 Validation
5.2.4 Configuration
5.3.0 FHIRWeb Console
5.3.1 Architecture
5.3.2 Security
5.3.3 Creating the Module
5.3.4 Using the Console
5.3.5 Configuration
5.4.0 OpenAPI / Swagger Support
5.4.1 Swagger UI
5.4.2 OpenID Connect Support
5.4.3 Limitations
5.5.0 Resource IDs
5.5.1 Server Assigned IDs
5.5.2 Client Assigned IDs
5.6.0 Search Parameters
5.6.1 Search Parameter Concepts
5.6.2 Default Search Parameters
5.6.3 Managing Search Parameters
5.6.4 Search Parameter Statistics
5.6.5 Filter Search Parameter
5.6.6 Manual Reindexing
5.6.7 $reindex Operation
5.6.8 Legacy Manual Reindex Operation
5.7.0 Search Parameter Features
5.7.1 Searching by English nickname (:nickname)
5.7.2 Index Missing Search Parameters (:missing)
5.7.3 Suppress Text Index on Tokens (:text)
5.7.4 Index Contained Resources
5.8.0 Phonetic Search Parameters
5.9.0 Custom Search Parameters
5.9.1 An Example Search Parameter
5.9.2 Search Parameter Expressions
5.9.3 Combo Search Index Parameters
5.9.4 Enforcing Uniqueness
5.10.0 Search Parameter Tuning
5.10.1 Checking Active Parameters
5.10.2 Seeding Search Parameters
5.11.0 Searching for Data
5.11.1 FHIR Search Extensions
5.11.2 Unsupported Search Parameters
5.11.3 Limitations
5.12.0 Creating Data
5.12.1 Validating References and Referential Integrity
5.12.2 Transactions and Submitting Bundles
5.12.3 Auto-Creating Reference Targets
5.12.4 Transaction With Conditional Create
5.12.5 Auto-Create Placeholder Reference Targets
5.12.6 Auto-Create Placeholder Reference Targets with Identifier
5.12.7 Auto-Created Placeholder Extension
5.12.8 Searching for Auto-Created Resources
5.12.9 Auto-Creating Reference Targets and Enforcing Uniqueness
5.12.10 Mass Ingestion Mode
5.13.0 Reading Data
5.13.1 Diff Operation
5.13.2 Diff Instance
5.13.3 Diff Type
5.13.4 $everything operation
5.14.0 Updating Data
5.14.1 Patching Data
5.14.2 Tag Retention
5.14.3 Concurrent Write Errors
5.15.0 Deleting Data
5.15.1 Deletes and Referential Integrity
5.15.2 Transactional Delete
5.15.3 Referential Integrity
5.15.4 Cascading Deletes
5.15.5 The $expunge Operation
5.16.0 Binary Data
5.16.1 Externalized Binary Storage
5.16.2 Binary Access Operations
5.16.3 Serving Raw Media Resources
5.16.4 Serving binary data within a FHIR Resource
5.17.0 Request Tracing and Provenance
5.17.1 Request Tracing
5.17.2 Performance Tracing
5.17.3 Storing Source Information
5.18.0 FHIR Versions
5.19.0 Versioned Resource References
5.19.1 Allow Versioned References
5.19.2 Automatically Version References
5.20.0 Tags, Profiles, and Security Labels
5.20.1 Search Parameters
5.21.0 Clinical Quality Language (CQL)
5.21.1 Evaluate Measure
6.0.0 FHIR Storage (Relational)
6.0.0 FHIR Storage (Relational) Module
6.0.1 Preparing for a New Installation
6.0.2 Creating the Module
6.0.3 Database Schema
6.0.4 Multi-Node Architectures
6.0.5 Resource Body Storage
6.0.6 Practical Limitations
6.0.7 Configuration
6.1.0 Performance Tuning
6.1.1 Improving Write Performance
6.1.2 Example Properties File
6.2.0 Lucene Indexing
6.2.1 Lucene Disk Provider
6.2.2 Elasticsearch Provider
6.3.0 Performance and Caching
6.3.1 The Query Cache
6.3.2 Search Counts
6.4.0 Partitioning and Multitenancy
6.4.1 Enabling Partitioning in Smile CDR
6.4.2 Request Partition Selection Mode
6.4.3 Request Partition Security
6.4.4 Tenant Identification Strategies
6.4.5 Seeding Partitions
6.4.6 Patient ID Partition Mode
6.4.7 Cross-Partition References
6.4.8 Disabling Partition Security
7.0.0 FHIR Storage (MongoDB)
7.0.0 FHIR Storage (MongoDB) Module
7.0.1 Preparing for a New Installation
7.0.2 Creating the Module
7.0.3 MongoDB Document Schema
7.0.4 MongoDB Uplift Search Parameter Extensions
7.0.5 Uplifting Tokens
7.0.6 Uplifting Reference Chains
7.0.7 Configuration
8.0.0 Validation and Conformance
8.0.0 Introduction
8.0.1 Validation Modes
8.1.0 Validation Support Repository
8.1.1 Potential Architectures
8.1.2 Single FHIR Repository (RDBMS)
8.1.3 Dedicated Validation Support Repository
8.1.4 Non-Repository Models
8.2.0 Validation Support Repository Options
8.2.1 Validating References
8.2.2 Handling Missing CodeSystems
8.3.0 Conformance Data
8.3.1 StructureDefinition resources
8.3.2 CodeSystem Resources
8.3.3 ValueSet Resources
8.4.0 Repository Validation
8.4.1 Validation Support Repository
8.4.2 Methods
8.5.0 Repository Validation: Java
8.6.0 Repository Validation: Javascript
8.6.1 Function: repositoryValidationProvideRules(theRuleBuilder)
8.6.2 Example: Require a Specific Profile
8.6.3 Example: Allow Several Profiles for a Resource Type
8.6.4 Example: Require Profile and Validate
8.7.0 Repository Validation: Validation Bean
8.8.0 Endpoint Validation
8.9.0 Packages and Implementation Guides
8.9.1 Background: Implementation Guides
8.9.2 Background: Packages
8.9.3 Ingesting Packages into Smile CDR
8.9.4 Package Pre-Seed Installation
8.9.5 Pre-Seeding Resources into the Repository
8.9.6 Package Registry Endpoint module
8.9.7 Creating Packages
8.10.0 Remote Terminology Services
8.10.1 Scope
8.10.2 Remote Terminology Server Requirements
8.11.0 Suppressing Messages
8.12.0 Validation Performance
8.13.0 Automatic Provenance Injection
8.13.1 Provenance Injection Feature
8.13.2 Provenance Injection Data
9.0.0 Terminology
9.0.0 Terminology Introduction
9.0.1 Unsupported Operations
9.1.0 Uploading Codes
9.1.1 Uploading External CodeSystems
9.1.2 Uploading ICD-10-CM
9.1.3 Uploading LOINC
9.1.4 Uploading SNOMED CT
9.1.5 Uploading Custom Vocabularies
9.1.6 Applying Deltas to External CodeSystems
9.1.7 Delta Add Operation: $apply-codesystem-delta-add
9.1.8 Delta Remove Operation: $apply-codesystem-delta-remove
9.1.9 Reference: CSV Vocabulary Input Files
9.2.0 Terminology and Lucene Indexing
9.2.1 Terminology Index
9.2.2 Validation
9.2.3 Operations
9.3.0 ValueSet Expansion
9.3.1 ValueSet Expansion Pre-Calculation
9.3.2 Expanding Hierarchical CodeSystems and ValueSets
9.3.3 Searching for Codes
9.4.0 FHIR Response Terminology Mapping
9.4.1 Response Terminology Mapping
9.4.2 Response Coding Displays
10.0.0 Subscription
10.0.0 Introduction
10.0.1 The Subscription Resource
10.0.2 Subscription Activation
10.0.3 Delivery Retry Handling
10.0.4 MultiTenancy and Subscriptions
10.0.5 Criteria
10.0.6 Troubleshooting Subscriptions
10.1.0 Architecture
10.1.1 Enabling and Configuring Subscription Processing
10.2.0 Channel Types
10.2.1 Channel Type: rest-hook
10.2.2 Channel Type: email
10.2.3 Channel Type: websocket
10.2.4 Channel Type: message
10.3.0 Delivery Options
10.3.1 Payload Search Result Mode
10.3.2 Replication Mode
10.3.3 Strip Version IDs
10.3.4 Delivering Latest Version
10.3.5 Delivering Delete Events
10.3.6 Custom Delivery Class
10.3.7 DEPRECATED: Delivery to Site-defined External Queue
10.4.0 Manual Triggering
11.0.0 Interceptors
11.0.0 Interceptors
11.0.1 HAPI FHIR and Smile CDR Pointcuts
11.0.2 Deploying Interceptors to Smile CDR Modules
11.1.0 Starter Project
11.1.1 Using the Starter Project
11.2.0 Examples: FHIR Endpoints
11.2.1 Example: Override CapabilityStatement Generation
11.3.0 Examples: FHIR Storage
11.3.1 Example: Response Attribute Enhancement
11.3.2 Example: Server-Reserved Tags
11.3.3 Example: JavaScript Storage Interceptor
11.4.0 Examples: FHIR Gateway
11.4.1 Example: Direct Search based on Parameter Value
11.4.2 Example: Modify Target Search based on Previous Target Search
11.4.3 Example: Modify Target Search Results
11.4.4 Example: Modify Target Search Uri
11.4.5 Example: Search Using Alternate Patient ID
12.0.0 Channel Import
12.0.0 Channel Import Overview
12.0.1 Enabling and Configuring Channel Import
13.0.0 Realtime Export
13.0.0 Realtime Export Overview
13.0.1 Operational Overview
13.0.2 Limitations
13.0.3 Troubleshooting
13.1.0 Realtime Export Rules Definition
13.1.1 Transformers
13.1.2 Named Transformers
13.1.3 Managing high-cardinality elements
13.2.0 Using FHIRPath
13.2.1 Collection Subsetting
13.2.2 Self-referral
13.2.3 Conditionals
13.3.0 Debezium
14.0.0 Security
14.0.0 Security in Smile CDR
14.0.1 Inbound Security Module
14.0.2 FHIR Listener Module
14.0.3 Admin Modules
14.0.4 Auth Directory
14.0.5 Audit Database
14.0.6 Outbound Security Modules
14.1.0 Authentication Protocols
14.1.1 HTTP Basic
14.1.2 OpenID Connect (OIDC) and SMART on FHIR
14.1.3 Security Access Markup Language (SAML)
14.2.0 Authorization and Consent
14.2.1 Authorization Service
14.2.2 Consent Service
14.3.0 Inbound Security Module
14.3.1 Permissions
14.3.2 Callback Script
14.4.0 Local Inbound Security Module
14.4.1 Configuration: Credentials
14.4.2 Caching
14.4.3 User Self Registration
14.5.0 LDAP Inbound Security Module
14.5.1 Requirements
14.5.2 Permissions
14.5.3 Callback Scripts
14.5.4 Configuration
14.6.0 Scripted Inbound Security Module
14.6.1 Script Format
14.6.2 Script Examples
14.7.0 SAML Inbound Security Module
14.7.1 SAML 2.0 Authentication Request Protocol
14.7.2 Enabling SAML Authentication
14.7.3 Entity ID Template
14.7.4 Authentication Scripts
14.7.5 Function: authenticate(theRequest, theOutcomeFactory)
14.8.0 Trusted Client Mode
14.8.1 Configuring Trusted Client Mode
14.8.2 Making Trusted Client Requests
14.8.3 Automatically Creating Users
14.9.0 Roles and Permissions
14.9.1 System-Defined Roles
14.9.2 System-Defined Permissions
14.9.3 System-Defined Negative Permissions
14.9.4 Block Unless Code in ValueSet
14.10.0 Callback Scripts
14.10.1 Function: onAuthenticateSuccess
14.10.2 Function: onSmartLoginPreContextSelection(theUserSession, theContextSelectionChoices)
14.10.3 Example Script
14.10.4 Function: onTokenGenerating(theUserSession, theAuthorizationRequestDetails)
14.10.5 Function: onPostAuthorize(theDetails)
14.10.6 Function: authenticate(theRequest, theOutcomeFactory)
14.11.0 Anonymous Access
14.12.0 Consent Service
14.12.1 Enabling the Consent Service
14.12.2 Method: consentStartOperation
14.12.3 Method: consentCanSeeResource
14.12.4 Method: consentWillSeeResource
14.12.5 Method: completeOperationSuccess
14.12.6 Method: completeOperationFailure
14.12.7 Example: Tag-Based Consent Script
14.12.8 Example: Scope-Based Consent Script
14.13.0 Security Recipes
14.13.1 App: Local Users with HTTP Basic Authentication
14.13.2 Integrating SMART Apps With a 3rd-Party OIDC Server
14.14.0 Two Factor Authentication
14.14.1 User Activating TOTP
14.14.2 Enforcing Two Factor Authentication
14.15.0 Troubleshooting Security
15.0.0 SMART on FHIR
15.0.0 SMART on FHIR: Introduction
15.0.1 The SMART Launch Sequence
15.0.2 The Interactive Launch Process
15.1.0 SMART: Scopes
15.1.1 Picking Scopes
15.1.2 Launch Context Scopes
15.1.3 The OpenID and Profile Scopes
15.2.0 SMART: Auth Flows
15.2.1 Launch Flow: Authorization Code
15.2.2 Security Option: Proof Key for Code Exchange (PKCE)
15.2.3 Launch Flow: Implicit Grant
15.2.4 Launch Flow: Resource Owner Password Credentials
15.2.5 Non-Interactive User Flow: Cross-Organization Data Access Profile
15.2.6 System Flow: Client Credentials
15.2.7 System Flow: Client Credentials with JWT Credential
15.2.8 System Flow: Refresh Token
15.3.0 SMART: Endpoints
15.3.1 Server Metadata Endpoint
15.3.2 UserInfo Endpoint
15.4.0 Client Management
15.4.1 Remembering Approved Scopes
15.4.2 Client Secrets
15.5.0 OIDC Keystores
15.6.0 SMART: Smile CDR Support
15.6.1 Models for Using External OIDC Servers
15.6.2 Supported Scopes
15.6.3 Online / Offline Access
15.7.0 SMART Outbound Security: Module
15.7.1 Setting Up This Module
15.7.2 Terms of Service
15.7.3 Plain-language Developer Attestation
15.7.4 Client Credentials Grant
15.7.5 Cross-Organization Data Access Profile Grant
15.7.6 SMART Callback Scripts
15.7.7 User Self Registration
15.8.0 SMART Outbound Security: Skinning
15.8.1 Creating a Skin
15.8.2 Installing a Skin
15.8.3 HTML Template Files
15.8.4 Sample Skin Project
15.9.0 SMART Outbound Security: Context Selection
15.10.0 SMART: Federated OAuth2/OIDC Login
15.10.1 Federated Flow
15.10.2 Considerations
15.10.3 Setting Up Federated OAuth2/OIDC Login
15.10.4 Authorization Script
15.11.0 SMART: Application Approval/Consent
15.11.1 Approval Overview
15.11.2 Auto-Approve / Auto-Grant Scopes
15.11.3 Approval Flow
15.11.4 Customizing Scope Names
15.11.5 Custom Security Scopes
15.11.6 Revocation Page
15.12.0 SMART Inbound Security Module
15.12.1 Requirements
15.12.2 Setting Up This Module
15.12.3 Accepting Tokens
15.12.4 Accepting Internal Access Tokens
15.12.5 Accepting External Access Tokens
15.12.6 Validating Tokens
15.12.7 Creating a Server Definition
15.12.8 Assigning Permissions
15.12.9 Function: authenticate(...)
15.13.0 SMART: Session Management
15.13.1 Token Revocation Endpoint
15.13.2 User Logout Endpoint
15.14.0 SMART: Assigning Permissions
15.14.1 Scope Permission Model
15.14.2 User and Patient Resource Linkage
15.15.0 SMART: Access Tokens
15.16.0 SMART: User Profile Information
15.17.0 FHIR Client Authentication
15.17.1 Rejecting Unauthorized FHIR Calls
16.0.0 appSphere
16.0.0 Introduction
16.1.0 Getting Started
16.1.1 Setting-up a Sandbox Environment
16.1.2 Config Diagnostics
16.2.0 Associated Module Configurations
16.2.1 Configuration of JSON Admin API module
16.2.2 Configuration of FHIR Endpoint Module
16.2.3 Configuration of SMART Auth Module
16.2.4 Configuring SMART Auth modules to support multiple OIDC endpoints
16.2.5 Setting-up Federated OAuth to work with appSphere
16.3.0 Client Creation and Configuration
16.4.0 Other Configurations
16.4.1 Configuring NGINX for the Module
16.4.2 Configuring Different Users
16.5.0 Developer Portal
16.5.1 API Documentation for Dev Portal
16.5.2 Developer Registration
16.5.3 Developer Portal: UI Description
16.5.4 Sandbox Testing: UI Description
16.5.5 App Registration
16.5.6 Managing 'Draft' App Registrations and Re-registrations
16.5.7 App Information Page
16.5.8 Attestation
16.5.9 New App versions
16.5.10 Additional Considerations
16.6.0 App Management Console
16.6.1 Management Console: UI Description
16.6.2 App Review and Management
16.6.3 Additional Considerations
16.7.0 App Gallery
16.7.1 App Gallery: UI Description
16.7.2 Gallery Functionality
16.8.0 Appendix
16.8.1 Config Diagnostics
16.8.2 App Registration Help Text
16.8.3 Sign Up Help Text
16.8.4 Smile CDR Config
16.8.5 Attestation Creation
16.8.6 Troubleshooting
16.8.7 Reference Documents
16.8.8 Glossary of Terms
17.0.0 FHIR Gateway
17.0.0 FHIR Gateway Introduction
17.0.1 Troubleshooting
17.1.0 Configuration: Initial Setup
17.1.1 Server Configuration
17.1.2 Encryption JWKS (Keystore)
17.1.3 Configuration Document
17.1.4 Interceptors
17.2.0 Configuration: Document
17.2.1 Defining Targets
17.2.2 Defining Search Routes
17.2.3 Defining Read Routes
17.2.4 Defining Operation Routes
18.0.0 FHIR Hybrid Providers
18.0.0 Hybrid Providers
18.0.1 Architecture
18.0.2 Resource Providers
18.0.3 CapabilityStatement
18.0.4 The Spring Context Config Class
18.0.5 Building Your Hybrid Providers
18.0.6 Paging
18.0.7 Deploying Your Hybrid Providers
18.0.8 Accessing Security Attributes
18.0.9 Exceptions
18.0.10 Example Project
19.0.0 LiveBundle
19.0.0 LiveBundle Overview
19.0.1 Configuration
19.0.2 Usage
19.0.3 LiveBundle Architecture
19.0.4 LiveBundle Aggregation
19.0.5 LiveBundle Retrieval
19.0.6 LiveBundle Seeding
19.0.7 LiveBundle Troubleshooting
19.1.0 LiveBundle API
19.1.1 Add a Subscriber to a Watchlist
19.1.2 Remove Subscriber from a Watchlist
19.1.3 View list of Subscribers to a Watchlist
19.1.4 Request a bundle of Subscribers to a watchlist
19.1.5 Reseed all bundles for a rule
19.1.6 Request a LiveBundle
19.2.0 LiveBundle Rule Definition
19.2.1 Loading Rules
19.2.2 Example LiveBundle Javascript
19.2.3 LiveBundle Watchlist
19.2.4 LiveBundle Rule
19.2.5 LiveBundle Filter
19.2.6 Keeper Filters
19.2.7 LiveBundle Keeper
19.3.0 LiveBundle Keepers
19.3.1 LiveBundle Keeper Examples
19.3.2 LatestByPath
19.3.3 LatestByParamPath
19.3.4 LatestByParamPathByMonth
19.3.5 ToggleByPath
19.3.6 ToggleBySearch
19.3.7 WatchlistPopulator
19.3.8 Optional Keeper Parameters
20.0.0 CDS Hooks
20.0.0 CDS Hooks
20.0.1 Auto Prefetch
20.0.2 Architecture
20.0.3 CDS Hooks Classes
20.0.4 The Spring Context Config Class
20.0.5 Building Your CDS Hooks
20.0.6 Deploying Your CDS Hooks
20.0.7 Accessing Security Attributes
20.0.8 Exceptions
20.0.9 Calling CDS Hooks
20.0.10 Example Project
21.0.0 Master Data Management
21.0.0 MDM
21.0.1 Getting Started with Smile CDR MDM
21.0.2 Enabling and Configuring MDM within Smile CDR
21.0.3 Troubleshooting
21.0.4 MDM User Interface
21.1.0 MDM Quickstart Guide
21.2.0 MDM Survivorship Rules
21.3.0 Upgrading from the EMPI module
22.0.0 Clustering
22.0.0 Designing a Cluster
22.0.1 Node and Module Design
22.0.2 Process IDs
22.0.3 Adding and Removing Processes
22.0.4 Multi-Node Clusters
22.0.5 Sample Architecture
22.1.0 Migration To 2020.02
22.1.1 Migrating Existing Clusters
23.0.0 Logging
23.0.0 Overview
23.1.0 Audit Log
23.1.1 Audit Log Configuration
23.1.2 Disabling the Audit Log
23.1.3 Broker Audit Log
23.2.0 Transaction Log
23.2.1 Disabling the Transaction Log
23.2.2 Transaction Log Configuration
23.2.3 Event Types and SubTypes
23.2.4 Realtime Reporting
23.3.0 System Logging
23.3.1 Changing Logging Settings
23.4.0 Troubleshooting Logs
23.4.1 HTTP Troubleshooting Log
23.4.2 Security Troubleshooting Log
23.4.3 Subscription Troubleshooting Log
23.4.4 LiveBundle Troubleshooting Log
23.4.5 MDM Troubleshooting Log
23.4.6 Channel Import Troubleshooting Log
23.4.7 Realtime Export Troubleshooting Log
23.4.8 FHIR Gateway Troubleshooting Log
23.4.9 Connection Pool Troubleshooting Log
24.0.0 HL7 v2.x Support
24.0.0 Introduction
24.0.1 Inbound HL7 v2.x Support
24.0.2 Outbound HL7 v2.x Support
24.0.3 HL7 v2.x Versions
24.1.0 Inbound Messaging
24.1.1 Processing
24.1.2 Callback Scripts
24.1.3 Function: onPreConvertHl7V2ToFhir(theMessage, theConversionResult)
24.1.4 Function: onPostConvertHl7V2ToFhir(theMessage, theConversionResult)
24.1.5 Adding Processing Messages
24.2.0 Outbound Messaging
24.2.1 ADT Workflow Mode
24.2.2 Enriching Message Conversion using Scripts
24.2.3 Function: onPostConvertFhirToHl7V2(theTriggerResource, theOutgoingMessage, theContext)
24.2.4 Using Persisted MessageHeader Resources
24.3.0 Outbound Messaging: Transport
24.3.1 Customizing HL7 over HTTP Payload
24.4.0 Transactions
24.4.1 ADT (Patient Administration) Domain
24.4.2 OMG/ORM (Orders) Domain
24.4.3 ORU (Results) Domain
24.4.4 RDE/RAS (Pharmacy) Domain
24.4.5 SIU (Scheduling) Domain
24.4.6 VXU (Immunization / Vaccination) Domain
24.4.7 DFT (Financial) Domain
24.4.8 BAR (Billing) Domain
24.5.0 Structure Definitions
24.5.1 Structure: ADT_A01
24.5.2 Structure: ADT_A02
24.5.3 Structure: ADT_A03
24.5.4 Structure: ADT_A05
24.5.5 Structure: ADT_A06
24.5.6 Structure: ADT_A09
24.5.7 Structure: ADT_A12
24.5.8 Structure: ADT_A17
24.5.9 Structure: ADT_A21
24.5.10 Structure: ADT_A30
24.5.11 Structure: ADT_A38
24.5.12 Structure: ADT_A39
24.5.13 Structure: ADT_A44
24.5.14 Structure: ADT_A45
24.5.15 Structure: ADT_A54
24.5.16 Structure: ADT_A60
24.5.17 Structure: ADT_A61
24.5.18 Structure: DFT_P03
24.5.19 Structure: OMG_O19
24.5.20 Structure: ORM_O01
24.5.21 Structure: ORU_R01
24.5.22 Structure: RAS_O17
24.5.23 Structure: RDE_O11
24.5.24 Structure: SIU_S12
24.5.25 Structure: VXU_V04
24.6.0 Segment Definitions
24.6.1 Segment: MSH (Message Header)
24.6.2 Segment: EVN (Event)
24.6.3 Segment: PID (Patient)
24.6.4 Segment: PD1 (Patient Demographics Extended)
24.6.5 Segment: PV1 (Visit/Encounter)
24.6.6 Segment: PV2 (Visit/Encounter Additional)
24.6.7 Segment: ROL (Role)
24.6.8 Segment: DG1 (Diagnosis)
24.6.9 Segment: PR1 (Procedure)
24.6.10 Segment: MRG (Merge Patient Information)
24.6.11 Segment: GT1 (Guarantor)
24.6.12 Segment: IN1 (Insurance)
24.6.13 Segment: IN2 (Insurance Additional Information)
24.6.14 Segment: ORC (Order Control)
24.6.15 Segment: OBR (Observation Request)
24.6.16 Segment: OBX (Observation)
24.6.17 Segment: NK1 (Next of Kin / Patient Contact)
24.6.18 Segment: NTE (Note)
24.6.19 Segment: FT1 (Financial Transaction)
24.6.20 Segment: RXA (Pharmacy Administration)
24.6.21 Segment: RXC (Pharmacy Component)
24.6.22 Segment: ZXC (Pharmacy Component)
24.6.23 Segment: RXE (Pharmacy Encoded Order)
24.6.24 Segment: RXR (Pharmacy Route)
24.6.25 Segment: AL1 (Allergy Information)
24.6.26 Segment: IAM (Patient Adverse Reaction)
24.6.27 Segment: SPM (Specimen)
24.6.28 Segment: SCH (Scheduling)
24.6.29 Segment: RGS (Resource Group Segment)
24.6.30 Segment: AIL (Location Resource)
24.6.31 Segment: AIP (Personnel Resource)
24.6.32 Segment: ZXT (Non-Standard)
24.6.33 A Note about Extra Components
24.7.0 Table Definitions
24.7.1 Table 0001: Administrative Sex
24.7.2 Table 0002: Marital Status
24.7.3 Table 0004: Patient Class
24.7.4 Table 0007: Admission Type
24.7.5 Table 0009: Ambulatory Status
24.7.6 Table 0017: Transaction Type
24.7.7 Table 0018: Patient Type
24.7.8 Table 0038: Order Status
24.7.9 Table 0052: Diagnosis Type
24.7.10 Table 0063: v2 Relationship
24.7.11 Table 0069: Hospital Service
24.7.12 Table 0074: Diagnostic Service Section ID
24.7.13 Table 0078: Observation Interpretation Codes
24.7.14 Table 0085: Observation Status
24.7.15 Table 0112: Discharge Disposition
24.7.16 Table 0119: Order Control
24.7.17 Table 0123: Result Status
24.7.18 Table 0125: Observation Value Type
24.7.19 Table 0127: Allergen Type
24.7.20 Table 0128: Allergen Severity
24.7.21 Table 0129: Accommodation Code
24.7.22 Table 0131: v2 Contact Role
24.7.23 Table 0136: Yes/No
24.7.24 Table 0166: RX Component Type
24.7.25 Table 0190: Address Type
24.7.26 Table 0200: Name Type Code
24.7.27 Table 0201: Telecom Use
24.7.28 Table 0202: Telecom Equipment Type
24.7.29 Table 0203: Identifier Type
24.7.30 Table 0276: Appointment Reason Codes
24.7.31 Table 0278: Filler Status Code
24.7.32 Table 0291: Subtype of Referenced Data
24.7.33 Table 0299: Encoding
24.7.34 Table 0305: Person Location Type
24.7.35 Table 0322: Completion Status
24.7.36 Table 0438: Allergy Clinical Status Code
24.7.37 Table 0834: Mime Types
24.8.0 Naming System Mapping
24.8.1 Default Mappings
24.8.2 Using NamingSystem for Mapping Identifiers
24.9.0 Processing Results Feeds
24.9.1 Unsolicited Observation Request (ORU^R01)
24.10.0 Protocol
24.10.1 Encoding Format
24.10.2 ER7 (Pipe-Delimited) Format
24.10.3 Minimal Lower Layer Protocol (MLLP) Transport
24.10.4 HL7 over HTTP
24.10.5 Character Encoding / Charsets
25.0.0 CDA Exchange Module
25.0.0 Introduction
25.0.1 CDA Export
25.0.2 CDA Import
25.0.3 Implementation roadmap
25.1.0 JavaScript Templates
25.1.1 The simplest CDA template script
25.1.2 Adding header information to our CDA template script
25.1.3 Adding and populating a section in our CDA template script
25.1.4 Using the Fhir.search() API to dynamically populate sections
25.1.5 Specifying input parameters
25.1.6 More complicated input parameters
25.1.7 Specifying section author participation
25.1.8 Putting it all together
25.1.9 Configuring the $docref CCD template
25.2.0 Rest API Operations
25.2.1 Endpoints for configuring templates
25.2.2 Endpoints for applying templates
25.2.3 Endpoints for importing CDA documents
25.3.0 Available Document and Section Types for CDA Export
25.3.1 Valid Document Types
25.3.2 Valid Resources for the header
25.3.3 Valid Section Types and Sources
25.3.4 Allergy and Intolerances Section
25.3.5 Dialysis Prescription Section
25.3.6 Encounters Section
25.3.7 Functional Status Section
25.3.8 Goals Section
25.3.9 Immunizations Section
25.3.10 Medical Equipment Section
25.3.11 Medications Section
25.3.12 Problem Section
25.3.13 Procedures Section
25.3.14 Reason for Referral Section
25.3.15 Results Section
25.3.16 Social History Section
25.3.17 Vital Signs Section
25.4.0 Available Document and Section Types for CDA Import
25.4.1 Valid Document Types
25.4.2 Resources derived from the header
25.4.3 Valid Section Types and Sources
25.4.4 Allergy and Intolerances Section
25.4.5 Encounters Section
25.4.6 Immunizations Section
25.4.7 Medications Section
25.4.8 Problem Section
25.4.9 Procedures Section
25.4.10 Results Section
25.4.11 Social History Section
25.4.12 Vital Signs Section
25.5.0 Further Reading
26.0.0 Bulk Operations
26.0.0 ETL Import Module
26.0.1 Importing CSV Data
26.0.2 Function: handleEtlImportRow(theInputMap, theContext)
26.0.3 Handling Multiple Import Formats
26.0.4 Initiating ETL Jobs
26.0.5 Performance and Concurrency
26.0.6 Locking Rows
26.0.7 Creating a Hashing Script
26.0.8 Asynchronous Execution
26.0.9 Performance
26.1.0 FHIR Bulk Import Operation
26.1.1 Triggering a Bulk Import
26.1.2 Methodology
26.1.3 Performance
26.2.0 FHIR Bulk Export Operation
26.2.1 Enabling Bulk Export
26.2.2 Types of Bulk Export Requests
26.2.3 Request Parameters
26.2.4 Requesting A Bulk Extract
26.2.5 Retrieving Data
26.2.6 Authorization for Bulk Export
27.0.0 Monitoring
27.0.0 Monitoring Basics
27.0.1 HTTP Endpoint Health Check
27.0.2 Runtime Health Checks
27.0.3 Runtime Monitoring Statistics
27.1.0 Elastic APM Basics
27.1.1 What is APM?
27.1.2 Setting Up an APM Server
27.1.3 Instrumenting Smile CDR and the JVM
27.1.4 Accessing the User Interface
27.1.5 Configuring Settings for the Agent
27.1.6 Securing the Agent
28.0.0 Product Administration
28.0.0 Batch Job Management
29.0.0 JSON Admin Endpoints
29.0.0 JSON Admin API
29.0.1 Security
29.0.2 Format
29.0.3 Allowing Anonymous Access
29.1.0 Audit Log Endpoint
29.1.1 Fetch Audit Log
29.1.2 Fetch Individual Event
29.2.0 Batch Job Endpoint
29.2.1 Fetch Batch Job Names
29.2.2 Fetch All Instances
29.2.3 Stop Job Execution
29.2.4 Restart Job Execution
29.3.0 Bulk Import Endpoint
29.3.1 Process ETL File
29.3.2 Smileutil: CSV Bulk Import File
29.4.0 CDA Exchange Endpoint
29.4.1 Create CDA Template
29.4.2 Update CDA Template
29.4.3 Update CDA Template script via text
29.4.4 View CDA Template(s)
29.4.5 Delete CDA template
29.4.6 Use / Apply CDA Template
29.4.7 Create CDA from Composition/Bundle
29.4.8 Example CDA Template
29.5.0 Metrics Endpoint
29.5.1 Fetch Local Metrics
29.5.2 Capture Thread Dump
29.6.0 Module Config Endpoint
29.6.1 Fetch Config: Module Property File
29.6.2 Fetch Config: All Modules
29.6.3 Fetch Config: Single Module
29.6.4 Create Module
29.6.5 Set Module Config
29.6.6 Start Module
29.6.7 Stop Module
29.6.8 Restart Module
29.6.9 Archive Module
29.7.0 OpenID Connect Clients Endpoint
29.7.1 Fetch All OpenID Connect Client Definitions
29.7.2 Fetch Individual Client by Client ID
29.7.3 Create Client
29.7.4 Update Client
29.7.5 Create Client and generate secrets
29.8.0 OpenID Connect Servers Endpoint
29.8.1 Fetch All OpenID Connect Server Definitions
29.8.2 Find OpenID Connect Server Definition
29.8.3 Create OpenID Connect Server Definition
29.8.4 Update OpenID Connect Server Definition
29.9.0 OpenID Connect Sessions Endpoint
29.9.1 Fetch All Active Clients for User
29.9.2 Revoke Active Client for User
29.10.0 Runtime Status Endpoint
29.10.1 Fetch Complete Node Status Information
29.10.2 Fetch All Runtime Health Checks
29.11.0 System Config Endpoint
29.12.0 Transaction Log Endpoint
29.12.1 Fetch Transaction Log
29.12.2 Fetch Individual Event
29.13.0 User Management Endpoint
29.13.1 Search for Users (All Modules)
29.13.2 Search for Users (Specific Module)
29.13.3 Create User
29.13.4 Update User
29.13.5 Update Password
29.13.6 Update Own Password
29.13.7 Update Own Default Launch Contexts
29.13.8 2FA: Create New Key
29.13.9 2FA: Generate QR Code
29.13.10 2FA: Confirm Key
29.13.11 2FA: Delete Key
29.13.12 Invalidate All Sessions
30.0.0 Product Configuration
30.0.0 HTTP Server Setup
30.0.1 Respecting Forward Headers
30.0.2 Specifying a Custom Context Path
30.0.3 Access Logs
30.0.4 Frame Options
30.1.0 TLS and HTTPS Reference
30.1.1 Background
30.1.2 Creating a Self-Signed KeyStore
30.1.3 Importing a LetsEncrypt Certificate into a KeyStore
30.1.4 Selecting Ciphers and Protocol
30.1.5 Enabling TLS Mutual Authentication (Client Auth)
31.0.0 Java Execution Environment
31.0.0 Security Attributes
31.1.0 Library Support
31.2.0 Exception Handling
31.3.0 Javadocs
32.0.0 JavaScript Execution Environment
32.0.0 Introduction
32.0.1 Change Log
32.1.0 Specifying JavaScript in Configuration File
32.2.0 Remote Debugging
32.3.0 Converter API
32.3.1 Method: hl7v2TsToFhirDate(dt);
32.3.2 Method: hl7v2TsToFhirDateTime(ts);
32.3.3 Method: hl7v2TsToFhirDateTime(ts, impliedTimeZone);
32.3.4 Method: urlDecode(string);
32.3.5 Method: urlEncode(string);
32.4.0 Environment API
32.5.0 Exceptions API
32.5.1 Method: Exceptions.newTrustedException(theMessage)
32.5.2 Method: Exceptions.newTrustedException(theStatusCode, theMessage)
32.6.0 OAuth2 Exceptions API
32.6.1 Method: OAuth2Exceptions.newUnauthorizedException(theMessage)
32.6.2 Method: OAuth2Exceptions.newForbiddenException(theMessage)
32.7.0 FHIR REST API
32.7.1 Method: create(resource)
32.7.2 Method: read(url)
32.7.3 Method: search().forResource(resourceType)
32.7.4 Method: transaction(IBundleBuilder theTransaction)
32.7.5 Method: translate()
32.7.6 Method: update(resource)
32.7.7 Method: patch(url, parameters)
32.7.8 Authentication
32.7.9 Tenant Selection
32.7.10 Concurrency Retry
32.8.0 FHIR Model API
32.8.1 Method: ResourceBuilder.build(resourceType)
32.8.2 Working with Resources
32.8.3 Working with Composition resources
32.8.4 Working with Bundle resources
32.8.5 Contained Resources
32.8.6 Meta Elements
32.8.7 Removing Data
32.9.0 HL7 v2.x Mapping API
32.9.1 Repetitions
32.9.2 Structure Interrogation
32.9.3 Content Clearing
32.9.4 Content Interrogation
32.9.5 Parsing Raw Field Values
32.9.6 Encoding
32.9.7 The Hl7V2 Object
32.9.8 Working with Variable Datatypes
32.9.9 Working with Z-Segments
32.10.0 HTTP API
32.10.1 Request Creation Methods
32.10.2 Request Execution Methods
32.10.3 Response Processing Methods
32.10.4 TLS / HTTPS
32.11.0 LDAP API
32.11.1 Method: searchByUsername(username)
32.11.2 Method: getStringAttributes(attributeName)
32.11.3 Method: isMemberOfGroup(groupDn)
32.12.0 Log API
32.12.1 Methods: debug(string), info(string), warn(string), error(string)
32.13.0 Composition Resource API
32.13.1 Method: set*(value)
32.13.2 Method: setDate(epoch)
32.13.3 Method: setType(documentType)
32.13.4 Method: addSection(sectionType)
32.14.0 Composition Section API
32.14.1 Method: populate(List resources)
32.14.2 Method: setTitle(title)
32.14.3 Method: setCode(system, code, display)
32.14.4 Method: addSection()
32.15.0 TransactionBuilder API
32.15.1 Method: newTransactionBuilder()
32.15.2 Method: withBundle(bundle)
32.15.3 Method: create(resource)
32.15.4 Method: update(resource)
32.15.5 Method: patch(resourceId, parameters)
32.15.6 Method Chain: createConditional(resource).onToken(parameter, system, value)
32.15.7 Method Chain: updateConditional(resource).onToken(parameter, system, value)
32.15.8 Methods: toXml(), toXml(prettyPrint), toJson(), toJson(prettyPrint)
32.15.9 Fhir.transaction(transaction)
32.16.0 Util API
32.16.1 Method: sleep(millis)
32.17.0 UUID API
32.17.1 Method: newPlaceholderId()
32.18.0 XML API
32.18.1 XPath Expressions
32.18.2 Function: getXPathValue(xpath)
32.18.3 Function: getXPathValues(xpath)
32.18.4 Function: getXPathElements(xpath)
32.19.0 Callback Models
32.19.1 AssociatedResource
32.19.2 AuthenticationContext
32.19.3 AuthenticationFailure
32.19.4 AuthenticationRequest
32.19.5 CsvProcessorContext
32.19.6 FhirEndpointTerminologyResponseMappingSpec
32.19.7 FhirEndpointTerminologyResponseMappingSpecSystem
32.19.8 GatewayConfiguration
32.19.9 GatewayOperation
32.19.10 GatewayOperationRoute
32.19.11 GatewayReadRoute
32.19.12 GatewayRouteTarget
32.19.13 GatewaySearchRoute
32.19.14 GatewayTarget
32.19.15 GrantedAuthority
32.19.16 Hl7V2GeneratedMessageContext
32.19.17 Hl7V2ReceivedMessage
32.19.18 Hl7V2ReceivedMessageConversionResult
32.19.19 LaunchContext
32.19.20 LaunchResourceId
32.19.21 OAuth2AuthorizationRequestDetails
32.19.22 OAuth2Client
32.19.23 OAuth2ClientSecret
32.19.24 OAuth2Clients
32.19.25 OAuth2Server
32.19.26 OAuth2Servers
32.19.27 OAuth2SmartContextSelectionChoicePerson
32.19.28 OAuth2SmartContextSelectionChoices
32.19.29 Oauth2InvalidateTokensResponseJson
32.19.30 PackageInstallationSpec
32.19.31 PartitionDefinition
32.19.32 PartitionDefinitions
32.19.33 RequestDetailsJson
32.19.34 ScriptAuthenticationOutcomeFactory
32.19.35 ScriptConsentContextServices
32.19.36 SecurityInLdapAuthenticationContext
32.19.37 SecurityInSmartAuthenticationContext
32.19.38 SmartCodapAuthorizationRequest
32.19.39 SmartOnPostAuthorizeDetails
32.19.40 UserDetails
32.19.41 UserDetailsChangeLaunchContextJson
32.19.42 UserDetailsList
32.19.43 UserDetailsOAuth2AllClientApprovals
32.19.44 UserDetailsOAuth2ClientApprovals
32.19.45 UserDetailsOAuth2ClientApprovalsApprovedScope
32.19.46 UserSessionDetails
33.0.0 Database Administration
33.0.0 Database Design
33.0.1 Cluster Manager Database
33.0.2 FHIR Relational Storage
33.0.3 FHIR MongoDB (Non-Relational) Storage
33.1.0 Database Connection Pool
33.2.0 Setting Up PostgreSQL
33.2.1 Supported Versions
33.2.2 Creating a Database for Smile CDR
33.2.3 Database Connection Properties
33.2.4 Setting up a Cluster Manager Database
33.2.5 Setting up a FHIR Storage (Relational) Database
33.3.0 Troubleshooting PostgreSQL
33.3.1 Host Name Verification Error
33.3.2 Network Timeouts
33.4.0 Setting Up MySQL
33.4.1 Supported Versions
33.4.2 Creating a Database for Smile CDR
33.4.3 Database Connection Properties
33.4.4 Setting up a Cluster Manager Database
33.4.5 Setting up a FHIR Storage (Relational) Database
33.5.0 Setting Up MariaDB
33.5.1 Supported Versions
33.5.2 Creating a Database for Smile CDR
33.5.3 Database Connection Properties
33.5.4 Setting up a Cluster Manager Database
33.5.5 Setting up a FHIR Storage (Relational) Database
33.6.0 Setting Up Oracle
33.6.1 Supported Versions
33.6.2 Setting up a Cluster Manager Database
33.6.3 Setting up a FHIR Storage (Relational) Database
33.7.0 Setting Up SQL Server (MSSQL)
33.7.1 Supported Versions
33.7.2 Creating a Database for Smile CDR
33.7.3 Preparing an SQL Server Database for Smile CDR
33.7.4 Database Connection Properties
33.7.5 Setting up a Cluster Manager Database
33.7.6 Setting up a FHIR Storage (Relational) Database
34.0.0 Localization
34.0.0 Localization
34.1.0 Examples
34.1.1 Example: Unknown Search Parameter Message
34.1.2 Example: Custom SMART Scope Names
34.2.0 Available Localization Keys
35.0.0 Smile CDR CLI (smileutil)
35.0.0 Introduction
35.0.1 Enabling Debug Logging
35.0.2 Memory Settings
35.1.0 Bulk Import
35.1.1 Usage
35.1.2 Options
35.2.0 Create FHIR Package
35.2.1 Usage
35.2.2 Options
35.3.0 Execute Script Function
35.3.1 Usage
35.3.2 Options
35.3.3 A Complete Example: Authenticate
35.3.4 Available Functions
35.3.5 Function: authenticate
35.4.0 Export ConceptMap to CSV
35.4.1 Usage
35.4.2 Options
35.5.0 HL7 v2.x Analyze Flat File
35.5.1 Usage
35.5.2 Options
35.6.0 HL7 v2.x Transmit Flat File
35.6.1 Usage
35.6.2 Options
35.6.3 Multiplex Paths
35.7.0 Import CSV to ConceptMap
35.7.1 Usage
35.7.2 Options
35.8.0 Map and Upload CSV Bulk Import File
35.8.1 Usage
35.8.2 Options
35.9.0 Migrate Database
35.9.1 Options
35.9.2 Examples
35.9.3 Disabling Flyway
35.10.0 Reindex Terminology
35.10.1 Usage
35.10.2 Options
35.11.0 Synchronize FHIR Servers
35.11.1 Usage
35.11.2 Options
35.11.3 Selecting Resource Types to Synchronize
35.11.4 Using a Search as the Source
35.11.5 Using a Directory as the Source
35.11.6 Uploading Bundles as Transactions
35.11.7 Using Inline Match URLs
35.11.8 Prefixing Numeric IDs
35.11.9 Synchronization Modes
35.11.10 Uploading Synthea (Synthetic Generated) Resources
35.11.11 Setting up a Resource Gold Master
35.11.12 Load Balancing Target Servers
35.12.0 Upgrade H2 Database File
35.12.1 Usage
35.12.2 Options
35.12.3 Example
35.13.0 Upload Bundle Files
35.13.1 This Command Is Deprecated
35.13.2 Usage
35.13.3 Options
35.14.0 Upload CSV Bulk Import File
35.14.1 Usage
35.14.2 Options
35.14.3 Sending Batches for a Single File
35.15.0 Upload Sample Dataset
35.15.1 Usage
35.15.2 Options
35.16.0 Upload Terminology
35.16.1 Usage
35.16.2 Options
35.16.3 Example: Add Delta to Custom Terminology
35.17.0 Validate FHIR Resources
35.17.1 Usage
35.17.2 Options
35.17.3 Profile Mode
35.17.4 Schema and Schematron Mode
36.0.0 Modules
36.0.0 JSON Admin API
36.0.1 Configuration Categories
36.1.0 Web Admin Console
36.1.1 Configuration Categories
36.2.0 CDA Exchange
36.2.1 Configuration Categories
36.3.0 Channel Import
36.3.1 Configuration Categories
36.4.0 Cluster Manager
36.4.1 Configuration Categories
36.5.0 Enterprise Master Patient Index
36.5.1 Configuration Categories
36.6.0 Amazon HealthLake Connection
36.6.1 Configuration Categories
36.7.0 CDS Hooks Endpoint
36.7.1 Configuration Categories
36.8.0 FHIR Gateway Endpoint
36.8.1 Configuration Categories
36.9.0 FHIR REST Endpoint (DSTU2)
36.9.1 Configuration Categories
36.10.0 FHIR REST Endpoint (DSTU3)
36.10.1 Configuration Categories
36.11.0 FHIR REST Endpoint (R4)
36.11.1 Configuration Categories
36.12.0 FHIRWeb Console
36.12.1 Configuration Categories
36.13.0 HL7 v2.x Listening Endpoint
36.13.1 Configuration Categories
36.14.0 HL7 v2.x Sending Endpoint
36.14.1 Configuration Categories
36.15.0 Hybrid Providers Endpoint
36.15.1 Configuration Categories
36.16.0 Package Registry Endpoint
36.16.1 Configuration Categories
36.17.0 Subscription Websocket Endpoint
36.17.1 Configuration Categories
36.18.0 ETL Importer
36.18.1 Configuration Categories
36.19.0 MDM
36.19.1 Configuration Categories
36.20.0 Narrative Generator
36.20.1 Configuration Categories
36.21.0 FHIR Storage (DSTU2 Relational)
36.21.1 Configuration Categories
36.22.0 FHIR Storage (R3 Relational)
36.22.1 Configuration Categories
36.23.0 FHIR Storage (Mongo)
36.23.1 Configuration Categories
36.24.0 FHIR Storage (R4 Relational)
36.24.1 Configuration Categories
36.25.0 Realtime Export
36.25.1 Configuration Categories
36.26.0 LDAP Inbound Security
36.26.1 Configuration Categories
36.27.0 Local Inbound Security
36.27.1 Configuration Categories
36.28.0 SAML Inbound Security
36.28.1 Configuration Categories
36.29.0 Scripted Inbound Security
36.29.1 Configuration Categories
36.30.0 SMART Inbound Security
36.30.1 Configuration Categories
36.31.0 SMART Outbound Security
36.31.1 Configuration Categories
36.32.0 SMART App Host
36.32.1 Configuration Categories
36.33.0 Subscription Matcher (All FHIR Versions)
36.33.1 Configuration Categories
36.34.0 Subscription Matcher (DSTU2 - Deprecated)
36.34.1 Configuration Categories
36.35.0 Subscription Matcher (DSTU3 - Deprecated)
36.35.1 Configuration Categories
36.36.0 Subscription Matcher (R4 - Deprecated)
36.36.1 Configuration Categories
36.37.0 appSphere
36.37.1 Configuration Categories
36.38.0 Payer to Payer
36.38.1 Configuration Categories
37.0.0 Configuration Categories
37.0.0 Web Admin Console Settings
37.0.1 Property: Transaction Log - Event Body Display Mode
37.1.0 appSphere
37.1.1 Property: JSON URL
37.1.2 Property: Auth URL
37.1.3 Property: Client ID
37.1.4 Property: Legal Company Name
37.1.5 Property: Admin Console Name
37.1.6 Property: Contact Helpdesk
37.1.7 Property: Contact Us URL
37.1.8 Property: FHIR Sandbox URL
37.1.9 Property: FHIR URL
37.1.10 Property: Application Gallery Name
37.1.11 Property: Hero Image, Large Format URL
37.1.12 Property: Hero Image, Small Format URL
37.1.13 Property: Company Logo Small URL
37.1.14 Property: Company Logo Large URL
37.1.15 Property: Enable Marketplace Functionality
37.1.16 Property: PHI Warning URL
37.1.17 Property: Developer Portal Name
37.1.18 Property: Privacy Policy URL
37.1.19 Property: Request app mail-to
37.1.20 Property: Terms of Use URL
37.2.0 Payer Config
37.2.1 Property: Payer Auto-Grant Scopes
37.2.2 Property: Enable Payer Functionality
37.3.0 Initial appSphere Seeding
37.3.1 Property: Default Attestation (Legal)
37.3.2 Property: Default Attestation (Plain)
37.3.3 Property: Default Attestation Title
37.4.0 Authentication Callback Scripts
37.4.1 Property: Authentication Callback Script (File)
37.4.2 Property: Authentication Callback Script (Text)
37.5.0 Auth: General for APIs
37.5.1 Property: Anonymous Account Username
37.5.2 Property: Allow Anonymous Access
37.6.0 User Authentication
37.6.1 Property: Anonymous Account Username
37.6.2 Property: Allow Anonymous Access
37.6.3 Property: SAML Authentication Enabled
37.7.0 Auth: HTTP Basic
37.7.1 Property: HTTP Basic Security
37.7.2 Property: HTTP Basic Realm
37.8.0 Auth: OpenID Connect
37.8.1 Property: OpenID Connect Security
37.9.0 Browser Syntax Highlighting
37.9.1 Property: Browser Syntax Highlighting Enabled
37.9.2 Property: Show Request Headers
37.9.3 Property: Show Response Headers
37.10.0 Capability Statement (metadata)
37.10.1 Property: Cache Resource Counts (Mins)
37.10.2 Property: Include Resource Counts
37.11.0 CDA Generation
37.11.1 Property: Base URL for Local Resources
37.12.0 CDA Import
37.12.1 Property: Assembly Device ID
37.13.0 CDS Hooks Definitions
37.13.1 Property: FHIR Version
37.13.2 Property: Spring Context Config Class
37.14.0 Channel Import
37.14.1 Property: Concurrent Consumers
37.14.2 Property: Concurrent Retry Consumers
37.14.3 Property: Channel Name
37.14.4 Property: Default mediaType
37.14.5 Property: Channel Import ETL Script (File)
37.14.6 Property: Channel Import ETL Script (Text)
37.15.0 Channel Retry
37.15.1 Property: Failure Channel Name
37.15.2 Property: Retry Delay(ms)
37.15.3 Property: Maximum amount of retry attempts.
37.15.4 Property: Maximum Delay(ms) between attempts.
37.15.5 Property: Retry Channel Name
37.15.6 Property: Retriable Exceptions
37.15.7 Property: Retry Strategy
37.16.0 Kafka
37.16.1 Property: Kafka Consumer Ack Mode
37.16.2 Property: Kafka Consumer Auto Commit Enabled
37.16.3 Property: Kafka Bootstrap Address
37.16.4 Property: Kafka Consumer Config Properties (File)
37.16.5 Property: Kafka Consumer Config Properties (Text)
37.16.6 Property: Kafka Subscription Matcher Consumer Group Id
37.16.7 Property: Kafka Producer Config Properties (File)
37.16.8 Property: Kafka Producer Config Properties (Text)
37.16.9 Property: Kafka SASL JAAS Config
37.16.10 Property: Kafka SASL Mechanism
37.16.11 Property: Kafka Security Protocol
37.16.12 Property: Kafka Broker SSL Enabled
37.16.13 Property: Kafka SSL Key Password
37.16.14 Property: Kafka SSL Keystore Location
37.16.15 Property: Kafka Keystore Password
37.16.16 Property: Kafka SSL TrustStore File Location
37.16.17 Property: Kafka SSL Truststore Password
37.16.18 Property: Validate Kafka Topics Exist Before Use
37.17.0 Cluster Manager Maintenance
37.17.1 Property: Audit Log Broker Channel Name
37.17.2 Property: Audit Log Broker Enabled
37.17.3 Property: Audit Log Database Async Writes
37.17.4 Property: Audit Log Database Enabled
37.17.5 Property: Request headers to store
37.17.6 Property: Stats Retention (Days) - Day Level
37.17.7 Property: Stats Retention (Days) - Hour Level
37.17.8 Property: Stats Retention (Days) - Minute Level
37.17.9 Property: Transaction Log Retention (Days)
37.17.10 Property: Scheduler Thread Count
37.17.11 Property: Persist Runtime Monitoring Statistics Enabled
37.17.12 Property: Heartbeat Persist Frequency MS
37.17.13 Property: Stats Cleanup Frequency MS
37.17.14 Property: Stats Persist Frequency MS
37.18.0 Message Broker
37.18.1 Property: Message Broker Address
37.18.2 Property: (Deprecated)Channel Naming Prefix
37.18.3 Property: Message Broker Password
37.18.4 Property: Message Broker Type
37.18.5 Property: Message Broker Username
37.19.0 Cluster Level Security
37.19.1 Property: OpenId Connect Keystores Pre-Seed File
37.20.0 Credentials
37.20.1 Property: Cache Successful Credentials
37.20.2 Property: Create Unknown Users
37.20.3 Property: Lock After Failed Attempts
37.20.4 Property: Case-Sensitive Passwords
37.20.5 Property: Password Encoding Scheme
37.20.6 Property: Password Mismatch Error
37.20.7 Property: Minimum Password Requirements
37.20.8 Property: Case-Sensitive Usernames
37.21.0 Cross-Origin Resource Sharing (CORS)
37.21.1 Property: CORS Allowed Request Headers
37.21.2 Property: CORS Enabled
37.21.3 Property: CORS Origins
37.22.0 Database
37.22.1 Property: Default Query Timeout (Seconds)
37.22.2 Property: Log Abandoned
37.22.3 Property: Max Idle Connections
37.22.4 Property: Connection Max Lifetime (millis)
37.22.5 Property: Max Total Connections
37.22.6 Property: Max Wait (Seconds)
37.22.7 Property: Min Idle Connections
37.22.8 Property: Pool Prepared Statements
37.22.9 Property: Remove Abandoned on Borrow
37.22.10 Property: Remove Abandoned Timeout Seconds
37.22.11 Property: Test Connections on Return
37.22.12 Property: Database Type
37.22.13 Property: Expect database to be writable
37.22.14 Property: Database Password
37.22.15 Property: Database Update Mode
37.22.16 Property: DB Secrets Manager
37.22.17 Property: SQL Parameter Bind Mode
37.22.18 Property: Database Connection URL
37.22.19 Property: Database Username
37.22.20 Property: Default Page Size
37.22.21 Property: FHIR Version
37.22.22 Property: Maximum Page Size
37.22.23 Property: Use ordinal date values for day precision searches.
37.23.0 Email Configuration
37.23.1 Property: Email From Address
37.23.2 Property: Notification Emails
37.23.3 Property: Email SMTP Hostname
37.23.4 Property: Email SMTP Password
37.23.5 Property: Email SMTP Port
37.23.6 Property: Use STARTTLS for connection security
37.23.7 Property: Email SMTP Username
37.24.0 ETL Import: CSV Properties
37.24.1 Property: CSV File Delimiter
37.24.2 Property: Parse Quotes
37.25.0 ETL Import: Source
37.25.1 Property: Async Mode Batch Size
37.25.2 Property: Asynchronous Mode Enabled
37.25.3 Property: Async Mode File Size
37.25.4 Property: Import Source
37.25.5 Property: Mapping Script (Text)
37.25.6 Property: Mapping Script (File)
37.25.7 Property: Worker Row Hashing Function
37.25.8 Property: Worker Thread Count
37.25.9 Property: Synchronous Mode: Continue On Failure
37.25.10 Property: Enable Transaction Log
37.26.0 FHIR Binary Storage
37.26.1 Property: Binary Access Operations Enabled
37.26.2 Property: Automatically inflate binaries.
37.26.3 Property: Binary inflation maximum size (bytes)
37.26.4 Property: Blob service access key
37.26.5 Property: Blob service bucket name.
37.26.6 Property: Endpoint URL for S3-compatible service
37.26.7 Property: Blob Service Region
37.26.8 Property: Blob service secret key
37.26.9 Property: Filesystem Mode: Base Directory
37.26.10 Property: Binary Storage Mode
37.26.11 Property: Maximum Size (bytes)
37.26.12 Property: Minimum Size (bytes)
37.27.0 FHIR Bulk Operations
37.27.1 Property: FHIR Bulk Export Enabled
37.27.2 Property: Bulk Export file retention (hours)
37.27.3 Property: Bulk Import Auto-Retry Maximum Count
37.27.4 Property: FHIR Bulk Import Enabled
37.28.0 Capability Statement
37.28.1 Property: Copyright Message
37.28.2 Property: Implementation Description
37.28.3 Property: Enable OpenAPI / Swagger Support
37.29.0 FHIR Configuration
37.29.1 Property: Cascading Deletes Enabled
37.29.2 Property: Allow External References Enabled
37.29.3 Property: Allow Inline Match URL References Enabled
37.29.4 Property: Allow Multiple Delete Enabled
37.29.5 Property: Allow storing all bundle types
37.29.6 Property: Auto-Create Placeholder Reference Targets
37.29.7 Property: Client ID Mode
37.29.8 Property: Delete Child Resource Count
37.29.9 Property: Delete Expunge Enabled
37.29.10 Property: Enforce Reference Target Types
37.29.11 Property: Disable Deletion Ref Checks for Paths
37.29.12 Property: Enforce Referential Integrity on Delete
37.29.13 Property: Enforce Referential Integrity on Write
37.29.14 Property: Expunge Operation Enabled
37.29.15 Property: Mark Resources for Reindexing after SearchParameter change
37.29.16 Property: Reindex Enabled
37.29.17 Property: Server ID Mode
37.29.18 Property: Store Meta.source information
37.29.19 Property: Tag Storage Mode
37.29.20 Property: Read Only Mode Enabled
37.29.21 Property: Seed Base Validation Resources
37.30.0 Consent Service
37.30.1 Property: Consent Service Enabled
37.30.2 Property: Consent Service Script (File)
37.30.3 Property: Consent Service Script (Text)
37.31.0 FHIR Endpoint Conversion
37.31.1 Property: Versioned API Mode
37.32.0 Interceptors
37.32.1 Property: Can Replace Authorization Interceptor
37.32.2 Property: Interceptor Bean Types
37.33.0 FHIR Endpoint Partitioning
37.33.1 Property: Tenant Identification Strategy
37.33.2 Property: Tenant Name
37.34.0 Custom Resource Providers
37.34.1 Property: Resource Provider Bean Types
37.35.0 FHIR Endpoint Security
37.35.1 Property: Allow Searches With Compartment Access
37.35.2 Property: Automatically Narrow Search Scope
37.35.3 Property: Reject Insufficient Permissions with HTTP 401
37.35.4 Property: Scopes Supported
37.36.0 Endpoint Terminology
37.36.1 Property: Populate Response Coding Displays
37.36.2 Property: Response Mapping
37.36.3 Property: Mapping Spec (Text)
37.37.0 FHIR Gateway Configuration
37.37.1 Property: FHIR Version
37.37.2 Property: Gateway Configuration (File)
37.37.3 Property: Show Underlying Errors
37.37.4 Property: Gateway Configuration (Text)
37.37.5 Property: Encryption JWKS (File)
37.37.6 Property: Encryption JWKS (Text)
37.38.0 FHIR Interceptors
37.38.1 Property: FHIR storage Callback Script (File)
37.38.2 Property: FHIR storage Callback Script (Text)
37.38.3 Property: Interceptor Bean Types
37.39.0 LiveBundle Service
37.39.1 Property: LiveBundle Enabled
37.39.2 Property: LiveBundle Rule Definition Script (File)
37.39.3 Property: LiveBundle Rule Definition Script (Text)
37.39.4 Property: LiveBundle Thread Count
37.39.5 Property: LiveBundle Watchlist Cache Enabled
37.40.0 FHIR MDM Server
37.40.1 Property: MDM Mode Enabled (Experimental)
37.40.2 Property: Search Expanding Interceptor Enabled (Experimental)
37.41.0 FHIR Performance
37.41.1 Property: Concurrent Bundle Validation Thread Count
37.41.2 Property: Concurrent Bundle Validation
37.41.3 Property: Default Total Calculation Mode
37.41.4 Property: Delete Enabled
37.41.5 Property: Expire Search Results After Minutes
37.41.6 Property: Expunge Batch Size
37.41.7 Property: Expunge Thread Count
37.41.8 Property: Inline Resource Storage Below Size (chars)
37.41.9 Property: Internal Synchronous Search Size
37.41.10 Property: Mass Ingestion Mode
37.41.11 Property: Match URL Cache Enabled
37.41.12 Property: Maximum Transaction Bundle Size
37.41.13 Property: Reindex Batch Size
37.41.14 Property: Reindex Thread Count
37.41.15 Property: Reuse Cached Results Timeout (Millis)
37.41.16 Property: Index Missing Search Params
37.41.17 Property: Suppress Scheduled Maintenance Jobs
37.41.18 Property: Write-Semaphore Mode: Enabled
37.41.19 Property: Write-Semaphore Mode: Log Waits
37.42.0 FHIR Performance Tracing
37.42.1 Property: Capture Raw SQL or Equivalent
37.42.2 Property: Trigger
37.42.3 Property: Performance Tracing Enabled
37.42.4 Property: Output to Response Headers
37.42.5 Property: Output to System Log
37.42.6 Property: Output to Transaction Log
37.43.0 FHIR Realtime Export
37.43.1 Property: Pointcut-based Realtime Export Mode Enabled
37.44.0 Repository Validation
37.44.1 Property: Enforce Referential Integrity on Write
37.44.2 Property: Repository Validation Javascript (File)
37.44.3 Property: Repository Validation Javascript (Text)
37.45.0 FHIR Resource Types
37.45.1 Property: Instance/Type History Enabled
37.45.2 Property: Server History Enabled
37.45.3 Property: Resource Types (whitelist)
37.46.0 FHIR REST Endpoint
37.46.1 Property: Fixed Value for Endpoint Base URL
37.46.2 Property: Default Encoding
37.46.3 Property: Default Prefer Return
37.46.4 Property: Pretty-Print by Default
37.46.5 Property: Process Header: Request Source
37.46.6 Property: Serve Raw Media Resources
37.47.0 FHIR Search
37.47.1 Property: Always use Offset Searches
37.47.2 Property: Allow :contains Searches
37.47.3 Property: Fetch Size (Default Maximum)
37.47.4 Property: Index Contained Resources
37.47.5 Property: Index Contained Resources Recursively
37.47.6 Property: Legacy Date Index Mode
37.47.7 Property: Max Includes per Page
37.47.8 Property: Use New Search SQL Builder (2020)
37.47.9 Property: Use ordinal date values for day precision searches.
37.47.10 Property: Filter Search Parameter Enabled
37.47.11 Property: GraphQL Enabled
37.47.12 Property: Index Identifier.type (:of-type modifier) Enabled
37.47.13 Property: Page Size (Default)
37.47.14 Property: Page Size (Maximum)
37.47.15 Property: Nickname enabled
37.47.16 Property: Phonetic Encoder
37.47.17 Property: Infinispan Cache Name
37.47.18 Property: Infinispan Hot Rod Protocol Version
37.47.19 Property: Infinispan Servers
37.47.20 Property: Search Cache Storage
37.47.21 Property: Suppress String Indexing In Tokens
37.48.0 FHIR Storage Module Scheduled Tasks
37.48.1 Property: Batch job retention days.
37.48.2 Property: Scheduler Thread Count
37.48.3 Property: Batch Job Executor: Maximum Thread Count
37.48.4 Property: Bulk Export Task Enabled
37.48.5 Property: Bulk Import Task Enabled
37.48.6 Property: Delete Stale Searches Task Enabled
37.48.7 Property: Pre-Expand ValueSets Task Enabled
37.48.8 Property: Resource Reindexing Task Enabled
37.49.0 FHIR Validation Services
37.49.1 Property: Remote Terminology Service: Base URL
37.49.2 Property: Terminology Basic Auth Password
37.49.3 Property: Terminology Basic Auth Username
37.49.4 Property: Remote Terminology Service: Enabled
37.49.5 Property: Remote Terminology Service: Log HTTP Calls
37.49.6 Property: Local Reference Policy
37.49.7 Property: Skip Contained Resource Validation
37.49.8 Property: Suppress Validation Message Patterns
37.49.9 Property: Unknown CodeSystem Validation Policy
37.50.0 FHIR Storage Package Registry
37.50.1 Property: Load Pre-Seed Installation Spec Files Asynchronously
37.50.2 Property: Package Pre-Seed Installation Spec Files
37.51.0 FHIR Storage Partitioning
37.51.1 Property: Cross-Partition Reference Mode
37.51.2 Property: Default Partition ID
37.51.3 Property: Partitioning Enabled
37.51.4 Property: Partition Naming Mode
37.51.5 Property: Partition Selection Mode
37.51.6 Property: Partition Seed File
37.51.7 Property: Partitioning Security Enabled
37.52.0 Versioned References
37.52.1 Property: Allow Versioned References at All Paths
37.52.2 Property: Allow Versioned References at Paths
37.52.3 Property: Automatically Version References at Paths
37.52.4 Property: Respect Versioned References for _include
37.53.0 FHIR Subscription Delivery
37.53.1 Property: Subscription Delivery Queue Naming
37.53.2 Property: Email From Address
37.54.0 FHIR Subscription Persistence
37.54.1 Property: Consumers Per Delivery Queue
37.54.2 Property: Matching Queue Consumers
37.54.3 Property: Cross-Partition Subscription Enabled
37.54.4 Property: Email Subscription Enabled
37.54.5 Property: Message Subscription Enabled
37.54.6 Property: REST Hook Subscription Enabled
37.54.7 Property: Trigger Subscriptions on Non-Versioning Changes
37.54.8 Property: Websocket Subscription Enabled
37.55.0 Amazon HealthLake REST Endpoint
37.55.1 Property: Log Requests to System Logs
37.55.2 Property: HealthLake Endpoint URL
37.55.3 Property: HealthLake Region Name
37.55.4 Property: HealthLake role ARN
37.55.5 Property: HealthLake send delete messages flag
37.55.6 Property: Auto-Manage Subscription Resource
37.55.7 Property: Auto-Managed Subscription Criteria
37.56.0 HL7 v2.x Mapper - Contained Resource
37.56.1 Property: Use standalone Related Person
37.56.2 Property: Use standalone Associated Party
37.56.3 Property: Use standalone Patient Account
37.57.0 HL7 v2.x Mapper - DG1
37.57.1 Property: Use DG1.1 as Condition.identifier.value` suffix.
37.58.0 HL7 v2.x Mapper - Forced Namespace Mode
37.58.1 Property: Forced Namespace Mode: Encounter System
37.58.2 Property: Forced Namespace Mode: Patient System
37.59.0 HL7 v2.x Mapper - General
37.59.1 Property: Create MessageHeader for Each Message
37.59.2 Property: Creation Mode - Practitioner
37.59.3 Property: Patient Primary Identifier Search Parameter
37.59.4 Property: Inferred TimeZone When Not Present
37.59.5 Property: Mapper Bean Types
37.59.6 Property: MessageHeader Hardcoded Destination Name
37.59.7 Property: Process AL1 Segments
37.60.0 HL7 v2.x Mapper - Medications
37.60.1 Property: Use Standalone Medications with Administered Code
37.60.2 Property: Use Standalone Medications with Component Code
37.60.3 Property: Use Standalone Medications with Give Code
37.61.0 HL7 v2.x Mapper - OBR
37.61.1 Property: Observation Identification Mode
37.61.2 Property: Use OBR-2 as Primary Identifier
37.61.3 Property: Use OBR-3 as Primary Identifier
37.62.0 HL7 v2.x to FHIR Mapper - OBSERVATION Group
37.62.1 Property: OBSERVATION Group Text Delimiter - NTE
37.62.2 Property: OBSERVATION Group Text Delimiter - OBX
37.63.0 HL7 v2.x to FHIR Mapper - ORDER_OBSERVATION Group
37.63.1 Property: ORDER_OBSERVATION Group Text Delimiter - NTE
37.64.0 HL7 v2.x Mapper - PID
37.64.1 Property: Patient Primary Identifier Type
37.65.0 HL7 v2.x Mapper - PV1
37.65.1 Property: Parse Encounter Providers
37.65.2 Property: Treat PV1-3 and PV1-6 Patient Locations as Single Atomic Locations
37.66.0 HL7 v2.x Listener Script
37.66.1 Property: Listener Processing Script (File)
37.66.2 Property: Listener Processing Script (Text)
37.67.0 HL7 v2.x MLLP Listener
37.67.1 Property: Charset: Forced
37.67.2 Property: Charset: Respect MSH-18
37.67.3 Property: Intermediate Logging Enabled
37.67.4 Property: HL7 v2.x Listener Port
37.67.5 Property: Socket Timeout (Millis)
37.67.6 Property: Storage Tenant Name
37.67.7 Property: Transport Protocol
37.67.8 Property: Unprocessable Message Handling
37.68.0 HL7 v2.x MLLP Sender
37.68.1 Property: Delay Between Failed Deliveries (millis)
37.68.2 Property: HL7 v2.x Destination Host
37.68.3 Property: Request Path
37.68.4 Property: HL7 v2.x Destination Port
37.68.5 Property: Retry message on NAK
37.68.6 Property: Send Timeout (millis)
37.68.7 Property: Transport Protocol
37.69.0 FHIR to HL7 v2.x Mapper Script
37.69.1 Property: HL7 v2.x Conversion Mapper Script (File)
37.69.2 Property: HL7 v2.x Conversion Mapper Script (Text)
37.70.0 HL7 v2.x Outbound Mapping
37.70.1 Property: Map Identifiers using NamingSystem
37.70.2 Property: Populate AL1 Segments
37.70.3 Property: Populate Encounter Participants in PV1
37.70.4 Property: Use Persisted Message Headers
37.71.0 HTTP Access Log
37.71.1 Property: Appenders
37.72.0 HTTP Listener
37.72.1 Property: Bind Address
37.72.2 Property: Context Path
37.72.3 Property: Endpoint Health Path
37.72.4 Property: Unhealthy Status Code
37.72.5 Property: HTTPS Forwarding Assumed
37.72.6 Property: Listener Port
37.72.7 Property: Respect Forward Headers
37.73.0 HTTP Request Pool
37.73.1 Property: Maximum Request Header Size (KB)
37.73.2 Property: Maximum Response Header Size (KB)
37.73.3 Property: Read Idle Timeout (millis)
37.73.4 Property: Thread Pool Accept Queue Size
37.73.5 Property: Thread Pool Maximum Size
37.73.6 Property: Thread Pool Minimum Size
37.74.0 HTTP Security
37.74.1 Property: Block HTTP HEAD
37.74.2 Property: Block HTTP OPTIONS
37.74.3 Property: Custom Headers
37.74.4 Property: Frame Options (Allow From)
37.74.5 Property: Pin Host
37.74.6 Property: Suppress Error Details
37.74.7 Property: Suppress Platform Information
37.75.0 Hybrid Providers Definitions
37.75.1 Property: Search Bundle Inclusion Rule
37.75.2 Property: FHIR Version
37.75.3 Property: Spring Context Config Class
37.76.0 Initial User Seeding
37.76.1 Property: Users Seed File
37.77.0 JavaScript Execution Environment
37.77.1 Property: Debug Enabled
37.77.2 Property: Debug Host Address
37.77.3 Property: Path
37.77.4 Property: Port
37.77.5 Property: Secure
37.77.6 Property: Suspend
37.78.0 JSON Web KeySet (JWKS)
37.78.1 Property: Signing JWKS (File)
37.78.2 Property: Signing JWKS (Text)
37.78.3 Property: Signing Key ID
37.78.4 Property: Keystore ID
37.79.0 LDAP Authentication
37.79.1 Property: Authentication: User Attributes to query
37.79.2 Property: Authentication: User Base DN
37.79.3 Property: Authentication: User Query
37.79.4 Property: Require Group DN
37.79.5 Property: Base DN for Groups
37.79.6 Property: Search Groups Recursively
37.79.7 Property: System User DN
37.79.8 Property: System User Password
37.79.9 Property: LDAP Server URL
37.79.10 Property: Global Permissions
37.79.11 Property: Native Permission User Attribute
37.79.12 Property: User Attribute: Family Name
37.79.13 Property: User Attribute: Given Name
37.80.0 Lucene FullText Indexing
37.80.1 Property: Lucene Index Directory
37.80.2 Property: Elasticsearch Index Prefix
37.80.3 Property: ElasticSearch Password
37.80.4 Property: ElasticSearch URL protocol. Either http or https
37.80.5 Property: ElasticSearch Host URLs.
37.80.6 Property: ElasticSearch Username
37.80.7 Property: Enable FullText Content Index
37.80.8 Property: Enable Indexing of Search Parameters (experimental)
37.80.9 Property: Enable Terminology Index
37.80.10 Property: Lucene Indexing Provider
37.80.11 Property: Lucene Indexing Enabled
37.81.0 MDM
37.81.1 Property: MDM Consumer Thread Count
37.81.2 Property: Interceptor Bean Types
37.81.3 Property: MDM Identifier Code
37.81.4 Property: MDM Identifier CodeSystem URL
37.81.5 Property: Prevent modification of External EIDs
37.81.6 Property: Prevent multiple EIDs from existing simultaneously on a target resource
37.81.7 Property: MDM Rule Definition Script (File)
37.81.8 Property: MDM Rule Definition Script (Text)
37.81.9 Property: MDM Survivorship Script (File)
37.81.10 Property: MDM Survivorship Script (Text)
37.82.0 Narrative Generator
37.82.1 Property: Narrative Template Manifest File
37.83.0 OpenID Connect Token Validation
37.83.1 Property: OIDC HTTP Client: JWKS Cache Timeout (mins)
37.83.2 Property: OIDC HTTP Client: Truststore File
37.83.3 Property: OIDC HTTP Client: Truststore Password
37.84.0 OpenID Connect (OIDC)
37.84.1 Property: Cache Authorizations (millis)
37.84.2 Property: Client Secret Encoding
37.84.3 Property: Smile CDR generated Client Secret expiry duration in days
37.84.4 Property: Issuer URL
37.84.5 Property: PKCE Plain Challenge Supported
37.84.6 Property: PKCE Required
37.84.7 Property: Rotate Refresh Token After Use
37.84.8 Property: Smart Capabilities List
37.85.0 Provenance Injection
37.85.1 Property: Agent Type
37.85.2 Property: Agent Who
37.85.3 Property: $everything operation
37.85.4 Property: Profile
37.85.5 Property: _revinclude=Provenance:target
37.86.0 Realtime Export
37.86.1 Property: Concurrent Consumers
37.86.2 Property: Import Channel Name
37.86.3 Property: Channel Name Prefix
37.86.4 Property: Realtime Export Script (File)
37.86.5 Property: Realtime Export Script (Text)
37.86.6 Property: Published Data source
37.86.7 Property: Transaction-Based Processing
37.87.0 Endpoint Validation: Request Validating
37.87.1 Property: Request Validating Bean Types
37.87.2 Property: Request Validating Enabled
37.87.3 Property: Fail On Severity
37.87.4 Property: Validation Response Headers Enabled
37.87.5 Property: Validation Tags Enabled
37.88.0 Search Parameter Seeding
37.88.1 Property: Disable Patterns
37.88.2 Property: Enable Patterns
37.89.0 SAML Provider
37.89.1 Property: Relying Party Entity ID Template
37.89.2 Property: Issuer ID
37.89.3 Property: Keystore File
37.89.4 Property: Keystore Password
37.89.5 Property: Registration ID
37.89.6 Property: Sign Auth Request
37.89.7 Property: Signing Key Alias
37.89.8 Property: Signing Key Password
37.89.9 Property: Verification Certificate Alias
37.89.10 Property: Web SSO URL
37.90.0 Security Inbound Script
37.90.1 Property: Script (File)
37.90.2 Property: HTTP Headers
37.90.3 Property: Script (Text)
37.91.0 Inbound SMART on FHIR Authentication
37.91.1 Property: Authentication Cache Timeout (Seconds)
37.91.2 Property: Prevent Token KeyID Reuse
37.91.3 Property: Require Key Expiry
37.91.4 Property: Scopes Supported
37.91.5 Property: Trust Intra-Cluster SMART Tokens from Module(s)
37.92.0 Inbound SMART on FHIR Endpoints
37.92.1 Property: Authorization Endpoint
37.92.2 Property: Introspection Endpoint
37.92.3 Property: Management Endpoint
37.92.4 Property: Revocation Endpoint
37.92.5 Property: Token Endpoint
37.93.0 OAuth2/OIDC Federation
37.93.1 Property: Federated OAuth2/OIDC Login
37.94.0 SMART Callback Script
37.94.1 Property: Post Authorization Script (File)
37.94.2 Property: Post Authorization Script (Text)
37.95.0 Cross-Organizational Data Access Profile
37.95.1 Property: CODAP Authorization Script (File)
37.95.2 Property: CODAP Authorization Script (Text)
37.95.3 Property: Enable Cross-Organization Data Access Profile
37.96.0 SMART Login Skin
37.96.1 Property: Approval Page Template
37.96.2 Property: Error Page Template
37.96.3 Property: Login Page (Federated OAuth2/OIDC) Template
37.96.4 Property: Login Page Template
37.96.5 Property: User Self Registration Template (Step 1)
37.96.6 Property: User Self Registration Template (Step 2)
37.96.7 Property: Session Management Page Template
37.96.8 Property: Two Factor Authentication Page Template
37.96.9 Property: Terms-of-service click-wrap Page Template
37.96.10 Property: WebJar ID
37.97.0 SMART Login Terms of Service
37.97.1 Property: Current version of terms.
37.98.0 SMART Authorization
37.98.1 Property: Allowed Audience List
37.98.2 Property: Enforce Approved Scopes to Restrict Permissions
37.98.3 Property: Scopes Supported
37.99.0 SMART Definitions Seeding
37.99.1 Property: OpenID Connect Client Pre-Seed File
37.99.2 Property: OpenID Connect Server Pre-Seed File
37.100.0 Sessions
37.100.1 Property: Use In-Memory Sessions
37.100.2 Property: Session Scavenger Interval (Millis)
37.100.3 Property: Session Timeout (Mins)
37.101.0 Two Factor Authentication
37.101.1 Property: TOTP Issuer Name
37.101.2 Property: Lock After Failed Attempts
37.102.0 TLS / SSL (Encryption)
37.102.1 Property: TLS Client Authentication
37.102.2 Property: TLS Enabled
37.102.3 Property: TLS KeyStore Filename
37.102.4 Property: TLS KeyStore Key Alias
37.102.5 Property: TLS KeyStore Key Password
37.102.6 Property: TLS KeyStore Password
37.102.7 Property: TLS Cipher Blacklist
37.102.8 Property: TLS Cipher Whitelist
37.102.9 Property: TLS Protocol Blacklist
37.102.10 Property: TLS Protocol Whitelist
37.102.11 Property: TLS TrustStore Filename
37.102.12 Property: TLS TrustStore Password
37.103.0 Transaction Log
37.103.1 Property: Transaction Log Step Body Serialization Mode
37.103.2 Property: Transaction Log Broker Channel Name
37.103.3 Property: Transaction Log Broker Enabled
37.103.4 Property: Transaction Log Database Storage Enabled
37.103.5 Property: Event Blacklist
37.103.6 Property: Event Whitelist
37.103.7 Property: Persist Transaction Bodies (Global)
37.103.8 Property: Persist Transaction Bodies: Incoming Request
37.103.9 Property: Persist Transaction Bodies: Incoming Response
37.103.10 Property: Truncate Transaction Bodies (bytes)
37.104.0 Trusted Client
37.104.1 Property: Assert Permissions
37.104.2 Property: Trusted Client Mode Enabled
37.105.0 User Self Registration
37.105.1 Property: User Self Registration Script (File)
37.105.2 Property: User Self Registration Script (Text)
37.105.3 Property: User Self Registration Enabled
37.105.4 Property: Referer URL List (Text)
38.0.0 Product Reference
38.0.0 Enumerated Types
38.0.1 Node And Module Status
38.0.2 Transaction Log Outcomes
38.0.3 Module Types
39.0.0 AWS / Amazon Support
39.0.0 HealthLake Export module
39.0.1 Subscription
40.0.0 Appendix
40.0.0 Preparing a Linux Host
40.0.1 Ubuntu Host with PostgreSQL / NGINX / Letsencrypt
40.0.2 Install letsencrypt and obtain Certs (optional)
40.0.3 Install nginx And Configure it to Front the Server
40.0.4 Red Hat Enterprise Linux (RHEL) or CentOS
40.1.0 Production Checklist
40.1.1 Host Server Setup
40.1.2 Network Infrastructure
40.1.3 CDR Process Settings
40.1.4 FHIR Server Performance
40.1.5 Monitoring
40.1.6 Security
40.1.7 Message Broker
40.1.8 Cluster Design
40.2.0 Installing Smile CDR, NGINX and PostgreSQL in a Docker Stack
40.2.1 Initial Setup of Docker and Context
40.2.2 Prepare Configuration for Smile CDR Docker Service
40.2.3 Prepare Configuration for NGINX Docker Service
40.2.4 Prepare Configuration for PostgreSQL Docker Service
40.2.5 Create Docker compose file for Smile CDR Docker stack
40.2.6 Build and Launch Smile CDR Stack
40.3.0 Deploying a Kubernetes Managed Cluster
40.3.1 Overview of Smile CDR Kubernetes Deployment Process
40.3.2 Pre-requisite Steps
40.3.3 Configuring Kubernetes
40.3.4 Kubernetes and Smile CDR Database Connections
40.3.5 Service Definitions
40.3.6 ConfigMap Definitions
40.3.7 Deployment Definitions
40.3.8 Deploying Smile CDR in a Kubernetes Cluster
40.3.9 Configuring Reverse Proxy and Load Balancer
40.3.10 Considerations When Deploying Smile CDR Using OpenShift
40.4.0 Password Hashing Algorithms
40.4.1 Available Algorithms
40.5.0 Resource Paths
40.6.0 JWT Signature Algorithms
40.7.0 Inferno Considerations