Welcome to Smile CDR

• Table of Contents 1.0
• Changelog (2020 Releases) 1.1
• Changelog (2019 Releases) 1.2
• Changelog (2018 Releases) 1.3
• Changelog (2017 Releases) 1.4

Getting Started

• Basic Concepts 2.0
• Platform Requirements 2.1

Installation

• Installing Smile CDR 3.0
• Docker Container Installation 3.1
• Unix Service Installation 3.2
• Tuning your Installation 3.3
• Message Brokers 3.4
• Message Broker Failure Management 3.5
• Message Broker: ActiveMQ 3.6
• Message Broker: Kafka 3.7
• Pre-Seeding Configuration and Data 3.8
• Upgrading Smile CDR 3.9
• Localization 3.10

Tutorial and Tour

• Preamble and Setup 4.0
• FHIR Basics 4.1
• FHIR Search Queries 4.2
• FHIR CRUD Operations 4.3
• SMART on FHIR Apps 4.4
• Processing HL7 v2.x Feeds 4.5

FHIR Storage

• Concepts in Smile CDR 5.0
• FHIR Storage (Relational) Module 5.1
• FHIR Storage (MongoDB) Module 5.2
• FHIR Endpoint Module 5.3
• FHIRWeb Console 5.4
• Lucene Indexing 5.5
• Performance and Caching 5.6
• Resource IDs 5.7
• Search Parameters 5.8
• Search Parameter Features 5.9
• Phonetic Search Parameters 5.10
• Custom Search Parameters 5.11
• Partitioning and Multitenancy 5.12
• Searching for Data 5.13
• Creating Data 5.14
• Reading Data 5.15
• Updating Data 5.16
• Deleting Data 5.17
• Interceptors 5.18
• Binary Data 5.19
• Request Tracing and Provenance 5.20
• Packages and Implementation Guides 5.21
• Validation 5.22
• FHIR Versions 5.23

Terminology

• Terminology Introduction 6.0
• Uploading Codes 6.1
• Searching for Codes 6.2

Subscription

• Introduction 7.0
• Architecture 7.1
• Channel Types 7.2
• Delivery Options 7.3
• Manual Triggering 7.4

LiveBundle

• LiveBundle Overview 8.0
• LiveBundle API 8.1
• LiveBundle Rule Definition 8.2
• LiveBundle Keepers 8.3

Channel Import

• Channel Import Overview 9.0

Realtime Export

• Realtime Export Overview 10.0
• Realtime Export Rules Definition 10.1
• Using FHIRPath 10.2
• Debezium 10.3

Security

• Security in Smile CDR 11.0
• Authentication Protocols 11.1
• Authorization and Consent 11.2
• Inbound Security Module 11.3
• Local Inbound Security Module 11.4
• LDAP Inbound Security Module 11.5
• Scripted Inbound Security Module 11.6
• SAML Inbound Security Module 11.7
• Trusted Client Mode 11.8
• Roles and Permissions 11.9
• Callback Scripts 11.10
• SMART on FHIR: Introduction 11.11
• SMART: Scopes 11.12
• SMART: Auth Flows 11.13
• SMART: Endpoints 11.14
• SMART: Smile CDR Support 11.15
• SMART Outbound Security Module 11.16
• SMART: Federated OAuth2/OIDC Login 11.17
• SMART: Application Approval/Consent 11.18
• SMART Inbound Security Module 11.19
• SMART: Session Management 11.20
• SMART: Assigning Permissions 11.21
• Anonymous Access 11.22
• Consent Service 11.23
• Security Recipes 11.24
• Two Factor Authentication 11.25
• Troubleshooting Security 11.26

FHIR Hybrid Providers

• Hybrid Providers 12.0

FHIR Gateway

• FHIR Gateway 13.0

Master Data Management

• EMPI 14.0
• EMPI Quickstart Guide 14.1

Clustering

• Designing a Cluster 15.0
• Migration To 2020.02 15.1

Logging

