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: ActiveMQ 3.5
• Message Broker: Kafka 3.6
• Pre-Seeding Configuration and Data 3.7
• Upgrading Smile CDR 3.8
• Localization 3.9

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
• Terminology 5.12
• Partitioning and Multitenancy 5.13
• Searching for Data 5.14
• Creating Data 5.15
• Reading Data 5.16
• Updating Data 5.17
• Deleting Data 5.18
• Interceptors 5.19
• Binary Data 5.20
• Request Tracing and Provenance 5.21
• Packages and Implementation Guides 5.22
• Validation 5.23
• FHIR Versions 5.24

Subscription

• Introduction 6.0
• Architecture 6.1
• Channel Types 6.2
• Delivery Options 6.3
• Manual Triggering 6.4

LiveBundle

• LiveBundle Overview 7.0
• LiveBundle API 7.1
• LiveBundle Rule Definition 7.2
• LiveBundle Keepers 7.3

Security

• Security in Smile CDR 8.0
• Authentication Protocols 8.1
• Authorization and Consent 8.2
• Inbound Security Module 8.3
• Local Inbound Security Module 8.4
• LDAP Inbound Security Module 8.5
• Scripted Inbound Security Module 8.6
• SAML Inbound Security Module 8.7
• Trusted Client Mode 8.8
• Roles and Permissions 8.9
• Callback Scripts 8.10
• SMART on FHIR: Introduction 8.11
• SMART: Scopes 8.12
• SMART: Auth Flows 8.13
• SMART: Endpoints 8.14
• SMART: Smile CDR Support 8.15
• SMART Outbound Security Module 8.16
• SMART: Federated OAuth2/OIDC Login 8.17
• SMART: Application Approval/Consent 8.18
• SMART Inbound Security Module 8.19
• SMART: Session Management 8.20
• SMART: Assigning Permissions 8.21
• Anonymous Access 8.22
• Consent Service 8.23
• Security Recipes 8.24
• Two Factor Authentication 8.25
• Troubleshooting Security 8.26

FHIR Hybrid Providers

• Hybrid Providers 9.0

FHIR Gateway

• FHIR Gateway 10.0

Master Data Management

• EMPI 11.0

Clustering

• Designing a Cluster 12.0
• Migration To 2020.02 12.1

Logging

• Overview 13.0
• Audit Log 13.1
• Transaction Log 13.2
• System Logging 13.3
• Troubleshooting Logs 13.4

HL7 v2.x Support

• Introduction 14.0
• Inbound Messaging 14.1
• Outbound Messaging 14.2
• Transactions 14.3
• Structure Definitions 14.4
• Segment Definitions 14.5
• Table Definitions 14.6
• Naming System Mapping 14.7
• Processing Results Feeds 14.8
• Protocol 14.9

CDA Exchange Module

• Introduction 15.0
• JavaScript Templates 15.1
• Rest API Operations 15.2
• Available Document and Section Types 15.3
• Further Reading 15.4

Bulk Operations

• ETL Import Module 16.0
• FHIR Bulk Export Operation 16.1

Monitoring

• Monitoring Basics 17.0
• Elastic APM Basics 17.1

JSON Admin Endpoints

• JSON Admin API 18.0
• Audit Log Endpoint 18.1
• Bulk Import Endpoint 18.2
• CDA Exchange Endpoint 18.3
• Metrics Endpoint 18.4
• Module Config Endpoint 18.5
• OpenID Connect Clients Endpoint 18.6
• OpenID Connect Servers Endpoint 18.7
• Runtime Status Endpoint 18.8
• Transaction Log Endpoint 18.9
• User Management Endpoint 18.10

Product Configuration

• HTTP Server Setup 19.0
• TLS and HTTPS Reference 19.1

Java Execution Environment

• Security Attributes 20.0

JavaScript Execution Environment

• Introduction 21.0
• Converter API 21.1
• Environment API 21.2
• Exceptions API 21.3
• FHIR REST API 21.4
• FHIR Model API 21.5
• HL7 v2.x Mapping API 21.6
• HTTP API 21.7
• LDAP API 21.8
• Log API 21.9
• Composition Resource API 21.10
• Composition Section API 21.11
• TransactionBuilder API 21.12
• Util API 21.13
• UUID API 21.14
• XML API 21.15
• Callback Models 21.16

Database Administration

• Database Design 22.0
• Setting Up PostgreSQL 22.1
• Troubleshooting PostgreSQL 22.2
• Setting Up MySQL 22.3
• Setting Up MariaDB 22.4
• Setting Up Oracle 22.5
• Setting Up SQL Server (MSSQL) 22.6

Smile CDR CLI (smileutil)

• Introduction 23.0
• Execute Script Function 23.1
• Create FHIR Package 23.2
• Export ConceptMap to CSV 23.3
• HL7 v2.x Analyze Flat File 23.4
• HL7 v2.x Transmit Flat File 23.5
• Import CSV to ConceptMap 23.6
• Migrate Database 23.7
• Synchronize FHIR Servers 23.8
• Upload Bundle Files 23.9
• Upload CSV Bulk Import File 23.10
• Upload Sample Dataset 23.11
• Upload Terminology 23.12
• Validate FHIR Resources 23.13

