SmileCDR Logo
  • Sign in
SmileCDR Logo
  • Sign in
  • Welcome to Smile CDR
    • Table of Contents 1.0
    • Smile CDR Maturity Model 1.1
    • Smile CDR Premium Solutions 1.2
    • List of Features by Maturity 1.3
    • Changelog (2024 Releases) 1.4
    • Changelog (2023 Releases) 1.5
    • Changelog (2022 Releases) 1.6
    • Changelog (2021 Releases) 1.7
    • Changelog (2020 Releases) 1.8
    • Changelog (2019 Releases) 1.9
    • Changelog (2018 Releases) 1.10
    • Changelog (2017 Releases) 1.11
  • 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: Kafka 3.6
    • Message Broker: ActiveMQ 3.7
    • Pre-Seeding Configuration and Data 3.8
    • Upgrading Smile CDR 3.9
    • Production Checklist 3.10
    • Module Licensing 3.11
  • Tutorial and Tour
    • Preamble and Setup 4.0
    • Processing HL7 v2.x Feeds 4.1
    • Federated OAuth2/OIDC Setup 4.2
  • The FHIR Standard
    • FHIR Introduction 5.0
    • FHIR CRUD Operations 5.1
    • FHIR Searching Basics 5.2
    • FHIR Search: References and Includes 5.3
    • FHIR Search: Custom Search Parameters 5.4
    • FHIR Transactions and Batches 5.5
    • FHIRPath Expressions 5.6
  • FHIR Storage
    • Concepts in Smile CDR 6.0
    • FHIR Storage Modules 6.1
    • FHIR Endpoint Module 6.2
    • FHIRWeb Console 6.3
    • OpenAPI / Swagger Support 6.4
    • FHIR Endpoint Customization 6.5
    • Resource IDs 6.6
    • Search Parameters 6.7
    • Search Parameter Features 6.8
    • Phonetic Search Parameters 6.9
    • Search Parameter Tuning 6.10
    • Search Parameter Reindexing 6.11
    • Searching for Data 6.12
    • Creating Data 6.13
    • Reading Data 6.14
    • Updating Data 6.15
    • Deleting Data 6.16
    • Binary Data 6.17
    • Request Tracing and Provenance 6.18
    • FHIR Versions 6.19
    • Resource Versions and Versioned References 6.20
    • Tags, Profiles, and Security Labels 6.21
    • Partitioning and Multitenancy 6.22
    • Custom Resource Types 6.23
    • Batch and Scheduled Jobs 6.24
  • FHIR Storage (Relational)
    • FHIR Storage (Relational) Module 7.0
    • Resource Storage Mode 7.1
    • Performance Tuning 7.2
    • Lucene Indexing 7.3
    • Performance and Caching 7.4
    • Chained Searching and Sorting 7.5
    • MegaScale 7.6
  • FHIR Storage (MongoDB)
    • FHIR Storage (MongoDB) Module 8.0
    • MongoDB Sharding / Partitioning 8.1
  • Validation and Conformance
    • Introduction 9.0
    • Validation Support Repository 9.1
    • Validation Support Repository Options 9.2
    • Conformance Data 9.3
    • Repository Validation 9.4
    • Repository Validation: Java 9.5
    • Repository Validation: Javascript 9.6
    • Repository Validation: Validation Bean 9.7
    • Endpoint Validation 9.8
    • Packages and Implementation Guides 9.9
    • Package Registry Endpoint Module 9.10
    • Remote Terminology Services 9.11
    • Suppressing Messages 9.12
    • Validation Performance 9.13
    • Automatic Provenance Injection 9.14
  • Terminology
    • Terminology Introduction 10.0
    • Uploading Codes 10.1
    • Terminology and Lucene Indexing 10.2
    • ValueSet Expansion 10.3
    • FHIR Response Terminology Mapping 10.4
  • Subscription
    • Introduction 11.0
    • Architecture 11.1
    • Channel Types 11.2
    • Delivery Options 11.3
    • Manual Triggering 11.4
    • Topic Subscriptions 11.5
  • Interceptors
    • Interceptors 12.0
    • Pointcuts 12.1
    • Starter Project 12.2
    • Examples: FHIR Endpoints 12.3
    • Examples: HL7v2 Endpoints 12.4
    • Examples: FHIR Storage 12.5
    • Examples: FHIR Gateway 12.6
    • Examples: FHIR Client 12.7
    • Examples: MDM 12.8
    • Examples: Subscription 12.9
    • Examples: Channel Import 12.10
    • Examples: Cluster Manager 12.11
    • 2024.02.01 Migration Guide 12.12
  • Channel Import
    • Channel Import Overview 13.0
  • Realtime Export
    • Realtime Export Overview 14.0
    • Realtime Export Rules Definition 14.1
    • Using FHIRPath 14.2
    • Debezium 14.3
  • Security
    • Security in Smile CDR 15.0
    • Authentication Protocols 15.1
    • Authorization and Consent 15.2
    • Inbound Security Module 15.3
    • Local Inbound Security Module 15.4
    • LDAP Inbound Security Module 15.5
    • Scripted Inbound Security Module 15.6
    • SAML Inbound Security Module 15.7
    • Trusted Client Mode 15.8
    • Roles and Permissions 15.9
    • Callback Scripts 15.10
    • Anonymous Access 15.11
    • Consent Service 15.12
    • Consent Service: JavaScript API 15.13
    • Consent Service: Java API 15.14
    • Security Recipes 15.15
    • Two Factor Authentication 15.16
    • Troubleshooting Security 15.17
  • SMART on FHIR
    • SMART on FHIR: Introduction 16.0
    • SMART: Scopes 16.1
    • SMART: Auth Flows 16.2
    • SMART: Endpoints 16.3
    • Client Management 16.4
    • OIDC Keystores 16.5
    • SMART: Smile CDR Support 16.6
    • SMART Outbound Security: Module 16.7
    • SMART Outbound Security: Skinning 16.8
    • SMART Outbound Security: Context Selection 16.9
    • SMART Outbound Security: SAML Bridging 16.10
    • SMART: Federated OAuth2/OIDC Login 16.11
    • SMART: Application Approval/Consent 16.12
    • SMART Inbound Security Module 16.13
    • SMART: Session Management 16.14
    • SMART: Assigning Permissions 16.15
    • SMART: Access Tokens 16.16
    • SMART: User Profile Information 16.17
    • FHIR Client Authentication 16.18
  • appSphere
    • Introduction 17.0
    • Getting Started 17.1
    • Associated Module Configurations 17.2
    • Client Creation and Configuration 17.3
    • Other Configurations 17.4
    • Developer Portal 17.5
    • App Management Console 17.6
    • App Gallery 17.7
    • Appendix 17.8
  • FHIR Gateway
    • FHIR Gateway Introduction 18.0
    • Configuration: Initial Setup 18.1
    • Configuration: Document 18.2
    • Custom Operations 18.3
    • Caching 18.4
    • Pagination 18.5
  • FHIR Hybrid Providers
    • Hybrid Providers 19.0
    • REST Custom Operations 19.1
  • LiveBundle
    • LiveBundle Overview 20.0
    • LiveBundle API 20.1
    • LiveBundle Rule Definition 20.2
    • LiveBundle Keepers 20.3
  • CDS Hooks
    • CDS Hooks 21.0
  • Master Data Management
    • MDM 22.0
    • MDM Quickstart Guide 22.1
    • MDM Rule Definition 22.2
    • Using EIDs in MDM Rule Definition 22.3
    • MDM Survivorship Rules 22.4
    • Upgrading from the EMPI module 22.5
    • MDM UI 22.6
    • MDM Blocklist Definition 22.7
    • MDM Evaluate Operation 22.8
  • Quality Improvement
    • Quality Improvement Overview 23.0
    • Clinical Quality Language (CQL) 23.1
    • Care Gaps 23.2
    • Evaluating Measures 23.3
    • Quality Payment Program (QPP) 23.4
    • ActivityDefinitions 23.5
    • PlanDefinitions 23.6
    • Questionnaires 23.7
  • IG Support
    • International Patient Summary (IPS) 24.0
  • EasyShare
    • EasyShare SMART Health Links (SHL) 25.0
    • EasyShare SHL Public module 25.1
    • EasyShare SHL Admin module 25.2
  • Clustering
    • Designing a Cluster 26.0
    • Migration To 2020.02 26.1
  • Logging
    • Overview 27.0
    • Audit Log 27.1
    • Transaction Log 27.2
    • System Logging 27.3
    • Troubleshooting Logs 27.4
    • Custom Logging 27.5
  • HL7 v2.x Support
    • Introduction 28.0
    • Inbound Messaging 28.1
    • FHIR-Based Terminology Translation 28.2
    • Outbound Messaging 28.3
    • Outbound: Default Resource Conversion 28.4
    • Outbound: Custom Resource Conversion 28.5
    • Outbound: Verbatim Messaging 28.6
    • Outbound: Transport 28.7
    • Transactions 28.8
    • Structure Definitions 28.9
    • Segment Definitions 28.10
    • Table Definitions 28.11
    • Naming System Mapping 28.12
    • Processing Results Feeds 28.13
    • Protocol 28.14
  • CDA Exchange Module
    • Introduction 29.0
    • JavaScript Templates 29.1
    • Rest API Operations 29.2
    • Available Document and Section Types for CDA Export 29.3
    • Available Document and Section Types for CDA Import 29.4
    • JavaScript Hooks on CDA Import / Export 29.5
    • Further Reading 29.6
  • CDA Exchange+ Module
    • Introduction 30.0
    • JavaScript Templates 30.1
    • Rest API Operations 30.2
    • Available Document and Section Types for CDA Export 30.3
    • Available Document and Section Types for CDA Import 30.4
    • JavaScript Hooks on CDA Import / Export 30.5
    • FHIR-Based Terminology Translation 30.6
    • Further Reading 30.7
  • System to System Data Exchange
    • System to System Data Exchange Module 31.0
    • Smile CDR Payer to Payer Quickstart Guide 31.1
    • Custom Matching Script 31.2
  • Bulk Operations
    • ETL Import Module 32.0
    • FHIR Bulk Import Operation 32.1
    • FHIR Bulk Export Operation 32.2
  • Additional Features
    • Da Vinci Clinical Data Exchange (CDex) 33.0
    • Da Vinci Health Record Exchange (HRex) 33.1
  • Monitoring
    • Monitoring Basics 34.0
    • Elastic APM Basics 34.1
    • Externalized Metrics 34.2
    • OpenTelemetry Integration 34.3
  • Product Administration
    • Batch Job Management 35.0
    • Web Admin Console 35.1
  • JSON Admin Endpoints
    • JSON Admin API 36.0
    • Audit Log Endpoint 36.1
    • Batch Job Endpoint 36.2
    • Bulk Import Endpoint 36.3
    • CDA Exchange Endpoint 36.4
    • Metrics Endpoint 36.5
    • Module Config Endpoint 36.6
    • OpenID Connect Clients Endpoint 36.7
    • OpenID Connect Servers Endpoint 36.8
    • OpenID Connect Sessions Endpoint 36.9
    • Runtime Status Endpoint 36.10
    • System Config Endpoint 36.11
    • Transaction Log Endpoint 36.12
    • Troubleshooting Log Endpoint 36.13
    • User Management Endpoint 36.14
  • HFQL: Direct SQL Access
    • HFQL/SQL Overview 37.0
    • SQL Syntax 37.1
    • SQL Syntax: Select 37.2
    • SQL Syntax: Where 37.3
    • SQL Syntax: Limitations 37.4
    • SQL Syntax: Examples 37.5
  • Product Configuration
    • HTTP Server Setup 38.0
    • TLS and HTTPS Reference 38.1
  • Java Execution Environment
    • Security Attributes 39.0
    • Library Support 39.1
    • Exception Handling 39.2
    • Javadocs 39.3
    • Examples 39.4
  • JavaScript Execution Environment
    • Introduction 40.0
    • Specifying JavaScript in Configuration File 40.1
    • Remote Debugging 40.2
    • ECMA Modules (import) 40.3
    • Converter API 40.4
    • Environment API 40.5
    • Exceptions API 40.6
    • OAuth2 Exceptions API 40.7
    • FHIR REST API 40.8
    • FHIR Model API 40.9
    • HL7 v2.x Mapping API 40.10
    • HTTP API 40.11
    • LDAP API 40.12
    • Log API 40.13
    • Composition Resource API 40.14
    • Composition Section API 40.15
    • TransactionBuilder API 40.16
    • Util API 40.17
    • UUID API 40.18
    • XML API 40.19
    • Callback Models 40.20
  • Database Administration
    • Database Design 41.0
    • Database Connection Pool 41.1
    • Setting Up PostgreSQL 41.2
    • Troubleshooting PostgreSQL 41.3
    • Setting Up MySQL 41.4
    • Setting Up MariaDB 41.5
    • Setting Up Oracle 41.6
    • Setting Up SQL Server (MSSQL) 41.7
    • AWS IAM Authentication 41.8
  • Localization
    • Localization 42.0
    • Examples 42.1
    • Available Localization Keys 42.2
  • Smile CDR CLI (smileutil)
    • Introduction 43.0
    • Bulk Import 43.1
    • Create FHIR Package 43.2
    • Execute Script Function 43.3
    • Export ConceptMap to CSV 43.4
    • HL7 v2.x Analyze Flat File 43.5
    • HL7 v2.x Transmit Flat File 43.6
    • Import CSV to ConceptMap 43.7
    • Map and Upload CSV Bulk Import File 43.8
    • Migrate Database 43.9
    • Clear Database Migration Lock 43.10
    • Module Config Properties Export 43.11
    • Reindex Terminology 43.12
    • Synchronize FHIR Servers 43.13
    • Upgrade H2 Database File 43.14
    • Upload Bundle Files 43.15
    • Upload CSV Bulk Import File 43.16
    • Upload Sample Dataset 43.17
    • Upload Terminology 43.18
    • Generate Realtime Export Schema 43.19
    • Validate FHIR Resources 43.20
  • Apache Camel Integration
    • Camel Module Overview 44.0
    • Smile Camel Processors 44.1
    • Smile Camel Converters 44.2
  • Prior Auth CRD (Coverage Requirement Discovery)
    • Prior Auth CRD (Coverage Requirement Discovery) Module 45.0
  • Prior Auth DTR (Documentation Templates and Rules)
    • Prior Auth DTR (Documentation Templates and Rules) Module 46.0
  • Prior Auth Support
    • Prior Auth Support Module 47.0
  • Modules
    • JSON Admin API 48.0
    • Web Admin Console 48.1
    • CDA Exchange 48.2
    • Channel Import 48.3
    • Cluster Manager 48.4
    • CQL 48.5
    • Audit Log Persistence 48.6
    • Transaction Log Persistence 48.7
    • Digital Quality Measures (DQM) 48.8
    • Documentation Templates and Rules (DTR) 48.9
    • Enterprise Master Patient Index 48.10
    • CDS Hooks Endpoint 48.11
    • FHIR Gateway Endpoint 48.12
    • FHIR REST Endpoint (All Versions) 48.13
    • FHIR REST Endpoint (DSTU2 - Deprecated) 48.14
    • FHIR REST Endpoint (DSTU3 - Deprecated) 48.15
    • FHIR REST Endpoint (R4 - Deprecated) 48.16
    • FHIRWeb Console 48.17
    • HL7 v2.x Listening Endpoint 48.18
    • HL7 v2.x Listening Endpoint (Deprecated) 48.19
    • HL7 v2.x Sending Endpoint 48.20
    • Hybrid Providers Endpoint 48.21
    • Package Registry Endpoint 48.22
    • Subscription Websocket Endpoint 48.23
    • ETL Importer 48.24
    • MDM 48.25
    • MDM UI 48.26
    • Prior Auth CRD 48.27
    • Prior Auth Support 48.28
    • Narrative Generator 48.29
    • FHIR Storage (DSTU2 RDBMS) 48.30
    • FHIR Storage (R3 RDBMS) 48.31
    • FHIR Storage (R4 RDBMS) 48.32
    • FHIR Storage (R5 RDBMS) 48.33
    • FHIR Storage (Mongo) 48.34
    • Realtime Export 48.35
    • LDAP Inbound Security 48.36
    • Local Inbound Security 48.37
    • SAML Inbound Security 48.38
    • Scripted Inbound Security 48.39
    • SMART Inbound Security 48.40
    • SMART Outbound Security 48.41
    • Subscription Matcher (All FHIR Versions) 48.42
    • Subscription Matcher (DSTU2 - Deprecated) 48.43
    • Subscription Matcher (DSTU3 - Deprecated) 48.44
    • Subscription Matcher (R4 - Deprecated) 48.45
    • appSphere 48.46
    • Payer to Payer 48.47
    • System to System Data Exchange 48.48
    • Amazon HealthLake Outbound REST Connector 48.49
    • License 48.50
    • Camel 48.51
  • Configuration Categories
    • Web Admin Console Settings 49.0
    • appSphere 49.1
    • Payer Config 49.2
    • Initial appSphere Seeding 49.3
    • Authentication Callback Scripts 49.4
    • Auth: General for APIs 49.5
    • User Authentication 49.6
    • Auth: HTTP Basic 49.7
    • Auth: OpenID Connect 49.8
    • Browser Syntax Highlighting 49.9
    • Camel 49.10
    • Capability Statement (metadata) 49.11
    • Care Gaps 49.12
    • CDA Generation 49.13
    • CDA Import 49.14
    • CDA Interceptors 49.15
    • CDA JavaScript Execution Scripts 49.16
    • CDA Terminology 49.17
    • CDS Hooks Definitions 49.18
    • CDS Hooks On FHIR 49.19
    • Channel Import 49.20
    • Channel Retry 49.21
    • Kafka 49.22
    • Cluster Manager Maintenance 49.23
    • Message Broker 49.24
    • Cluster Level Security 49.25
    • CQL 49.26
    • Credentials 49.27
    • Cross-Origin Resource Sharing (CORS) 49.28
    • Invoke Export 49.29
    • Member Match 49.30
    • Database 49.31
    • Da Vinci Health Record Exchange 49.32
    • DQM 49.33
    • EasyShare SMART Health Links 49.34
    • Email Configuration 49.35
    • MDM UI 49.36
    • ETL Import: CSV Properties 49.37
    • ETL Import: Source 49.38
    • FHIR Binary Storage 49.39
    • FHIR Bulk Operations 49.40
    • Capability Statement 49.41
    • FHIR Configuration 49.42
    • Consent Service 49.43
    • FHIR Endpoint Conversion 49.44
    • FHIR Endpoint HFQL Support 49.45
    • FHIR Endpoint Partitioning 49.46
    • Resource Providers 49.47
    • FHIR Endpoint Security 49.48
    • Endpoint Terminology 49.49
    • FHIR Gateway Cache 49.50
    • FHIR Gateway Configuration 49.51
    • FHIR Interceptors 49.52
    • LiveBundle Service 49.53
    • FHIR MDM Server 49.54
    • FHIR Performance 49.55
    • FHIR Performance Tracing 49.56
    • FHIR Realtime Export 49.57
    • Repository Validation 49.58
    • FHIR Resource Types 49.59
    • FHIR REST Endpoint 49.60
    • FHIR Search 49.61
    • Custom Resource Types 49.62
    • IG Support 49.63
    • MegaScale 49.64
    • FHIR Storage Module Conditional Updates 49.65
    • FHIR Storage Module Scheduled Tasks 49.66
    • FHIR Validation Services 49.67
    • FHIR Storage Package Registry 49.68
    • FHIR Storage Partitioning 49.69
    • Versioned References 49.70
    • FHIR Subscription Delivery 49.71
    • FHIR Subscription Persistence 49.72
    • Amazon HealthLake REST Endpoint 49.73
    • HL7 v2.x Mapper - Contained Resource 49.74
    • HL7 v2.x Mapper - DG1 49.75
    • HL7 v2.x Mapper - Forced Namespace Mode 49.76
    • HL7 v2.x Mapper - General 49.77
    • HL7 v2.x Mapper - Medications 49.78
    • HL7 v2.x Mapper - OBR 49.79
    • HL7 v2.x to FHIR Mapper - OBSERVATION Group 49.80
    • HL7 v2.x Mapper - ORC 49.81
    • HL7 v2.x to FHIR Mapper - ORDER_OBSERVATION Group 49.82
    • HL7 v2.x Mapper - PID 49.83
    • HL7 v2.x Mapper - PV1 49.84
    • Listener Interceptors 49.85
    • HL7 v2.x Listener Script 49.86
    • HL7 v2.x Listening Endpoint 49.87
    • HL7 v2.x MLLP Listener 49.88
    • HL7 v2.x MLLP Sender 49.89
    • FHIR to HL7 v2.x Mapper Script 49.90
    • HL7 v2.x Outbound Mapping 49.91
    • HTTP Access Log 49.92
    • HTTP Listener 49.93
    • HTTP Request Pool 49.94
    • HTTP Security 49.95
    • Hybrid Providers Definitions 49.96
    • IG Support 49.97
    • Initial User Seeding 49.98
    • JavaScript Execution Environment 49.99
    • JSON Web KeySet (JWKS) 49.100
    • LDAP Authentication 49.101
    • Smile CDR License 49.102
    • Lucene FullText Indexing 49.103
    • MDM 49.104
    • Narrative Generator 49.105
    • OpenID Connect Token Validation 49.106
    • OpenID Connect (OIDC) 49.107
    • Payer to Payer 49.108
    • Prior Authorization Coverage Requirement Discovery 49.109
    • Prior Auth DTR 49.110
    • Prior Authorization Support 49.111
    • Privacy Security Notice 49.112
    • Provenance Injection 49.113
    • Quality Payment Program (QPP) 49.114
    • Realtime Export 49.115
    • Endpoint Validation: Request Validating 49.116
    • Scheduler Configuration 49.117
    • Search Parameter Seeding 49.118
    • SAML Provider 49.119
    • Security Inbound Script 49.120
    • Inbound SMART on FHIR Authentication 49.121
    • Inbound SMART on FHIR Endpoints 49.122
    • OAuth2/OIDC Federation 49.123
    • SMART Callback Script 49.124
    • Cross-Organizational Data Access Profile 49.125
    • SMART Login Skin 49.126
    • SMART Login Terms of Service 49.127
    • SMART Authorization 49.128
    • SMART Definitions Seeding 49.129
    • Sessions 49.130
    • Two Factor Authentication 49.131
    • TLS / SSL (Encryption) 49.132
    • Transaction Log 49.133
    • Trusted Client 49.134
    • User Self Registration 49.135
  • Product Reference
    • Enumerated Types 50.0
  • Amazon HealthLake Outbound REST Connector
    • Introduction 51.0
    • Getting Started 51.1
    • Data Management and Transfer 51.2
  • Appendix
    • Preparing a Linux Host 52.0
    • Installing Smile CDR, NGINX and PostgreSQL in a Docker Stack 52.1
    • Deploying a Kubernetes Managed Cluster 52.2
    • Password Hashing Algorithms 52.3
    • Resource Paths 52.4
    • JWT Signature Algorithms 52.5
    • Inferno Considerations 52.6
Search Results Loading
Loading