• Overview 16.0
• Audit Log 16.1
• Transaction Log 16.2
• System Logging 16.3
• Troubleshooting Logs 16.4

HL7 v2.x Support

• Introduction 17.0
• Inbound Messaging 17.1
• Outbound Messaging 17.2
• Transactions 17.3
• Structure Definitions 17.4
• Segment Definitions 17.5
• Table Definitions 17.6
• Naming System Mapping 17.7
• Processing Results Feeds 17.8
• Protocol 17.9

CDA Exchange Module

• Introduction 18.0
• JavaScript Templates 18.1
• Rest API Operations 18.2
• Available Document and Section Types 18.3
• Further Reading 18.4

Bulk Operations

• ETL Import Module 19.0
• FHIR Bulk Export Operation 19.1

Monitoring

• Monitoring Basics 20.0
• Elastic APM Basics 20.1

JSON Admin Endpoints

• JSON Admin API 21.0
• Audit Log Endpoint 21.1
• Bulk Import Endpoint 21.2
• CDA Exchange Endpoint 21.3
• Metrics Endpoint 21.4
• Module Config Endpoint 21.5
• OpenID Connect Clients Endpoint 21.6
• OpenID Connect Servers Endpoint 21.7
• Runtime Status Endpoint 21.8
• Transaction Log Endpoint 21.9
• User Management Endpoint 21.10

Product Configuration

• HTTP Server Setup 22.0
• TLS and HTTPS Reference 22.1

Java Execution Environment

• Security Attributes 23.0

JavaScript Execution Environment

• Introduction 24.0
• Converter API 24.1
• Environment API 24.2
• Exceptions API 24.3
• FHIR REST API 24.4
• FHIR Model API 24.5
• HL7 v2.x Mapping API 24.6
• HTTP API 24.7
• LDAP API 24.8
• Log API 24.9
• Composition Resource API 24.10
• Composition Section API 24.11
• TransactionBuilder API 24.12
• Util API 24.13
• UUID API 24.14
• XML API 24.15
• Callback Models 24.16

Database Administration

• Database Design 25.0
• Setting Up PostgreSQL 25.1
• Troubleshooting PostgreSQL 25.2
• Setting Up MySQL 25.3
• Setting Up MariaDB 25.4
• Setting Up Oracle 25.5
• Setting Up SQL Server (MSSQL) 25.6

Smile CDR CLI (smileutil)

• Introduction 26.0
• Execute Script Function 26.1
• Create FHIR Package 26.2
• Export ConceptMap to CSV 26.3
• HL7 v2.x Analyze Flat File 26.4
• HL7 v2.x Transmit Flat File 26.5
• Import CSV to ConceptMap 26.6
• Migrate Database 26.7
• Synchronize FHIR Servers 26.8
• Upload Bundle Files 26.9
• Upload CSV Bulk Import File 26.10
• Upload Sample Dataset 26.11
• Upload Terminology 26.12
• Validate FHIR Resources 26.13

Modules

• CDA Exchange 27.0
• Channel Import 27.1
• Cluster Manager 27.2
• EMPI 27.3
• ETL Importer 27.4
• FHIR REST Endpoint (DSTU2) 27.5
• FHIR REST Endpoint (R3) 27.6
• FHIR Storage (DSTU2 Relational) 27.7
• FHIR Storage (R3 Relational) 27.8
• Subscription Matcher (R3) 27.9
• Subscription Matcher (R4) 27.10
• FHIRWeb Console 27.11
• HL7 v2.x Listening Endpoint 27.12
• HL7 v2.x Sending Endpoint 27.13
• JSON Admin API 27.14
• LDAP Inbound Security 27.15
• Local Inbound Security 27.16
• Scripted Inbound Security 27.17
• SMART App Host 27.18
• SMART Inbound Security 27.19
• Realtime Export 27.20
• SMART Outbound Security 27.21
• Web Admin Console 27.22

Configuration Categories

