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.
| Welcome |
| Table of Contents |
| Table of Contents |
| Changelog (Current Releases) |
| Changelog |
| Smile CDR 2026.11.R01 (TBD) |
| Smile CDR 2026.08.R02 (Evolution) |
| Smile CDR 2026.08.R01 (Evolution) |
| Smile CDR 2026.05.R02 (Synchronicity) |
| Smile CDR 2026.05.R01 (Synchronicity) |
| Smile CDR 2026.02.R01 (Prologue) |
| Smile CDR 2025.11.R08 (Euphoria) |
| Smile CDR 2025.11.R07 (Euphoria) |
| Smile CDR 2025.11.R06 (Euphoria) |
| Smile CDR 2025.11.R05 (Euphoria) |
| Smile CDR 2025.11.R04 (Euphoria) |
| Smile CDR 2025.08.R04 (Amplification) |
| Changelog (2025 Releases) |
| Changelog: 2025 |
| Smile CDR 2025.11.R03 (Euphoria) |
| Smile CDR 2025.11.R02 (Euphoria) |
| Smile CDR 2025.11.R01 (Euphoria) |
| Smile CDR 2025.08.R03 (Amplification) |
| Smile CDR 2025.08.R02 (Amplification) |
| Smile CDR 2025.08.R01 (Amplification) |
| Smile CDR 2025.05.R03 (Fortification) |
| Smile CDR 2025.05.R02 (Fortification) |
| Smile CDR 2025.05.R01 (Fortification) |
| Smile CDR 2025.02.R04 (Transfiguration) |
| Smile CDR 2025.02.R03 (Transfiguration) |
| Smile CDR 2025.02.R02 (Transfiguration) |
| Smile CDR 2025.02.R01 (Transfiguration) |
| Changelog (2024 Releases) |
| Changelog: 2024 |
| Smile CDR 2024.11.R03 (Despina) |
| Smile CDR 2024.11.R02 (Despina) |
| Smile CDR 2024.11.R01 (Despina) |
| Smile CDR 2024.08.R05 (Copernicus) |
| Smile CDR 2024.08.R04 (Copernicus) |
| Smile CDR 2024.08.R03 (Copernicus) |
| Smile CDR 2024.08.R02 (Copernicus) |
| Smile CDR 2024.08.R01 (Copernicus) |
| Smile CDR 2024.05.R05 (Borealis) |
| Smile CDR 2024.05.R04 (Borealis) |
| Smile CDR 2024.05.R03 (Borealis) |
| Smile CDR 2024.05.R02 (Borealis) |
| Smile CDR 2024.05.R01 (Borealis) |
| Smile CDR 2024.02.R07 (Apollo) |
| Smile CDR 2024.02.R04 (Apollo) |
| Smile CDR 2024.02.R03 (Apollo) |
| Smile CDR 2024.02.R02 (Apollo) |
| Smile CDR 2024.02.R01 (Apollo) |
| Smile CDR 2023.11.R05 (Zed) |
| Smile CDR 2023.11.R04 (Zed) |
| Smile CDR 2023.08.R09 (Yucatán) |
| Changelog (2023 Releases) |
| Changelog: 2023 |
| Smile CDR 2023.11.R03 (Zed) |
| Smile CDR 2023.11.R02 (Zed) |
| Smile CDR 2023.11.R01 (Zed) |
| Smile CDR 2023.08.R08 (Yucatán) |
| Smile CDR 2023.08.R07 (Yucatán) |
| Smile CDR 2023.08.R06 (Yucatán) |
| Smile CDR 2023.08.R05 (Yucatán) |
| Smile CDR 2023.08.R04 (Yucatán) |
| Smile CDR 2023.08.R03 (Yucatán) |
| Smile CDR 2023.08.R02 (Yucatán) |
| Smile CDR 2023.08.R01 (Yucatán) |
| Smile CDR 2023.05.R03 (Xenon) |
| Smile CDR 2023.05.R02 (Xenon) |
| Smile CDR 2023.05.R01 (Xenon) |
| Smile CDR 2023.02.R07 (Wizard) |
| Smile CDR 2023.02.R06 (Wizard) |
| Smile CDR 2023.02.R05 (Wizard) |
| Smile CDR 2023.02.R04 (Wizard) |
| Smile CDR 2023.02.R03 (Wizard) |
| Smile CDR 2023.02.R02 (Wizard) |
| Smile CDR 2023.02.R01 (Wizard) |
| Smile CDR 2022.11.R05 (Vishwa) |
| Smile CDR 2022.11.R04 (Vishwa) |
| Smile CDR 2022.11.R03 (Vishwa) |
| Changelog (2022 Releases) |
| Changelog: 2022 |
| Smile CDR 2022.11.R02 (Vishwa) |
| Smile CDR 2022.11.R01 (Vishwa) |
| Smile CDR 2022.08.R05 (Unicorn) |
| Smile CDR 2022.08.R04 (Unicorn) |
| Smile CDR 2022.08.R03 (Unicorn) |
| Smile CDR 2022.08.R02 (Unicorn) |
| Smile CDR 2022.08.R01 (Unicorn) |
| Smile CDR 2022.05.R07 (Tanuki) |
| Smile CDR 2022.05.R06 (Tanuki) |
| Smile CDR 2022.05.R05 (Tanuki) |
| Smile CDR 2022.05.R04 (Tanuki) |
| Smile CDR 2022.05.R03 (Tanuki) |
| Smile CDR 2022.05.R02 (Tanuki) |
| Smile CDR 2022.05.R01 (Tanuki) |
| Smile CDR 2022.02.R08 (Sojourner) |
| Smile CDR 2022.02.R07 (Sojourner) |
| Smile CDR 2022.02.R06 (Sojourner) |
| Smile CDR 2022.02.R05 (Sojourner) |
| Smile CDR 2022.02.R04 (Sojourner) |
| Smile CDR 2022.02.R03 (Sojourner) |
| Smile CDR 2022.02.R02 (Sojourner) |
| Smile CDR 2022.02.R01 (Sojourner) |
| Smile CDR 2021.11.R07 (Raccoon) |
| Smile CDR 2021.11.R06 (Raccoon) |
| Smile CDR 2021.11.R05 (Raccoon) |
| Smile CDR 2021.11.R04 (Raccoon) |
| Smile CDR 2021.08.R09 (Quasar) |
| Smile CDR 2021.08.R08 (Quasar) |
| Changelog (2021 Releases) |
| Changelog: 2021 |
| Smile CDR 2021.11.R03 (Raccoon) |
| Smile CDR 2021.11.R02 (Raccoon) |
| Smile CDR 2021.11.R01 (Raccoon) |
| Smile CDR 2021.08.R06 (Quasar) |
| Smile CDR 2021.08.R05 (Quasar) |
| Smile CDR 2021.08.R04 (Quasar) |
| Smile CDR 2021.08.R03 (Quasar) |
| Smile CDR 2021.08.R02 (Quasar) |
| Smile CDR 2021.08.R01 (Quasar) |
| Smile CDR 2021.05.R03 (Pangolin) |
| Smile CDR 2021.05.R02 (Pangolin) |
| Smile CDR 2021.05.R01 (Pangolin) |
| Smile CDR 2021.02.R05 (Odyssey) |
| Smile CDR 2021.02.R04 (Odyssey) |
| Smile CDR 2021.02.R03 (Odyssey) |
| Smile CDR 2021.02.R02 (Odyssey) |
| Smile CDR 2021.02.R01 (Odyssey) |
| Smile CDR 2020.11.R02 (Numbat) |
| Changelog (2020 Releases) |
| Changelog: 2020 |
| Smile CDR 2020.11.R01 (Numbat) |
| Smile CDR 2020.08.R03 (Manticore) |
| Smile CDR 2020.08.R02 (Manticore) |
| Smile CDR 2020.08.R01 (Manticore) |
| Smile CDR 2020.05.R02 (Labrador) |
| Smile CDR 2020.05.R01 (Labrador) |
| Smile CDR 2020.02.R01 (Koala) |
| Changelog (2019 Releases) |
| Changelog: 2019 |
| Smile CDR 2019.11.R01 (Jitterbug) |
| Smile CDR 2019.08.R01 (Igloo) |
| Smile CDR 2019.05.R02 (Hippo) |
| Smile CDR 2019.05.R01 (Hippo) |
| Smile CDR 2019.02.R01 (Gale) |
| Changelog (2018 Releases) |
| Changelog: 2018 |
| Smile CDR 2018.11.R01 (Food) |
| Smile CDR 2018.09.R01 (Economist) |
| Smile CDR 2018.05.R01 (Dromedário) |
| Smile CDR 2018.03.R01 (Crouton) |
| Changelog (2017 Releases) |
| Changelog: 2017 |
| Smile CDR 2017.11.R01 (Buccaneer) |
| Smile CDR 2017.09.R01 (Aardvark) |
| Smile CDR 2017.07.R01 |
| Quick Start |
| Quick Installation |
| Installing Smile CDR |
| Installing to Linux / OSX |
| Basic Configuration |
| Quick Start |
| Hosting Responsibilities |
| Populating Sample Data |
| Populating Sample Data |
| Product Overview |
| Smile CDR Maturity Model |
| Smile CDR Maturity Model |
| List of Levels |
| Stable Features |
| Early Access Program Features |
| Limited Market Availability Features |
| Deprecated Features |
| Smile CDR Premium Solutions |
| Smile CDR Premium Solutions |
| List of Features by Maturity |
| List of Features by Maturity |
| Early Access Program (EAP) Features |
| Limited Market Availability (LMA) Features |
| Deprecated Features |
| Removed Modules |
| Removed Features |
| Development Forecast |
| Development Forecast |
| May 2026 Release Forecast |
| August 2026 Release Forecast |
| And Beyond |
| FHIR Certification |
| FHIR Certification |
| Product Concepts |
| Node and Module Framework |
| Smile HDP Process, Node and Module Framework |
| Processes, Nodes, and Modules |
| The Cluster Manager Module |
| Module Dependencies |
| Endpoint and Storage Modules |
| Concepts in Smile CDR |
| The FHIR Storage Module |
| The FHIR REST Endpoint Module |
| Clustering |
| Security in Smile CDR |
| Security in Smile CDR |
| Inbound Security Module |
| FHIR Listener Module |
| Admin Modules |
| Auth Directory |
| Audit Database |
| Outbound Security Modules |
| The FHIR Standard |
| FHIR Introduction |
| FHIR Introduction |
| Resources |
| Datatypes |
| Parts of a Resource |
| Encodings (MIME Types, Wire Formats) |
| The JSON Format |
| The XML Format |
| FHIR Versions |
| FHIR versions |
| FHIR CRUD Operations |
| FHIR CRUD Operations |
| Testing Tools |
| FHIR Create |
| FHIR Read / vRead |
| FHIR Update |
| FHIR Patch |
| FHIR Delete |
| Controlling the Response Payload |
| Storage Outcome Status Codes |
| FHIR Searching Basics |
| FHIR Searching Basics |
| How Searching Works |
| Basic Searching: Finding Patients |
| Quantities: Finding Laboratory Values |
| Dates and Times: Narrowing Your Search Window |
| Paging Search Results |
| Sorting Search Results |
| Fulltext Searching |
| The Patient $everything Search (Across Patient Chart) |
| FHIR Search: References and Includes |
| FHIR Search: References and Includes |
| References Example |
| Searching By Reference |
| Chained References |
| Reverse Chained References |
| Including Reference Targets |
| Reverse Includes |
| Chaining into Contained Resources |
| Canonical References |
| Example: Using subject Group Membership to Filter Results |
| REST Operation: $hapi.fhir.replace-references |
| FHIR Search: Custom Search Parameters |
| FHIR Search: Custom Search Parameters |
| An Example Search Parameter |
| Search Parameter Expressions |
| Introducing Search Parameters on Existing Data |
| FHIR Search: Combo Search Parameters |
| Combo Search Index Parameters |
| Composite vs Combo Search Index Parameters |
| Example |
| Indexing Dates in Combo Search Parameters |
| Ranged Date Searches |
| Ranged Date Search Example |
| Support for Component Types |
| FHIR Search: Enforcing Uniqueness |
| Enforcing Uniqueness in FHIR Data |
| Unique Combo Search Index Parameters |
| FHIR Search: Uplifted Refchains |
| FHIR Search: Uplifted Refchains |
| Document and Message Search Parameters |
| Combo Search Parameters on Uplifted Refchains |
| FHIR Transactions and Batches |
| FHIR Transactions and Batches |
| FHIR Transaction |
| Creating Multiple Related Resources |
| Placeholder IDs and References |
| Conditional Creates |
| Conditional Updates |
| Example: Conditional Create Patient and Create Other Data |
| Deletes |
| Patching |
| Meta Operations |
| Example: Conditional Create + Patch On Same Resource |
| FHIR Transaction Response |
| FHIR Batch |
| FHIR Batch Response |
| FHIR Batch vs Transaction |
| Transaction Semantics and Auto-Retry |
| FHIRPath Expressions |
| FHIRPath Expressions |
| Testing FHIRPath Expressions |
| Expression: Extension With Reference Value |
| Expression: Nested Extension |
| Expression: Contained Resource |
| Expression: Bundle (FHIR Message) Entry Resource |
| Expression: Bundle (FHIR Document) Entry Resource |
| Example: Indexing Automatically Created Placeholder Resources |
| Expression: Multiple Paths |
| FHIRPath Patch |
| FHIRPath Patch |
| Operation: Add |
| Operation: Insert |
| Operation: Delete |
| Deleting Multiple Elements |
| Operation: Replace |
| Operation: Move |
| Example: Replace Any Existing LOINC Codes |
| Versions and Upgrading |
| Smile CDR Versioning |
| A Primer on Smile CDR Versioning |
| Types of Releases |
| Release Cadence |
| Example Releases |
| Upgrade Concepts |
| Upgrade Concepts |
| What is an upgrade |
| Upgrade Modes |
| Updating Smile CDR Software |
| Upgrading the binaries |
| Upgrade Best Practices |
| Best Practices |
| Database Migration Impact |
| Database Upgrade Impact |
| Vulnerability (CVE) Policy |
| CVE Policy and Vulnerability Management |
| CVE Guarantees by Release Type |
| How Dependency Vulnerabilities Accumulate Over Time |
| Vulnerability Scanning |
| Reporting a CVE |
| Migration Technical Details |
| Migration Technical Details |
| Appendix and FAQ |
| Version-Specific upgrade concerns |
| Frequently Asked Questions |
| Testing Tools |
| Overview |
| SmileCdrContainer and SmileHarness Overview |
| Usage |
| SmileCdrContainer and SmileHarness Usage |
| SmileCdrContainer Configuration Options |
| Working with SmileHarness |
| Working with FHIR Contexts |
| Clients |
| Available Clients in SmileHarness |
| Best Practices |
| Best Practices for Testing with SmileCdrContainer and SmileHarness |
| Installing |
| Platform Requirements |
| Platform Requirements |
| Server Requirements |
| Java Requirements |
| Database Requirements |
| Database Testing Matrix |
| Network Infrastructure |
| Event Streaming |
| Preparing a Linux Host |
| Preparing a new Linux Host |
| Ubuntu Host with PostgreSQL / NGINX / Letsencrypt |
| Install letsencrypt and obtain Certs (optional) |
| Install nginx And Configure it to Front the Server |
| Red Hat Enterprise Linux (RHEL) or CentOS |
| Installing Smile CDR, NGINX and PostgreSQL in a Docker Stack |
| Installing Smile CDR, NGINX and PostgreSQL as a Docker Stack |
| Initial Setup of Docker and Context |
| Prepare Configuration for Smile CDR Docker Service |
| Prepare Configuration for NGINX Docker Service |
| Prepare Configuration for PostgreSQL Docker Service |
| Create Docker compose file for Smile CDR Docker stack |
| Build and Launch Smile CDR Stack |
| Deploying a Kubernetes Managed Cluster |
| Deploying a Kubernetes Managed Cluster |
| Overview of Smile CDR Kubernetes Deployment Process |
| Pre-requisite Steps |
| Configuring Kubernetes |
| Kubernetes and Smile CDR Database Connections |
| Kubernetes Health Probes |
| JVM Memory Settings |
| Service Definitions |
| ConfigMap Definitions |
| Deployment Definitions |
| Deploying Smile CDR in a Kubernetes Cluster |
| Configuring Reverse Proxy and Load Balancer |
| Considerations When Deploying Smile CDR Using OpenShift |
| Docker Container Installation |
| Docker Container Installation |
| Quick Start |
| Basic Configuration |
| Customizing Smile CDR in Docker Container |
| Mounting Customizations with Bind Mounts |
| Using System Environment for Variable Substitution |
| Read-Only Filesystem Support |
| Configuring Databases for Smile CDR Installed in Container |
| Configuring Smile CDR |
| Configuring Smile CDR |
| The Initial Configuration |
| The Node Configuration Properties File |
| Node Configuration Properties |
| Module Property Source |
| Maintaining Module Configuration |
| Variable Substitution |
| Fetching Configuration Using Scripts |
| Configuring Your Database |
| Starting the CDR |
| API Gateways |
| Resource Paths |
| Unix Service Installation |
| Unix Service Installation |
| Testing the Service |
| Starting Automatically on Boot |
| Tuning your Installation |
| Tuning Your Installation |
| Memory Settings |
| Designing a Cluster |
| Designing a Cluster |
| Node and Module Design |
| Process IDs |
| Adding and Removing Processes |
| Multi-Node Clusters |
| Sample Architecture |
| Message Brokers |
| Message Brokers |
| Subscription Channels |
| Subscription Channel Names |
| Modules Dependent On Message Brokers |
| Message Ordering and Partition Keys |
| Sending your own messages to Message Brokers |
| Message Broker Failure Management |
| Message Broker Failure Management |
| Message Broker: Kafka |
| Message Broker: Kafka |
| Kafka Topic Names |
| Message Ordering with Partition Keys |
| Kafka - Overriding Default Configuration Settings |
| Configuring Kafka with SASL |
| Message Broker: ActiveMQ |
| Message Broker: ActiveMQ |
| Resource Limits |
| Message Broker: Pulsar |
| Message Broker: Pulsar |
| Pulsar Topic Names |
| Message Ordering with Message Keys |
| Customizing Pulsar Configuration with Interceptors |
| Dead Letter Queue |
| Pre-Seeding Configuration and Data |
| Pre-Seeding Configuration and Data |
| Pre-Seeding Module Configuration |
| Variable Substitution for Pre-Seeding files |
| Pre-Seeding Users |
| Pre-Seeding Custom Roles |
| Pre-Seeding OpenID Connect Servers |
| Pre-Seeding OpenID Connect Clients |
| Pre-Seeding OpenID Connect Keystores |
| Pre-Seeding Packages |
| Pre-Seeding FHIR Resources |
| Production Checklist |
| Production Checklist |
| Host Server Setup |
| Network Infrastructure |
| CDR Process Settings |
| FHIR Server Performance |
| Monitoring |
| Security |
| Message Broker |
| Cluster Design |
| Module Licensing |
| Module Licensing |
| Upgrading |
| Introduction |
| Migration Guides |
| Example Online Upgrade |
| Example Online Mode Upgrade |
| Operating |
| Monitoring Basics |
| Monitoring Basics |
| HTTP Endpoint Health Check |
| Process Status Endpoints |
| Runtime Health Checks |
| Externalized Metrics |
| Externalized Metrics |
| Step 1 - Install Prometheus |
| Step 2 - Install Grafana |
| Step 3 - Creating a Prometheus data source on Grafana |
| Step 4 - Configure Smile CDR |
| Step 5 - Creating a Grafana Dashboard  |
| Smile CDR Observability |
| Smile CDR Observability with Grafana, OpenTelemetry, Loki & Tempo |
| OpenTelemetry Integration |
| Step 1: Enable OpenTelemetry in Smile CDR |
| Java Agent Setup (Optional) |
| Notes on Metrics |
| Step 2: Launch Smile CDR with Observability Stack |
| Troubleshooting |
| Useful Docker Commands |
| Summary |
| Performance Tuning |
| Performance Tuning for FHIR Storage (Relational) |
| Improving Write Performance |
| Example Properties File |
| Disabling Non Resource DB History |
| Enabling Index Storage Optimization |
| Tuning External Object Storage |
| Troubleshooting |
| Troubleshooting Smile CDR |
| Database Administration |
| Database Design |
| Database Design |
| Cluster Manager Database |
| FHIR Relational Storage |
| FHIR MongoDB (Non-Relational) Storage |
| Database Connection Pool |
| Database Connection Pool |
| Setting Up PostgreSQL |
| Setting Up PostgreSQL |
| Supported Versions |
| Creating a Database for Smile CDR |
| Database Connection Properties |
| Cluster Manager Database |
| FHIR Storage Database |
| FHIR Storage Database: Standard |
| FHIR Storage Database: Database Partition Mode |
| FHIR Storage Database: 5 Hash Partition |
| Troubleshooting PostgreSQL |
| Troubleshooting Postgresql |
| Host Name Verification Error |
| Network Timeouts |
| Setting Up MariaDB |
| Setting Up MariaDB |
| Supported Versions |
| Creating a Database for Smile CDR |
| Database Connection Properties |
| Setting up a Cluster Manager Database |
| Setting up a FHIR Storage (Relational) Database |
| Setting Up Oracle |
| Setting Up Oracle |
| Supported Versions |
| Database Connection Properties |
| Setting up a Cluster Manager Database |
| Setting up a FHIR Storage (Relational) Database |
| Setting Up SQL Server (MSSQL) |
| Setting Up SQL Server (MSSQL) |
| Supported Versions |
| Creating a Database for Smile CDR |
| Preparing an SQL Server Database for Smile CDR |
| Database Connection Properties |
| Setting up a Cluster Manager Database |
| Setting up a FHIR Storage (Relational) Database |
| Troubleshooting |
| AWS RDS Authentication |
| Support for AWS RDS |
| Username and Password Authentication |
| IAM Authentication |
| AWS Secrets Manager Authentication |
| Troubleshooting Connection Issues |
| Choosing Between IAM and Secrets Manager Authentication |
| Limitations |
| Azure Entra Authentication |
| Support for Entra Authentication for Azure Databases |
| Planning |
| CDA Exchange Plus Import Planning |
| Considerations to make before implementing CDA Exchange Plus |
| Implementation |
| CDA Exchange Plus Import Implementation |
| Implementation of CDA Exchange Plus Import |
| Tutorials |
| Introduction |
| Smile CDR Tutorials |
| Identify your Setup |
| Integration Testing Tutorial |
| Tutorial: Writing Tests with SmileCdrContainer and SmileHarness |
| HL7v2 Testing |
| NPM Package Testing |
| Customizing SmileCdrContainer |
| Conclusion |
| Custom Operations Tutorial |
| Smile CDR Tutorial - Custom Operations |
| HL7 v2.x Ingestion Tutorial |
| HL7 v2.x Ingestion Tutorial |
| Transmitting to Smile CDR |
| ORU (Observation Result) Messages |
| ADT (Admission/Discharge/Transfer) Messages |
| Federated OAuth2/OIDC Tutorial |
| Federated OAuth2/OIDC Tutorial |
| Setting up Smile CDR - SMART Outbound Security Module |
| Setting up Smile CDR - OIDC Client Definition |
| Setting up Smile CDR - OIDC Server Definition |
| Setting up the IDP |
| Starting the Federated Flow |
| Token Signature Algorithms |
| Considerations |
| MDM Tutorial |
| Smile CDR MDM Tutorial |
| MDM UI Tutorial |
| Master Data Management User Interface (MDMUI) |
| Setup |
| MDM First Golden Resource Tutorial |
| Your First Golden Resource |
| Prerequisites |
| Step 1: Create a User for This Tutorial |
| Step 2: Enable MDM on the FHIR Storage Module |
| Step 3: Add and Configure the MDM Module |
| Step 4: Create the First Patient |
| Step 5: Create the Second Patient |
| Step 6: Inspect the MDM Links |
| Step 7: Read the Golden Resource |
| What You've Accomplished |
| Next Steps |
| MDM Advanced Rule Authoring Tutorial |
| Advanced Rule Authoring |
| How a Rule Definition Script Works |
| Example 1: Family Name Matching |
| Example 2: Requiring Both Family and Given Name |
| Example 3: Adding a POSSIBLE_MATCH Tier |
| Example 4: Multiple Candidate Searches and Identifier Matching |
| Example 5: Fine-Grained Control with Similarity Scoring |
| Example 6: A Production-Grade Rule Set |
| Design Considerations |
| Next Steps |
| MDM Web UI Admin Setup Tutorial |
| Setting Up the MDM Web UI for Data Stewards |
| Prerequisites |
| Step 1: Configure the FHIR Storage Module |
| Step 2: Configure the MDM Module with Match Rules |
| Step 3: Configure the SMART Outbound Security Module |
| Step 4: Configure the JSON Admin API Endpoint |
| Step 5: Configure the FHIR REST Endpoint |
| Step 6: Create the OIDC Client |
| Step 7: Add the MDM UI Module |
| Step 8: Create Data Steward User Accounts |
| Step 9: Verify the Setup |
| What You've Accomplished |
| Next Steps |
| CDA Import Tutorial |
| Smile CDR Tutorial - Convert a CDA Document into FHIR Resources |
| CDA Export Tutorial |
| Smile CDR Tutorial - Export a CDA document from the SmileCDR repository |
| CDA Export - Custom Narrative Generation Tutorial |
| CDA Export Tutorial - Generating Narrative text |
| CDA Import JSON example |
| Smile CDR Tutorial Resource - CDA Import Example |
| CDA Export Template JSON example |
| Smile CDR Tutorial Resource - CDA Export Template Example |
| Consent Tutorial |
| Smile CDR Tutorial - Use the Consent Module to Manage Patient Consent |
| CMS-0057-F IG Setup Tutorial |
| CMS-0057-F Compliance: Installing and Validating IGs |
| FHIR Storage |
| FHIR Storage Modules |
| FHIR Storage Modules |
| Feature Comparison Summary |
| Features |
| FHIR Operations |
| Search Parameters |
| Search Parameter Types |
| FHIR Endpoint Module |
| FHIR Endpoint Module |
| Creating the Module |
| Request Transaction IDs |
| Capturing Source Information |
| Response Watermarking |
| Validation |
| Configuration |
| FHIRWeb Console |
| FHIRWeb Console |
| Architecture |
| Security |
| Creating the Module |
| Using the Console |
| Configuration |
| OpenAPI / Swagger Support |
| OpenAPI / Swagger Support |
| Swagger UI |
| OpenID Connect Support |
| Limitations |
| FHIR Endpoint Customization |
| FHIR Endpoint Customization |
| Customizing Available Interactions |
| Customizing CapabilityStatement and OpenApi |
| Resource IDs |
| Resource IDs |
| Server Assigned IDs |
| Client Assigned IDs |
| Search Parameters |
| Search Parameters |
| Search Parameter Concepts |
| Default Search Parameters |
| Managing Search Parameters |
| Search Parameter Statistics |
| Filter Search Parameter |
| Search Parameter Features |
| Search Parameter Features |
| Searching by English nickname (:nickname) |
| Index Missing Search Parameters (:missing) |
| Suppress Text Index on Tokens (:text) |
| Index Contained Resources |
| Phonetic Search Parameters |
| Phonetic Search Parameters |
| Search Parameter Tuning |
| Search Parameter Initialization |
| Checking Active Parameters |
| Seeding Search Parameters |
| Search Parameter Reindexing |
| Manual Reindexing |
| $reindex Operation (Server) |
| Reindex URLs |
| Examples |
| Reindexing Deleted Resources |
| Reindex Batch Job |
| Correcting Current Version Pointers |
| $reindex Operation (Instance) |
| $reindex-dryrun Operation (Instance) |
| Legacy Manual Reindex Operation |
| Searching for Data |
| Searching For Data |
| FHIR Search Extensions |
| Unsupported Search Parameters |
| Limitations |
| Creating Data |
| Creating Data |
| Validating References and Referential Integrity |
| Transactions and Submitting Bundles |
| Auto-Creating Reference Targets |
| Auto-Create Placeholder Reference Targets |
| Auto-Create Placeholder Reference Targets with Identifier |
| Auto-Created Placeholder Extension |
| Searching for Auto-Created Resources |
| Auto-Creating Reference Targets and Enforcing Uniqueness |
| Mass Ingestion Mode |
| Reading Data |
| Reading Data |
| Diff Operation |
| Diff Instance |
| Diff Type |
| $everything operation |
| Updating Data |
| Updating Data |
| Patching Data |
| Tag Retention |
| Concurrent Write Errors |
| Deleting Data |
| Deleting Data |
| Deletes and Referential Integrity |
| Transactional Delete |
| Referential Integrity |
| Cascading Deletes |
| The $expunge Operation |
| Delete Expunge |
| Binary Data |
| Binary Data |
| Externalized Binary Storage |
| Binary Access Operations |
| Serving Raw Media Resources |
| Serving binary data within a FHIR Resource |
| External Object Storage |
| External Object Storage |
| External Object Storage Performance Tuning |
| Externalized Resource Body Storage |
| Externalized Resource Body Storage |
| Real-time Resource Body Offload |
| Resource Body Offload Operation |
| Performance And Storage Implications |
| Limitations |
| Request Tracing and Provenance |
| Request Tracing and Provenance |
| Request Tracing |
| Performance Tracing |
| Storing Source Information |
| Resource Versions and Versioned References |
| Resource Versions |
| Disabling Resource History |
| Rewriting Resource History |
| Versioned Resource References |
| Allow Versioned References |
| Automatically Version References |
| Tags, Profiles, and Security Labels |
| Tags, Profiles and Security Labels |
| Search Parameters |
| Partitioning and Multitenancy |
| Partitioning and Multitenancy |
| Storage Module Support |
| Partitioning Patient and Ancillary Resources |
| Enabling Partitioning in Smile CDR |
| Request Partition Selection Mode |
| Request Tenant Partition Selection Mode |
| Request Header Partition Selection Mode |
| Partition Naming Mode |
| Seeding Named Partitions |
| Request Partition Security |
| Cross-Partition References |
| Supported Modules |
| Patient ID Partitioning Modes |
| Patient ID Partition Modes |
| Patient ID Partition Selection Mode |
| Bucketed Patient ID Partition Selection Mode |
| Resource Type Policies |
| Custom Resource Types |
| Custom Resource Types |
| Defining Custom Resource Type Classes |
| Example Project |
| Search Parameters |
| Batch and Scheduled Jobs |
| Batch And Scheduled Jobs |
| Batch Jobs |
| Architecture |
| Optimizing Batch Job Performance |
| Clustered Scheduled Jobs |
| Local Scheduled Jobs |
| Scheduler Performance |
| Tokenization |
| Tokenization and Field-Level Encryption |
| Tokenization Algorithm |
| Tokenization Rules |
| Searching and Tokenization |
| Tokenization and Validation |
| Other Limitations |
| Updating Tokenization Rules |
| Update Tokenization Operation ($sdh.update-tokenization) |
| Bulk Resource Modification |
| Bulk Resource Modification |
| Security Implications |
| Bulk Patch ($hapi.fhir.bulk-patch) |
| Bulk Patch with History Rewrite ($hapi.fhir.bulk-patch-rewrite-history) |
| Common Bulk Modification Request Parameters |
| Partitioned Bulk Modification Jobs |
| Polling for Status |
| FHIR Storage (Relational) |
| FHIR Storage (Relational) Module |
| FHIR Storage (Relational) Module |
| Preparing for a New Installation |
| Creating the Module |
| Database Schema |
| Multi-Node Architectures |
| Configuration |
| Full-Text Indexing Configuration |
| Resource Storage Mode |
| Resource Storage Mode |
| Resource Body Storage |
| Full-Text Indexing |
| Full-Text Indexing |
| Indexes |
| Customizing Text and Content Full-Text Indexing |
| Full-Text Providers |
| Lucene Disk Provider |
| Elasticsearch/OpenSearch Provider |
| Performance and Caching |
| FHIR Performance and Caching |
| The Query Cache |
| Search Counts |
| Query Cache Support |
| Chained Searching and Sorting |
| Chained Searching And Sorting |
| Uplifted Refchains and Chaining Performance |
| Chained Sorting |
| Scaling Smile CDR Databases |
| Scaling Smile CDR Databases |
| Summary |
| Background |
| Partitioning |
| Scaling Recommendations |
| MegaScale |
| MegaScale |
| Architecture |
| Partitions and Shards |
| Patient ID Partition Selection Mode |
| FHIR Transactions Spanning Multiple Shards |
| FHIR Searches Spanning Multiple Shards |
| Limitations |
| Configuration |
| Connection Provider Interceptor |
| MegaScale Patient ID Partition Selection Modes |
| MegaScale Patient ID Partition Selection Modes |
| Required and Suggested Settings |
| Partition Distribution |
| Patient Resource ID-Identifier Mapping |
| Reading Data |
| Writing Data |
| Overriding Partition Distribution |
| Document Repository Mode |
| Document Repository Mode |
| Placeholder Patients |
| Supported Search Parameters |
| Writing Documents |
| Meta Source Migration |
| Resource Meta Source Migration |
| Compressed Token Indexing |
| Compressed Token Indexing |
| Configuration |
| Routing Search Parameters to the Identifier Table |
| Available Strategies |
| Migrating Existing Data |
| Database Schema |
| Database Partition Mode |
| Database Partition Mode |
| Support |
| AWS Limitless Database Support |
| Citus Data Support |
| FHIR Storage (MongoDB) |
| FHIR Storage (MongoDB) Module |
| FHIR Storage (MongoDB) Module |
| Preparing for a New Installation |
| Creating the Module |
| MongoDB Document Schema |
| MongoDB Uplift Search Parameter Extensions |
| Uplifting Tokens |
| Uplifting Reference Chains |
| Configuration |
| MongoDB Sharding / Partitioning |
| Sharding / Partitioning on MongoDB |
| Scope and Limitations |
| Enabling Sharding |
| Architecture |
| Validation and Conformance |
| Introduction |
| Validation and Conformance |
| Conformance Resources |
| Validation Modes |
| Remote Terminology Services |
| Suppressing Validation Messages |
| Validation Performance |
| Validation Support Repository |
| Validation Support Repository |
| Potential Architectures |
| Single FHIR Repository (RDBMS) |
| Dedicated Validation Support Repository |
| Non-Repository Models |
| Validation Support Repository Options |
| Validation Support Repository Options |
| Validating References |
| Handling Missing CodeSystems |
| Handling Multiple Codings |
| Allowing Database Validation Override |
| Code Display Mismatch Policy |
| Validation Support Cache |
| Conformance Data |
| Conformance Data |
| StructureDefinition resources |
| CodeSystem Resources |
| ValueSet Resources |
| Repository Validation |
| Repository Validation |
| Validation Support Repository |
| Methods |
| Repository Validation: Java |
| Java Based Repository Validation |
| Repository Validation: Javascript |
| JavaScript Based Repository Validation |
| Function: repositoryValidationProvideRules(theRuleBuilder) |
| Example: Require a Specific Profile |
| Example: Allow Several Profiles for a Resource Type |
| Example: Require Profile and Validate |
| Repository Validation: Custom Validation Beans |
| Custom Validation Beans |
| Endpoint Validation |
| Endpoint Validation |
| Packages and Implementation Guides |
| Packages and Implementation Guides |
| Background: Implementation Guides |
| Background: Packages |
| Ingesting Packages into Smile CDR |
| Allowed Package URLs (whitelist) |
| Package Pre-Seed Installation |
| Pre-Seeding Resources into the Repository |
| Customizing Installed Resource Types |
| Creating Packages |
| Troubleshooting Package Installation |
| Package Registry Endpoint Module |
| Package Registry Endpoint module |
| Swagger UI |
| Operation: Fetch Metadata By Package ID |
| Operation: Fetch Package |
| Operation: Search For Packages |
| Operation: Find Package Asset Info |
| Operation: Find Package Resource JSON |
| Operation: Install By Param |
| Operation: Install By Spec |
| Operation: Delete By Spec |
| Remote Terminology Services |
| Remote Terminology Service |
| Scope |
| Remote Terminology Server Requirements |
| Remote Terminology Server Authentication |
| Suppressing Messages |
| Validation Message Post-Processing |
| Validation Performance |
| Validation Performance |
| Automatic Provenance Injection |
| Automatic Provenance Injection |
| Provenance Injection Feature |
| Provenance Injection Data |
| Terminology |
| Terminology Introduction |
| Terminology |
| FHIR Terminology Resources |
| Terminology Features in Smile CDR |
| Supported Terminology Operations |
| Unsupported Operations |
| Uploading Codes |
| Uploading CodeSystems |
| Withdrawn Operations |
| Uploading External CodeSystems |
| Uploading LOINC |
| Uploading SNOMED CT |
| Uploading ICD-10 |
| Uploading ICD-10-CM |
| Uploading Other Vocabularies |
| Vocabulary Input File Formats |
| Upload Terminology Operations |
| External Terminology Upload Operation: $hapi.fhir.upload-terminology.create-job |
| External Terminology Upload Operation: $hapi.fhir.upload-terminology.attach-file |
| External Terminology Upload Operation: $hapi.fhir.upload-terminology.start-job |
| External Terminology Upload Operation: $hapi.fhir.upload-terminology.poll-for-status |
| How Uploaded Terminology Interacts with IG Packages |
| Terminology and Full-Text Indexing |
| Terminology and Full-Text Indexing |
| ValueSet Expansion |
| ValueSet Expansion |
| ValueSet Expansion Pre-Calculation |
| Invalidating Pre-Calculated Expansion ($invalidate-expansion) |
| Expanding Hierarchical CodeSystems and ValueSets |
| Troubleshooting Expansion Failures |
| Searching for Codes |
| Terminology Mapping |
| Terminology Mapping |
| The ConceptMap Resource |
| Mapping Codes: $translate Operation |
| Adding Mappings to ConceptMaps |
| Removing Mappings from ConceptMaps |
| FHIR Response Terminology Mapping |
| FHIR Response Terminology Enhancement |
| Response Terminology Mapping |
| Response Coding Displays |
| In-Place Code Translation |
| In-Place Code Translation |
| Activation Methods |
| Missing Translation Suggestion |
| Semantic Standardization |
| Semantic Standardization Module |
| Semantic Standardization Module |
| West Coast Informatics (WCI) Provider |
| Semantic Standardization (3s) Provider West Coast Informatics (WCI) |
| Subscription |
| Introduction |
| Subscription |
| The Subscription Resource |
| Subscription Activation |
| Delivery Retry Handling |
| MultiTenancy and Subscriptions |
| Criteria |
| Synchronization of Subscription updates |
| Troubleshooting Subscriptions |
| Architecture |
| Smile CDR Subscription Architecture |
| Enabling and Configuring Subscription Processing |
| Channel Types |
| Channel Types |
| Channel Type: rest-hook |
| Channel Type: email |
| Channel Type: websocket |
| Channel Type: message |
| Delivery Options |
| Delivery Options |
| Payload Search Result Mode |
| Replication Mode |
| Strip Version IDs |
| Delivering Latest Version |
| Delivering Delete Events |
| Custom Delivery Class |
| Kafka Record Header Delivery |
| DEPRECATED: Delivery to Site-defined External Queue |
| Manual Triggering |
| Manually Triggering Subscriptions |
| Topic Subscriptions |
| Topic Subscriptions |
| Interceptors |
| Interceptors |
| Interceptors |
| HAPI FHIR and Smile CDR Pointcuts |
| Deploying Interceptors to Smile CDR Modules |
| Registering a Client Interceptor |
| Example Interceptors |
| Pointcuts |
| Pointcuts |
| Starter Project |
| Starter Project |
| Examples: FHIR Endpoints |
| FHIR Endpoint Examples |
| Example: Override CapabilityStatement Generation |
| Example: Starter Server interceptor for all SERVER_xxx pointcuts |
| Examples: HL7v2 Endpoints |
| HL7v2 Endpoint Examples |
| Example: Starter Server interceptor for all HL7v2 pointcuts |
| Examples: FHIR Storage |
| FHIR Storage Examples |
| Example: Response Attribute Enhancement |
| Example: Server-Reserved Tags |
| Example: JavaScript Storage Interceptor |
| Example: MegaScale Connection Provider |
| Example: Starter Storage interceptor for all STORAGE_xxx pointcuts |
| Examples: FHIR Gateway |
| FHIR Gateway Examples |
| Pointcuts |
| Example: Direct Search based on Parameter Value |
| Example: Modify Target Search based on Previous Target Search |
| Example: Modify Target Search Results |
| Example: Modify Target Search Uri |
| Example: Search Using Alternate Patient ID |
| Example: Add Custom Headers to a GET Target Request |
| Example: Add Custom Headers to a Bulk Export Operation Request |
| Example: Starter Gateway interceptor for all FHIRGW_xxx pointcuts |
| Examples: FHIR Client |
| FHIR Client interceptor Examples |
| Example: Starter Client interceptor for all CLIENT_xxx pointcuts |
| Examples: MDM |
| MDM Examples |
| Example: Operate on resources analyzed by MDM, before and after analysis |
| Example: Starter MDM interceptor for all MDM_xxx pointcuts |
| Examples: Subscription |
| Subscription Examples |
| Example: Adding Authorization header |
| Example: Starter Subscription interceptor for all SUBSCRIPTION_xxx pointcuts |
| Examples: Channel Import |
| Channel Import Examples |
| Example: Starter Channel Import interceptor for CHANNEL_IMPORT_MESSAGE_PRE_PROCESSED pointcut |
| Examples: Cluster Manager |
| Cluster Manager Examples |
| Example: Starter Server interceptor for Auditing and Open ID Connect Client Pointcuts |
| Examples: App Sphere |
| App Sphere Examples |
| Example: Starter Server interceptor for all AppSphere Pointcuts |
| OIDC Client Secrets and Interceptors |
| Propagating a Regenerated Client Secret |
| Examples: System To System Data Exchange |
| System-to-System Data Exchange Examples |
| Example: Custom Member Match |
| Example: Client Auth Pre Token |
| 2024.02.01 Migration Guide |
| 2024.02.R01 Interceptor Upgrade Guide |
| Channel Import |
| Channel Import Overview |
| Channel Import Overview |
| Enabling and Configuring Channel Import |
| Channel Import With Partitioning Enabled |
| Message Ordering for Channel Import |
| Realtime Export |
| Realtime Export Overview |
| Realtime Export Overview |
| Operational Overview |
| Limitations |
| Troubleshooting |
| Supported Databases |
| Batch Processing |
| Loading Existing Data |
| Bootstrapping RTE Data |
| Loading Existing Data |
| Limitations |
| Realtime Export Rules Definition |
| Realtime Export Rules Definition |
| Transformers |
| Named Transformers |
| Managing high-cardinality elements |
| Using FHIRPath |
| Using FHIRPath |
| Collection Subsetting |
| Self-referral |
| Conditionals |
| Delta Lake Export |
| Delta Lake Export |
| Architecture |
| Write Semantics |
| Configuration |
| Child Tables |
| Schema Evolution |
| Type Mapping |
| Differences from JDBC Realtime Export |
| Limitations |
| Bulk Batch Replication |
| Bulk Batch Replication |
| Module |
| Architecture |
| Manual Trigger Operation |
| Configuration |
| Limitations |
| Security |
| Authentication Protocols |
| Authentication Protocols |
| HTTP Basic |
| OpenID Connect (OIDC) and SMART on FHIR |
| Security Assertion Markup Language (SAML) |
| Authorization and Consent |
| Authorization and Consent |
| Authorization Service |
| Consent Service |
| Inbound Security Module |
| Inbound Security Module |
| Permissions |
| Callback Script |
| Local Inbound Security Module |
| Local Inbound Security Module |
| Configuration: Credentials |
| Caching |
| User Self Registration |
| LDAP Inbound Security Module |
| LDAP Inbound Security Module |
| Requirements |
| Permissions |
| Callback Scripts |
| Configuration |
| Scripted Inbound Security Module |
| Scripted Inbound Security |
| Script Format |
| Script Examples |
| SAML Inbound Security Module |
| SAML Inbound Security Module |
| SAML 2.0 Authentication Request Protocol |
| Enabling SAML Authentication |
| Entity ID Template |
| Authentication Scripts |
| Function: authenticate(theRequest, theOutcomeFactory) |
| Authorizing SMART on FHIR Apps using SAML |
| Trusted Client Mode |
| Trusted Client Mode |
| Configuring Trusted Client Mode |
| Making Trusted Client Requests |
| Automatically Creating Users |
| Roles and Permissions |
| Roles and Permissions |
| System-Defined Roles |
| System-Defined Permissions |
| System-Defined Negative Permissions |
| Block Unless Code in ValueSet |
| User-Defined Roles |
| Callback Scripts |
| Authentication Callback Scripts |
| Function: onAuthenticateSuccess |
| Function: onAuthenticateSuccessClientCredentials |
| Function: onSmartLoginPreContextSelection(theUserSession, theContextSelectionChoices) |
| Function: onSmartScopeAuthorityNarrowing |
| Function: onTokenGenerating(theUserSession, theAuthorizationRequestDetails, theClientDetails) |
| Function: onPostAuthorize(theDetails) |
| Function: authenticate(theRequest, theOutcomeFactory) |
| Function: getUserName(theOidcUserInfoMap, theServerInfo) |
| Anonymous Access |
| Anonymous Access |
| Consent Service |
| Consent Service |
| Enabling the Consent Service |
| Consent Service: JavaScript API |
| Consent Service: JavaScript API |
| Method: consentStartOperation |
| Method: consentCanSeeResource |
| Method: consentWillSeeResource |
| Method: completeOperationSuccess |
| Method: completeOperationFailure |
| Example: Tag-Based Consent Script |
| Example: Scope-Based Consent Script |
| Example: Using Consent Purpose and Actor |
| Consent Service: Java API |
| Consent Service: Java API |
| Example |
| Security Recipes |
| Security Recipes |
| App: Local Users with HTTP Basic Authentication |
| Integrating SMART Apps With a 3rd-Party OIDC Server |
| Two Factor Authentication |
| Two Factor Authentication |
| User Activating TOTP |
| Enforcing Two Factor Authentication |
| Password Hashing Algorithms |
| Password Hashing Algorithms |
| Available Algorithms |
| JWT Signature Algorithms |
| JWT Signature Algorithms |
| Troubleshooting Security |
| Troubleshooting Security |
| Consent Module |
| Overview |
| Consent Module: Overview |
| Introduction |
| Consent Module JSON Configuration |
| Consent Module Configuration (Diagram) |
| Consent Module Request Flow |
| Bulk Export Support |
| Glossary |
| Built-in Fixed Policies |
| Built-in Fixed Policies |
| Built-in Parameterized Policies |
| Built-in Parameterized Policies |
| End-to-End Worked Example |
| Troubleshooting |
| Examples |
| Consent Module: Examples |
| Smile Provided Consent Resource Policies |
| smileSecurityLabelConsentServiceR4 |
| Built-in Fixed Policies |
| Built-in Parameterized Policies |
| SMART on FHIR |
| SMART on FHIR: Introduction |
| SMART on FHIR: Introduction |
| The SMART Launch Sequence |
| The Interactive Launch Process |
| SMART: Scopes |
| SMART on FHIR: Scopes |
| Picking Scopes |
| Launch Context Scopes |
| The OpenID and Profile Scopes |
| fhirContext |
| SMART: Auth Flows |
| Authorization Flows |
| Client Types |
| Launch Flow: Authorization Code |
| Security Option: private-key-jwt |
| Security Option: Proof Key for Code Exchange (PKCE) |
| Launch Flow: Implicit Grant |
| Launch Flow: Resource Owner Password Credentials |
| Non-Interactive User Flow: Cross-Organization Data Access Profile |
| System Flow: Client Credentials |
| System Flow: Client Credentials with JWT Credential |
| System Flow: Refresh Token |
| SMART: Endpoints |
| SMART on FHIR: Endpoints |
| Server Metadata Endpoint |
| UserInfo Endpoint |
| SMART: Smile CDR Support |
| SMART on FHIR: Smile CDR Support |
| Models for Using External OIDC Servers |
| Serving the CapabilityStatement Anonymously |
| Supported Scopes |
| Online / Offline Access |
| SMART Outbound Security: Module |
| SMART on FHIR Outbound Security Module |
| Setting Up This Module |
| Terms of Service |
| Plain-language Developer Attestation |
| Client Credentials Grant |
| Cross-Organization Data Access Profile Grant |
| SMART Callback Scripts |
| User Self Registration |
| SMART Outbound Security: Skinning |
| Skinning the SMART Outbound Security Module |
| Creating a Skin |
| Installing a Skin |
| HTML Template Files |
| Sample Skin Project |
| SMART Outbound Security: Context Selection |
| SMART on FHIR Outbound Security Module: Context Selection |
| SMART Outbound Security: SAML Bridging |
| SAML to SMART Bridging |
| Creating a SAML to SMART Bridge |
| SMART: Federated OAuth2/OIDC Login |
| Federated OAuth2/OIDC Login |
| Federated Flow |
| Considerations |
| Setting Up Federated OAuth2/OIDC Login |
| Client Authentication |
| Authorization Script |
| Server Selection Interceptor |
| SMART: Application Approval/Consent |
| SMART: Application Approval / Consent |
| Approval Overview |
| Auto-Approve / Auto-Grant Scopes |
| Approval Flow |
| Customizing Scope Names |
| Custom Security Scopes |
| Revocation Page |
| SMART Inbound Security Module |
| SMART on FHIR Inbound Security Module |
| Requirements |
| Setting Up This Module |
| Accepting Tokens |
| Accepting Internal Access Tokens |
| Accepting External Access Tokens |
| Validating Tokens |
| Creating a Server Definition |
| Assigning Permissions |
| Function: authenticate(...) |
| Function: getUserName(...) |
| Function: onSmartScopeAuthorityNarrowing(...) |
| SMART Client Definitions |
| SMART Client Definitions |
| Remembering Approved Scopes |
| Export and Import |
| Client Secrets |
| Client JWT Authentication |
| Requiring Client Authentication |
| Change Client Secret Endpoint |
| SMART Server Definitions |
| SMART Server Definitions |
| Creating a Server Definition |
| Issuer |
| Key |
| Client Authentication Mode |
| SMART OIDC Keystore Definitions |
| SMART OpenID Connect Keystores |
| SMART: Session Management |
| Session Management |
| Token Revocation Endpoint |
| User Logout Endpoint |
| SMART: Assigning Permissions |
| SMART on FHIR: Assigning Permissions |
| Scope Permission Model |
| User and Patient Resource Linkage |
| SMART: Access Tokens |
| Access Tokens |
| SMART: User Profile Information |
| SMART User Profile Information |
| FHIR Client Authentication |
| FHIR Client Authentication |
| Rejecting Unauthorized FHIR Calls |
| SMART: Machine to Machine Authentication |
| SMART on FHIR Machine to Machine (M2M) Authentication |
| appSphere |
| Introduction |
| appSphere: Introduction |
| Getting Started |
| Getting Started |
| Auto-Approving Registrations in a Testing Zone |
| Config Diagnostics |
| Associated Module Configurations |
| Associated Module Configurations |
| Configuration of JSON Admin API module |
| Configuration of FHIR Endpoint Module |
| Configuration of SMART Auth Module |
| Configuring SMART Auth modules to support multiple OIDC endpoints |
| Setting-up Federated OAuth to work with appSphere |
| Client Creation and Configuration |
| Client Creation and Configuration |
| Other Configurations |
| Other Configurations |
| Configuring NGINX for the Module |
| Configuring Different Users |
| Developer Portal |
| Developer Portal |
| API Documentation for Dev Portal |
| Developer Registration |
| Developer Portal: UI Description |
| Repository Partitions |
| App Registration |
| Managing 'Draft' App Registrations and Re-registrations |
| App Information Page |
| Attestation |
| New App versions |
| Backend Service Registration |
| Additional Considerations |
| App Management Console |
| App Management Console |
| Management Console: UI Description |
| App Review and Management |
| Backend Service Review and Management |
| Upgrading |
| Additional Considerations |
| App Gallery |
| App Gallery |
| App Gallery: UI Description |
| Gallery Functionality |
| Appendix |
| Appendix |
| Config Diagnostics |
| App Registration Help Text |
| Sign Up Help Text |
| Smile CDR Config |
| Attestation Creation |
| Current Software Versions --TRAIL-- |
| Troubleshooting |
| Reference Documents |
| Glossary of Terms |
| FHIR Gateway |
| FHIR Gateway Introduction |
| FHIR Gateway Endpoint |
| Troubleshooting |
| Limitations |
| Supported FHIR Operations |
| Configuring Consent Service |
| Bulk Export Operation |
| Davinci Data Export Operation |
| Terminology Operations |
| Resource Validation Operation |
| Configuration: Initial Setup |
| Gateway Setup |
| Server Configuration |
| Encryption JWKS (Keystore) |
| Configuration Document |
| Interceptors |
| Error Handling |
| Configuration: Document |
| FHIR Gateway Configuration Document |
| Defining Targets |
| Defining Search Routes |
| Defining Read, Create, Update, Delete, and History Routes |
| Defining Operation Routes |
| Defining a Retry Strategy |
| Custom Operations |
| Custom Operation Providers |
| Sample Custom System Operation Provider |
| Processing Target Invocation Responses |
| The Spring Context Config Class |
| Packaging Your Providers |
| Deploying Your Custom Providers |
| Caching |
| Caching |
| Pagination |
| Pagination |
| FHIR Hybrid Providers |
| Hybrid Providers |
| Hybrid Providers |
| Architecture |
| Resource Providers |
| CapabilityStatement |
| The Spring Context Config Class |
| Interceptor Loading |
| Building Your Hybrid Providers |
| Paging |
| Camel Services |
| Packaging Your Providers |
| Deploying Your Hybrid Providers |
| Accessing Security Attributes |
| Configuring Consent Service |
| Accessing Dao (Data Access Object) |
| Exceptions |
| Example Project |
| REST Custom Operations |
| REST Custom Operations |
| LiveBundle |
| LiveBundle Overview |
| LiveBundle |
| Configuration |
| Usage |
| LiveBundle Architecture |
| LiveBundle Aggregation |
| LiveBundle Retrieval |
| LiveBundle Seeding |
| LiveBundle Troubleshooting |
| LiveBundle API |
| LiveBundle API |
| Add a Subscriber to a Watchlist |
| Remove Subscriber from a Watchlist |
| View list of Subscribers to a Watchlist |
| Request a bundle of Subscribers to a watchlist |
| Reseed all bundles for a rule |
| Request a LiveBundle |
| LiveBundle Rule Definition |
| LiveBundle Rule Definition |
| Loading Rules |
| Example LiveBundle Javascript |
| LiveBundle Watchlist |
| LiveBundle Rule |
| LiveBundle Filter |
| Keeper Filters |
| LiveBundle Keeper |
| LiveBundle Keepers |
| LiveBundle Keepers |
| LiveBundle Keeper Examples |
| LatestByPath |
| LatestByParamPath |
| LatestByParamPathByMonth |
| ToggleByPath |
| ToggleBySearch |
| WatchlistPopulator |
| Optional Keeper Parameters |
| CDS Hooks |
| CDS Hooks |
| CDS Hooks |
| Auto Prefetch |
| Architecture |
| CDS Hooks Classes |
| The Spring Context Config Class |
| CDS Hooks Extensions |
| Building Your CDS Hooks |
| Deploying Your CDS Hooks |
| Accessing Security Attributes |
| Exceptions |
| Calling CDS Hooks |
| Example Project |
| CDS on FHIR |
| CDS Hooks Version |
| Master Data Management |
| MDM |
| Master Data Management (MDM) |
| Selecting a deduplication strategy |
| Deduplication on Ingestion |
| Deduplication on Ingestion |
| Integrating an External Entity Resolution Service |
| Integrating an External Entity Resolution Service |
| Golden Record MDM |
| Golden Record MDM |
| Working with Duplicates |
| Working with Duplicates |
| Deduplication Operations |
| $merge Operation |
| $hapi.fhir.merge Operation |
| $hapi.fhir.undo-merge Operation |
| $hapi.fhir.replace-references Operation |
| $hapi.fhir.undo-replace-references Operation |
| $sdh.mdm-bundle-match Operation for Deduplication |
| $sdh.mdm-deduplicate Operation |
| Deduplication Roadmap |
| MDM Rule Definition |
| MDM Rule Definition |
| Finding Candidates |
| Matching and Creating Links |
| MDM Rule Schema Reference |
| MDM Rule Schema |
| Supported Match Algorithms |
| Supported Match Algorithms |
| Custom MDM Matching Algorithms |
| Custom MDM Matching Algorithms |
| Implementing a Custom Matcher |
| Implementing a Custom Similarity |
| Packaging and Deployment |
| Using Custom Algorithms in MDM Rules |
| Testing Custom Algorithms |
| Troubleshooting |
| Using EIDs in MDM Rule Definition |
| Using Enterprise Identifiers (EIDs) in MDM Rule Definition |
| Changing the way MDM is processing incoming resources |
| MDM Blocklist Definition |
| MDM Block Rules |
| MDM Survivorship Rules |
| MDM Survivorship Rules |
| MDM Operations |
| MDM Operations |
| $mdm-evaluate Operation |
| $sdh.mdm-bundle-match Operation |
| MDM Bundle Match Processor |
| MDM API Operations Reference |
| MDM API Operations |
| MDM Match Result Definitions |
| MDM Match Result Definitions |
| MDM Virtualized Endpoint |
| MDM Virtualized Endpoint |
| Architecture |
| Upgrading from the EMPI module |
| Upgrading from EMPI |
| IG Support |
| International Patient Summary (IPS) |
| International Patient Summary (IPS) |
| Generation Rules |
| EasyShare |
| EasyShare SMART Health Links (SHL) |
| EasyShare SMART Health Links |
| Understanding SMART Health Links |
| Architecture |
| Security |
| EasyShare SHL Public module |
| EasyShare SMART Health Links Public module |
| Installation |
| SHL Creation API |
| EasyShare SHL Admin module |
| EasyShare SMART Health Links Admin module |
| Installation |
| SHL Creation Application |
| Logging |
| Overview |
| Audit and Transaction Logs |
| Audit Log |
| Audit Log |
| Audit Log Configuration |
| Disabling the Audit Log |
| Example Audit Log Json |
| Audit Module |
| Transaction Log |
| Transaction Log |
| Cluster Manager Transaction Log Storage |
| Transaction Log Persistence Module |
| Transaction Log Broker Module |
| Example Transaction Log JSON |
| What Does the Transaction Log Store? |
| Transaction Log Configuration |
| Controlling Transaction Log Events |
| Performance Tracing |
| Event Types and SubTypes |
| Transaction Storage Outcomes |
| Hiding Request Body |
| Capturing System Logs |
| Changing Timezone |
| Using Multiple Transaction Logs |
| System Logging |
| System Logging |
| Changing Logging Settings |
| Stdout-Only Logging in Containers |
| Protected Health Information (PHI) in Logs |
| Retrieving Logs |
| JVM Stats Logging |
| Troubleshooting Logs |
| Troubleshooting Logs |
| Capturing Troubleshooting Logs in the Transaction Log |
| Docker Considerations |
| Troubleshooting Logs Endpoint |
| Camel HTTP Endpoint Troubleshooting Log |
| CDA Exchange+ Troubleshooting Log |
| Consent Module Troubleshooting Log |
| HL7V2 Troubleshooting Log |
| HTTP Troubleshooting Log |
| Partition Troubleshooting Log |
| Security Troubleshooting Log |
| Subscription Troubleshooting Log |
| LiveBundle Troubleshooting Log |
| MDM Troubleshooting Log |
| Channel Import Troubleshooting Log |
| Realtime Export Troubleshooting Log |
| FHIR Gateway Troubleshooting Log |
| Connection Pool Troubleshooting Log |
| Batch Framework Troubleshooting Log |
| Narrative Generation Troubleshooting Log |
| Terminology Troubleshooting Log |
| MongoDB Troubleshooting Log |
| Prior Auth Troubleshooting Log |
| System to System Data Exchange Troubleshooting Log |
| Custom Logging |
| Custom Logging |
| Custom Logging |
| HL7 v2.x Support |
| Introduction |
| HL7 v2.x Support |
| Inbound HL7 v2.x Support |
| Outbound HL7 v2.x Support |
| HL7 v2.x Versions |
| Inbound Messaging |
| HL7 v2.x Support: Inbound Messaging (to Smile CDR) |
| Security |
| Processing |
| Callback Scripts |
| Function: onPreConvertHl7V2ToFhir(theMessage, theConversionResult) |
| Function: onPostConvertHl7V2ToFhir(theMessage, theConversionResult) |
| Function: onPreQueryResponse(theResponse, theContext) |
| Adding Processing Messages |
| Lookup message segments by type |
| Custom Processing Logic |
| Pointcuts |
| Utility Functions |
| Deduplication Against MDM Records |
| Inbound: Query Processing |
| Query Processing |
| Processing |
| Callback Scripts |
| FHIR-Based Terminology Translation |
| FHIR-based Terminology Translation |
| Which ConceptMap do I want? |
| Outbound Messaging |
| HL7 v2.x Support: Outbound Messaging (from Smile CDR) |
| Getting Started |
| Message Generation Subscription Types |
| Outbound: Default Resource Conversion |
| Default Outbound Resource Conversion |
| ADT Workflow Mode |
| Enriching Message Conversion using Scripts |
| Function: onPostConvertFhirToHl7V2(theTriggerResource, theOutgoingMessage, theContext) |
| Using Persisted MessageHeader Resources |
| Outbound: Custom Resource Conversion |
| Custom Outbound Resource Conversion |
| Business Transaction Triggers with MessageHeader |
| Custom Mapper Class |
| Custom Mapper Subscription |
| Outbound: Verbatim Messaging |
| Verbatim Messaging Subscriptions |
| Outbound: Transport |
| Outbound HL7v2 Messaging: Transport |
| Customizing HL7 over HTTP Payload |
| Transactions |
| HL7 v2.x Transactions |
| ADT (Patient Administration) Domain |
| BAR (Billing) Domain |
| DFT (Financial) Domain |
| MDM (Document Management) Domain |
| OMG/ORM (Orders) Domain |
| ORU (Results) Domain |
| RDE/RAS (Pharmacy) Domain |
| SIU (Scheduling) Domain |
| VXU (Immunization / Vaccination) Domain |
| QBP (Query by Parameter) Domain |
| Structure Definitions |
| Structure Definitions |
| Structure: ADT_A01 |
| Structure: ADT_A02 |
| Structure: ADT_A03 |
| Structure: ADT_A05 |
| Structure: ADT_A06 |
| Structure: ADT_A09 |
| Structure: ADT_A10 |
| Structure: ADT_A12 |
| Structure: ADT_A17 |
| Structure: ADT_A21 |
| Structure: ADT_A30 |
| Structure: ADT_A38 |
| Structure: ADT_A39 |
| Structure: ADT_A44 |
| Structure: ADT_A45 |
| Structure: ADT_A54 |
| Structure: ADT_A60 |
| Structure: ADT_A61 |
| Structure: BAR_P12 |
| Structure: DFT_P03 |
| Structure: MDM_T01 |
| Structure: MDM_T02 |
| Structure: OMG_O19 |
| Structure: QBP_Q21 |
| Structure: ORM_O01 |
| Structure: ORU_R01 |
| Structure: RAS_O17 |
| Structure: RDE_O11 |
| Structure: RSP_K23 |
| Structure: SIU_S12 |
| Structure: VXU_V04 |
| Segment Definitions |
| Segment Definitions |
| Segment: MSH (Message Header) |
| Segment: EVN (Event) |
| Segment: PID (Patient) |
| Segment: PD1 (Patient Demographics Extended) |
| Segment: PV1 (Visit/Encounter) |
| Segment: PV2 (Visit/Encounter Additional) |
| Segment: ROL (Role) |
| Segment: DG1 (Diagnosis) |
| Segment: PR1 (Procedure) |
| Segment: MRG (Merge Patient Information) |
| Segment: GT1 (Guarantor) |
| Segment: IN1 (Insurance) |
| Segment: IN2 (Insurance Additional Information) |
| Segment: ORC (Order Control) |
| Segment: OBR (Observation Request) |
| Segment: OBX (Observation) |
| Segment: NK1 (Next of Kin / Patient Contact) |
| Segment: NTE (Note) |
| Segment: FT1 (Financial Transaction) |
| Segment: RXA (Pharmacy Administration) |
| Segment: RXC (Pharmacy Component) |
| Segment: ZXC (Pharmacy Component) |
| Segment: RXE (Pharmacy Encoded Order) |
| Segment: RXR (Pharmacy Route) |
| Segment: AL1 (Allergy Information) |
| Segment: IAM (Patient Adverse Reaction) |
| Segment: SPM (Specimen) |
| Segment: SCH (Scheduling) |
| Segment: RGS (Resource Group Segment) |
| Segment: AIL (Location Resource) |
| Segment: AIP (Personnel Resource) |
| Segment: TXA (Transcription Document Header) |
| Segment: QPD (Query Parameter Definition) |
| Segment: RCP (Response Control Parameter) |
| Segment: QAK (Query Acknowledgment) |
| Segment: PID (Query Response) |
| Segment: ZXT (Non-Standard) |
| A Note about Extra Components |
| A Note about the XTN Data Type |
| A Note about DSTU3 Mode Mappings |
| Table Definitions |
| Table Definitions |
| Table 0001: Administrative Sex |
| Table 0002: Marital Status |
| Table 0004: Patient Class |
| Table 0007: Admission Type |
| Table 0009: Ambulatory Status |
| Table 0017: Transaction Type |
| Table 0018: Patient Type |
| Table 0038: Order Status |
| Table 0052: Diagnosis Type |
| Table 0063: Relationship |
| Table 0069: Hospital Service |
| Table 0074: Diagnostic Service Section ID |
| Table 0078: Observation Interpretation Codes |
| Table 0085: Observation Status |
| Table 0112: Discharge Disposition |
| Table 0117: Account Status |
| Table 0119: Order Control |
| Table 0123: Result Status |
| Table 0125: Observation Value Type |
| Table 0127: Allergen Type |
| Table 0128: Allergen Severity |
| Table 0129: Accommodation Code |
| Table 0131: Contact Role |
| Table 0136: Yes/No |
| Table 0166: RX Component Type |
| Table 0190: Address Type |
| Table 0191: Type of Referenced Data |
| Table 0200: Name Type Code |
| Table 0201: Telecom Use |
| Table 0202: Telecom Equipment Type |
| Table 0203: Identifier Type |
| Table 0208: Query Response Status |
| Table 0270: Document Type |
| Table 0271: Document Completion Status |
| Table 0273: Document Availability Status |
| Table 0276: Appointment Reason Codes |
| Table 0278: Filler Status Code |
| Table 0291: Subtype of Referenced Data |
| Table 0299: Encoding |
| Table 0301: Universal ID Type |
| Table 0305: Person Location Type |
| Table 0322: Completion Status |
| Table 0438: Allergy Clinical Status Code |
| Table 0834: MIME Types |
| Naming System Mapping |
| Naming System Mapping |
| Default Mappings |
| Using NamingSystem for Mapping Identifiers |
| Using NamingSystem for Query Mapping |
| Processing Results Feeds |
| Processing ORU (Results) Messages |
| Unsolicited Observation Request (ORU^R01) |
| Protocol |
| HL7 v2.x Protocol |
| Encoding Format |
| ER7 (Pipe-Delimited) Format |
| Minimal Lower Layer Protocol (MLLP) Transport |
| HL7 over HTTP |
| Character Encoding / Charsets |
| CDA Exchange+ Module |
| Introduction |
| CDA Exchange+ Module Introduction |
| CDA Export |
| CDA Import |
| Supported sections and CDA document types |
| JavaScript Templates |
| CDA JavaScript Templating System |
| The simplest CDA template script |
| Adding header information to our CDA template script |
| Adding and populating a section in our CDA template script |
| Using the Fhir.search() API to dynamically populate sections |
| Specifying input parameters |
| More complicated input parameters |
| Specifying section author participation |
| Putting it all together |
| Configuring the $docref CCD template |
| Rest API Operations |
| CDA REST Operations |
| Endpoints for configuring templates |
| Endpoints for applying templates |
| Endpoints for importing CDA documents |
| Endpoints for exporting CDA documents |
| Available Document and Section Types for CDA Export |
| CDA Module Mappings for Export |
| Valid Document Types |
| Valid Resources for the header |
| Valid Section Types and Sources |
| Applicable To All Sections |
| Admission Diagnosis Section |
| Admission Medication Section |
| Allergy and Intolerances Section |
| Assessment and Plan Section |
| Encounters Section |
| Care Team Section |
| Discharge Medication Section |
| Family History Section |
| Functional Status Section |
| Goals Section |
| Immunizations Section |
| Medical Equipment Section |
| Medications Section |
| Mental Status Section |
| Past Medical History Section |
| Payer Section |
| Plan of Treatment Section |
| Problem Section |
| Procedures Section |
| Reason For Referral Section |
| Results Section |
| Social History Section |
| General Status Section |
| History of Present Illness Section |
| Objective Section |
| Review of Systems Section |
| Subjective Section |
| Course of Care Section |
| Health Status Evaluations and Outcomes Section |
| Interventions Section |
| Physical Exam Section |
| Vital Signs Section |
| Note Section |
| Discharge Diagnosis Section |
| Chief Complaint Section |
| Reason for Visit Section |
| Chief Complaint and Reason for Visit Section |
| Hospital Consultations Section |
| Hospital Course Section |
| Hospital Discharge Instructions Section |
| Hospital Discharge Physical Section |
| Hospital Discharge Studies Summary Section |
| Instructions Section |
| Nutrition Section |
| Assessment Section |
| Advance Directives Section |
| Medical (General) History Section |
| Health Concerns Section |
| Available Document and Section Types for CDA Import |
| CDA Module Mappings for Import |
| Valid Document Types |
| Resources derived from the header |
| Valid Section Types and Sources |
| Admission Diagnosis Section |
| Admission Medications Section |
| Allergy and Intolerances Section |
| Assessment and Plan Section |
| Care Team Section |
| Discharge Diagnosis Section |
| Discharge Medication Section |
| Encounters Section |
| Family History Section |
| Functional Status Section |
| Goals Section |
| Immunizations Section |
| Medical Equipment Section |
| Medications Section |
| Mental Status Section |
| Past Medical History Section |
| Payer Section |
| Course of Care Section |
| General Status Section |
| Health Status Evaluations and Outcomes Section |
| History of Present Illness Section |
| Interventions Section |
| Objective Section |
| Physical Exam Section |
| Review of Systems Section |
| Subjective Section |
| Plan of Treatment Section |
| Problem Section |
| Procedures Section |
| Reason for Referral Section |
| Results Section |
| Social History Section |
| Vital Signs Section |
| Note Section |
| Chief Complaint Section |
| Reason for Visit Section |
| Chief Complaint and Reason for Visit Section |
| Hospital Consultations Section |
| Hospital Course Section |
| Hospital Discharge Instructions Section |
| Hospital Discharge Physical Section |
| Hospital Discharge Studies Summary Section |
| Instructions Section |
| Nutrition Section |
| Assessment Section |
| Advance Directives Section |
| Medical (General) History Section |
| Health Concerns Section |
| JavaScript Hooks on CDA Import / Export |
| JavaScript Hooks on CDA Import / Export |
| CDA Pre Import JavaScript Hook |
| CDA Post Import JavaScript Hook |
| CDA Post Export JavaScript Hook |
| Exposed APIs for use in JavaScript Execution Environment |
| Example Scripts |
| FHIR-Based Terminology Translation |
| FHIR-Based Terminology Translation |
| Default Mappings: DSTU3 |
| Default Mappings: R4 |
| CDA Section-level Narrative Generation |
| Narrative Generation |
| Further Reading |
| Additional Documentation for CDA |
| System to System Data Exchange |
| System to System Data Exchange Module |
| System to System Data Exchange Module |
| Smile CDR Payer to Payer Quickstart Guide |
| Smile CDR Payer to Payer Quickstart Guide |
| Custom Matching Script |
| Custom Matching Script |
| Bulk Member Match |
| Multi-member match operations |
| Consent Status Operation |
| $sdh.s2s.consent-status operation |
| Plans Operation |
| $sdh.s2s.plans operation |
| Bulk Operations |
| ETL Import Module |
| ETL Import (Extract/Transform/Load) |
| Importing CSV Data |
| Function: handleEtlImportRow(theInputMap, theContext) |
| Handling Multiple Import Formats |
| Initiating ETL Jobs |
| Performance and Concurrency |
| Locking Rows |
| Creating a Hashing Script |
| Asynchronous Execution |
| Failure Handling and the Transaction Log |
| Performance |
| FHIR Bulk Import Operation |
| FHIR Bulk Import |
| Triggering a Bulk Import |
| Methodology |
| Performance |
| Limitations |
| FHIR Bulk Export Operation |
| FHIR Bulk Export Operation |
| Enabling Bulk Export |
| Types of Bulk Export Requests |
| Request Parameters |
| Requesting A Bulk Extract |
| Authorization for Bulk Export |
| Polling for Job Status |
| Accessing Bulk Export Files |
| Cancelling a Bulk Export Job |
| Limitations |
| Additional Features |
| Da Vinci Clinical Data Exchange (CDex) |
| Da Vinci Clinical Data Exchange (CDex) |
| Da Vinci Health Record Exchange (HRex) |
| Da Vinci Health Record Exchange (HRex) |
| Product Administration |
| Batch Job Management |
| Batch Job Management |
| OpenTelemetry Integration |
| OpenTelemetry Integration |
| Observability Backends |
| Enabling OpenTelemetry Instrumentation in Smile CDR |
| Agent Configuration |
| Enabling/Disabling Exported Data |
| Correlating Logs and Traces |
| Vendor specific OpenTelemetry tools and agents |
| Custom Telemetry Data Provided by Smile CDR |
| OpenTelemetry Audit and Transaction Log Modules |
| Web Admin Console |
| Web Admin Console |
| JSON Admin Endpoints |
| JSON Admin API |
| JSON Admin API |
| Endpoint Summary |
| Security |
| Format |
| Allowing Anonymous Access |
| JSON Admin Home Endpoint |
| JSON Admin Home Endpoint |
| Access Swagger UI |
| MDM Endpoint |
| MDM Endpoint |
| MDM Deprecation Migration |
| JSON Admin API MDM Deprecation Migration |
| Audit Log Endpoint |
| Audit Log Endpoint |
| Fetch Audit Log |
| Fetch Individual Event |
| Fetch Individual Event by Module |
| Fetch Module IDs |
| Fetch Event Types |
| Export Audit Events as CSV |
| Batch Job Endpoint |
| Batch Job Endpoint |
| List Available Batch Job Modules |
| Fetch Batch Jobs by Filters |
| Fetch Batch Job Names |
| Fetch All Job Instances |
| Fetch Job Instance by ID |
| Cancel Job Execution |
| Custom Scheduled Job Endpoint |
| Custom Scheduled Job Endpoint |
| Create a Scheduled Job |
| Update a Scheduled Job |
| Fetch All Scheduled Jobs |
| Fetch a Specific Scheduled Job |
| Delete a Scheduled Job |
| Trigger a Scheduled Job |
| Fetch Scheduled Job Execution History |
| Fetch a Specific Execution History Event |
| Bulk Import Endpoint |
| Bulk Import Endpoint |
| Process ETL File |
| Smileutil: CSV Bulk Import File |
| CDA Exchange Endpoint |
| CDA Exchange Endpoint |
| Create CDA Template |
| Update CDA Template |
| Update CDA Template script via text |
| View CDA Template(s) |
| Delete CDA template |
| Example CDA Template |
| Config Diagnostics Endpoint |
| Config Diagnostics Endpoint |
| Metrics Endpoint |
| Metrics Endpoint |
| Fetch Local Metrics |
| Capture Thread Dump |
| Module Config Endpoint |
| Module Config Endpoint |
| Fetch Module Types |
| Fetch Module Prototype |
| Fetch Config: Module Property File |
| Fetch Config: All Modules |
| Fetch Config: Single Module |
| Fetch Config: Single Module (Detailed) |
| Fetch Module Interceptors |
| Create Module |
| Set Module Config |
| Start Module |
| Stop Module |
| Restart Module |
| Archive Module |
| Reinstate Module |
| System Restore |
| OpenID Connect Clients Endpoint |
| OpenID Connect Clients Endpoint |
| Fetch All OpenID Connect Client Definitions |
| Fetch Individual Client by Client ID |
| Create Client |
| Update Client |
| Create Client and generate secrets |
| OpenID Connect Keystores Endpoint |
| OpenID Connect Keystores Endpoint |
| Fetch All OpenID Connect Keystore Definitions |
| Fetch OpenID Connect Keystore Definition by ID |
| Create OpenID Connect Keystore Definition |
| Update OpenID Connect Keystore Definition |
| Delete OpenID Connect Keystore Definition |
| OpenID Connect Servers Endpoint |
| OpenID Connect Servers Endpoint |
| Fetch All OpenID Connect Server Definitions |
| Find OpenID Connect Server Definition |
| Create OpenID Connect Server Definition |
| Update OpenID Connect Server Definition |
| OpenID Connect Sessions Endpoint |
| OpenID Connect Sessions Endpoint |
| Fetch All Active Clients for User |
| Revoke Active Client for User |
| Revoke All Tokens |
| Privacy Notice Endpoint |
| Privacy Notice Endpoint |
| Runtime Status Endpoint |
| Runtime Status Endpoint |
| Fetch Complete Node Status Information |
| Fetch All Runtime Health Checks |
| System Config Endpoint |
| System Config Endpoint |
| Transaction Log Endpoint |
| Transaction Log Endpoint |
| Fetch Module IDs |
| Fetch Event Type and Subtype Codes |
| Fetch Transaction Log |
| Fetch Individual Event (Deprecated) |
| Fetch Individual Event by Module |
| Troubleshooting Log Endpoint |
| Troubleshooting Log Endpoint |
| Fetch Troubleshooting Log Configuration |
| Update Troubleshooting Logger Level |
| Update Troubleshooting Log Configuration |
| User Management Endpoint |
| User Management Endpoint |
| Search for Users (All Modules) |
| Search for Users (Specific Module) |
| Create User |
| Update User |
| Update Password |
| Update Own Password |
| Update Own Default Launch Contexts |
| 2FA: Create New Key |
| 2FA: Generate QR Code |
| 2FA: Confirm Key |
| 2FA: Delete Key |
| Get Available Authorities |
| Invalidate All Sessions |
| Version Endpoint |
| Version Endpoint |
| HFQL: Direct SQL Access |
| HFQL/SQL Overview |
| HFQL: Direct SQL Access to the FHIR Repository |
| Overview |
| Goals and Architecture |
| JDBC Driver |
| Enabling Server Support |
| SQL Syntax |
| HFQL SQL Syntax |
| Syntax Overview |
| SQL Syntax: Select |
| HFQL SQL Syntax: Selects |
| Selecting Columns |
| Column Name Aliases |
| Column Data Types and Choice Elements |
| Count and Group-By Expressions |
| Ordering Results |
| Select Data Manipulation and Concatenation |
| Limiting Results |
| SQL Syntax: Where |
| HFQL SQL Syntax: Where and Having |
| WHERE Clauses |
| Search Parameter WHERE Expressions |
| FHIRPath WHERE Expressions |
| SQL Syntax: Limitations |
| SQL Syntax Limitations |
| Syntax Limitations |
| SQL Syntax: Examples |
| HFQL Syntax Examples |
| Find Resources with Repeating Elements |
| Product Configuration |
| HTTP Server Setup |
| HTTP Server Setup |
| Respecting Forward Headers |
| Specifying a Custom Context Path |
| Access Logs |
| Frame Options |
| TLS and HTTPS Reference |
| TLS and HTTPS |
| Background |
| Creating a Self-Signed KeyStore |
| Importing a LetsEncrypt Certificate into a KeyStore |
| Selecting Ciphers and Protocol |
| Enabling TLS Mutual Authentication (Client Auth) |
| Programmatically Configuring a FHIR Endpoint KeyStore |
| Smile Util TLS JSON Authentication File |
| Java Execution Environment |
| Security Attributes |
| Security Attributes |
| Library Support |
| Library Support |
| Exception Handling |
| Exceptions |
| Javadocs |
| Smile CDR Javadocs |
| Examples |
| Java Execution Environment Examples |
| Database Access using JDBC |
| JavaScript Execution Environment |
| Introduction |
| JavaScript Execution Environment |
| Change Log |
| Specifying JavaScript in Configuration File |
| Specifying JavaScript in Configuration File |
| Remote Debugging |
| JavaScript Execution Environment Remote Debugging |
| ECMA Modules (import) |
| ECMA Modules |
| Converter API |
| Converter API |
| Method: hl7v2TsToFhirDate(dt); |
| Method: hl7v2TsToFhirDateTime(ts); |
| Method: hl7v2TsToFhirDateTime(ts, impliedTimeZone); |
| Method: urlDecodeString(string); |
| Method: urlEncodeString(string); |
| Method: base64Encode(string); |
| Method: base64Decode(string); |
| Environment API |
| Environment |
| Method: getProperty(name) |
| Method: getEnv(name) |
| Exceptions API |
| Exceptions |
| Method: Exceptions.newTrustedException(theMessage) |
| Method: Exceptions.newTrustedException(theStatusCode, theMessage) |
| OAuth2 Exceptions API |
| Oauth2 Exceptions |
| Method: OAuth2Exceptions.newUnauthorizedException(theMessage) |
| Method: OAuth2Exceptions.newForbiddenException(theMessage) |
| FHIR REST API |
| FHIR REST API |
| Method: create(resource) |
| Method: read(url) |
| Method: search().forResource(resourceType) |
| Method: transaction(IBundleBuilder theTransaction) |
| Method: translate() |
| Method: update(resource) |
| Method: patch(url, parameters) |
| Authentication |
| Tenant Selection |
| Concurrency Retry |
| Configuration Requirements for ONC (g)(10) Certification |
| FHIR Model API |
| FHIR Model API |
| Method: ResourceBuilder.build(resourceType) |
| Working with Resources |
| Working with Composition resources |
| Working with Bundle resources |
| Resource References |
| Contained Resources |
| Meta Elements |
| Patient Deceased Element |
| Evaluating FHIRPath Expressions |
| Removing Data |
| HL7 v2.x Mapping API |
| HL7 v2.x Mapping API |
| Path Syntax: Repetitions |
| Path Syntax: Groups and Nesting |
| Structure Interrogation |
| Content Clearing |
| Content Interrogation |
| Parsing Raw Field Values |
| Encoding |
| The Hl7V2 Object |
| Working with Variable Datatypes |
| Working with Z-Segments |
| Encoding FT (Formatted Text) Fields |
| HTTP API |
| HTTP API |
| Request Creation Methods |
| Request Execution Methods |
| Response Processing Methods |
| TLS / HTTPS |
| LDAP API |
| LDAP API |
| Method: searchByUsername(username) |
| Method: getStringAttributes(attributeName) |
| Method: isMemberOfGroup(groupDn) |
| Log API |
| Log API |
| Methods: trace(string), debug(string), info(string), warn(string), error(string) |
| Composition Resource API |
| Composition Resource API |
| Method: set*(value) |
| Method: setDate(epoch) |
| Method: setType(documentType) |
| Method: addAttester(mode) |
| Method: addEvent() |
| Method: addSection(sectionType) |
| Composition Section API |
| Composition Section API |
| Method: populate(List resources) |
| Method: setTitle(title) |
| Method: setCode(system, code, display) |
| Method: addSection() |
| TransactionBuilder API |
| TransactionBuilder API |
| Method: newTransactionBuilder() |
| Method: withBundle(bundle) |
| Method: create(resource) |
| Method: update(resource) |
| Method: patch(resourceId, parameters) |
| Method Chain: createConditional(resource).onToken(parameter, system, value) |
| Method Chain: updateConditional(resource).onToken(parameter, system, value) |
| Methods: toXml(), toXml(prettyPrint), toJson(), toJson(prettyPrint) |
| Fhir.transaction(transaction) |
| Util API |
| Util API |
| Method: sleep(millis) |
| UUID API |
| UUID API |
| Method: newPlaceholderId() |
| XML API |
| XML API |
| Global function: XML.createDocument(str) |
| XPath Expressions |
| Traversing the Document |
| Function: toXMLString() |
| Manipulating the DOM |
| Callback Models |
| Callback Models |
| AssociatedResource |
| AuthenticationContext |
| AuthenticationFailure |
| AuthenticationRequest |
| BulkModifyResourcesResults |
| ClientCredentialsAuthenticationRequest |
| Coding |
| CsvProcessorContext |
| FhirContextEntry |
| FhirEndpointTerminologyResponseMappingSpec |
| FhirEndpointTerminologyResponseMappingSpecSystem |
| GatewayConfiguration |
| GatewayCreateRoute |
| GatewayDeleteRoute |
| GatewayHistoryRoute |
| GatewayOperation |
| GatewayOperationRoute |
| GatewayReadRoute |
| GatewayRouteTarget |
| GatewaySearchRoute |
| GatewayTarget |
| GatewayTargetRetryStrategy |
| GatewayTransactionRoute |
| GatewayUpdateRoute |
| GrantedAuthority |
| Hl7V2GeneratedMessageContext |
| Hl7V2ReceivedMessage |
| Hl7V2ReceivedMessageConversionResult |
| LaunchContext |
| LaunchContextParameter |
| LaunchResourceId |
| MegaScaleCredentialRequest |
| MegaScaleCredentialResponse |
| OAuth2AuthorizationRequestDetails |
| OAuth2Client |
| OAuth2ClientSecret |
| OAuth2ClientSession |
| OAuth2Clients |
| OAuth2Keystore |
| OAuth2Keystores |
| OAuth2Server |
| OAuth2Servers |
| OAuth2SmartContextSelectionChoicePerson |
| OAuth2SmartContextSelectionChoices |
| Oauth2InvalidateTokensResponseJson |
| OpenIdIntrospectTokenResponse |
| PackageInstallationSpec |
| PartitionDefinition |
| PartitionDefinitions |
| RequestDetailsJson |
| ScriptAuthenticationOutcomeFactory |
| ScriptConsentContextServices |
| SecurityInLdapAuthenticationContext |
| SecurityInSmartAuthenticationContext |
| SmartCodapAuthorizationRequest |
| SmartOnPostAuthorizeDetails |
| SmartScopeAuthorityNarrowingResult |
| TokenizationRule |
| TokenizationRules |
| UserDetails |
| UserDetailsChangeLaunchContextJson |
| UserDetailsList |
| UserDetailsOAuth2AllClientApprovals |
| UserDetailsOAuth2ClientApprovals |
| UserDetailsOAuth2ClientApprovalsApprovedScope |
| UserSessionDetails |
| Localization |
| Localization |
| Localization |
| Examples |
| Localization Customization Examples |
| Example: Unknown Search Parameter Message |
| Example: Custom SMART Scope Names |
| Available Localization Keys |
| Available Localization Keys |
| Smile CDR CLI (smileutil) |
| Introduction |
| Smile command-line tool (smileutil) |
| Enabling Debug Logging |
| Memory Settings |
| Bulk Import |
| smileutil: Bulk Import |
| Usage |
| Options |
| Create FHIR Package |
| smileutil: Create FHIR Package |
| Usage |
| Options |
| Example |
| Execute Script Function |
| smileutil: Test Script Function |
| Usage |
| Options |
| A Complete Example: Authenticate |
| Available Functions |
| Function: authenticate |
| Export ConceptMap to CSV |
| smileutil: Export ConceptMap to CSV |
| Usage |
| Options |
| HL7 v2.x Analyze Flat File |
| smileutil: HL7 v2.x Analyze Flat File |
| Usage |
| Options |
| HL7 v2.x Transmit Flat File |
| smileutil: HL7 v2.x Transmit Flat File |
| Usage |
| Options |
| Multiplex Paths |
| Import CSV to ConceptMap |
| smileutil: Import CSV to ConceptMap |
| Usage |
| Options |
| Map and Upload CSV Bulk Import File |
| Map and Upload CSV Bulk Import File |
| Usage |
| Options |
| Migrate Database |
| smileutil: Migrate Database |
| Options |
| Dry Run Output |
| Examples |
| Clear Database Migration Lock |
| smileutil: Clear Migration Lock |
| Example |
| Options |
| Module Config Properties Export |
| smileutil: Module Config Properties Export |
| Options |
| Reindex Terminology |
| smileutil: Reindex Terminology |
| Usage |
| Options |
| Synchronize FHIR Servers |
| smileutil: Synchronize FHIR Servers |
| Usage |
| Options |
| Selecting Resource Types to Synchronize |
| Using a Search as the Source |
| Using a Directory as the Source |
| Uploading Bundles as Transactions |
| Using Inline Match URLs |
| Prefixing Numeric IDs |
| Synchronization Modes |
| Uploading Synthea (Synthetic Generated) Resources |
| Setting up a Resource Gold Master |
| Load Balancing Target Servers |
| Upgrade H2 Database File |
| smileutil: Upgrade H2 Database File |
| Usage |
| Options |
| Example |
| Upload Bundle Files |
| smileutil: Upload Bundle Files |
| This Command Is Deprecated |
| Usage |
| Options |
| Upload CSV Bulk Import File |
| smileutil: Upload CSV Bulk Import File |
| Usage |
| Options |
| Sending Batches for a Single File |
| CSV-to-FHIR Mapping Configuration |
| Upload Sample Dataset |
| smileutil: Upload Sample Dataset |
| Usage |
| Options |
| Upload Terminology |
| smileutil: Upload Terminology |
| Usage |
| Options |
| Example: Add Delta to Custom Terminology |
| Generate Realtime Export Schema |
| smileutil: Realtime Export Generation |
| Usage |
| Options |
| Snowflake Support |
| Snowflake Standard Tables |
| Snowflake Hybrid Tables |
| Validate FHIR Resources |
| smileutil: Validate FHIR Resources |
| Usage |
| Options |
| Profile Mode |
| Schema and Schematron Mode |
| Apache Camel Integration |
| Camel Module Overview |
| Camel Module Overview |
| Apache Camel Introduction |
| Apache Camel Data Formats |
| Smile Data Formats |
| Apache Camel Components |
| Smile Component |
| Ingesting Broker Messages with Camel Routes |
| Environment Variables in Routes |
| Camel Health Checks |
| The Spring Context Config Class |
| Packaging Your Camel Module Custom Classes |
| Deploying Your Camel Module Custom Classes |
| Example Project |
| Smile Camel Processors |
| Smile Processors Overview |
| Quick Reference |
| Processors: FHIR Storage module |
| FHIR Storage Processors |
| Resource Operation Processor |
| Transaction/Batch Bundle Processor |
| FHIR NDJSON Converter |
| Single Resource Processor |
| FHIR Validator Processor |
| ValueSet $expand Processor |
| ValueSet $validate-code Processor |
| CodeSystem $validate-code Processor |
| CodeSystem $lookup Processor |
| ConceptMap $translate Processor |
| In-Place Translate Processor |
| Patient $merge Processor |
| $replace-references Processor |
| Processors: ETL Import module |
| ETL Importer Processors |
| ETL Importer: CSV Processor |
| Processors: Camel module |
| Camel Processors |
| Channel Import Processor |
| Increment Retry Count Processor |
| Wrap In DocumentReference Processor |
| Wrap In Binary Resource Processor |
| Processors: Cluster Manager module |
| Cluster Manager Processors |
| Broker Consumer/Processor |
| Kafka Manual Commit |
| Processors: HL7v2 Inbound module |
| Hl7v2 Inbound Processors |
| Pre-Convert Script Processor |
| Pre-Convert Mapper Bean Processor |
| Pre-Convert Interceptor Processor |
| Convert HL7 v2.x to FHIR |
| Post-Convert Script Processor |
| Post-Convert Interceptor Processor |
| HL7v2 Inbound: Sample Route |
| Processors: CDA Exchange+ module |
| CDA Exchange+ Processors |
| CDA Import (CDA to FHIR) Processors |
| CDA Export (FHIR to CDA) Processors |
| Processors: Semantic Standardization module |
| Semantic Standardization Processors |
| Processors: Transaction Logging |
| Transaction Logging Processors |
| Start Transaction Log Processor |
| Add Transaction Log Step Processor |
| Adding Module-Specific Transaction Log Helpers |
| Smile Camel Converters |
| Smile Camel Converters |
| Smile Camel Recipes |
| Camel Recipes |
| Load HL7 v2 Messages from AWS S3 Bucket |
| Using Apache Pulsar with Camel |
| Controlling Transaction Logging in Camel Routes |
| Smile Camel HTTP Endpoint |
| Smile Camel HTTP Endpoint |
| Configuration |
| Data Transfer |
| Permissions |
| Smile Portal |
| Smile Portal Module |
| Smile Portal |
| Client Creation and Configuration |
| Davinci Data Exchange |
| Davinci Data Exchange Module |
| Davinci Data Exchange |
| Davinci-Data-Export Operation |
| Member Provider Operation |
| Modules |
| JSON Admin API |
| JSON Admin API |
| Configuration Categories |
| Dependencies |
| Web Admin Console |
| Web Admin Console |
| Updated Web Admin Console UI |
| Configuration Categories |
| Dependencies |
| CDA Exchange+ |
| CDA Exchange+ |
| Configuration Categories |
| Dependencies |
| Channel Import |
| Channel Import |
| Configuration Categories |
| Dependencies |
| Cluster Manager |
| Cluster Manager |
| Configuration Categories |
| Audit Log Persistence |
| Audit Log Persistence |
| Configuration Categories |
| Audit Log OpenTelemetry |
| Audit Log OpenTelemetry |
| Configuration Categories |
| Transaction Log Persistence |
| Transaction Log Persistence |
| Configuration Categories |
| Transaction Log OpenTelemetry |
| Transaction Log OpenTelemetry |
| Configuration Categories |
| Enterprise Master Patient Index |
| EMPI (deprecated) |
| Configuration Categories |
| CDS Hooks Endpoint |
| CDS Hooks REST Endpoint |
| Configuration Categories |
| Dependencies |
| FHIR Gateway Endpoint |
| FHIR Gateway REST Endpoint |
| Configuration Categories |
| Dependencies |
| FHIR REST Endpoint (All Versions) |
| FHIR REST Endpoint (All FHIR Versions) |
| Configuration Categories |
| Dependencies |
| FHIR REST Endpoint (DSTU2 - Deprecated) |
| FHIR REST Endpoint (DSTU2 - Deprecated) |
| Configuration Categories |
| FHIR REST Endpoint (DSTU3 - Deprecated) |
| FHIR REST Endpoint (R3 - Deprecated) |
| Configuration Categories |
| FHIR REST Endpoint (R4 - Deprecated) |
| FHIR REST Endpoint (R4 - Deprecated) |
| Configuration Categories |
| FHIRWeb Console |
| FHIRWeb Console |
| Configuration Categories |
| Dependencies |
| HL7 v2.x Listening Endpoint |
| HL7 v2.x Listening Endpoint |
| Configuration Categories |
| Dependencies |
| HL7 v2.x Listening Endpoint (Deprecated) |
| HL7 v2.x Listening Endpoint (Deprecated) |
| Configuration Categories |
| HL7 v2.x Sending Endpoint |
| HL7 v2.x Sending Endpoint |
| Configuration Categories |
| Dependencies |
| Hybrid Providers Endpoint |
| Hybrid Providers REST Endpoint |
| Configuration Categories |
| Dependencies |
| Package Registry Endpoint |
| Package Registry Endpoint |
| Configuration Categories |
| Dependencies |
| Subscription Websocket Endpoint |
| Subscription Websocket Endpoint |
| Configuration Categories |
| Dependencies |
| ETL Importer |
| ETL Importer |
| Configuration Categories |
| Dependencies |
| MDM |
| MDM |
| Configuration Categories |
| Plugins |
| MDM UI |
| MDM UI |
| Configuration Categories |
| Dependencies |
| Prior Auth CRD |
| Prior Auth CRD |
| Configuration Categories |
| Dependencies |
| Prior Auth Support |
| Prior Auth Support |
| Configuration Categories |
| Dependencies |
| Narrative Generator |
| Narrative Generator |
| Configuration Categories |
| FHIR Storage (DSTU2 RDBMS) |
| FHIR Storage (DSTU2 RDBMS) |
| Configuration Categories |
| Dependencies |
| FHIR Storage (R3 RDBMS) |
| FHIR Storage (R3 RDBMS) |
| Configuration Categories |
| Dependencies |
| FHIR Storage (R4 RDBMS) |
| FHIR Storage (R4 RDBMS) |
| Configuration Categories |
| Dependencies |
| FHIR Storage (R5 RDBMS) |
| FHIR Storage (R5 RDBMS) |
| Configuration Categories |
| Dependencies |
| FHIR Storage (Mongo) |
| FHIR Storage (MongoDB - Deprecated) |
| Configuration Categories |
| Realtime Export |
| Realtime Export |
| Configuration Categories |
| Plugins |
| Realtime Export (Delta Lake) |
| Realtime Export (Delta Lake) |
| Configuration Categories |
| Plugins |
| Realtime Export (Bulk Batch Replication) |
| Realtime Export (Bulk Batch Replication) |
| Configuration Categories |
| Plugins |
| LDAP Inbound Security |
| LDAP Inbound Security |
| Configuration Categories |
| Dependencies |
| Local Inbound Security |
| Local Inbound Security |
| Configuration Categories |
| Dependencies |
| SAML Inbound Security |
| SAML Inbound Security |
| Configuration Categories |
| Dependencies |
| Scripted Inbound Security |
| Scripted Inbound Security |
| Configuration Categories |
| Dependencies |
| SMART Inbound Security |
| SMART Inbound Security |
| Configuration Categories |
| Dependencies |
| SMART Outbound Security |
| SMART Outbound Security |
| Configuration Categories |
| Dependencies |
| Subscription Matcher (All FHIR Versions) |
| Subscription Matcher (All FHIR Versions) |
| Configuration Categories |
| Plugins |
| Subscription Matcher (DSTU2 - Deprecated) |
| Subscription Matcher (DSTU2 - Deprecated) |
| Configuration Categories |
| Plugins |
| Subscription Matcher (DSTU3 - Deprecated) |
| Subscription Matcher (DSTU3 - Deprecated) |
| Configuration Categories |
| Plugins |
| Subscription Matcher (R4 - Deprecated) |
| Subscription Matcher (R4 - Deprecated) |
| Configuration Categories |
| Plugins |
| appSphere |
| appSphere |
| Configuration Categories |
| Dependencies |
| Payer to Payer (Deprecated) |
| Payer to Payer (Deprecated) |
| Configuration Categories |
| System to System Data Exchange |
| System to System Data Exchange |
| Configuration Categories |
| Plugins |
| License |
| License Manager |
| Configuration Categories |
| Camel |
| Camel |
| Configuration Categories |
| Dependencies |
| Smile Camel HTTP Endpoint |
| Camel HTTP Endpoint |
| Configuration Categories |
| Dependencies |
| Consent Module |
| Consent |
| Configuration Categories |
| Plugins |
| Smile Portal |
| Smile Portal |
| Configuration Categories |
| Dependencies |
| Davinci Data Exchange |
| Davinci Data Exchange |
| Dependencies |
| Custom Scheduled Jobs |
| Custom Scheduled Jobs Overview |
| Custom Scheduled Jobs Overview |
| Example |
| Permissions |
| Batch Job Reference |
| Batch Job Reference |
| Appendix |
| Demo Projects |
| Demo Projects |
| General Purpose Interceptor Demo Project |
| HL7V2 Interceptor Demo Project |
| Camel Demo Project |
| CDS Hooks Demo Project |
| Custom Resources Demo Project |
| Custom Resource Provider Demo Project |
| Hybrid Provider Demo Project |
| Outbound Security Demo Skin Project |
| International Patient Summary Demo Project |
| Consent Demo Project. |
| Configuration Categories |
| Web Admin Console Settings |
| Web Admin Console Settings |
| Property: Prometheus Datasource ID |
| Property: SSO Button Label |
| Property: Transaction Log - Event Body Display Mode |
| appSphere |
| appSphere |
| Property: JSON URL |
| Property: Auth URL |
| Property: Auto-approving for Public and Confidential registrations |
| Property: Auto-approve scheduler frequency in minutes |
| Property: Client ID |
| Property: Legal Company Name |
| Property: Admin Console Name |
| Property: Contact Helpdesk |
| Property: Contact Us URL |
| Property: FHIR URL |
| Property: Application Gallery Name |
| Property: Hero Image, Large Format URL |
| Property: Hero Image, Small Format URL |
| Property: Company Logo Small URL |
| Property: Company Logo Large URL |
| Property: PHI Warning URL |
| Property: Developer Portal Name |
| Property: Privacy Policy URL |
| Property: Request app mail-to |
| Property: Terms of Use URL |
| Payer Config |
| Payer Config |
| Property: Payer Auto-Grant Scopes |
| Property: Enable Payer Functionality |
| Initial appSphere Seeding |
| Initial appSphere Seeding |
| Property: Default Attestation (Legal) |
| Property: Default Attestation (Plain) |
| Property: Default Attestation Title |
| Authentication Callback Scripts |
| Authentication Callback Scripts |
| Property: Authentication Callback Script (File) |
| Property: Authentication Callback Script (Text) |
| Auth: General for APIs |
| Auth: General for APIs |
| Property: Anonymous Account Username |
| Property: Allow Anonymous Access |
| User Authentication |
| User Authentication |
| Property: Anonymous Account Username |
| Property: Allow Anonymous Access |
| Property: SAML Authentication Enabled |
| Auth: HTTP Basic |
| Auth: HTTP Basic |
| Property: HTTP Basic Security |
| Property: HTTP Basic Realm |
| Auth: OpenID Connect |
| Auth: OpenID Connect |
| Property: OpenID Connect Security |
| Browser Syntax Highlighting |
| Browser Syntax Highlighting |
| Property: Browser Syntax Highlighting Enabled |
| Property: Show Request Headers |
| Property: Show Response Headers |
| Bulk Batch Replication |
| Bulk Batch Replication |
| Property: Enabled |
| Property: Page Size |
| Property: Partition Scope |
| Property: Schedule Interval (ms) |
| Property: Stale Instance Threshold (ms) |
| Property: Target Repository |
| Property: Trailing-Lag Slop (ms) |
| Camel HTTP Endpoint |
| Camel HTTP Endpoint |
| Property: Mapping Configuration (File) |
| Property: Mapping Configuration (Text) |
| Camel |
| Camel |
| Property: Spring Context Config Class(es) |
| Property: Enable Transaction Log on All Routes |
| Property: Camel Functions (File) |
| Property: Camel Functions (Text) |
| Property: Camel Routes (File) |
| Property: Camel Routes (Text) |
| Capability Statement (metadata) |
| Capability Statement (metadata) |
| Property: Cache Resource Counts (Mins) |
| Property: Include Resource Counts |
| CDA Export |
| CDA Export |
| Property: Store Generated Bundle |
| Property: Store Generated Composition |
| Property: Store Generated CDA Document as Binary |
| Property: Store Generated CDA Document as DocumentReference |
| CDA Import |
| CDA Import |
| Property: Import Mode |
| Property: Store Original CCD |
| CDA Interceptors |
| CDA Interceptors |
| Property: Interceptor Bean Types |
| CDA JavaScript Execution Scripts |
| CDA JavaScript Execution Scripts |
| Property: CDA Processing Script (File) |
| Property: CDA Processing Script (Text) |
| CDA Terminology |
| CDA Terminology |
| Property: Prefer user-supplied terminology translations |
| CDS Hooks Definitions |
| CDS Hooks Definitions |
| Property: CDS Hooks Version |
| Property: FHIR Version |
| Property: Spring Context Config Class |
| CDS Hooks On FHIR |
| CDS Hooks On FHIR |
| Property: Client Id Header Name |
| Property: Enable CDS on FHIR |
| Channel Import |
| Channel Import |
| Property: Allowed Partitions |
| Property: Concurrent Consumers |
| Property: Concurrent Retry Consumers |
| Property: Channel Name |
| Property: Default mediaType |
| Property: Channel Import ETL Script (File) |
| Property: Channel Import ETL Script (Text) |
| Property: Interceptor Bean Types |
| Channel Retry |
| Channel Retry |
| Property: Failure Channel Name |
| Property: Retry Delay(ms) |
| Property: Maximum amount of retry attempts. |
| Property: Maximum Delay(ms) between attempts. |
| Property: Retry Channel Name |
| Property: Retriable Exceptions |
| Property: Retry Strategy |
| Cluster Manager Interceptors |
| Cluster Manager Interceptors |
| Property: Interceptor Bean Types |
| Kafka |
| Kafka |
| Property: Kafka Consumer Ack Mode |
| Property: Kafka Consumer Auto Commit Enabled |
| Property: Kafka Bootstrap Address |
| Property: Kafka Consumer Config Properties (File) |
| Property: Kafka Consumer Config Properties (Text) |
| Property: Kafka Subscription Matcher Consumer Group Id |
| Property: Kafka Producer Auto Flush |
| Property: Kafka Producer Config Properties (File) |
| Property: Kafka Producer Config Properties (Text) |
| Property: Kafka Producer Send Timeout (ms) |
| Property: Kafka Replace Hyphens With Periods |
| Property: Kafka SASL JAAS Config |
| Property: Kafka SASL Mechanism |
| Property: Kafka Security Protocol |
| Property: Kafka Broker SSL Enabled |
| Property: Kafka SSL Key Password |
| Property: Kafka SSL Keystore Location |
| Property: Kafka Keystore Password |
| Property: Kafka SSL TrustStore File Location |
| Property: Kafka SSL Truststore Password |
| Property: Validate Kafka Topics Exist Before Use |
| Cluster Manager Maintenance |
| Cluster Manager Maintenance |
| Property: Audit Log Broker Channel Name |
| Property: Audit Log Broker Enabled |
| Property: Always Write to Cluster Manager Log |
| Property: Audit Log Database Async Writes |
| Property: Audit Log Database Enabled |
| Property: Audit Log OpenTelemetry Enabled |
| Property: Request headers to store |
| Property: Reload Scripts on Module Config Save |
| Property: Transaction Log Retention (Days) |
| Property: Scheduler Thread Count |
| Property: Heartbeat Persist Frequency MS |
| Property: Stats Cleanup Frequency MS |
| Property: Stats Persist Frequency MS |
| Property: Support writes to LOB columns |
| Message Broker |
| Message Broker |
| Property: Message Broker Address |
| Property: Channel Naming Prefix |
| Property: Message Broker Password |
| Property: Message Broker Type |
| Property: Message Broker Username |
| Pulsar |
| Pulsar |
| Property: Pulsar Acknowledgement Timeout (seconds) |
| Property: Pulsar Admin URL |
| Property: Pulsar Receiver Queue Size |
| Property: Pulsar Service URL |
| Property: Validate Pulsar Topics Exist Before Use |
| Cluster Level Security |
| Cluster Level Security |
| Property: OpenId Connect Keystores Pre-Seed File |
| Consent |
| Consent |
| Property: Bucket Definition (File) |
| Property: Bucket Definition (Text) |
| Property: Gateway Route filtering Definition (File) |
| Property: Gateway Route filtering Definition (Text) |
| Property: Register Consent Module With Specified Persistence Dependency |
| Credentials |
| Credentials |
| Property: Authentication Cache Duration (millis) |
| Property: Cache Successful Credentials |
| Property: Create Unknown Users |
| Property: Lock After Failed Attempts |
| Property: Case-Sensitive Passwords |
| Property: Password Encoding Scheme |
| Property: Password Mismatch Error |
| Property: Minimum Password Requirements |
| Property: Case-Sensitive Usernames |
| Cross-Origin Resource Sharing (CORS) |
| Cross-Origin Resource Sharing (CORS) |
| Property: CORS Allowed Request Headers |
| Property: CORS Enabled |
| Property: CORS Origins |
| Invoke Export |
| Invoke Export |
| Property: Reference System used by Target Patient |
| Property: Responder Identifier System |
| Property: Interceptor Bean Types |
| Property: Maximum poll attempts for exported results. |
| Property: OIC Server Seed File |
| Member Match |
| Member Match |
| Property: Allow Synchronous Member Match |
| Property: Audit Member Identifiers in Transaction Log |
| Property: Member Match Patient Matching Script (File) |
| Property: Member Match Patient Matching Script (Text) |
| Property: Support Consent Filtering |
| Database |
| Database |
| Property: Default Query Timeout (Seconds) |
| Property: Log Abandoned |
| Property: Max Idle Connections |
| Property: Connection Max Lifetime (millis) |
| Property: Max Total Connections |
| Property: Max Wait (Seconds) |
| Property: Min Idle Connections |
| Property: Pool Prepared Statements |
| Property: Remove Abandoned on Borrow |
| Property: Remove Abandoned Timeout Seconds |
| Property: Test Connections on Return |
| Property: Database Type |
| Property: Expect database to be writable |
| Property: Database Password |
| Property: SQL Parameter Bind Mode |
| Property: Database Connection URL |
| Property: Database Username |
| Property: FHIR Version |
| Da Vinci Health Record Exchange |
| Da Vinci Health Record Exchange |
| Property: Native Consent Handling. |
| Delta Lake Export |
| Delta Lake Export |
| Property: Concurrent Consumers |
| Property: Concurrent Retry Consumers |
| Property: Channel Name Prefix |
| Property: Delta Lake Root Path |
| Property: Spark Connect URL |
| Property: Delta Lake Export Script (File) |
| Property: Delta Lake Export Script (Text) |
| EasyShare SMART Health Links |
| EasyShare SMART Health Links |
| Property: Passcode Case Sensitive |
| Property: Passcode Encoding Scheme |
| Property: Lock After Failed Passcode Attempts |
| Property: Public Base URL |
| Email Configuration |
| Email Configuration |
| Property: Email From Address |
| Property: Notification Emails |
| Property: Email SMTP Hostname |
| Property: Email SMTP Password |
| Property: Email SMTP Port |
| Property: Use STARTTLS for connection security |
| Property: Email SMTP Username |
| MDM UI |
| MDM UI |
| Property: JSON Admin URL |
| Property: OIDC Client ID |
| Property: OIDC Issuer URL |
| Property: OIDC Logout URL |
| Property: OIDC Redirect URI |
| Property: OIDC scopes |
| Property: Organization Identifier |
| ETL Import: CSV Properties |
| ETL Import: CSV Properties |
| Property: CSV File Delimiter |
| Property: Parse Quotes |
| ETL Import: Source |
| ETL Import: Source |
| Property: Async Mode Batch Size |
| Property: Asynchronous Mode Enabled |
| Property: Async Mode File Size |
| Property: Import Source |
| Property: Mapping Script (Text) |
| Property: Mapping Script (File) |
| Property: Worker Row Hashing Function (Text) |
| Property: Worker Row Hashing Function (File) |
| Property: Worker Thread Count |
| Property: Synchronous Mode: Continue On Failure |
| Property: Enable Transaction Log |
| External Object Storage |
| External Object Storage |
| Property: Blob service S3 access key |
| Property: Blob service Azure account name |
| Property: Blob service Azure client / application ID |
| Property: Blob service Azure access key / client secret (app password) / Account-level SAS token |
| Property: Blob service Azure tenant ID |
| Property: Blob service Azure use managed identity |
| Property: Blob service bucket / container name |
| Property: Blob Service Connection Acquisition Timeout (Seconds) |
| Property: Blob Service Connection Timeout (Seconds) |
| Property: Endpoint URL for S3-compatible service |
| Property: Blob Service Maximum Connections |
| Property: Blob Service Maximum Pending Connection Requests |
| Property: Blob Service Region |
| Property: Blob service secret key |
| FHIR Binary Storage |
| FHIR Binary Storage |
| Property: Binary Access Operations Enabled |
| Property: Automatically inflate binaries. |
| Property: Binary inflation maximum size (bytes) |
| Property: Filesystem Mode: Base Directory |
| Property: Binary Storage Mode |
| Property: Maximum Size (bytes) |
| Property: Minimum Size (bytes) |
| FHIR Bulk Modification Operations |
| FHIR Bulk Modification Operations |
| Property: Bulk Modify Patch Operation |
| Property: Bulk Modify Patch with History Rewrite Operation |
| FHIR Bulk Import/Export Operations |
| FHIR Bulk Import/Export Operations |
| Property: Enable Bulk Export batch job reuse |
| Property: FHIR Bulk Export Enabled |
| Property: Maximum Bulk Export file capacity |
| Property: Bulk Export file retention (hours) |
| Property: Normalize Terminology on Bulk Export |
| Property: Restrict Download to Initiating User |
| Property: FHIR Bulk Import Enabled |
| Capability Statement |
| Capability Statement |
| Property: Copyright Message |
| Property: Implementation Description |
| Property: Include Partition Name |
| Property: Enable OpenAPI / Swagger Support |
| Property: Swagger-UI Custom CSS (Text) |
| Property: Swagger-UI Logo URL |
| Property: Swagger-UI Uses Resource Pages |
| Property: Software Name |
| Property: Software Version |
| FHIR Configuration |
| FHIR Configuration |
| Property: Cascading Deletes Enabled |
| Property: Allow External References Enabled |
| Property: Allow Inline Match URL References Enabled |
| Property: Allow Multiple Delete Enabled |
| Property: Allow storing all bundle types |
| Property: Auto-Create Placeholder Reference Targets |
| Property: Client ID Mode |
| Property: Delete Child Resource Count |
| Property: Delete Expunge Enabled |
| Property: Enforce Reference Target Types |
| Property: Disable Deletion Ref Checks for Paths |
| Property: Enforce Referential Integrity on Delete |
| Property: Enforce Referential Integrity on Write |
| Property: Expunge Operation Enabled |
| Property: History Rewrite |
| Property: Batch Job Fasttracking Enabled |
| Property: Load Meta.source information from Legacy Table |
| Property: Mark Resources for Reindexing after SearchParameter change |
| Property: Preserve request ID in resource body. |
| Property: Preserve Resource History |
| Property: Reindex Enabled |
| Property: Server ID Mode |
| Property: Store Meta.source information |
| Property: Tag Storage Mode |
| Property: Token Index Identifier Search Params |
| Property: Token Index Read Target |
| Property: Token Index Write Targets |
| Property: Read Only Mode Enabled |
| Property: Seed Base Validation Resources |
| Consent Service |
| Consent Service |
| Property: Consent Service Enabled |
| Property: Java Consent Service Types |
| Property: Consent Service Script (File) |
| Property: Consent Service Script (Text) |
| FHIR Endpoint Conversion |
| FHIR Endpoint Conversion |
| Property: Versioned API Mode |
| Property: MDM Virtualized Endpoint Enabled |
| FHIR Endpoint HFQL Support |
| FHIR Endpoint HFQL Support |
| Property: HFQL/SQL Endpoint Enabled |
| FHIR Endpoint Partitioning |
| FHIR Endpoint Partitioning |
| Property: Tenant Identification Strategy |
| Property: Tenant Name |
| Resource Providers |
| Resource Providers |
| Property: Allowed Interactions |
| Property: Resource Provider Bean Types |
| FHIR Endpoint Security |
| FHIR Endpoint Security |
| Property: Allow Searches With Compartment Access |
| Property: Automatically Narrow Search Scope |
| Property: Narrow Conditional URL Search Scope |
| Property: Reject Insufficient Permissions with HTTP 401 |
| Property: Watermark Responses Enabled |
| Property: Scopes Supported |
| Endpoint Terminology |
| Endpoint Terminology |
| Property: Populate Response Coding Displays |
| Property: Response Mapping |
| Property: Mapping Spec (Text) |
| FHIR Gateway Cache |
| FHIR Gateway Cache |
| Property: Cache Expiration Seconds |
| Property: Cache Maximum Entries |
| Property: Cache Provider |
| FHIR Gateway Configuration |
| FHIR Gateway Configuration |
| Property: Spring Context Config Class |
| Property: FHIR Version |
| Property: Gateway Configuration (File) |
| Property: Show Underlying Errors |
| Property: Gateway Configuration (Text) |
| Property: Encryption JWKS (File) |
| Property: Encryption JWKS (Text) |
| Property: The default page size |
| Property: The maximum page size |
| FHIR Interceptors |
| FHIR Interceptors |
| Property: FHIR storage Callback Script (File) |
| Property: FHIR storage Callback Script (Text) |
| Property: Can Replace Authorization Interceptor |
| Property: Secure Application Context For Customer-Provided Beans |
| Property: Interceptor Bean Types |
| LiveBundle Service |
| LiveBundle Service |
| Property: LiveBundle Enabled |
| Property: LiveBundle Rule Definition Script (File) |
| Property: LiveBundle Rule Definition Script (Text) |
| Property: LiveBundle Thread Count |
| Property: LiveBundle Watchlist Cache Enabled |
| FHIR MDM Server |
| FHIR MDM Server |
| Property: MDM Mode Enabled (Experimental) |
| Property: Search Expanding Interceptor Enabled (Experimental) |
| FHIR Performance |
| FHIR Performance |
| Property: Always Include Identity Hash in Token Searches |
| Property: Pool Size for Bundle Batch execution |
| Property: Default Total Calculation Mode |
| Property: Delete Enabled |
| Property: Expire Search Results After Minutes |
| Property: Expunge Batch Size |
| Property: Expunge Thread Count |
| Property: ID Sequence Pooling Strategy |
| Property: Optimize index storage |
| Property: Internal Synchronous Search Size |
| Property: Mass Ingestion Mode |
| Property: Match URL Cache Enabled |
| Property: Maximum Transaction Bundle Size |
| Property: Only Allow IN-MEMORY Subscriptions |
| Property: Reindex Thread Count |
| Property: Reuse Cached Results Timeout (Millis) |
| Property: Index Missing Search Params |
| Property: Keep history for MDM links and other non-FHIR-resource DB history. |
| Property: Suppress Scheduled Maintenance Jobs |
| Property: Write-Semaphore Mode: Enabled |
| Property: Write-Semaphore Mode: Log Waits |
| FHIR Performance Tracing |
| FHIR Performance Tracing |
| Property: Capture Raw SQL or Equivalent |
| Property: Trigger |
| Property: Performance Tracing Enabled |
| Property: Output to Response Headers |
| Property: Output to System Log |
| Property: Output to Transaction Log |
| FHIR Realtime Export |
| FHIR Realtime Export |
| Property: Pointcut-based Realtime Export Mode Enabled |
| Repository Validation |
| Repository Validation |
| Property: Repository Validation Javascript (File) |
| Property: Repository Validation Javascript (Text) |
| FHIR Resource Body Storage |
| FHIR Resource Body Storage |
| Property: Blob Service Path Prefix |
| Property: Expunge Offloaded Resource Bodies Enabled |
| Property: Resource Body Offload Mode |
| Property: Resource Body Offload Operation Enabled |
| Property: Resource Body Storage Target Mode |
| FHIR Resource Types |
| FHIR Resource Types |
| Property: Resource Types (whitelist) |
| FHIR REST Endpoint |
| FHIR REST Endpoint |
| Property: Bulk Export Resource-Level Auditing |
| Property: Fixed Value for Endpoint Base URL |
| Property: Default Encoding |
| Property: Default Prefer Return |
| Property: Pretty-Print by Default |
| Property: Process Header: Request Source |
| Property: Serve Raw Media Resources |
| FHIR Search |
| FHIR Search |
| Property: Always use Offset Searches |
| Property: Allow :contains Searches |
| Property: Bind ID List as JSON Above Size |
| Property: Maximum number of codes to expand |
| Property: Default number of codes for ValueSet pre-expansion |
| Property: Maximum number of codes for ValueSet pre-expansion |
| Property: Fetch Size (Default Maximum) |
| Property: Index Contained Resources |
| Property: Index Contained Resources Recursively |
| Property: Index Uplifted Refchains |
| Property: Max Includes per Page |
| Property: Use ordinal date values for day precision searches. |
| Property: Filter Search Parameter Enabled |
| Property: GraphQL Enabled |
| Property: Index Identifier.type (:of-type modifier) Enabled |
| Property: Language Search Parameter Enabled |
| Property: Custom names file |
| Property: Normalized Unit Searching |
| Property: Page Size (Default) |
| Property: Page Size (Maximum) |
| Property: Nickname enabled |
| Property: Phonetic Encoder |
| Property: Infinispan Searches Cache Name |
| Property: Infinispan Hot Rod Protocol Version |
| Property: Infinispan Servers |
| Property: Infinispan Servers Password |
| Property: Infinispan Servers Username |
| Property: Redis Database |
| Property: Redis Maximum Connections |
| Property: Redis Maximum Idle Connections |
| Property: Redis Minimum Idle Connections |
| Property: Redis Password |
| Property: Redis Servers |
| Property: Redis Timeout (ms) |
| Property: Searches Cache Storage |
| Property: Stale Search Cleanup Interval (seconds) |
| Property: Suppress String Indexing In Tokens |
| Custom Resource Types |
| Custom Resource Types |
| Property: Custom Resource Classes |
| IG Support |
| IG Support |
| Property: International Patient Summary (IPS) Enabled |
| Property: IPS Generation Strategy Class Name |
| MegaScale |
| MegaScale |
| Property: MegaScale Cross-Partition Reference Acquire Timeout (seconds) |
| Property: MegaScale Cross-Partition Reference Concurrency |
| Property: MegaScale Enabled |
| FHIR Storage Module Conditional Updates |
| FHIR Storage Module Conditional Updates |
| Property: Prevent Conditional Update from Invalidating Match Criteria |
| FHIR Storage Module Scheduled Tasks |
| FHIR Storage Module Scheduled Tasks |
| Property: Batch job retention days. |
| Property: Scheduler Thread Count |
| Property: Subscription Matcher Submission Batch Size |
| Property: Resource Submission Interval (Millis) |
| Property: Batch Job Executor: Maximum Thread Count |
| Property: Bulk Export Task Enabled |
| Property: Bulk Import Task Enabled |
| Property: Delete Stale Searches Task Enabled |
| Property: Pre-Expand ValueSets Task Enabled |
| Property: Resource Reindexing Task Enabled |
| FHIR Validation Services |
| FHIR Validation Services |
| Property: Allow Database Validation Override |
| Property: Concurrent Bundle Validation Thread Count |
| Property: Concurrent Bundle Validation |
| Property: Remote Terminology Service: Base URL |
| Property: Terminology Basic Auth Password |
| Property: Terminology Basic Auth Username |
| Property: Remote Terminology Service: Client Connect Timeout (ms) |
| Property: Remote Terminology Service: Client Pool Max |
| Property: Remote Terminology Service: Client Pool Max Per Route |
| Property: Remote Terminology Service: Client Socket Timeout (ms) |
| Property: Remote Terminology Service: Enabled |
| Property: Remote Terminology Service: Log HTTP Calls |
| Property: Remote Terminology smart authentication client id |
| Property: Force http audience in token requests |
| Property: Remote Terminology smart authentication keystore |
| Property: Remote Terminology Smart Authentication Scope |
| Property: Accept All Codings Only |
| Property: Code Display Mismatch Policy |
| Property: Local Reference Policy |
| Property: Post-processing Validation Message Rules (file) |
| Property: Post-processing Validation Message Rules (text) |
| Property: Skip Contained Resource Validation |
| Property: Validation Support Cache Expiry (mins) |
| Property: Validation Support Cache Size |
| Property: Suppress Validation Message Patterns |
| Property: Unknown CodeSystem Validation Policy |
| FHIR Validation Services Remote Terminology Client TLS / SSL (Encryption) |
| FHIR Validation Services Remote Terminology Client TLS / SSL (Encryption) |
| Property: TLS Client Authentication |
| Property: TLS Enabled |
| Property: TLS KeyStore Filename |
| Property: TLS KeyStore Key Alias |
| Property: TLS KeyStore Key Password |
| Property: TLS KeyStore Password |
| Property: TLS Cipher Blacklist |
| Property: TLS Cipher Whitelist |
| Property: TLS Protocol Blacklist |
| Property: TLS Protocol Whitelist |
| Property: TLS TrustStore Filename |
| Property: TLS TrustStore Password |
| Property: TLS: Disable SNI checking for debugging |
| FHIR Storage Package Registry |
| FHIR Storage Package Registry |
| Property: Path to file containing whitelist rules |
| Property: Whitelist rules for package loading |
| Property: Load Pre-Seed Installation Spec Files Asynchronously |
| Property: Enable Validation of Resource Status for Package Installation |
| Property: Package Pre-Seed Installation Spec Files |
| FHIR Storage Partitioning |
| FHIR Storage Partitioning |
| Property: Database Partition Mode Enabled |
| Property: Database Partition Mode Initial Schema |
| Property: Patient-Partitioned Document Repository |
| Property: Patient Identifier Systems for Pre-Assignment |
| Property: Block resource updates changing Patient compartment |
| Property: Allow conditional creates with duplicate resource identifiers across partitions |
| Property: Cross-Partition Reference Mode |
| Property: Default Partition ID |
| Property: Partitioning Enabled |
| Property: Partition Naming Mode |
| Property: Partition Selection Mode |
| Property: Patient ID Mode Resource Type Policies |
| Property: Partition Seed File |
| Property: Partitioning Security Enabled |
| Versioned References |
| Versioned References |
| Property: Allow Versioned References at All Paths |
| Property: Allow Versioned References at Paths |
| Property: Automatically Version References at Paths |
| Property: Respect Versioned References for _include |
| FHIR Subscription Delivery |
| FHIR Subscription Delivery |
| Property: Subscription Delivery Queue Naming |
| Property: Email From Address |
| FHIR Subscription Persistence |
| FHIR Subscription Persistence |
| Property: Consumers Per Delivery Queue |
| Property: Matching Queue Consumers |
| Property: Cross-Partition Subscription Enabled |
| Property: Email Subscription Enabled |
| Property: Message Subscription Enabled |
| Property: Qualify subscription matching channel name |
| Property: REST Hook Subscription Enabled |
| Property: Perform validation on REST Hook endpoint URL |
| Property: REST Hook Endpoint URL Validation Regex |
| Property: Trigger Subscriptions on Non-Versioning Changes |
| Property: Websocket Subscription Enabled |
| FHIR Tokenization |
| FHIR Tokenization |
| Property: Tokenization Enabled |
| Property: Tokenization Provider Class |
| Property: Tokenization Rules (File) |
| Property: Tokenization Rules (Text) |
| Full-Text Indexing |
| Full-Text Indexing |
| Property: Lucene Index Directory |
| Property: Elasticsearch/OpenSearch AWS Region. |
| Property: Elasticsearch Index Prefix |
| Property: ElasticSearch Password |
| Property: ElasticSearch URL protocol. Either http or https |
| Property: ElasticSearch Host URLs. |
| Property: ElasticSearch Username |
| Property: Enable Full-Text Content Index |
| Property: Enable Indexing of Search Parameters (experimental) |
| Property: Store resource bodies in the Full-Text index (experimental) |
| Property: Full-Text Indexing Provider |
| Property: Full-Text Indexing Enabled |
| HL7 v2.x Resource Deduplication |
| HL7 v2.x Resource Deduplication |
| Property: Enable MDM Deduplication |
| HL7 v2.x Mapper - Contained Resource |
| HL7 v2.x Mapper - Contained Resource |
| Property: Use standalone Related Person |
| Property: Use standalone Associated Party |
| Property: Use standalone Patient Account |
| HL7 v2.x Mapper - DG1 |
| HL7 v2.x Mapper - DG1 |
| Property: Use DG1.1 as Condition.identifier.value` suffix. |
| HL7 v2.x Mapper - Forced Namespace Mode |
| HL7 v2.x Mapper - Forced Namespace Mode |
| Property: Forced Namespace Mode: Encounter System |
| Property: Forced Namespace Mode: Patient System |
| HL7 v2.x Mapper - General |
| HL7 v2.x Mapper - General |
| Property: Create MessageHeader for Each Message |
| Property: Creation Mode - Practitioner |
| Property: Escape Markdown Punctuation: NTE-3 |
| Property: Raise Issue for codes with missing code system |
| Property: Raise Issue for Required Codes |
| Property: Patient Primary Identifier Search Parameter |
| Property: Inferred TimeZone When Not Present |
| Property: Map Identifiers using NamingSystem |
| Property: Mapper Bean Types |
| Property: MessageHeader Hardcoded Destination Name |
| Property: Process AL1 Segments |
| Property: Store Original HL7v2 message |
| HL7 v2.x Mapper - Medications |
| HL7 v2.x Mapper - Medications |
| Property: Use Standalone Medications with Administered Code |
| Property: Medication Component Mapping Mode |
| Property: Use Standalone Medications with Give Code |
| HL7 v2.x Mapper - OBR |
| HL7 v2.x Mapper - OBR |
| Property: Observation Identification Mode |
| Property: Use OBR-2 as Primary Identifier |
| Property: Use OBR-3 as Primary Identifier |
| HL7 v2.x to FHIR Mapper - OBSERVATION Group |
| HL7 v2.x to FHIR Mapper - OBSERVATION Group |
| Property: OBSERVATION Group Text Delimiter - NTE |
| Property: OBSERVATION Group Text Delimiter - OBX |
| HL7 v2.x Mapper - ORC |
| HL7 v2.x Mapper - ORC |
| Property: Use ORC-3 as Primary Identifier |
| HL7 v2.x to FHIR Mapper - ORDER_OBSERVATION Group |
| HL7 v2.x to FHIR Mapper - ORDER_OBSERVATION Group |
| Property: ORDER_OBSERVATION Group Text Delimiter - NTE |
| HL7 v2.x Mapper - PID |
| HL7 v2.x Mapper - PID |
| Property: Patient Primary Identifier Type |
| HL7 v2.x Mapper - PV1 |
| HL7 v2.x Mapper - PV1 |
| Property: Coding System for PV1-4 Admission Type |
| Property: Parse Encounter Providers |
| Property: Treat PV1-3 and PV1-6 Patient Locations as Single Atomic Locations |
| HL7 v2.x Mapper - TXA |
| HL7 v2.x Mapper - TXA |
| Property: Default Organization Namespace |
| Listener Interceptors |
| Listener Interceptors |
| Property: Interceptor Bean Types |
| HL7 v2.x Listener Script |
| HL7 v2.x Listener Script |
| Property: Listener Processing Script (File) |
| Property: Listener Processing Script (Text) |
| HL7 v2.x Listening Endpoint |
| HL7 v2.x Listening Endpoint |
| Property: Intermediate Logging Enabled |
| Property: Non-standard segment behaviour |
| Property: Storage Tenant Name |
| Property: Transport Protocol |
| Property: Unprocessable Message Handling |
| HL7 v2.x MLLP Listener |
| HL7 v2.x MLLP Listener |
| Property: Charset: Forced |
| Property: Charset: Respect MSH-18 |
| Property: Maximum Connection Count |
| Property: Maximum Message Size |
| Property: Maximum Message Timeout |
| Property: HL7 v2.x MLLP Listener Port |
| Property: Socket Timeout (Millis) |
| HL7 v2.x MLLP Sender |
| HL7 v2.x MLLP Sender |
| Property: Delay Between Failed Deliveries (millis) |
| Property: Forward Persisted Messages |
| Property: HL7 v2.x Destination Host |
| Property: Request Path |
| Property: HL7 v2.x Destination Port |
| Property: Retry message on NAK |
| Property: Send Timeout (millis) |
| Property: Transport Protocol |
| FHIR to HL7 v2.x Mapper Script |
| FHIR to HL7 v2.x Mapper Script |
| Property: HL7 v2.x Conversion Mapper Script (File) |
| Property: HL7 v2.x Conversion Mapper Script (Text) |
| HL7 v2.x Outbound Mapping |
| HL7 v2.x Outbound Mapping |
| Property: Coding System for PV1-4 Admission Type |
| Property: Map Identifiers using NamingSystem |
| Property: Populate AL1 Segments |
| Property: Populate Encounter Participants in PV1 |
| Property: Use Persisted Message Headers |
| HTTP Access Log |
| HTTP Access Log |
| Property: Appenders |
| HTTP Listener |
| HTTP Listener |
| Property: Allow HTTP Request Headers Inspection |
| Property: Bind Address |
| Property: Context Path |
| Property: Endpoint Health Path |
| Property: Unhealthy Status Code |
| Property: HTTPS Forwarding Assumed |
| Property: Listener Port |
| Property: Respect Forward Headers |
| HTTP Request Pool |
| HTTP Request Pool |
| Property: Maximum Request Header Size (KB) |
| Property: Maximum Response Header Size (KB) |
| Property: Read Idle Timeout (millis) |
| Property: Thread Pool Accept Queue Size |
| Property: Thread Pool Maximum Size |
| Property: Thread Pool Minimum Size |
| HTTP Security |
| HTTP Security |
| Property: Two-Factor Authentication (2FA) Required |
| Property: Block HTTP HEAD |
| Property: Block HTTP OPTIONS |
| Property: Custom Headers |
| Property: Frame Options (Allow From) |
| Property: CSP Frame Ancestors |
| Property: Pin Host |
| Property: Suppress Error Details |
| Property: Suppress Platform Information |
| Hybrid Providers Definitions |
| Hybrid Providers Definitions |
| Property: Search Bundle Inclusion Rule |
| Property: FHIR Parser Error Handler Mode |
| Property: FHIR Version |
| Property: Spring Context Config Class |
| IG Support |
| IG Support |
| Property: Target Implementation Guide |
| Initial Custom Roles Seeding |
| Initial Custom Roles Seeding |
| Property: Custom Roles Seed File |
| Initial User Seeding |
| Initial User Seeding |
| Property: Users Seed File |
| JavaScript Execution Environment |
| JavaScript Execution Environment |
| Property: Class Allowlist |
| Property: Debug Enabled |
| Property: Debug Host Address |
| Property: Path |
| Property: Port |
| Property: Secure |
| Property: Suspend |
| Property: ECMAScript Module |
| JSON Web KeySet (JWKS) |
| JSON Web KeySet (JWKS) |
| Property: Keystore ID |
| LDAP Authentication |
| LDAP Authentication |
| Property: Authentication: User Attributes to query |
| Property: Authentication: User Base DN |
| Property: Authentication: User Query |
| Property: Require Group DN |
| Property: Base DN for Groups |
| Property: Search Groups Recursively |
| Property: System User DN |
| Property: System User Password |
| Property: LDAP Server URL |
| Property: Global Permissions |
| Property: Native Permission User Attribute |
| Property: User Attribute: Family Name |
| Property: User Attribute: Given Name |
| Smile CDR License |
| Smile CDR License |
| Property: License JWT File |
| Property: License JWT Text |
| MDM |
| MDM |
| Property: Auto Delete Golden Resources |
| Property: Block List Rules File |
| Property: Block List Rules |
| Property: MDM Consumer Thread Count |
| Property: Custom Matcher Bean Types |
| Property: Golden Resource Partition |
| Property: Ignore Golden Resources during Conditional Match resolution |
| Property: Ignore Placeholder Resources during MDM match operations |
| Property: Interceptor Bean Types |
| Property: MDM Partition Key Generator Script (File) |
| Property: MDM Partition Key Generator Script (Text) |
| Property: Maximum allowed search candidates |
| Property: MDM Partition Key generator type |
| Property: MDM Mode |
| Property: Prevent modification of External EIDs |
| Property: Prevent multiple EIDs from existing simultaneously on a target resource |
| Property: MDM Rule Definition Script (File) |
| Property: MDM Rule Definition Script (Text) |
| Property: Search All Partitions For Matches |
| Property: MDM Survivorship Script (File) |
| Property: MDM Survivorship Script (Text) |
| Property: Synchronous $mdm-clear Max Link Count |
| Property: Warn threshold for search candidates |
| Migration |
| Migration |
| Property: Only Dry-Run the Migration |
| Property: Include Heavyweight Skippable Migrations |
| Property: Migration Versions to skip |
| Property: Database Update Mode |
| Narrative Generator |
| Narrative Generator |
| Property: Narrative Template Manifest File |
| OpenID Connect Token Validation |
| OpenID Connect Token Validation |
| Property: OIDC HTTP Client: JWKS Cache Timeout (mins) |
| Property: OIDC HTTP Client: JWKS Fetch Failure Cache (Seconds) |
| Property: OIDC HTTP Client: Truststore File |
| Property: OIDC HTTP Client: Truststore Password |
| OpenID Connect (OIDC) |
| OpenID Connect (OIDC) |
| Property: Cache Authorizations (millis) |
| Property: Client Secret Encoding |
| Property: Smile CDR generated Client Secret expiry duration in days |
| Property: Issuer URL |
| Property: New Session for Each Flow |
| Property: PKCE Plain Challenge Supported |
| Property: PKCE Required |
| Property: Rotate Refresh Token After Use |
| Property: Smart Capabilities List |
| Prior Authorization Coverage Requirement Discovery |
| Prior Authorization Coverage Requirement Discovery |
| Property: CDS Hook Json (Text) |
| Property: CDS Hook JSON (File) |
| Prior Authorization Support |
| Prior Authorization Support |
| Property: Organization identifier code system NPI |
| Property: Payer System Item TRN |
| Property: Practitioner identifier code system NPI |
| Privacy Security Notice |
| Privacy Security Notice |
| Property: Privacy Text |
| Property: Expiry time (days) |
| Property: Version |
| Provenance Injection |
| Provenance Injection |
| Property: Agent Type |
| Property: Agent Who |
| Property: $everything operation |
| Property: Profile |
| Property: _revinclude=Provenance:target |
| Realtime Export |
| Realtime Export |
| Property: Concurrent Consumers |
| Property: Concurrent Retry Consumers |
| Property: Channel Name Prefix |
| Property: Default Query Timeout (Seconds) |
| Property: Max Idle Connections |
| Property: Max Total Connections |
| Property: Max Wait (Seconds) |
| Property: Min Idle Connections |
| Property: Target Database Type |
| Property: Target Database Password |
| Property: Target Database Connection URL |
| Property: Target Database Username |
| Property: Snowflake PAT |
| Property: Snowflake OAuth Token |
| Property: Realtime Export Script (File) |
| Property: Realtime Export Script (Text) |
| Property: Transaction-Based Processing |
| Endpoint Validation: Request Validating |
| Endpoint Validation: Request Validating |
| Property: Request Validating Bean Types |
| Property: Request Validating Enabled |
| Property: Fail On Severity |
| Property: Validation Response Headers Enabled |
| Property: Validation Tags Enabled |
| Search Parameter Seeding |
| Search Parameter Seeding |
| Property: Disable Patterns |
| Property: Enable Patterns |
| Property: Support Default SearchParameters |
| SAML Provider |
| SAML Provider |
| Property: Relying Party Entity ID Template |
| Property: Issuer ID |
| Property: Keystore File |
| Property: Keystore Password |
| Property: Registration ID |
| Property: Sign Auth Request |
| Property: Signing Key Alias |
| Property: Signing Key Password |
| Property: Verification Certificate Alias |
| Property: Web SSO URL |
| Security Inbound Script |
| Security Inbound Script |
| Property: Script (File) |
| Property: HTTP Headers |
| Property: Script (Text) |
| Inbound SMART on FHIR Authentication |
| Inbound SMART on FHIR Authentication |
| Property: Authentication Cache Timeout (Seconds) |
| Property: Prevent Token KeyID Reuse |
| Property: Require Key Expiry |
| Property: Scopes Supported |
| Property: Trust Intra-Cluster SMART Tokens from Module(s) |
| Inbound SMART on FHIR Endpoints |
| Inbound SMART on FHIR Endpoints |
| Property: Authorization Endpoint |
| Property: Introspect ingested tokens |
| Property: Introspection Endpoint |
| Property: Management Endpoint |
| Property: Revocation Endpoint |
| Property: Token Endpoint |
| OAuth2/OIDC Federation |
| OAuth2/OIDC Federation |
| Property: Federated OAuth2/OIDC Login |
| SMART Callback Script |
| SMART Callback Script |
| Property: Authorization Request Details (whitelist) |
| Property: Post Authorization Script (File) |
| Property: Post Authorization Script (Text) |
| Cross-Organizational Data Access Profile |
| Cross-Organizational Data Access Profile |
| Property: CODAP Authorization Script (File) |
| Property: CODAP Authorization Script (Text) |
| Property: Enable Cross-Organization Data Access Profile |
| SMART Login Skin |
| SMART Login Skin |
| Property: Login Page Logo |
| Property: Approval Page Template |
| Property: Context Selection Page Template |
| Property: Error Page Template |
| Property: User Self Registration Forgot Password (Step 1) |
| Property: User Self Registration Forgot Password (Step 2) |
| Property: User Self Registration Forgot Password (Step 3) |
| Property: Login Page (Federated OAuth2/OIDC) Template |
| Property: Login Page Template |
| Property: User Self Registration Template (Step 1) |
| Property: User Self Registration Template (Step 2) |
| Property: Session Management Page Template |
| Property: Two Factor Authentication Page Template |
| Property: Terms-of-service click-wrap Page Template |
| Property: WebJar ID |
| SMART Login Terms of Service |
| SMART Login Terms of Service |
| Property: Current version of terms. |
| SMART Authorization |
| SMART Authorization |
| Property: Allowed Audience List |
| Property: Email From Address |
| Property: Enforce Approved Scopes to Restrict Permissions |
| Property: Smart Granular Scope Selection |
| Property: Scopes Supported |
| SMART Definitions Seeding |
| SMART Definitions Seeding |
| Property: OpenID Connect Client Pre-Seed File |
| Property: OpenID Connect Server Pre-Seed File |
| Semantic Standardization Configuration |
| Semantic Standardization Configuration |
| Property: Provider Base URL |
| Property: Mapping Options Configuration (File) |
| Property: Mapping Options Configuration (Text) |
| Property: Confidence Threshold |
| Sessions |
| Sessions |
| Property: Use In-Memory Sessions |
| Property: Maximum concurrent session per user |
| Property: Session Timeout (Mins) |
| Smile Portal |
| Smile Portal |
| Property: Admin JSON URL |
| Property: Custom Application Configuration (File) |
| Property: Custom Application Configuration (Text) |
| Property: OIDC Client ID |
| Property: OIDC Issuer URL |
| Property: OIDC Logout URL |
| Property: OIDC scopes |
| Terminology Suggestions |
| Terminology Suggestions |
| Property: In-Place Translate Interceptor: Enabled |
| Property: Missing Translation Suggestion: Enabled |
| Property: Missing Translation Suggestion Provider: Active Name |
| Two Factor Authentication |
| Two Factor Authentication |
| Property: TOTP Issuer Name |
| Property: Lock After Failed Attempts |
| TLS / SSL (Encryption) |
| TLS / SSL (Encryption) |
| Property: TLS Client Authentication |
| Property: TLS Enabled |
| Property: TLS KeyStore Filename |
| Property: TLS KeyStore Key Alias |
| Property: TLS KeyStore Key Password |
| Property: TLS KeyStore Password |
| Property: TLS Cipher Blacklist |
| Property: TLS Cipher Whitelist |
| Property: TLS Protocol Blacklist |
| Property: TLS Protocol Whitelist |
| Property: TLS TrustStore Filename |
| Property: TLS TrustStore Password |
| Property: TLS: Disable SNI checking for debugging |
| Transaction Log |
| Transaction Log |
| Property: Transaction Log Broker Batch Size |
| Property: Transaction Log Broker Block Timeout (ms) |
| Property: Transaction Log Broker Flush Interval (ms) |
| Property: Transaction Log Broker Queue Capacity |
| Property: Transaction Log Broker Queue Full Strategy |
| Property: Transaction Log Broker Channel Name |
| Property: Transaction Log Broker Send Mode |
| Property: Event Blacklist |
| Property: Event Whitelist |
| Property: Persist Transaction Bodies (All) |
| Property: Persist Transaction Bodies: Incoming Request |
| Property: Persist Transaction Bodies: Incoming Response |
| Property: Persist Storage Outcome Details |
| Property: Capture System Logs |
| Property: System Log Capture Level |
| Property: System Log Capture Maximum Lines |
| Property: Capture System Logs On Error Only |
| Property: Transaction Log Step Body Serialization Mode |
| Property: Transaction Log Broker Enabled (DEPRECATED) |
| Property: Cluster Manager Transaction Log Storage |
| Property: Request Headers to Store |
| Property: Response Headers to Store |
| Property: Transaction Log Show Request Body Enabled |
| Property: Truncate Transaction Bodies (bytes) |
| Trusted Client |
| Trusted Client |
| Property: Assert Permissions |
| Property: Trusted Client Mode Enabled |
| User Self Registration |
| User Self Registration |
| Property: User Self Registration Script (File) |
| Property: User Self Registration Script (Text) |
| Property: User Self Registration Enabled |
| Property: Referer URL List (Text) |
| Module Dependencies |
| Module Dependencies |
| Module Dependencies |
| Dependency: ADMIN_JSON |
| Dependency: BOOT_AFTER |
| Dependency: CAMEL |
| Dependency: CDA_EXCHANGE |
| Dependency: CONSENT |
| Dependency: CQL |
| Dependency: EASYSHARE_PUBLIC |
| Dependency: ENDPOINT_CDS_HOOKS |
| Dependency: ENDPOINT_FHIR |
| Dependency: ENDPOINT_HL7V2_IN |
| Dependency: ETL_IMPORTER |
| Dependency: MDM |
| Dependency: NARRATIVE_GENERATOR |
| Dependency: PACKAGE_CACHE |
| Dependency: PERSISTENCE_ALL |
| Dependency: PERSISTENCE_DSTU3 |
| Dependency: SECURITY_IN_ANONYMOUS |
| Dependency: SECURITY_IN_OIC |
| Dependency: SECURITY_IN_SAML |
| Dependency: SECURITY_IN_UP |
| Dependency: SECURITY_USER_SELF_REGISTRATION |
| Dependency: SUBSCRIPTION |
| Dependency: VALIDATION_SUPPORT |
| Product Reference |
| Enumerated Types |
| Enumerated Types |
| Node And Module Status |
| Transaction Log Outcomes |
| Module Types |
| Explanation |
| Overview |
| Payer to Payer Solution Overview |
| Regulatory Context |
| Supported Implementation Guides |
| Actors, Roles & Data Scope |
| Actors and Roles |
| Exchange Modes |
| Phases of the Exchange |
| Key Activities Overview |
| Storing Imported Records |
| Solution Modules & Standards |
| Solution Modules & Standards |
| Matching Logic |
| Matching Logic |
| $member-match: Single Member Match |
| $bulk-member-match: Multi-Member Match |
| Customizing Matching Logic |
| Implementation Considerations |
| Data Exchange Patterns |
| Data Exchange Patterns |
| Security & Privacy Framework |
| Security and Privacy Framework |
| Glossary of Terms |
| Glossary of Terms |
| Reference |
| P2P Implementation Checklist |
| P2P Implementation Checklist |
| Responding Payer Checklist |
| Requesting Payer Checklist |
| Prerequisites Checklist |
| How-to Guides |
| Configure Requesting Payer |
| Configure Requesting Payer |
| Configure the FHIR Endpoint Module for Security |
| Configure OIDC Server as part of a registration workflow |
| Configure Responding Payer |
| Configure Responding Payer |
| Configure FHIR Storage Settings |
| Configuring OIDC Client as part of a registration workflow |
| Registration and Authentication |
| Registration and Authentication Overview |
| When You Are the Requesting Payer |
| When You Are the Responding Payer |
| Authorizing Access |
| Configuration Considerations |
| Execute P2P Exchanges |
| P2P Execute Exchange |
| What $invoke-export Does |
| Monitor and Troubleshooting P2P Exchanges |
| Monitoring P2P Exchanges |
| Monitoring Methods |
| Troubleshooting |
| Enable Data Blend |
| Enable Data Blend |
| Create the MDM Rule Definition Script |
| Register the Interceptor |
| Configure the FHIR Storage Module |
| Configure the Subscription Matcher Module |
| Configure the MDM Module |
| Tutorials |
| P2P Requests |
| Payer-to-Payer Requests |
| Member Match |
| Invoke Export |
| Target Patient $everything |
| Responding Payer OIDC Client Setup |
| Responding Payer OIDC Client Setup |
| OIDC Configuration |
| Key Responsibilities as Responding Payer |
| Consent Management |
| Authorization Methods |
| Requesting Payer OIDC Server Setup |
| Requesting Payer OIDC Server Setup |
| OIDC Configuration |
| Executing P2P Exchanges |
| Explanation |
| Overview |
| Regulatory Context |
| Smile's Prior Authorization Solution |
| Solution Modules & Standards |
| Solution Modules |
| Standards & Technology |
| Actors, Roles & Data Scope |
| Actors and Roles |
| Data Scope |
| Use Cases & Timeliness |
| Use Cases |
| Timeliness |
| Security |
| Security |
| Glossary of Terms |
| Glossary of Terms |
| How-to Guides |
| Setup Prior Auth for Providers |
| Setup Prior Auth for Providers (DEMO) |
| 1. Overview |
| 2. Setting up a demo provider environment |
| 3. Client flow |
| Setup Prior Auth for Payers |
| SmileCDR Prior-Auth Module Configuration Guide |
| Tutorials |
| Using CRD API |
| Using the CRD (Coverage Requirement Discovery) API |
| CDS Discovery |
| Calling a CDS Service |
| Using DTR API |
| Using the DTR (Documentation Templates and Rules) API |
| Calling the Questionnaire Package |
| Using PAS API |
| Using the PAS (Prior Auth Support) API |
| Submit a New Prior Authorization Request |
| Check the Status of a Prior Authorization Request |
| Update a Prior Authorization Response |
| Reference |
| Prior Auth Support Module Overview |
| Prior Auth Support Module Overview |
| Introduction |
| Operations |
| PAS Request Routing |
| Prior Auth CRD (Coverage Requirement Discovery) Module Overview |
| Prior Auth CRD (Coverage Requirement Discovery) Module Overview |
| Prior Auth CRD (Coverage Requirement Discovery) Introduction |
| Prior Auth CRD (Coverage Requirement Discovery) Module Overview |
| Prior Auth DTR (Documentation Templates and Rules) Module Overview |
| Prior Auth DTR (Documentation Templates and Rules) Module Overview |
| Explanation |
| Overview |
| Provider Access API |
| Regulatory Context |
| Solution Module |
| Standards & Technology |
| Actors, Roles & Data Flow |
| Actors and Roles |
| Data Flow Overview |
| Data Scope, Use Cases and Timeliness |
| Data Scope |
| Supported Use Cases |
| Timeliness |
| Security |
| Security |
| Consent Management |
| Consent Management |
| Glossary of Terms |
| Glossary of Terms |
| Reference |
| Provider System Registration |
| Provider System Registration |
| FHIR Resource Requirements |
| Multi-Repo Data Blend |
| Multi-Repo Data Blend |
| Key Concepts |
| Where Application Gateway Fits In |
| Data Blend Use Case: |
| Example Scenario |
| Configuration Requirements |
| How It Works |
| $davinci-data-export Operation |
| $davinci-data-export Operation for Provider Access |
| Sequence Diagram |
| How-to Guides |
| Get Started |
| Get Started |
| Enable the DaVinci Data Exchange Module |
| Enable the DaVinci Data Exchange Module |
| Create an Organization Resource |
| Create an Organization Resource to store the Provider System Business Identifer |
| Create Group Resources |
| Create Member Attribution (Access) List as FHIR Group Resources |
| Manage Consent |
| Manage Consent |
| Enable Data Blend |
| Enable Data Blend |
| Create the MDM Rule Definition Script |
| Register the Interceptor |
| Configure the FHIR Storage Module |
| Configure the Subscription Matcher Module |
| Configure the MDM Module |
| Authenticate and Authorize Provider System |
| Authenticate and Authorize Provider System |
| Discover the Group ID |
| Discover the Group IDs |
| Call the $davinci-data-export Operation |
| Call the $davinci-data-export Operation |
| Poll Asynchronous Exports |
| Poll Asynchronous Exports |
| Tutorials |
| Calling the $davinci-data-export Operation |
| Calling the $davinci-data-export Operation |
| ATR Export (Member Attribution List) |
| Single Patient Export (Delta) |
| Multiple Patients Export (Delta) |
| Full Group Export (Download) |
| Snapshot Export |
| Poll Asynchronous Exports |
| Polling the Export Job |