Modules

• CDA Exchange 24.0
• Cluster Manager 24.1
• ETL Importer 24.2
• FHIR REST Endpoint (DSTU2) 24.3
• FHIR REST Endpoint (R3) 24.4
• FHIR Storage (DSTU2 Relational) 24.5
• FHIR Storage (R3 Relational) 24.6
• Subscription Matcher (R3) 24.7
• Subscription Matcher (R4) 24.8
• FHIRWeb Console 24.9
• HL7 v2.x Listening Endpoint 24.10
• HL7 v2.x Sending Endpoint 24.11
• JSON Admin API 24.12
• LDAP Inbound Security 24.13
• Local Inbound Security 24.14
• Scripted Inbound Security 24.15
• SMART App Host 24.16
• SMART Inbound Security 24.17
• SMART Outbound Security 24.18
• Web Admin Console 24.19

Configuration Categories

• Web Admin Console Settings 25.0
• Authentication Callback Scripts 25.1
• Auth: General for APIs 25.2
• User Authentication 25.3
• Auth: HTTP Basic 25.4
• Auth: OpenID Connect 25.5
• Browser Syntax Highlighting 25.6
• Capability Statement (metadata) 25.7
• Cluster Manager Subscription Messaging 25.8
• Cluster Manager Maintenance 25.9
• Cluster Manager Message Broker 25.10
• Cluster Manager Kafka 25.11
• Credentials 25.12
• Cross-Origin Resource Sharing (CORS) 25.13
• Database 25.14
• ETL Import: CSV Properties 25.15
• ETL Import: Source 25.16
• FHIR Binary Storage 25.17
• FHIR Bulk Operations 25.18
• FHIR Configuration 25.19
• FHIR Consent Service 25.20
• FHIR LiveBundle Service 25.21
• FHIR EMPI Server 25.22
• FHIR Endpoint Conversion 25.23
• FHIR Endpoint Security 25.24
• Interceptors 25.25
• FHIR Endpoint Partitioning and Multitenancy 25.26
• FHIR Gateway Target 25.27
• FHIR Gateway Cache 25.28
• FHIR Storage Partitioning and Multitenancy 25.29
• Package Registry 25.30
• FHIR Performance 25.31
• FHIR Performance Tracing 25.32
• FHIR Resource Types 25.33
• FHIR REST Endpoint 25.34
• FHIR Search 25.35
• FHIR Interceptors 25.36
• FHIR Subscription Persistence 25.37
• FHIR Subscription Delivery 25.38
• FHIR Validation Services 25.39
• HL7 v2.x to FHIR Mapper - Forced Namespace Mode 25.40
• HL7 v2.x to FHIR Mapper - General 25.41
• HL7 v2.x Mapper - Medications 25.42
• HL7 v2.x to FHIR Mapper - OBR 25.43
• HL7 v2.x to FHIR Mapper - OBSERVATION Group 25.44
• HL7 v2.x to FHIR Mapper - ORDER_OBSERVATION Group 25.45
• HL7 v2.x to FHIR Mapper - PV1 25.46
• HL7 v2.x Listener Script 25.47
• HL7 v2.x MLLP Listener 25.48
• FHIR to HL7 v2.x Mapper Script 25.49
• HL7 v2.x MLLP Sender 25.50
• HTTP Access Log 25.51
• HTTP Listener 25.52
• HTTP Request Pool 25.53
• HTTP Security 25.54
• Hybrid Providers Definitions 25.55
• Initial User Seeding 25.56
• JSON Web KeySet (JWKS) 25.57
• LDAP Authentication 25.58
• Lucene FullText Indexing 25.59
• Narrative Generator 25.60
• OpenID Connect (OIC) 25.61
• Request Validating 25.62
• Security Inbound Script 25.63
• Inbound SMART on FHIR Authentication 25.64
• Inbound SMART on FHIR Endpoints 25.65
• OpenID Connect Token Validation 25.66
• SAML Provider 25.67
• OAuth2/OIDC Federation 25.68
• SMART Authorization 25.69
• SMART Definitions Seeding 25.70
• Sessions 25.71
• SMART Outbound Security: Callback Script 25.72
• SMART Outbound Security: CODAP 25.73
• SMART Outbound Security: Login Skin 25.74
• Two Factor Authentication 25.75
• TLS / SSL (Encryption) 25.76
• Trusted Client 25.77
• Trusted Client 25.78
• Miscellaneous Categories 25.79

Product Reference

• Enumerated Types 26.0

Appendix

• Preparing a Linux Host 27.0
• Production Checklist 27.1
• Installing Smile CDR, NGINX and PostgreSQL in a Docker Stack 27.2
• Deploying a Kubernetes Managed Cluster 27.3
• Password Hashing Algorithms 27.4
• Resource Paths 27.5
• JWT Signature Algorithms 27.6