• Web Admin Console Settings 28.0
• Authentication Callback Scripts 28.1
• Auth: General for APIs 28.2
• User Authentication 28.3
• Auth: HTTP Basic 28.4
• Auth: OpenID Connect 28.5
• Browser Syntax Highlighting 28.6
• Capability Statement (metadata) 28.7
• Channel Import 28.8
• Channel Retry 28.9
• Cluster Manager Subscription Messaging 28.10
• Cluster Manager Maintenance 28.11
• Cluster Manager Message Broker 28.12
• Cluster Manager Kafka 28.13
• Credentials 28.14
• Cross-Origin Resource Sharing (CORS) 28.15
• Database 28.16
• EMPI 28.17
• ETL Import: CSV Properties 28.18
• ETL Import: Source 28.19
• FHIR Binary Storage 28.20
• FHIR Bulk Operations 28.21
• FHIR Configuration 28.22
• FHIR Consent Service 28.23
• FHIR LiveBundle Service 28.24
• FHIR EMPI Server 28.25
• FHIR Endpoint Conversion 28.26
• FHIR Endpoint Security 28.27
• Interceptors 28.28
• FHIR Endpoint Partitioning and Multitenancy 28.29
• FHIR Gateway Target 28.30
• FHIR Gateway Cache 28.31
• FHIR Storage Partitioning and Multitenancy 28.32
• Package Registry 28.33
• FHIR Performance 28.34
• FHIR Performance Tracing 28.35
• FHIR Realtime Export 28.36
• FHIR Resource Types 28.37
• FHIR REST Endpoint 28.38
• FHIR Search 28.39
• FHIR Interceptors 28.40
• FHIR Subscription Persistence 28.41
• FHIR Subscription Delivery 28.42
• FHIR Validation Services 28.43
• HL7 v2.x to FHIR Mapper - Forced Namespace Mode 28.44
• HL7 v2.x to FHIR Mapper - General 28.45
• HL7 v2.x Mapper - Medications 28.46
• HL7 v2.x to FHIR Mapper - OBR 28.47
• HL7 v2.x to FHIR Mapper - OBSERVATION Group 28.48
• HL7 v2.x to FHIR Mapper - ORDER_OBSERVATION Group 28.49
• HL7 v2.x to FHIR Mapper - PV1 28.50
• HL7 v2.x Listener Script 28.51
• HL7 v2.x MLLP Listener 28.52
• FHIR to HL7 v2.x Mapper Script 28.53
• HL7 v2.x MLLP Sender 28.54
• HTTP Access Log 28.55
• HTTP Listener 28.56
• HTTP Request Pool 28.57
• HTTP Security 28.58
• Hybrid Providers Definitions 28.59
• Initial User Seeding 28.60
• JSON Web KeySet (JWKS) 28.61
• LDAP Authentication 28.62
• Lucene FullText Indexing 28.63
• Narrative Generator 28.64
• OpenID Connect (OIC) 28.65
• Realtime Export 28.66
• Request Validating 28.67
• Security Inbound Script 28.68
• Inbound SMART on FHIR Authentication 28.69
• Inbound SMART on FHIR Endpoints 28.70
• OpenID Connect Token Validation 28.71
• SAML Provider 28.72
• OAuth2/OIDC Federation 28.73
• SMART Authorization 28.74
• SMART Definitions Seeding 28.75
• Sessions 28.76
• SMART Outbound Security: Callback Script 28.77
• SMART Outbound Security: CODAP 28.78
• SMART Outbound Security: Login Skin 28.79
• Two Factor Authentication 28.80
• TLS / SSL (Encryption) 28.81
• Trusted Client 28.82
• Transaction Log 28.83
• Miscellaneous Categories 28.84

Product Reference

• Enumerated Types 29.0

Appendix

• Preparing a Linux Host 30.0
• Production Checklist 30.1
• Installing Smile CDR, NGINX and PostgreSQL in a Docker Stack 30.2
• Deploying a Kubernetes Managed Cluster 30.3
• Password Hashing Algorithms 30.4
• Resource Paths 30.5
• JWT Signature Algorithms 30.6