This online document contains instructions for how to install Smile CDR, how to plan and execute a deployment that meets your specific needs, how to manage and maintain that deployment, and how to keep it healthy.
If this is your first time reading these documents, we highly recommend you start by reading the Basic Concepts page.
| 1.0.0 |
Welcome to Smile CDR |
| 1.0.0 |
Table of Contents |
| 1.1.0 |
Changelog (2021 Releases) |
| 1.1.1 |
Smile CDR 2021.05.R01 (Pre-Release) |
| 1.1.2 |
Smile CDR 2021.02.R05 (Odyssey) |
| 1.1.3 |
Smile CDR 2021.02.R04 (Odyssey) |
| 1.1.4 |
Smile CDR 2021.02.R03 (Odyssey) |
| 1.1.5 |
Smile CDR 2021.02.R02 (Odyssey) |
| 1.1.6 |
Smile CDR 2021.02.R01 (Odyssey) |
| 1.1.7 |
Smile CDR 2020.11.R02 (Numbat) |
| 1.2.0 |
Changelog (2020 Releases) |
| 1.2.1 |
Smile CDR 2020.11.R01 (Numbat) |
| 1.2.2 |
Smile CDR 2020.08.R03 (Manticore) |
| 1.2.3 |
Smile CDR 2020.08.R02 (Manticore) |
| 1.2.4 |
Smile CDR 2020.08.R01 (Manticore) |
| 1.2.5 |
Smile CDR 2020.05.R02 (Labrador) |
| 1.2.6 |
Smile CDR 2020.05.R01 (Labrador) |
| 1.2.7 |
Smile CDR 2020.02.R01 (Koala) |
| 1.3.0 |
Changelog (2019 Releases) |
| 1.3.1 |
Smile CDR 2019.11.R01 (Jitterbug) |
| 1.3.2 |
Smile CDR 2019.08.R01 (Igloo) |
| 1.3.3 |
Smile CDR 2019.05.R01 (Hippo) |
| 1.3.4 |
Smile CDR 2019.02.R01 (Gale) |
| 1.4.0 |
Changelog (2018 Releases) |
| 1.4.1 |
Smile CDR 2018.11.R01 (Food) |
| 1.4.2 |
Smile CDR 2018.09.R01 (Economist) |
| 1.4.3 |
Smile CDR 2018.05.R01 (Dromedário) |
| 1.4.4 |
Smile CDR 2018.03.R01 (Crouton) |
| 1.5.0 |
Changelog (2017 Releases) |
| 1.5.1 |
Smile CDR 2017.11.R01 (Buccaneer) |
| 1.5.2 |
Smile CDR 2017.09.R01 (Aardvark) |
| 1.5.3 |
Smile CDR 2017.07.R01 |
| 2.0.0 |
Getting Started |
| 2.0.0 |
Basic Concepts |
| 2.0.1 |
Nodes and Modules |
| 2.0.2 |
The Cluster Manager Module |
| 2.0.3 |
Module Dependencies |
| 2.1.0 |
Platform Requirements |
| 2.1.1 |
Server Requirements |
| 2.1.2 |
Java Requirements |
| 2.1.3 |
Database Requirements |
| 2.1.4 |
Network Infrastructure |
| 3.0.0 |
Installation |
| 3.0.0 |
Installing Smile CDR |
| 3.0.1 |
Installing to Linux / OSX |
| 3.0.2 |
Basic Configuration |
| 3.0.3 |
Quick Start |
| 3.0.4 |
The Initial Configuration |
| 3.0.5 |
The Node Configuration Properties File |
| 3.0.6 |
Module Property Source |
| 3.0.7 |
Variable Substitution |
| 3.0.8 |
Fetching Configuration Using Scripts |
| 3.0.9 |
Configuring Your Database |
| 3.0.10 |
Starting the CDR |
| 3.0.11 |
API Gateways |
| 3.1.0 |
Docker Container Installation |
| 3.1.1 |
Quick Start |
| 3.1.2 |
Basic Configuration |
| 3.1.3 |
Customizing Smile CDR in Docker Container |
| 3.1.4 |
Using System Environment for Variable Substitution |
| 3.1.5 |
Configuring Databases for Smile CDR Installed in Container |
| 3.2.0 |
Unix Service Installation |
| 3.2.1 |
Testing the Service |
| 3.2.2 |
Starting Automatically on Boot |
| 3.3.0 |
Tuning your Installation |
| 3.3.1 |
Memory Settings |
| 3.4.0 |
Message Brokers |
| 3.4.1 |
Subscription Channels |
| 3.4.2 |
Subscription Channel Names |
| 3.5.0 |
Message Broker Failure Management |
| 3.6.0 |
Message Broker: ActiveMQ |
| 3.6.1 |
Resource Limits |
| 3.7.0 |
Message Broker: Kafka |
| 3.7.1 |
Kafka Topic Names |
| 3.8.0 |
Pre-Seeding Configuration and Data |
| 3.8.1 |
Pre-Seeding Module Configuration |
| 3.8.2 |
Pre-Seeding Users |
| 3.8.3 |
Pre-Seeding OpenID Connect Servers |
| 3.8.4 |
Pre-Seeding OpenID Connect Clients |
| 3.8.5 |
Pre-Seeding Packages and FHIR Resources |
| 3.9.0 |
Upgrading Smile CDR |
| 4.0.0 |
Tutorial and Tour |
| 4.0.0 |
Preamble and Setup |
| 4.0.1 |
Getting Up to Speed |
| 4.0.2 |
Preparing Your Instance |
| 4.0.3 |
Accessing the Web Admin Console |
| 4.0.4 |
Enabling Anonymous Access to the FHIR Endpoint |
| 4.0.5 |
Uploading Sample FHIR Resources |
| 4.1.0 |
FHIR Basics |
| 4.1.1 |
Resources |
| 4.1.2 |
Datatypes |
| 4.1.3 |
Parts of a Resource |
| 4.1.4 |
Encodings (MIME Types, Wire Formats) |
| 4.2.0 |
FHIR Search Queries |
| 4.2.1 |
How Searching Works |
| 4.2.2 |
Basic Searching: Finding Patients |
| 4.2.3 |
References: Finding Encounters |
| 4.2.4 |
Quantities: Finding Laboratory Values |
| 4.2.5 |
Dates and Times: Narrowing Your Search Window |
| 4.2.6 |
Paging Search Results |
| 4.2.7 |
Sorting Search Results |
| 4.2.8 |
Fulltext Searching |
| 4.2.9 |
The Patient $everything Search (Across Patient Chart) |
| 4.3.0 |
FHIR CRUD Operations |
| 4.3.1 |
Testing Tools |
| 4.3.2 |
FHIR Create |
| 4.3.3 |
FHIR Update |
| 4.3.4 |
FHIR Patch |
| 4.3.5 |
FHIR Read / vRead |
| 4.3.6 |
FHIR Delete |
| 4.4.0 |
SMART on FHIR Apps |
| 4.4.1 |
Accessing the Web Admin Console |
| 4.4.2 |
Creating a Client Definition |
| 4.4.3 |
Enabling SMART on FHIR Requests |
| 4.4.4 |
Install Growth Chart App |
| 4.4.5 |
Create Some Test Data |
| 4.4.6 |
Enable SMART Authorization on FHIR Endpoint |
| 4.4.7 |
Install a Launch Context Script |
| 4.4.8 |
Launch SMART on FHIR Growth Chart App |
| 4.5.0 |
Processing HL7 v2.x Feeds |
| 4.5.1 |
Transmitting to Smile CDR |
| 4.5.2 |
ORU (Observation Result) Messages |
| 4.5.3 |
ADT (Admission/Discharge/Transfer) Messages |
| 4.6.0 |
FHIRPath Expressions |
| 4.6.1 |
Testing FHIRPath Expressions |
| 4.6.2 |
Expression: Extension With Reference Value |
| 4.6.3 |
Expression: Contained Resource |
| 4.6.4 |
Expression: Bundle (FHIR Message) Entry Resource |
| 4.6.5 |
Expression: Bundle (FHIR Document) Entry Resource |
| 4.6.6 |
Expression: Multiple Paths |
| 4.7.0 |
Federated OAuth2/OIDC Setup |
| 4.7.1 |
Setting up Smile CDR - SMART Outbound Security Module |
| 4.7.2 |
Setting up Smile CDR - OIDC Client Definition |
| 4.7.3 |
Setting up Smile CDR - OIDC Server Definition |
| 4.7.4 |
Setting up the IDP |
| 4.7.5 |
Starting the Federated Flow |
| 4.7.6 |
Token Signature Algorithms |
| 4.7.7 |
Considerations |
| 5.0.0 |
FHIR Storage |
| 5.0.0 |
Concepts in Smile CDR |
| 5.0.1 |
The FHIR Storage Module |
| 5.0.2 |
The FHIR REST Endpoint Module |
| 5.0.3 |
Clustering |
| 5.1.0 |
FHIR Storage (Relational) Module |
| 5.1.1 |
Preparing for a New Installation |
| 5.1.2 |
Creating the Module |
| 5.1.3 |
Database Schema |
| 5.1.4 |
Configuration |
| 5.2.0 |
FHIR Storage (MongoDB) Module |
| 5.2.1 |
Preparing for a New Installation |
| 5.2.2 |
Creating the Module |
| 5.2.3 |
MongoDB Document Schema |
| 5.2.4 |
MongoDB Uplift Search Parameter Extensions |
| 5.2.5 |
Uplifting Tokens |
| 5.2.6 |
Uplifting Reference Chains |
| 5.2.7 |
Configuration |
| 5.2.8 |
MongoDB vs RDBMS Support Comparison |
| 5.3.0 |
FHIR Endpoint Module |
| 5.3.1 |
Creating the Module |
| 5.3.2 |
Capturing Source Information |
| 5.3.3 |
Validation |
| 5.3.4 |
Configuration |
| 5.4.0 |
FHIRWeb Console |
| 5.4.1 |
Architecture |
| 5.4.2 |
Security |
| 5.4.3 |
Creating the Module |
| 5.4.4 |
Using the Console |
| 5.4.5 |
Configuration |
| 5.5.0 |
OpenAPI / Swagger Support |
| 5.5.1 |
Swagger UI |
| 5.5.2 |
Limitations |
| 5.6.0 |
Lucene Indexing |
| 5.6.1 |
Lucene Disk Provider |
| 5.6.2 |
Elasticsearch Provider |
| 5.7.0 |
Performance and Caching |
| 5.7.1 |
The Query Cache |
| 5.7.2 |
Search Counts |
| 5.7.3 |
Improving Write Performance |
| 5.8.0 |
Resource IDs |
| 5.8.1 |
Server Assigned IDs |
| 5.8.2 |
Client Assigned IDs |
| 5.9.0 |
Search Parameters |
| 5.9.1 |
Search Parameter Concepts |
| 5.9.2 |
Default Search Parameters |
| 5.9.3 |
Managing Search Parameters |
| 5.9.4 |
Search Parameter Statistics |
| 5.9.5 |
Filter Search Parameter |
| 5.9.6 |
Manual Reindexing |
| 5.10.0 |
Search Parameter Features |
| 5.10.1 |
Index Missing Search Parameters (:missing) |
| 5.10.2 |
Suppress Text Index on Tokens (:text) |
| 5.10.3 |
Index Contained Resources (_contained) |
| 5.11.0 |
Phonetic Search Parameters |
| 5.12.0 |
Custom Search Parameters |
| 5.12.1 |
An Example Search Parameter |
| 5.12.2 |
Search Parameter Expressions |
| 5.12.3 |
Enforcing Uniqueness |
| 5.13.0 |
Partitioning and Multitenancy |
| 5.13.1 |
Enabling Partitioning in Smile CDR |
| 5.13.2 |
Request Partition Selection Mode |
| 5.13.3 |
Request Partition Security |
| 5.13.4 |
Tenant Identification Strategies |
| 5.13.5 |
Seeding Partitions |
| 5.13.6 |
Cross-Partition References |
| 5.14.0 |
Searching for Data |
| 5.14.1 |
FHIR Search Extensions |
| 5.14.2 |
Unsupported Search Parameters |
| 5.15.0 |
Creating Data |
| 5.15.1 |
Transactions and Submitting Bundles |
| 5.15.2 |
Auto-Creating Reference Targets |
| 5.15.3 |
Transaction With Conditional Create |
| 5.15.4 |
Auto-Create Placeholder Reference Targets |
| 5.15.5 |
Auto-Create Placeholder Reference Targets with Identifier |
| 5.15.6 |
Auto-Created Placeholder Extension |
| 5.15.7 |
Searching for Auto-Created Resources |
| 5.15.8 |
Auto-Creating Reference Targets and Enforcing Uniqueness |
| 5.15.9 |
Creation Performance |
| 5.16.0 |
Reading Data |
| 5.16.1 |
Diff Operation |
| 5.16.2 |
Diff Instance |
| 5.16.3 |
Diff Type |
| 5.17.0 |
Updating Data |
| 5.17.1 |
Patching Data |
| 5.17.2 |
Tag Retention |
| 5.17.3 |
Concurrent Write Errors |
| 5.18.0 |
Deleting Data |
| 5.18.1 |
Deletes and Referential Integrity |
| 5.18.2 |
Transactional Delete |
| 5.18.3 |
Referential Integrity |
| 5.18.4 |
Cascading Deletes |
| 5.18.5 |
The $expunge Operation |
| 5.19.0 |
Binary Data |
| 5.19.1 |
Externalized Binary Storage |
| 5.19.2 |
Binary Access Operations |
| 5.19.3 |
Serving Raw Media Resources |
| 5.20.0 |
Request Tracing and Provenance |
| 5.20.1 |
Request Tracing |
| 5.20.2 |
Performance Tracing |
| 5.20.3 |
Storing Source Information |
| 5.21.0 |
FHIR Versions |
| 5.22.0 |
Versioned Resource References |
| 5.22.1 |
Allow Versioned References |
| 5.22.2 |
Automatically Version References |
| 5.23.0 |
Clinical Quality Language (CQL) |
| 5.23.1 |
Evaluate Measure |
| 6.0.0 |
Validation and Conformance |
| 6.0.0 |
Introduction |
| 6.0.1 |
Validation Modes |
| 6.1.0 |
Validation Support Repository |
| 6.1.1 |
Potential Architectures |
| 6.1.2 |
Single FHIR Repository (RDBMS) |
| 6.1.3 |
Dedicated Validation Support Repository |
| 6.1.4 |
Non-Repository Models |
| 6.2.0 |
Validation Support Repository Options |
| 6.2.1 |
Validating References |
| 6.2.2 |
Handling Missing CodeSystems |
| 6.3.0 |
Conformance Data |
| 6.3.1 |
StructureDefinition resources |
| 6.3.2 |
CodeSystem Resources |
| 6.3.3 |
ValueSet Resources |
| 6.4.0 |
Repository Validation |
| 6.4.1 |
Validation Support Repository |
| 6.4.2 |
Methods |
| 6.5.0 |
Repository Validation: Java |
| 6.6.0 |
Repository Validation: Javascript |
| 6.6.1 |
Function: repositoryValidationProvideRules(theRuleBuilder) |
| 6.6.2 |
Example: Require a Specific Profile |
| 6.6.3 |
Example: Allow Several Profiles for a Resource Type |
| 6.6.4 |
Example: Require Profile and Validate |
| 6.7.0 |
Endpoint Validation |
| 6.8.0 |
Packages and Implementation Guides |
| 6.8.1 |
Background: Implementation Guides |
| 6.8.2 |
Background: Packages |
| 6.8.3 |
Ingesting Packages into Smile CDR |
| 6.8.4 |
Package Pre-Seed Installation |
| 6.8.5 |
Pre-Seeding Resources into the Repository |
| 6.8.6 |
Package Registry Endpoint module |
| 6.8.7 |
Creating Packages |
| 6.9.0 |
Remote Terminology Services |
| 6.9.1 |
Scope |
| 6.9.2 |
Remote Server Requirements |
| 7.0.0 |
Terminology |
| 7.0.0 |
Terminology Introduction |
| 7.1.0 |
Uploading Codes |
| 7.1.1 |
Uploading External CodeSystems |
| 7.1.2 |
Uploading LOINC |
| 7.1.3 |
Uploading SNOMED CT |
| 7.1.4 |
Uploading Custom Vocabularies |
| 7.1.5 |
Applying Deltas to External CodeSystems |
| 7.1.6 |
Delta Add Operation: $apply-codesystem-delta-add |
| 7.1.7 |
Delta Remove Operation: $apply-codesystem-delta-remove |
| 7.1.8 |
Reference: CSV Vocabulary Input Files |
| 7.2.0 |
Terminology and Lucene Indexing |
| 7.2.1 |
Terminology Index |
| 7.2.2 |
Validation |
| 7.2.3 |
Operations |
| 7.3.0 |
ValueSet Expansion |
| 7.3.1 |
ValueSet Expansion Pre-Calculation |
| 7.3.2 |
Expanding Hierarchical CodeSystems and ValueSets |
| 7.3.3 |
Searching for Codes |
| 7.4.0 |
FHIR Response Terminology Mapping |
| 7.4.1 |
Response Terminology Mapping |
| 7.4.2 |
Response Coding Displays |
| 8.0.0 |
Subscription |
| 8.0.0 |
Introduction |
| 8.0.1 |
The Subscription Resource |
| 8.0.2 |
Subscription Activation |
| 8.0.3 |
Criteria |
| 8.0.4 |
Troubleshooting Subscriptions |
| 8.1.0 |
Architecture |
| 8.1.1 |
Enabling and Configuring Subscription Processing |
| 8.2.0 |
Channel Types |
| 8.2.1 |
Channel Type: rest-hook |
| 8.2.2 |
Channel Type: email |
| 8.2.3 |
Channel Type: websocket |
| 8.2.4 |
Channel Type: message |
| 8.3.0 |
Delivery Options |
| 8.3.1 |
Payload Search Result Mode |
| 8.3.2 |
Replication Mode |
| 8.3.3 |
Strip Version IDs |
| 8.3.4 |
Delivering Latest Version |
| 8.3.5 |
Custom Delivery Class |
| 8.3.6 |
Delivery to Site-defined External Queue |
| 8.4.0 |
Manual Triggering |
| 9.0.0 |
Interceptors |
| 9.0.0 |
Interceptors |
| 9.0.1 |
HAPI FHIR and Smile CDR Pointcuts |
| 9.0.2 |
Deploying Interceptors to Smile CDR Modules |
| 9.1.0 |
Starter Project |
| 9.1.1 |
Using the Starter Project |
| 9.2.0 |
Examples: FHIR Endpoints |
| 9.2.1 |
Example: Override CapabilityStatement Generation |
| 9.3.0 |
Examples: FHIR Storage |
| 9.3.1 |
Example: Response Attribute Enhancement |
| 9.4.0 |
Examples: FHIR Gateway |
| 9.4.1 |
Example: Direct Search based on Parameter Value |
| 9.4.2 |
Example: Modify Target Search based on Previous Target Search |
| 9.4.3 |
Example: Modify Target Search Results |
| 9.4.4 |
Example: Modify Target Search Uri |
| 10.0.0 |
LiveBundle |
| 10.0.0 |
LiveBundle Overview |
| 10.0.1 |
Configuration |
| 10.0.2 |
Usage |
| 10.0.3 |
LiveBundle Architecture |
| 10.0.4 |
LiveBundle Aggregation |
| 10.0.5 |
LiveBundle Retrieval |
| 10.0.6 |
LiveBundle Seeding |
| 10.0.7 |
LiveBundle Troubleshooting |
| 10.1.0 |
LiveBundle API |
| 10.1.1 |
Add a Subscriber to a Watchlist |
| 10.1.2 |
Remove Subscriber from a Watchlist |
| 10.1.3 |
View list of Subscribers to a Watchlist |
| 10.1.4 |
Request a bundle of Subscribers to a watchlist |
| 10.1.5 |
Reseed all bundles for a rule |
| 10.1.6 |
Request a LiveBundle |
| 10.2.0 |
LiveBundle Rule Definition |
| 10.2.1 |
Loading Rules |
| 10.2.2 |
Example LiveBundle Javascript |
| 10.2.3 |
LiveBundle Watchlist |
| 10.2.4 |
LiveBundle Rule |
| 10.2.5 |
LiveBundle Filter |
| 10.2.6 |
Keeper Filters |
| 10.2.7 |
LiveBundle Keeper |
| 10.3.0 |
LiveBundle Keepers |
| 10.3.1 |
LiveBundle Keeper Examples |
| 10.3.2 |
LatestByPath |
| 10.3.3 |
LatestByParamPath |
| 10.3.4 |
LatestByParamPathByMonth |
| 10.3.5 |
ToggleByPath |
| 10.3.6 |
ToggleBySearch |
| 10.3.7 |
WatchlistPopulator |
| 10.3.8 |
Optional Keeper Parameters |
| 11.0.0 |
Channel Import |
| 11.0.0 |
Channel Import Overview |
| 11.0.1 |
Enabling and Configuring Channel Import |
| 12.0.0 |
Realtime Export |
| 12.0.0 |
Realtime Export Overview |
| 12.0.1 |
Operational Overview |
| 12.0.2 |
Limitations |
| 12.0.3 |
Troubleshooting |
| 12.1.0 |
Realtime Export Rules Definition |
| 12.1.1 |
Transformers |
| 12.1.2 |
Named Transformers |
| 12.1.3 |
Managing high-cardinality elements |
| 12.2.0 |
Using FHIRPath |
| 12.2.1 |
Collection Subsetting |
| 12.2.2 |
Self-referral |
| 12.2.3 |
Conditionals |
| 12.3.0 |
Debezium |
| 13.0.0 |
Security |
| 13.0.0 |
Security in Smile CDR |
| 13.0.1 |
Inbound Security Module |
| 13.0.2 |
FHIR Listener Module |
| 13.0.3 |
Admin Modules |
| 13.0.4 |
Auth Directory |
| 13.0.5 |
Audit Database |
| 13.0.6 |
Outbound Security Modules |
| 13.1.0 |
Authentication Protocols |
| 13.1.1 |
HTTP Basic |
| 13.1.2 |
OpenID Connect (OIDC) and SMART on FHIR |
| 13.1.3 |
Security Access Markup Language (SAML) |
| 13.2.0 |
Authorization and Consent |
| 13.2.1 |
Authorization Service |
| 13.2.2 |
Consent Service |
| 13.3.0 |
Inbound Security Module |
| 13.3.1 |
Permissions |
| 13.3.2 |
Callback Script |
| 13.4.0 |
Local Inbound Security Module |
| 13.4.1 |
Configuration: Credentials |
| 13.4.2 |
Caching |
| 13.4.3 |
User Self Registration |
| 13.5.0 |
LDAP Inbound Security Module |
| 13.5.1 |
Requirements |
| 13.5.2 |
Permissions |
| 13.5.3 |
Callback Scripts |
| 13.5.4 |
Configuration |
| 13.6.0 |
Scripted Inbound Security Module |
| 13.6.1 |
Script Format |
| 13.6.2 |
Script Examples |
| 13.7.0 |
SAML Inbound Security Module |
| 13.7.1 |
SAML 2.0 Authentication Request Protocol |
| 13.7.2 |
Enabling SAML Authentication |
| 13.7.3 |
Entity ID Template |
| 13.7.4 |
Authentication Scripts |
| 13.7.5 |
Function: authenticate(theRequest, theOutcomeFactory) |
| 13.8.0 |
Trusted Client Mode |
| 13.8.1 |
Configuring Trusted Client Mode |
| 13.8.2 |
Making Trusted Client Requests |
| 13.8.3 |
Automatically Creating Users |
| 13.9.0 |
Roles and Permissions |
| 13.9.1 |
System-Defined Roles |
| 13.9.2 |
System-Defined Permissions |
| 13.10.0 |
Callback Scripts |
| 13.10.1 |
Function: onAuthenticateSuccess |
| 13.10.2 |
Function: onTokenGenerating(theUserSession, theAuthorizationRequestDetails) |
| 13.10.3 |
Function: onPostAuthorize(theDetails) |
| 13.10.4 |
Function: authenticate(theRequest, theOutcomeFactory) |
| 13.11.0 |
Anonymous Access |
| 13.12.0 |
Consent Service |
| 13.12.1 |
Enabling the Consent Service |
| 13.12.2 |
Method: consentStartOperation |
| 13.12.3 |
Method: consentCanSeeResource |
| 13.12.4 |
Method: consentWillSeeResource |
| 13.12.5 |
Method: completeOperationSuccess |
| 13.12.6 |
Method: completeOperationFailure |
| 13.12.7 |
Example: Tag-Based Consent Script |
| 13.12.8 |
Example: Scope-Based Consent Script |
| 13.13.0 |
Security Recipes |
| 13.13.1 |
App: Local Users with HTTP Basic Authentication |
| 13.13.2 |
Integrating SMART Apps With a 3rd-Party OIDC Server |
| 13.14.0 |
Two Factor Authentication |
| 13.14.1 |
User Activating TOTP |
| 13.14.2 |
Enforcing Two Factor Authentication |
| 13.15.0 |
Troubleshooting Security |
| 14.0.0 |
SMART on FHIR |
| 14.0.0 |
SMART on FHIR: Introduction |
| 14.0.1 |
The SMART Launch Sequence |
| 14.0.2 |
The Interactive Launch Process |
| 14.1.0 |
SMART: Scopes |
| 14.1.1 |
Picking Scopes |
| 14.1.2 |
Launch Context Scopes |
| 14.1.3 |
The OpenID and Profile Scopes |
| 14.2.0 |
SMART: Auth Flows |
| 14.2.1 |
Launch Flow: Authorization Code |
| 14.2.2 |
Launch Flow: Implicit Grant |
| 14.2.3 |
Launch Flow: Resource Owner Password Credentials |
| 14.2.4 |
Non-Interactive User Flow: Cross-Organization Data Access Profile |
| 14.2.5 |
System Flow: Client Credentials |
| 14.2.6 |
System Flow: Refresh Token |
| 14.3.0 |
SMART: Endpoints |
| 14.3.1 |
Server Metadata Endpoint |
| 14.3.2 |
UserInfo Endpoint |
| 14.4.0 |
Client Management |
| 14.4.1 |
Remembering Approved Scopes |
| 14.4.2 |
Client Secrets |
| 14.5.0 |
SMART: Smile CDR Support |
| 14.5.1 |
Models for Using External OIDC Servers |
| 14.5.2 |
Supported Scopes |
| 14.5.3 |
Online / Offline Access |
| 14.6.0 |
SMART Outbound Security: Module |
| 14.6.1 |
Setting Up This Module |
| 14.6.2 |
Terms of Service |
| 14.6.3 |
Client Credentials Grant |
| 14.6.4 |
Cross-Organization Data Access Profile Grant |
| 14.6.5 |
SMART Callback Scripts |
| 14.6.6 |
User Self Registration |
| 14.7.0 |
SMART Outbound Security: Skinning |
| 14.7.1 |
Creating a Skin |
| 14.7.2 |
Installing a Skin |
| 14.7.3 |
HTML Template Files |
| 14.7.4 |
Sample Skin Project |
| 14.8.0 |
SMART: Federated OAuth2/OIDC Login |
| 14.8.1 |
Federated Flow |
| 14.8.2 |
Considerations |
| 14.8.3 |
Setting Up Federated OAuth2/OIDC Login |
| 14.8.4 |
Authorization Script |
| 14.9.0 |
SMART: Application Approval/Consent |
| 14.9.1 |
Approval Overview |
| 14.9.2 |
Auto-Approve / Auto-Grant Scopes |
| 14.9.3 |
Approval Flow |
| 14.9.4 |
Customizing Scope Names |
| 14.9.5 |
Custom Security Scopes |
| 14.9.6 |
Revocation Page |
| 14.10.0 |
SMART Inbound Security Module |
| 14.10.1 |
Requirements |
| 14.10.2 |
Setting Up This Module |
| 14.10.3 |
Accepting Tokens |
| 14.10.4 |
Accepting Internal Access Tokens |
| 14.10.5 |
Accepting External Access Tokens |
| 14.10.6 |
Validating Tokens |
| 14.10.7 |
Creating a Server Definition |
| 14.10.8 |
Assigning Permissions |
| 14.10.9 |
Function: authenticate(...) |
| 14.11.0 |
SMART: Session Management |
| 14.11.1 |
Token Revocation Endpoint |
| 14.11.2 |
User Logout Endpoint |
| 14.12.0 |
SMART: Assigning Permissions |
| 14.12.1 |
Scope Permission Model |
| 14.12.2 |
User and Patient Resource Linkage |
| 14.13.0 |
SMART: Access Tokens |
| 14.14.0 |
SMART: User Profile Information |
| 14.15.0 |
FHIR Client Authentication |
| 14.15.1 |
Rejecting Unauthorized FHIR Calls |
| 15.0.0 |
FHIR Hybrid Providers |
| 15.0.0 |
Hybrid Providers |
| 15.0.1 |
Architecture |
| 15.0.2 |
Resource Providers |
| 15.0.3 |
CapabilityStatement |
| 15.0.4 |
The Spring Context Config Class |
| 15.0.5 |
Building Your Hybrid Providers |
| 15.0.6 |
Deploying Your Hybrid Providers |
| 15.0.7 |
Accessing Security Attributes |
| 15.0.8 |
Exceptions |
| 15.0.9 |
Example Project |
| 16.0.0 |
CDS-Hooks |
| 16.0.0 |
CDS-Hooks |
| 16.0.1 |
Auto Prefetch |
| 16.0.2 |
Architecture |
| 16.0.3 |
CDS-Hooks classes |
| 16.0.4 |
The Spring Context Config Class |
| 16.0.5 |
Building Your CDS-Hooks |
| 16.0.6 |
Deploying Your CDS-Hooks |
| 16.0.7 |
Accessing Security Attributes |
| 16.0.8 |
Exceptions |
| 16.0.9 |
Calling CDS-Hooks |
| 16.0.10 |
Example Project |
| 17.0.0 |
FHIR Gateway |
| 17.0.0 |
FHIR Gateway Introduction |
| 17.0.1 |
Smile CDR 2020.02 Gateway Redesign |
| 17.1.0 |
Configuration: Initial Setup |
| 17.1.1 |
Server Configuration |
| 17.1.2 |
Encryption JWKS (Keystore) |
| 17.1.3 |
Configuration Document |
| 17.1.4 |
Interceptors |
| 17.2.0 |
Configuration: Document |
| 17.2.1 |
Defining Targets |
| 17.2.2 |
Defining Search Routes |
| 17.2.3 |
Defining Read Routes |
| 17.2.4 |
Defining Operation Routes |
| 18.0.0 |
EMPI |
| 18.0.0 |
Enterprise Master Patient Index |
| 19.0.0 |
Master Data Management |
| 19.0.0 |
MDM |
| 19.0.1 |
Getting Started with Smile CDR MDM |
| 19.0.2 |
Enabling and Configuring MDM within Smile CDR |
| 19.0.3 |
Troubleshooting |
| 19.0.4 |
MDM User Interface |
| 19.0.5 |
MDM Scenarios |
| 19.1.0 |
MDM Quickstart Guide |
| 19.2.0 |
MDM Survivorship Rules |
| 19.3.0 |
Upgrading from the EMPI module |
| 20.0.0 |
Clustering |
| 20.0.0 |
Designing a Cluster |
| 20.0.1 |
Node and Module Design |
| 20.0.2 |
Process IDs |
| 20.0.3 |
Adding and Removing Processes |
| 20.0.4 |
Multi-Node Clusters |
| 20.0.5 |
Sample Architecture |
| 20.1.0 |
Migration To 2020.02 |
| 20.1.1 |
Migrating Existing Clusters |
| 21.0.0 |
Logging |
| 21.0.0 |
Overview |
| 21.1.0 |
Audit Log |
| 21.1.1 |
Audit Log Configuration |
| 21.1.2 |
Disabling the Audit Log |
| 21.1.3 |
Broker Audit Log |
| 21.2.0 |
Transaction Log |
| 21.2.1 |
Disabling the Transaction Log |
| 21.2.2 |
Transaction Log Configuration |
| 21.2.3 |
Event Types and SubTypes |
| 21.3.0 |
System Logging |
| 21.3.1 |
Changing Logging Settings |
| 21.4.0 |
Troubleshooting Logs |
| 21.4.1 |
HTTP Troubleshooting Log |
| 21.4.2 |
Security Troubleshooting Log |
| 21.4.3 |
Subscription Troubleshooting Log |
| 21.4.4 |
LiveBundle Troubleshooting Log |
| 21.4.5 |
MDM Troubleshooting Log |
| 21.4.6 |
Channel Import Troubleshooting Log |
| 21.4.7 |
Realtime Export Troubleshooting Log |
| 22.0.0 |
HL7 v2.x Support |
| 22.0.0 |
Introduction |
| 22.0.1 |
Inbound HL7 v2.x Support |
| 22.0.2 |
Outbound HL7 v2.x Support |
| 22.0.3 |
HL7 v2.x Versions |
| 22.1.0 |
Inbound Messaging |
| 22.1.1 |
Processing |
| 22.1.2 |
Callback Scripts |
| 22.1.3 |
Function: onPreConvertHl7V2ToFhir(theMessage, theConversionResult) |
| 22.1.4 |
Function: onPostConvertHl7V2ToFhir(theMessage, theConversionResult) |
| 22.1.5 |
Adding Processing Messages |
| 22.2.0 |
Outbound Messaging |
| 22.2.1 |
ADT Workflow Mode |
| 22.2.2 |
Enriching Message Conversion using Scripts |
| 22.2.3 |
Function: onPostConvertFhirToHl7V2(theTriggerResource, theOutgoingMessage, theContext) |
| 22.2.4 |
Using Persisted MessageHeader Resources |
| 22.3.0 |
Transactions |
| 22.3.1 |
ADT (Patient Administration) Domain |
| 22.3.2 |
OMG (Orders) Domain |
| 22.3.3 |
ORU (Results) Domain |
| 22.3.4 |
RDE/RAS (Pharmacy) Domain |
| 22.3.5 |
SIU (Scheduling) Domain |
| 22.3.6 |
VXU (Immunization / Vaccination) Domain |
| 22.3.7 |
DFT (Financial) Domain |
| 22.4.0 |
Structure Definitions |
| 22.4.1 |
Structure: ADT_A01 |
| 22.4.2 |
Structure: ADT_A02 |
| 22.4.3 |
Structure: ADT_A03 |
| 22.4.4 |
Structure: ADT_A05 |
| 22.4.5 |
Structure: ADT_A06 |
| 22.4.6 |
Structure: ADT_A09 |
| 22.4.7 |
Structure: ADT_A12 |
| 22.4.8 |
Structure: ADT_A17 |
| 22.4.9 |
Structure: ADT_A21 |
| 22.4.10 |
Structure: ADT_A30 |
| 22.4.11 |
Structure: ADT_A38 |
| 22.4.12 |
Structure: ADT_A39 |
| 22.4.13 |
Structure: ADT_A44 |
| 22.4.14 |
Structure: ADT_A45 |
| 22.4.15 |
Structure: ADT_A54 |
| 22.4.16 |
Structure: ADT_A60 |
| 22.4.17 |
Structure: ADT_A61 |
| 22.4.18 |
Structure: OMG_O19 |
| 22.4.19 |
Structure: ORM_O01 |
| 22.4.20 |
Structure: ORU_R01 |
| 22.4.21 |
Structure: RAS_O17 |
| 22.4.22 |
Structure: RDE_O11 |
| 22.4.23 |
Structure: SIU_S12 |
| 22.4.24 |
Structure: VXU_V04 |
| 22.4.25 |
Structure: DFT_P03 |
| 22.5.0 |
Segment Definitions |
| 22.5.1 |
Segment: MSH (Message Header) |
| 22.5.2 |
Segment: EVN (Event) |
| 22.5.3 |
Segment: PID (Patient) |
| 22.5.4 |
Segment: PD1 (Patient Demographics Extended) |
| 22.5.5 |
Segment: PV1 (Visit/Encounter) |
| 22.5.6 |
Segment: ROL (Role) |
| 22.5.7 |
Segment: DG1 (Diagnosis) |
| 22.5.8 |
Segment: PR1 (Procedure) |
| 22.5.9 |
Segment: MRG (Merge Patient Information) |
| 22.5.10 |
Segment: GT1 (Guarantor) |
| 22.5.11 |
Segment: IN1 (Insurance) |
| 22.5.12 |
Segment: IN2 (Insurance Additional Information) |
| 22.5.13 |
Segment: ORC (Order Control) |
| 22.5.14 |
Segment: OBR (Observation Request) |
| 22.5.15 |
Segment: OBX (Observation) |
| 22.5.16 |
Segment: NK1 (Next of Kin / Patient Contact) |
| 22.5.17 |
Segment: NTE (Note) |
| 22.5.18 |
Segment: FT1 (Financial Transaction) |
| 22.5.19 |
Segment: RXA (Pharmacy Administration) |
| 22.5.20 |
Segment: RXC (Pharmacy Component) |
| 22.5.21 |
Segment: ZXC (Pharmacy Component) |
| 22.5.22 |
Segment: RXE (Pharmacy Encoded Order) |
| 22.5.23 |
Segment: RXR (Pharmacy Route) |
| 22.5.24 |
Segment: IAM (Patient Adverse Reaction) |
| 22.5.25 |
Segment: SPM (Specimen) |
| 22.5.26 |
Segment: SCH (Scheduling) |
| 22.5.27 |
Segment: AIL (Location Resource) |
| 22.5.28 |
Segment: AIP (Personnel Resource) |
| 22.5.29 |
Segment: ZXT (Non-Standard) |
| 22.5.30 |
A Note about Extra Components |
| 22.6.0 |
Table Definitions |
| 22.6.1 |
Table 0001: Administrative Sex |
| 22.6.2 |
Table 0002: Marital Status |
| 22.6.3 |
Table 0004: Patient Class |
| 22.6.4 |
Table 0017: Transaction Type |
| 22.6.5 |
Table 0038: Order Status |
| 22.6.6 |
Table 0052: Diagnosis Type |
| 22.6.7 |
Table 0063: v2 Relationship |
| 22.6.8 |
Table 0074: Dianostic Service Section ID |
| 22.6.9 |
Table 0078: Observation Interpretation Codes |
| 22.6.10 |
Table 0085: Observation Status |
| 22.6.11 |
Table 0119: Order Control |
| 22.6.12 |
Table 0125: Observation Value Type |
| 22.6.13 |
Table 0127: Allergen Type |
| 22.6.14 |
Table 0128: Allergen Severity |
| 22.6.15 |
Table 0131: v2 Contact Role |
| 22.6.16 |
Table 0136: Yes/No |
| 22.6.17 |
Table 0166: RX Component Type |
| 22.6.18 |
Table 0190: Address Type |
| 22.6.19 |
Table 0200: Name Type Code |
| 22.6.20 |
Table 0201: Telecom Use |
| 22.6.21 |
Table 0202: Telecom Equipment Type |
| 22.6.22 |
Table 0203: Identifier Type |
| 22.6.23 |
Table 0271: Result Status |
| 22.6.24 |
Table 0276: Appointment Reason Codes |
| 22.6.25 |
Table 0278: Filler Status Code |
| 22.6.26 |
Table 0305: Person Location Type |
| 22.6.27 |
Table 0322: Completion Status |
| 22.6.28 |
Table 0438: Allergy Clinical Status Code |
| 22.7.0 |
Naming System Mapping |
| 22.7.1 |
Default Mappings |
| 22.7.2 |
Using NamingSystem for Mapping Identifiers |
| 22.8.0 |
Processing Results Feeds |
| 22.8.1 |
Unsolicited Observation Request (ORU^R01) |
| 22.9.0 |
Protocol |
| 22.9.1 |
Encoding Format |
| 22.9.2 |
ER7 (Pipe-Delimited) Format |
| 22.9.3 |
Minimal Lower Layer Protocol (MLLP) Transport |
| 22.9.4 |
HL7 over HTTP |
| 22.9.5 |
Character Encoding / Charsets |
| 23.0.0 |
CDA Exchange Module |
| 23.0.0 |
Introduction |
| 23.1.0 |
JavaScript Templates |
| 23.1.1 |
The simplest CDA template script |
| 23.1.2 |
Adding header information to our CDA template script |
| 23.1.3 |
Adding and populating a section in our CDA template script |
| 23.1.4 |
Using the Fhir.search() API to dynamically populate sections |
| 23.1.5 |
Specifying input parameters |
| 23.1.6 |
More complicated input parameters |
| 23.1.7 |
Putting it all together |
| 23.2.0 |
Rest API Operations |
| 23.2.1 |
Endpoints for configuring templates |
| 23.2.2 |
Endpoints for applying templates |
| 23.3.0 |
Available Document and Section Types |
| 23.3.1 |
Valid Document Types |
| 23.3.2 |
Valid Resources for the header |
| 23.3.3 |
Valid Section Types and Sources |
| 23.3.4 |
Allergy and Intolerances Section |
| 23.3.5 |
Medications Section |
| 23.3.6 |
Problem Section |
| 23.3.7 |
Results Section |
| 23.3.8 |
Social History Section |
| 23.3.9 |
Vital Signs Section |
| 23.3.10 |
Dialysis Prescription Section |
| 23.3.11 |
Reason for Referral Section |
| 23.4.0 |
Further Reading |
| 24.0.0 |
Bulk Operations |
| 24.0.0 |
ETL Import Module |
| 24.0.1 |
Importing CSV Data |
| 24.0.2 |
Function: handleEtlImportRow(theInputMap, theContext) |
| 24.0.3 |
Handling Multiple Import Formats |
| 24.0.4 |
Initiating ETL Jobs |
| 24.0.5 |
Performance and Concurrency |
| 24.0.6 |
Locking Rows |
| 24.0.7 |
Creating a Hashing Script |
| 24.0.8 |
Asynchronous Execution |
| 24.0.9 |
Performance |
| 24.1.0 |
FHIR Bulk Export Operation |
| 24.1.1 |
Enabling Bulk Export |
| 24.1.2 |
Types of Bulk Export Requests |
| 24.1.3 |
Request Parameters |
| 24.1.4 |
Requesting A Bulk Extract |
| 24.1.5 |
Retrieving Data |
| 25.0.0 |
Monitoring |
| 25.0.0 |
Monitoring Basics |
| 25.0.1 |
HTTP Endpoint Health Check |
| 25.0.2 |
Runtime Health Checks |
| 25.1.0 |
Elastic APM Basics |
| 25.1.1 |
What is APM? |
| 25.1.2 |
Setting Up an APM Server |
| 25.1.3 |
Instrumenting Smile CDR and the JVM |
| 25.1.4 |
Accessing the User Interface |
| 25.1.5 |
Configuring Settings for the Agent |
| 25.1.6 |
Securing the Agent |
| 26.0.0 |
JSON Admin Endpoints |
| 26.0.0 |
JSON Admin API |
| 26.0.1 |
Security |
| 26.0.2 |
Format |
| 26.0.3 |
Allowing Anonymous Access |
| 26.1.0 |
Audit Log Endpoint |
| 26.1.1 |
Fetch Audit Log |
| 26.1.2 |
Fetch Individual Event |
| 26.2.0 |
Batch Job Endpoint |
| 26.2.1 |
Fetch Batch Job Names |
| 26.2.2 |
Fetch All Instances |
| 26.3.0 |
Bulk Import Endpoint |
| 26.3.1 |
Process ETL File |
| 26.3.2 |
Smileutil: CSV Bulk Import File |
| 26.4.0 |
CDA Exchange Endpoint |
| 26.4.1 |
Create CDA Template |
| 26.4.2 |
Update CDA Template |
| 26.4.3 |
Update CDA Template script via text |
| 26.4.4 |
View CDA Template(s) |
| 26.4.5 |
Delete CDA template |
| 26.4.6 |
Use / Apply CDA Template |
| 26.4.7 |
Create CDA from Composition/Bundle |
| 26.4.8 |
Example CDA Template |
| 26.5.0 |
Metrics Endpoint |
| 26.5.1 |
Fetch Local Metrics |
| 26.5.2 |
Capture Thread Dump |
| 26.6.0 |
Module Config Endpoint |
| 26.6.1 |
Fetch Config: Module Property File |
| 26.6.2 |
Fetch Config: All Modules |
| 26.6.3 |
Fetch Config: Single Module |
| 26.6.4 |
Create Module |
| 26.6.5 |
Set Module Config |
| 26.6.6 |
Start Module |
| 26.6.7 |
Stop Module |
| 26.6.8 |
Restart Module |
| 26.6.9 |
Archive Module |
| 26.7.0 |
OpenID Connect Clients Endpoint |
| 26.7.1 |
Fetch All OpenID Connect Client Definitions |
| 26.7.2 |
Fetch Individual Client by Client ID |
| 26.7.3 |
Create Client |
| 26.7.4 |
Update Client |
| 26.7.5 |
Create Client and generate secrets |
| 26.8.0 |
OpenID Connect Servers Endpoint |
| 26.8.1 |
Fetch All OpenID Connect Server Definitions |
| 26.8.2 |
Find OpenID Connect Server Definition |
| 26.8.3 |
Create OpenID Connect Server Definition |
| 26.8.4 |
Update OpenID Connect Server Definition |
| 26.9.0 |
Runtime Status Endpoint |
| 26.9.1 |
Fetch Complete Node Status Information |
| 26.9.2 |
Fetch All Runtime Health Checks |
| 26.10.0 |
System Config Endpoint |
| 26.11.0 |
Transaction Log Endpoint |
| 26.11.1 |
Fetch Transaction Log |
| 26.11.2 |
Fetch Individual Event |
| 26.12.0 |
User Management Endpoint |
| 26.12.1 |
Search for Users (All Modules) |
| 26.12.2 |
Search for Users (Specific Module) |
| 26.12.3 |
Create User |
| 26.12.4 |
Update User |
| 26.12.5 |
Update Password |
| 26.12.6 |
Update Own Password |
| 26.12.7 |
Update Own Default Launch Contexts |
| 26.12.8 |
2FA: Create New Key |
| 26.12.9 |
2FA: Generate QR Code |
| 26.12.10 |
2FA: Confirm Key |
| 26.12.11 |
2FA: Delete Key |
| 26.12.12 |
Invalidate All Sessions |
| 27.0.0 |
Product Configuration |
| 27.0.0 |
HTTP Server Setup |
| 27.0.1 |
Respecting Forward Headers |
| 27.0.2 |
Specifying a Custom Context Path |
| 27.0.3 |
Access Logs |
| 27.0.4 |
Frame Options |
| 27.1.0 |
TLS and HTTPS Reference |
| 27.1.1 |
Background |
| 27.1.2 |
Creating a Self-Signed KeyStore |
| 27.1.3 |
Importing a LetsEncrypt Certificate into a KeyStore |
| 27.1.4 |
Selecting Ciphers and Protocol |
| 27.1.5 |
Enabling TLS Mutual Authentication (Client Auth) |
| 28.0.0 |
Java Execution Environment |
| 28.0.0 |
Security Attributes |
| 28.1.0 |
Library Support |
| 28.2.0 |
Exception Handling |
| 28.3.0 |
Javadocs |
| 29.0.0 |
JavaScript Execution Environment |
| 29.0.0 |
Introduction |
| 29.1.0 |
Specifying JavaScript in Configuration File |
| 29.2.0 |
Converter API |
| 29.2.1 |
Method: hl7v2TsToFhirDate(dt); |
| 29.2.2 |
Method: hl7v2TsToFhirDateTime(ts); |
| 29.2.3 |
Method: hl7v2TsToFhirDateTime(ts, impliedTimeZone); |
| 29.2.4 |
Method: urlDecode(string); |
| 29.2.5 |
Method: urlEncode(string); |
| 29.3.0 |
Environment API |
| 29.4.0 |
Exceptions API |
| 29.4.1 |
Method: Exceptions.newTrustedException(theMessage) |
| 29.4.2 |
Method: Exceptions.newTrustedException(theStatusCode, theMessage) |
| 29.5.0 |
OAuth2 Exceptions API |
| 29.5.1 |
Method: OAuth2Exceptions.newUnauthorizedException(theMessage) |
| 29.5.2 |
Method: OAuth2Exceptions.newForbiddenException(theMessage) |
| 29.6.0 |
FHIR REST API |
| 29.6.1 |
Method: create(resource) |
| 29.6.2 |
Method: read(url) |
| 29.6.3 |
Method: search().forResource(resourceType) |
| 29.6.4 |
Method: transaction(IBundleBuilder theTransaction) |
| 29.6.5 |
Method: translate() |
| 29.6.6 |
Method: update(resource) |
| 29.6.7 |
Method: patch(url, parameters) |
| 29.6.8 |
Authentication |
| 29.6.9 |
Tenant Selection |
| 29.6.10 |
Concurrency Retry |
| 29.7.0 |
FHIR Model API |
| 29.7.1 |
Method: ResourceBuilder.build(resourceType) |
| 29.7.2 |
Working with Resources |
| 29.7.3 |
Working with Composition resources |
| 29.7.4 |
Working with Bundle resources |
| 29.7.5 |
Contained Resources |
| 29.7.6 |
Meta Elements |
| 29.7.7 |
Removing Data |
| 29.8.0 |
HL7 v2.x Mapping API |
| 29.8.1 |
Repetitions |
| 29.8.2 |
Structure Interrogation |
| 29.8.3 |
Content Clearing |
| 29.8.4 |
Content Interrogation |
| 29.8.5 |
Parsing Raw Field Values |
| 29.8.6 |
Encoding |
| 29.8.7 |
The Hl7V2 Object |
| 29.8.8 |
Working with Variable Datatypes |
| 29.8.9 |
Working with Z-Segments |
| 29.9.0 |
HTTP API |
| 29.9.1 |
Request Creation Methods |
| 29.9.2 |
Request Execution Methods |
| 29.9.3 |
Response Processing Methods |
| 29.9.4 |
TLS / HTTPS |
| 29.10.0 |
LDAP API |
| 29.10.1 |
Method: searchByUsername(username) |
| 29.10.2 |
Method: getStringAttributes(attributeName) |
| 29.10.3 |
Method: isMemberOfGroup(groupDn) |
| 29.11.0 |
Log API |
| 29.11.1 |
Methods: debug(string), info(string), warn(string), error(string) |
| 29.12.0 |
Composition Resource API |
| 29.12.1 |
Method: set*(value) |
| 29.12.2 |
Method: setDate(epoch) |
| 29.12.3 |
Method: setType(documentType) |
| 29.12.4 |
Method: addSection(sectionType) |
| 29.13.0 |
Composition Section API |
| 29.13.1 |
Method: populate(List resources) |
| 29.13.2 |
Method: setTitle(title) |
| 29.13.3 |
Method: setCode(system, code, display) |
| 29.14.0 |
TransactionBuilder API |
| 29.14.1 |
Method: newTransactionBuilder() |
| 29.14.2 |
Method: withBundle(bundle) |
| 29.14.3 |
Method: create(resource) |
| 29.14.4 |
Method: update(resource) |
| 29.14.5 |
Method Chain: createConditional(resource).onToken(parameter, system, value) |
| 29.14.6 |
Method Chain: updateConditional(resource).onToken(parameter, system, value) |
| 29.14.7 |
Methods: toXml(), toXml(prettyPrint), toJson(), toJson(prettyPrint) |
| 29.14.8 |
Fhir.transaction(transaction) |
| 29.15.0 |
Util API |
| 29.15.1 |
Method: sleep(millis) |
| 29.16.0 |
UUID API |
| 29.16.1 |
Method: newPlaceholderId() |
| 29.17.0 |
XML API |
| 29.17.1 |
XPath Expressions |
| 29.17.2 |
Function: getXPathValue(xpath) |
| 29.17.3 |
Function: getXPathValues(xpath) |
| 29.17.4 |
Function: getXPathElements(xpath) |
| 29.18.0 |
Callback Models |
| 29.18.1 |
AssociatedResource |
| 29.18.2 |
AuthenticationContext |
| 29.18.3 |
AuthenticationFailure |
| 29.18.4 |
AuthenticationRequest |
| 29.18.5 |
CsvProcessorContext |
| 29.18.6 |
FhirEndpointTerminologyResponseMappingSpec |
| 29.18.7 |
FhirEndpointTerminologyResponseMappingSpecSystem |
| 29.18.8 |
GatewayConfiguration |
| 29.18.9 |
GatewayOperation |
| 29.18.10 |
GatewayOperationRoute |
| 29.18.11 |
GatewayReadRoute |
| 29.18.12 |
GatewayRouteTarget |
| 29.18.13 |
GatewaySearchRoute |
| 29.18.14 |
GatewayTarget |
| 29.18.15 |
GrantedAuthority |
| 29.18.16 |
Hl7V2GeneratedMessageContext |
| 29.18.17 |
Hl7V2ReceivedMessage |
| 29.18.18 |
Hl7V2ReceivedMessageConversionResult |
| 29.18.19 |
LaunchContext |
| 29.18.20 |
LaunchResourceId |
| 29.18.21 |
OAuth2AuthorizationRequestDetails |
| 29.18.22 |
OAuth2Client |
| 29.18.23 |
OAuth2ClientSecret |
| 29.18.24 |
OAuth2Clients |
| 29.18.25 |
OAuth2Server |
| 29.18.26 |
OAuth2Servers |
| 29.18.27 |
Oauth2InvalidateTokensResponseJson |
| 29.18.28 |
PackageInstallationSpec |
| 29.18.29 |
PartitionDefinition |
| 29.18.30 |
PartitionDefinitions |
| 29.18.31 |
RequestDetailsJson |
| 29.18.32 |
ScriptAuthenticationOutcomeFactory |
| 29.18.33 |
ScriptConsentContextServices |
| 29.18.34 |
SecurityInLdapAuthenticationContext |
| 29.18.35 |
SecurityInSmartAuthenticationContext |
| 29.18.36 |
SmartCodapAuthorizationRequest |
| 29.18.37 |
SmartOnPostAuthorizeDetails |
| 29.18.38 |
UserDetails |
| 29.18.39 |
UserDetailsChangeLaunchContextJson |
| 29.18.40 |
UserDetailsList |
| 29.18.41 |
UserSessionDetails |
| 30.0.0 |
Database Administration |
| 30.0.0 |
Database Design |
| 30.0.1 |
Cluster Manager Database |
| 30.0.2 |
FHIR Relational Storage |
| 30.0.3 |
FHIR MongoDB (Non-Relational) Storage |
| 30.1.0 |
Setting Up PostgreSQL |
| 30.1.1 |
Supported Versions |
| 30.1.2 |
Creating a Database for Smile CDR |
| 30.1.3 |
Database Connection Properties |
| 30.1.4 |
Setting up a Cluster Manager Database |
| 30.1.5 |
Setting up a FHIR Storage (Relational) Database |
| 30.2.0 |
Troubleshooting PostgreSQL |
| 30.2.1 |
Host Name Verification Error |
| 30.3.0 |
Setting Up MySQL |
| 30.3.1 |
Supported Versions |
| 30.3.2 |
Creating a Database for Smile CDR |
| 30.3.3 |
Database Connection Properties |
| 30.3.4 |
Setting up a Cluster Manager Database |
| 30.3.5 |
Setting up a FHIR Storage (Relational) Database |
| 30.4.0 |
Setting Up MariaDB |
| 30.4.1 |
Supported Versions |
| 30.4.2 |
Creating a Database for Smile CDR |
| 30.4.3 |
Database Connection Properties |
| 30.4.4 |
Setting up a Cluster Manager Database |
| 30.4.5 |
Setting up a FHIR Storage (Relational) Database |
| 30.5.0 |
Setting Up Oracle |
| 30.5.1 |
Supported Versions |
| 30.5.2 |
Setting up a Cluster Manager Database |
| 30.5.3 |
Setting up a FHIR Storage (Relational) Database |
| 30.6.0 |
Setting Up SQL Server (MSSQL) |
| 30.6.1 |
Supported Versions |
| 30.6.2 |
Creating a Database for Smile CDR |
| 30.6.3 |
Preparing an SQL Server Database for Smile CDR |
| 30.6.4 |
Database Connection Properties |
| 30.6.5 |
Setting up a Cluster Manager Database |
| 30.6.6 |
Setting up a FHIR Storage (Relational) Database |
| 31.0.0 |
Localization |
| 31.0.0 |
Localization |
| 31.1.0 |
Examples |
| 31.1.1 |
Example: Unknown Search Parameter Message |
| 31.1.2 |
Example: Custom SMART Scope Names |
| 31.2.0 |
Available Localization Keys |
| 32.0.0 |
Smile CDR CLI (smileutil) |
| 32.0.0 |
Introduction |
| 32.0.1 |
Enabling Debug Logging |
| 32.1.0 |
Execute Script Function |
| 32.1.1 |
Usage |
| 32.1.2 |
Options |
| 32.1.3 |
A Complete Example: Authenticate |
| 32.1.4 |
Available Functions |
| 32.1.5 |
Function: authenticate |
| 32.2.0 |
Create FHIR Package |
| 32.2.1 |
Usage |
| 32.2.2 |
Options |
| 32.3.0 |
Export ConceptMap to CSV |
| 32.3.1 |
Usage |
| 32.3.2 |
Options |
| 32.4.0 |
HL7 v2.x Analyze Flat File |
| 32.4.1 |
Usage |
| 32.4.2 |
Options |
| 32.5.0 |
HL7 v2.x Transmit Flat File |
| 32.5.1 |
Usage |
| 32.5.2 |
Options |
| 32.5.3 |
Multiplex Paths |
| 32.6.0 |
Import CSV to ConceptMap |
| 32.6.1 |
Usage |
| 32.6.2 |
Options |
| 32.7.0 |
Map and Upload CSV Bulk Import File |
| 32.7.1 |
Usage |
| 32.7.2 |
Options |
| 32.8.0 |
Migrate Database |
| 32.8.1 |
Options |
| 32.8.2 |
Examples |
| 32.8.3 |
Disabling Flyway |
| 32.8.4 |
Troubleshooting |
| 32.9.0 |
Synchronize FHIR Servers |
| 32.9.1 |
Usage |
| 32.9.2 |
Options |
| 32.9.3 |
Selecting Resource Types to Synchronize |
| 32.9.4 |
Using a Search as the Source |
| 32.9.5 |
Using a Directory as the Source |
| 32.9.6 |
Uploading Bundles as Transactions |
| 32.9.7 |
Using Inline Match URLs |
| 32.9.8 |
Prefixing Numeric IDs |
| 32.9.9 |
Synchronization Modes |
| 32.9.10 |
Uploading Synthea (Synthetic Generated) Resources |
| 32.9.11 |
Setting up a Resource Gold Master |
| 32.10.0 |
Upload Bundle Files |
| 32.10.1 |
This Command Is Deprecated |
| 32.10.2 |
Usage |
| 32.10.3 |
Options |
| 32.11.0 |
Upload CSV Bulk Import File |
| 32.11.1 |
Usage |
| 32.11.2 |
Options |
| 32.11.3 |
Sending Batches for a Single File |
| 32.12.0 |
Upload Sample Dataset |
| 32.12.1 |
Usage |
| 32.12.2 |
Options |
| 32.13.0 |
Upload Terminology |
| 32.13.1 |
Usage |
| 32.13.2 |
Options |
| 32.13.3 |
Example: Add Delta to Custom Terminology |
| 32.14.0 |
Validate FHIR Resources |
| 32.14.1 |
Usage |
| 32.14.2 |
Options |
| 32.14.3 |
Profile Mode |
| 32.14.4 |
Schema and Schematron Mode |
| 33.0.0 |
Modules |
| 33.0.0 |
JSON Admin API |
| 33.0.1 |
Configuration Categories |
| 33.1.0 |
Web Admin Console |
| 33.1.1 |
Configuration Categories |
| 33.2.0 |
CDA Exchange |
| 33.2.1 |
Configuration Categories |
| 33.3.0 |
Channel Import |
| 33.3.1 |
Configuration Categories |
| 33.4.0 |
Cluster Manager |
| 33.4.1 |
Configuration Categories |
| 33.5.0 |
Enterprise Master Patient Index |
| 33.5.1 |
Configuration Categories |
| 33.6.0 |
CDS Hooks Endpoint |
| 33.6.1 |
Configuration Categories |
| 33.7.0 |
FHIR Gateway Endpoint |
| 33.7.1 |
Configuration Categories |
| 33.8.0 |
FHIR REST Endpoint (DSTU2) |
| 33.8.1 |
Configuration Categories |
| 33.9.0 |
FHIR REST Endpoint (DSTU3) |
| 33.9.1 |
Configuration Categories |
| 33.10.0 |
FHIR REST Endpoint (R4) |
| 33.10.1 |
Configuration Categories |
| 33.11.0 |
FHIRWeb Console |
| 33.11.1 |
Configuration Categories |
| 33.12.0 |
HL7 v2.x Listening Endpoint |
| 33.12.1 |
Configuration Categories |
| 33.13.0 |
HL7 v2.x Sending Endpoint |
| 33.13.1 |
Configuration Categories |
| 33.14.0 |
Hybrid Providers Endpoint |
| 33.14.1 |
Configuration Categories |
| 33.15.0 |
Package Registry Endpoint |
| 33.15.1 |
Configuration Categories |
| 33.16.0 |
Subscription Websocket Endpoint |
| 33.16.1 |
Configuration Categories |
| 33.17.0 |
ETL Importer |
| 33.17.1 |
Configuration Categories |
| 33.18.0 |
MDM |
| 33.18.1 |
Configuration Categories |
| 33.19.0 |
Narrative Generator |
| 33.19.1 |
Configuration Categories |
| 33.20.0 |
FHIR Storage (DSTU2 Relational) |
| 33.20.1 |
Configuration Categories |
| 33.21.0 |
FHIR Storage (R3 Relational) |
| 33.21.1 |
Configuration Categories |
| 33.22.0 |
FHIR Storage (Mongo) |
| 33.22.1 |
Configuration Categories |
| 33.23.0 |
FHIR Storage (R4 Relational) |
| 33.23.1 |
Configuration Categories |
| 33.24.0 |
Realtime Export |
| 33.24.1 |
Configuration Categories |
| 33.25.0 |
LDAP Inbound Security |
| 33.25.1 |
Configuration Categories |
| 33.26.0 |
Local Inbound Security |
| 33.26.1 |
Configuration Categories |
| 33.27.0 |
SAML Inbound Security |
| 33.27.1 |
Configuration Categories |
| 33.28.0 |
Scripted Inbound Security |
| 33.28.1 |
Configuration Categories |
| 33.29.0 |
SMART Inbound Security |
| 33.29.1 |
Configuration Categories |
| 33.30.0 |
SMART Outbound Security |
| 33.30.1 |
Configuration Categories |
| 33.31.0 |
SMART App Host |
| 33.31.1 |
Configuration Categories |
| 33.32.0 |
Subscription Matcher (All FHIR Versions) |
| 33.32.1 |
Configuration Categories |
| 33.33.0 |
Subscription Matcher (DSTU2 - Deprecated) |
| 33.33.1 |
Configuration Categories |
| 33.34.0 |
Subscription Matcher (DSTU3 - Deprecated) |
| 33.34.1 |
Configuration Categories |
| 33.35.0 |
Subscription Matcher (R4 - Deprecated) |
| 33.35.1 |
Configuration Categories |
| 33.36.0 |
Application Gallery |
| 33.36.1 |
Configuration Categories |
| 34.0.0 |
Configuration Categories |
| 34.0.0 |
Web Admin Console Settings |
| 34.0.1 |
Property: Transaction Log - Event Body Display Mode |
| 34.1.0 |
App Gallery |
| 34.1.1 |
Property: JSON URL |
| 34.1.2 |
Property: AUTH URL |
| 34.1.3 |
Property: Client ID |
| 34.1.4 |
Property: Legal Company Name |
| 34.1.5 |
Property: Application Gallery Admin Console Name |
| 34.1.6 |
Property: Contact Us URL |
| 34.1.7 |
Property: FHIR URL |
| 34.1.8 |
Property: Application Gallery Name |
| 34.1.9 |
Property: Hero Image, Large Format URL |
| 34.1.10 |
Property: Hero Image, Small Format URL |
| 34.1.11 |
Property: Company Logo Small URL |
| 34.1.12 |
Property: Company Logo Large URL |
| 34.1.13 |
Property: Application Gallery Developer Portal Name |
| 34.1.14 |
Property: Terms of Use URL |
| 34.2.0 |
Authentication Callback Scripts |
| 34.2.1 |
Property: Authentication Callback Script (File) |
| 34.2.2 |
Property: Authentication Callback Script (Text) |
| 34.3.0 |
Auth: General for APIs |
| 34.3.1 |
Property: Anonymous Account Username |
| 34.3.2 |
Property: Allow Anonymous Access |
| 34.4.0 |
User Authentication |
| 34.4.1 |
Property: Anonymous Account Username |
| 34.4.2 |
Property: Allow Anonymous Access |
| 34.4.3 |
Property: SAML Authentication Enabled |
| 34.5.0 |
Auth: HTTP Basic |
| 34.5.1 |
Property: HTTP Basic Security |
| 34.5.2 |
Property: HTTP Basic Realm |
| 34.6.0 |
Auth: OpenID Connect |
| 34.6.1 |
Property: OpenID Connect Security |
| 34.7.0 |
Browser Syntax Highlighting |
| 34.7.1 |
Property: Browser Syntax Highlighting Enabled |
| 34.7.2 |
Property: Show Request Headers |
| 34.7.3 |
Property: Show Response Headers |
| 34.8.0 |
Capability Statement (metadata) |
| 34.8.1 |
Property: Cache Resource Counts (Mins) |
| 34.8.2 |
Property: Include Resource Counts |
| 34.9.0 |
CDS Hooks |
| 34.9.1 |
Property: FHIR Version |
| 34.9.2 |
Property: Spring Context Config Class |
| 34.10.0 |
Channel Import |
| 34.10.1 |
Property: Concurrent Consumers |
| 34.10.2 |
Property: Channel Name |
| 34.10.3 |
Property: Default mediaType |
| 34.10.4 |
Property: Channel Import ETL Script (File) |
| 34.10.5 |
Property: Channel Import ETL Script (Text) |
| 34.11.0 |
Channel Retry |
| 34.11.1 |
Property: Failure Channel Name |
| 34.11.2 |
Property: Retry Delay(ms) |
| 34.11.3 |
Property: Maximum amount of retry attempts. |
| 34.11.4 |
Property: Maximum Delay(ms) between attempts. |
| 34.11.5 |
Property: Retry Channel Name |
| 34.11.6 |
Property: Retriable Exceptions |
| 34.11.7 |
Property: Retry Strategy |
| 34.12.0 |
Cluster Manager Maintenance |
| 34.12.1 |
Property: Audit Log Broker Enabled |
| 34.12.2 |
Property: Audit Log Database Enabled |
| 34.12.3 |
Property: Request headers to store |
| 34.12.4 |
Property: Stats Retention (Days) - Day Level |
| 34.12.5 |
Property: Stats Retention (Days) - Hour Level |
| 34.12.6 |
Property: Stats Retention (Days) - Minute Level |
| 34.12.7 |
Property: Transaction Log Retention (Days) |
| 34.12.8 |
Property: Scheduler Thread Count |
| 34.12.9 |
Property: Heartbeat Persist Frequency MS |
| 34.12.10 |
Property: Stats Cleanup Frequency MS |
| 34.12.11 |
Property: Stats Persist Frequency MS |
| 34.13.0 |
Cluster Manager Message Broker |
| 34.13.1 |
Property: Message Broker Address |
| 34.13.2 |
Property: Channel Naming Prefix |
| 34.13.3 |
Property: Message Broker Password |
| 34.13.4 |
Property: Message Broker Type |
| 34.13.5 |
Property: Message Broker Username |
| 34.14.0 |
Cluster Manager Kafka |
| 34.14.1 |
Property: Kafka Consumer Ack Mode |
| 34.14.2 |
Property: Kafka Consumer Auto Commit Enabled |
| 34.14.3 |
Property: Kafka Bootstrap Address |
| 34.14.4 |
Property: Kafka Consumer Config Properties (File) |
| 34.14.5 |
Property: Kafka Consumer Config Properties (Text) |
| 34.14.6 |
Property: Kafka Subscription Matcher Consumer Group Id |
| 34.14.7 |
Property: Kafka Producer Config Properties (File) |
| 34.14.8 |
Property: Kafka Producer Config Properties (Text) |
| 34.14.9 |
Property: Kafka SASL JAAS Config |
| 34.14.10 |
Property: Kafka SASL Mechanism |
| 34.14.11 |
Property: Kafka Security Protocol |
| 34.14.12 |
Property: Kafka Broker SSL Enabled |
| 34.14.13 |
Property: Kafka SSL Key Password |
| 34.14.14 |
Property: Kafka SSL Keystore Location |
| 34.14.15 |
Property: Kafka Keystore Password |
| 34.14.16 |
Property: Kafka SSL TrustStore File Location |
| 34.14.17 |
Property: Kafka SSL Truststore Password |
| 34.14.18 |
Property: Validate Kafka Topics Exist Before Use |
| 34.15.0 |
Credentials |
| 34.15.1 |
Property: Cache Successful Credentials |
| 34.15.2 |
Property: Create Unknown Users |
| 34.15.3 |
Property: Lock After Failed Attempts |
| 34.15.4 |
Property: Case-Sensitive Passwords |
| 34.15.5 |
Property: Password Encoding Scheme |
| 34.15.6 |
Property: Password Mismatch Error |
| 34.15.7 |
Property: Minimum Password Requirements |
| 34.15.8 |
Property: Case-Sensitive Usernames |
| 34.16.0 |
Cross-Origin Resource Sharing (CORS) |
| 34.16.1 |
Property: CORS Enabled |
| 34.16.2 |
Property: CORS Origins |
| 34.17.0 |
Database |
| 34.17.1 |
Property: Default Query Timeout (Seconds) |
| 34.17.2 |
Property: Max Idle Connections |
| 34.17.3 |
Property: Connection Max Lifetime (millis) |
| 34.17.4 |
Property: Max Total Connections |
| 34.17.5 |
Property: Max Wait (Seconds) |
| 34.17.6 |
Property: Min Idle Connections |
| 34.17.7 |
Property: Pool Prepared Statements |
| 34.17.8 |
Property: Database Type |
| 34.17.9 |
Property: Expect database to be writable |
| 34.17.10 |
Property: Database Password |
| 34.17.11 |
Property: Database Update Mode |
| 34.17.12 |
Property: SQL Parameter Bind Mode |
| 34.17.13 |
Property: Database Connection URL |
| 34.17.14 |
Property: Database Username |
| 34.17.15 |
Property: Default Page Size |
| 34.17.16 |
Property: FHIR Version |
| 34.17.17 |
Property: Maximum Page Size |
| 34.18.0 |
ETL Import: CSV Properties |
| 34.18.1 |
Property: CSV File Delimiter |
| 34.18.2 |
Property: Parse Quotes |
| 34.19.0 |
ETL Import: Source |
| 34.19.1 |
Property: Asynchronous Mode Enabled |
| 34.19.2 |
Property: Import Source |
| 34.19.3 |
Property: Mapping Script |
| 34.19.4 |
Property: Worker Row Hashing Function |
| 34.19.5 |
Property: Worker Thread Count |
| 34.20.0 |
FHIR Binary Storage |
| 34.20.1 |
Property: Binary Access Operations Enabled |
| 34.20.2 |
Property: Filesystem Mode: Base Directory |
| 34.20.3 |
Property: Binary Storage Mode |
| 34.20.4 |
Property: Maximum Size (bytes) |
| 34.20.5 |
Property: Minimum Size (bytes) |
| 34.21.0 |
FHIR Bulk Operations |
| 34.21.1 |
Property: FHIR Bulk Export Enabled |
| 34.22.0 |
FHIR Configuration |
| 34.22.1 |
Property: Cascading Deletes Enabled |
| 34.22.2 |
Property: Allow External References Enabled |
| 34.22.3 |
Property: Allow Inline Match URL References Enabled |
| 34.22.4 |
Property: Allow Multiple Delete Enabled |
| 34.22.5 |
Property: Allow storing all bundle types |
| 34.22.6 |
Property: Auto-Create Placeholder Reference Targets |
| 34.22.7 |
Property: Client ID Mode |
| 34.22.8 |
Property: Delete Child Resource Count |
| 34.22.9 |
Property: Delete Expunge Enabled |
| 34.22.10 |
Property: Enforce Reference Target Types |
| 34.22.11 |
Property: Disable Deletion Ref Checks for Paths |
| 34.22.12 |
Property: Enforce Referential Integrity on Delete |
| 34.22.13 |
Property: Enforce Referential Integrity on Write |
| 34.22.14 |
Property: Expunge Operation Enabled |
| 34.22.15 |
Property: Mark Resources for Reindexing after SearchParameter change |
| 34.22.16 |
Property: Server ID Mode |
| 34.22.17 |
Property: Store Meta.source information |
| 34.22.18 |
Property: Seed Base Validation Resources |
| 34.23.0 |
FHIR Capability Statement |
| 34.23.1 |
Property: Copyright Message |
| 34.23.2 |
Property: Implementation Description |
| 34.23.3 |
Property: Enable OpenAPI / Swagger Support |
| 34.24.0 |
FHIR Consent Service |
| 34.24.1 |
Property: Consent Service Enabled |
| 34.24.2 |
Property: Consent Service Script (File) |
| 34.24.3 |
Property: Consent Service Script (Text) |
| 34.25.0 |
FHIR Endpoint Terminology |
| 34.25.1 |
Property: Populate Response Coding Displays |
| 34.25.2 |
Property: Response Mapping |
| 34.25.3 |
Property: Mapping Spec (Text) |
| 34.26.0 |
FHIR LiveBundle Service |
| 34.26.1 |
Property: LiveBundle Enabled |
| 34.26.2 |
Property: LiveBundle Rule Definition Script (File) |
| 34.26.3 |
Property: LiveBundle Rule Definition Script (Text) |
| 34.26.4 |
Property: LiveBundle Thread Count |
| 34.26.5 |
Property: LiveBundle Watchlist Cache Enabled |
| 34.27.0 |
FHIR Endpoint Conversion |
| 34.27.1 |
Property: Versioned API Mode |
| 34.28.0 |
FHIR Endpoint Security |
| 34.28.1 |
Property: Automatically Narrow Search Scope |
| 34.28.2 |
Property: Reject Insufficient Permissions with HTTP 401 |
| 34.29.0 |
Interceptors |
| 34.29.1 |
Property: Can Replace Authorization Interceptor |
| 34.29.2 |
Property: Interceptor Bean Types |
| 34.30.0 |
FHIR Endpoint Partitioning and Multitenancy |
| 34.30.1 |
Property: Tenant Identification Strategy |
| 34.31.0 |
FHIR Gateway Config |
| 34.31.1 |
Property: FHIR Version |
| 34.31.2 |
Property: Gateway Configuration (File) |
| 34.31.3 |
Property: Gateway Configuration (Text) |
| 34.31.4 |
Property: Encryption JWKS (File) |
| 34.31.5 |
Property: Encryption JWKS (Text) |
| 34.32.0 |
FHIR MDM Server |
| 34.32.1 |
Property: MDM Mode Enabled (Experimental) |
| 34.32.2 |
Property: Search Expanding Interceptor Enabled (Experimental) |
| 34.33.0 |
FHIR Storage Partitioning and Multitenancy |
| 34.33.1 |
Property: Cross-Partition Reference Mode |
| 34.33.2 |
Property: Partitioning Enabled |
| 34.33.3 |
Property: Partition Selection Mode |
| 34.33.4 |
Property: Partition Seed File |
| 34.34.0 |
FHIR Storage Package Registry |
| 34.34.1 |
Property: Package Pre-Seed Installation Spec Files |
| 34.35.0 |
Versioned References |
| 34.35.1 |
Property: Allow Versioned References at All Paths |
| 34.35.2 |
Property: Allow Versioned References at Paths |
| 34.35.3 |
Property: Automatically Version References at Paths |
| 34.35.4 |
Property: Respect Versioned References for _include |
| 34.36.0 |
FHIR Performance |
| 34.36.1 |
Property: Default Total Calculation Mode |
| 34.36.2 |
Property: Delete Enabled |
| 34.36.3 |
Property: Expire Search Results After Minutes |
| 34.36.4 |
Property: Expunge Batch Size |
| 34.36.5 |
Property: Expunge Thread Count |
| 34.36.6 |
Property: Match URL Cache Enabled |
| 34.36.7 |
Property: Maximum Transaction Bundle Size |
| 34.36.8 |
Property: Reindex Thread Count |
| 34.36.9 |
Property: Reuse Cached Results Timeout (Millis) |
| 34.36.10 |
Property: Index Missing Search Params |
| 34.36.11 |
Property: Suppress Scheduled Maintenance Jobs |
| 34.37.0 |
FHIR Performance Tracing |
| 34.37.1 |
Property: Capture Raw SQL |
| 34.37.2 |
Property: Trigger |
| 34.37.3 |
Property: Performance Tracing Enabled |
| 34.37.4 |
Property: Output to Response Headers |
| 34.37.5 |
Property: Output to System Log |
| 34.37.6 |
Property: Output to Transaction Log |
| 34.38.0 |
FHIR Realtime Export |
| 34.38.1 |
Property: Pointcut-based Realtime Export Mode Enabled |
| 34.39.0 |
FHIR Resource Types |
| 34.39.1 |
Property: Resource Types (whitelist) |
| 34.40.0 |
FHIR REST Endpoint |
| 34.40.1 |
Property: Fixed Value for Endpoint Base URL |
| 34.40.2 |
Property: Default Encoding |
| 34.40.3 |
Property: Default Prefer Return |
| 34.40.4 |
Property: Pretty-Print by Default |
| 34.40.5 |
Property: Process Header: Request Source |
| 34.40.6 |
Property: Serve Raw Media Resources |
| 34.41.0 |
FHIR Search |
| 34.41.1 |
Property: Allow :contains Searches |
| 34.41.2 |
Property: Fetch Size (Default Maximum) |
| 34.41.3 |
Property: Index Contained Resources |
| 34.41.4 |
Property: Use New Search SQL Builder (2020) |
| 34.41.5 |
Property: Use ordinal date values for day precision searches. |
| 34.41.6 |
Property: Filter Search Parameter Enabled |
| 34.41.7 |
Property: GraphQL Enabled |
| 34.41.8 |
Property: Page Size (Default) |
| 34.41.9 |
Property: Page Size (Maximum) |
| 34.41.10 |
Property: Phonetic Encoder |
| 34.41.11 |
Property: Infinispan Cache Name |
| 34.41.12 |
Property: Infinispan Hot Rod Protocol Version. Note that you will need to include an appropriate driver client JAR in the customer_lib directory of your installation. |
| 34.41.13 |
Property: Infinispan Servers |
| 34.41.14 |
Property: Search Cache Storage |
| 34.41.15 |
Property: Suppress String Indexing In Tokens |
| 34.42.0 |
FHIR Interceptors |
| 34.42.1 |
Property: FHIR storage Callback Script (File) |
| 34.42.2 |
Property: FHIR storage Callback Script (Text) |
| 34.42.3 |
Property: Interceptor Bean Types |
| 34.43.0 |
FHIR Repository Validation |
| 34.43.1 |
Property: Repository Validation Javascript (File) |
| 34.43.2 |
Property: Repository Validation Javascript (Text) |
| 34.44.0 |
FHIR Subscription Persistence |
| 34.44.1 |
Property: Consumers Per Delivery Queue |
| 34.44.2 |
Property: Matching Queue Consumers |
| 34.44.3 |
Property: Email Subscription Enabled |
| 34.44.4 |
Property: Message Subscription Enabled |
| 34.44.5 |
Property: REST Hook Subscription Enabled |
| 34.44.6 |
Property: Websocket Subscription Enabled |
| 34.45.0 |
FHIR Subscription Delivery |
| 34.45.1 |
Property: Subscription Delivery Queue Naming |
| 34.45.2 |
Property: Email SMTP Hostname |
| 34.45.3 |
Property: Email SMTP Password |
| 34.45.4 |
Property: Email SMTP Port |
| 34.45.5 |
Property: Use STARTTLS for connection security |
| 34.45.6 |
Property: Email SMTP Username |
| 34.45.7 |
Property: Email From Address |
| 34.46.0 |
FHIR Validation Services |
| 34.46.1 |
Property: Base URL |
| 34.46.2 |
Property: Remote Terminology Service - Enabled |
| 34.46.3 |
Property: Log HTTP Calls |
| 34.46.4 |
Property: Local Reference Policy |
| 34.46.5 |
Property: Unknown CodeSystem Validation Policy |
| 34.47.0 |
HL7 v2.x to FHIR Mapper - Forced Namespace Mode |
| 34.47.1 |
Property: Forced Namespace Mode: Encounter System |
| 34.47.2 |
Property: Forced Namespace Mode: Patient System |
| 34.48.0 |
HL7 v2.x to FHIR Mapper - General |
| 34.48.1 |
Property: Create MessageHeader for Each Message |
| 34.48.2 |
Property: Creation Mode - Practitioner |
| 34.48.3 |
Property: Patient Primary Identifier Search Parameter |
| 34.48.4 |
Property: Inferred TimeZone When Not Present |
| 34.48.5 |
Property: Mapper Bean Types |
| 34.48.6 |
Property: MessageHeader Hardcoded Destination Name |
| 34.49.0 |
HL7 v2.x Mapper - Medications |
| 34.49.1 |
Property: Use Standalone Medications with Administered Code |
| 34.49.2 |
Property: Use Standalone Medications with Component Code |
| 34.49.3 |
Property: Use Standalone Medications with Give Code |
| 34.50.0 |
HL7 v2.x to FHIR Mapper - OBR |
| 34.50.1 |
Property: Observation Identification Mode |
| 34.50.2 |
Property: Use OBR-2 as Primary Identifier |
| 34.50.3 |
Property: Use OBR-3 as Primary Identifier |
| 34.51.0 |
HL7 v2.x to FHIR Mapper - OBSERVATION Group |
| 34.51.1 |
Property: OBSERVATION Group Text Delimiter - NTE |
| 34.51.2 |
Property: OBSERVATION Group Text Delimiter - OBX |
| 34.52.0 |
HL7 v2.x to FHIR Mapper - ORDER_OBSERVATION Group |
| 34.52.1 |
Property: ORDER_OBSERVATION Group Text Delimiter - NTE |
| 34.53.0 |
HL7 v2.x to FHIR Mapper - PV1 |
| 34.53.1 |
Property: Treat PV1-3 and PV1-6 Patient Locations as Single Atomic Locations |
| 34.54.0 |
HL7 v2.x Listener Script |
| 34.54.1 |
Property: Listener Processing Script (File) |
| 34.54.2 |
Property: Listener Processing Script (Text) |
| 34.55.0 |
HL7 v2.x MLLP Listener |
| 34.55.1 |
Property: Charset: Forced |
| 34.55.2 |
Property: Charset: Respect MSH-18 |
| 34.55.3 |
Property: HL7 v2.x Listener Port |
| 34.55.4 |
Property: Socket Timeout (Millis) |
| 34.55.5 |
Property: Storage Tenant Name |
| 34.55.6 |
Property: Transport Protocol |
| 34.55.7 |
Property: Unprocessable Message Handling |
| 34.56.0 |
FHIR to HL7 v2.x Mapper Script |
| 34.56.1 |
Property: HL7 v2.x Conversion Mapper Script (File) |
| 34.56.2 |
Property: HL7 v2.x Conversion Mapper Script (Text) |
| 34.57.0 |
HL7 v2.x MLLP Sender |
| 34.57.1 |
Property: Delay Between Failed Deliveries (millis) |
| 34.57.2 |
Property: HL7 v2.x Destination Host |
| 34.57.3 |
Property: Map Identifiers using NamingSystem |
| 34.57.4 |
Property: Request Path |
| 34.57.5 |
Property: HL7 v2.x Destination Port |
| 34.57.6 |
Property: Retry message on NAK |
| 34.57.7 |
Property: Send Timeout (millis) |
| 34.57.8 |
Property: Transport Protocol |
| 34.57.9 |
Property: Use Persisted Message Headers |
| 34.58.0 |
HTTP Access Log |
| 34.58.1 |
Property: Appenders |
| 34.59.0 |
HTTP Listener |
| 34.59.1 |
Property: Bind Address |
| 34.59.2 |
Property: Context Path |
| 34.59.3 |
Property: Endpoint Health Path |
| 34.59.4 |
Property: HTTPS Forwarding Assumed |
| 34.59.5 |
Property: Listener Port |
| 34.59.6 |
Property: Respect Forward Headers |
| 34.60.0 |
HTTP Request Pool |
| 34.60.1 |
Property: Maximum Request Header Size (KB) |
| 34.60.2 |
Property: Maximum Response Header Size (KB) |
| 34.60.3 |
Property: Read Idle Timeout (millis) |
| 34.60.4 |
Property: Thread Pool Accept Queue Size |
| 34.60.5 |
Property: Thread Pool Maximum Size |
| 34.60.6 |
Property: Thread Pool Minimum Size |
| 34.61.0 |
HTTP Security |
| 34.61.1 |
Property: Block HTTP HEAD |
| 34.61.2 |
Property: Block HTTP OPTIONS |
| 34.61.3 |
Property: Frame Options (Allow From) |
| 34.61.4 |
Property: Pin Host |
| 34.61.5 |
Property: Suppress Error Details |
| 34.61.6 |
Property: Suppress Platform Information |
| 34.62.0 |
Hybrid Providers Definitions |
| 34.62.1 |
Property: FHIR Version |
| 34.62.2 |
Property: Spring Context Config Class |
| 34.63.0 |
Initial User Seeding |
| 34.63.1 |
Property: Users Seed File |
| 34.64.0 |
JSON Web KeySet (JWKS) |
| 34.64.1 |
Property: Signing JWKS (File) |
| 34.64.2 |
Property: Signing JWKS (Text) |
| 34.64.3 |
Property: Signing Key ID |
| 34.65.0 |
LDAP Authentication |
| 34.65.1 |
Property: Authentication: User Attributes to query |
| 34.65.2 |
Property: Authentication: User Base DN |
| 34.65.3 |
Property: Authentication: User Query |
| 34.65.4 |
Property: Require Group DN |
| 34.65.5 |
Property: Base DN for Groups |
| 34.65.6 |
Property: Search Groups Recursively |
| 34.65.7 |
Property: System User DN |
| 34.65.8 |
Property: System User Password |
| 34.65.9 |
Property: LDAP Server URL |
| 34.65.10 |
Property: Global Permissions |
| 34.65.11 |
Property: Native Permission User Attribute |
| 34.65.12 |
Property: User Attribute: Family Name |
| 34.65.13 |
Property: User Attribute: Given Name |
| 34.66.0 |
Lucene FullText Indexing |
| 34.66.1 |
Property: Lucene Index Directory |
| 34.66.2 |
Property: ElasticSearch Password |
| 34.66.3 |
Property: ElasticSearch URL protocol. Either http or https |
| 34.66.4 |
Property: ElasticSearch URL |
| 34.66.5 |
Property: ElasticSearch Username |
| 34.66.6 |
Property: Enable FullText Content Index |
| 34.66.7 |
Property: Enable Terminology Index |
| 34.66.8 |
Property: Lucene Indexing Provider |
| 34.66.9 |
Property: Lucene Indexing Enabled |
| 34.67.0 |
Narrative Generator |
| 34.67.1 |
Property: Narrative Template Manifest File |
| 34.68.0 |
Master Data Management |
| 34.68.1 |
Property: MDM Consumer Thread Count |
| 34.68.2 |
Property: Prevent modification of External EIDs |
| 34.68.3 |
Property: Prevent multiple EIDs from existing simultaneously on a target resource |
| 34.68.4 |
Property: MDM Rule Definition Script (File) |
| 34.68.5 |
Property: MDM Rule Definition Script (Text) |
| 34.68.6 |
Property: MDM Survivorship Script (File) |
| 34.68.7 |
Property: MDM Survivorship Script (Text) |
| 34.69.0 |
OpenID Connect (OIDC) |
| 34.69.1 |
Property: Cache Authorizations (millis) |
| 34.69.2 |
Property: Client Secret Encoding |
| 34.69.3 |
Property: Smile CDR generated Client Secret expiry duration in days |
| 34.69.4 |
Property: Issuer URL |
| 34.69.5 |
Property: Rotate Refresh Token After Use |
| 34.69.6 |
Property: Smart Capabilities List |
| 34.70.0 |
Realtime Export |
| 34.70.1 |
Property: Concurrent Consumers |
| 34.70.2 |
Property: Import Channel Name |
| 34.70.3 |
Property: Realtime Export Script (File) |
| 34.70.4 |
Property: Realtime Export Script (Text) |
| 34.70.5 |
Property: Published Data source |
| 34.70.6 |
Property: Transaction-Based Processing |
| 34.71.0 |
Request Validating |
| 34.71.1 |
Property: Request Validating Enabled |
| 34.71.2 |
Property: Fail On Severity |
| 34.71.3 |
Property: Validation Response Headers Enabled |
| 34.71.4 |
Property: Validation Tags Enabled |
| 34.72.0 |
Security Inbound Script |
| 34.72.1 |
Property: Script (File) |
| 34.72.2 |
Property: Script (Text) |
| 34.73.0 |
Inbound SMART on FHIR Authentication |
| 34.73.1 |
Property: Authentication Cache Timeout (Seconds) |
| 34.73.2 |
Property: Prevent Token KeyID Reuse |
| 34.73.3 |
Property: Require Key Expiry |
| 34.73.4 |
Property: Scopes Supported |
| 34.73.5 |
Property: Trust Intra-Cluster SMART Tokens from Module(s) |
| 34.74.0 |
Inbound SMART on FHIR Endpoints |
| 34.74.1 |
Property: Authorization Endpoint |
| 34.74.2 |
Property: Token Endpoint |
| 34.75.0 |
OpenID Connect Token Validation |
| 34.75.1 |
Property: Token Introspection Client: Truststore File |
| 34.75.2 |
Property: Token Introspection Client: Truststore Password |
| 34.76.0 |
SAML Provider |
| 34.76.1 |
Property: Relying Party Entity ID Template |
| 34.76.2 |
Property: Issuer ID |
| 34.76.3 |
Property: Keystore File |
| 34.76.4 |
Property: Keystore Password |
| 34.76.5 |
Property: Registration ID |
| 34.76.6 |
Property: Sign Auth Request |
| 34.76.7 |
Property: Signing Key Alias |
| 34.76.8 |
Property: Signing Key Password |
| 34.76.9 |
Property: Verification Certificate Alias |
| 34.76.10 |
Property: Web SSO URL |
| 34.77.0 |
OAuth2/OIDC Federation |
| 34.77.1 |
Property: Federated OAuth2/OIDC Login |
| 34.78.0 |
SMART Authorization |
| 34.78.1 |
Property: Enforce Approved Scopes to Restrict Permissions |
| 34.78.2 |
Property: Scopes Supported |
| 34.79.0 |
SMART Definitions Seeding |
| 34.79.1 |
Property: OpenID Connect Client Pre-Seed File |
| 34.79.2 |
Property: OpenID Connect Server Pre-Seed File |
| 34.80.0 |
Sessions |
| 34.80.1 |
Property: Use In-Memory Sessions |
| 34.80.2 |
Property: Session Scavenger Interval (Millis) |
| 34.80.3 |
Property: Session Timeout (Mins) |
| 34.81.0 |
SMART Outbound Security: Callback Script |
| 34.81.1 |
Property: Post Authorization Script (File) |
| 34.81.2 |
Property: Post Authorization Script (Text) |
| 34.82.0 |
SMART Outbound Security: CODAP |
| 34.82.1 |
Property: CODAP Authorization Script (File) |
| 34.82.2 |
Property: CODAP Authorization Script (Text) |
| 34.82.3 |
Property: Enable Cross-Organization Data Access Profile |
| 34.83.0 |
SMART Outbound Security: Login Skin |
| 34.83.1 |
Property: Approval Page Template |
| 34.83.2 |
Property: Error Page Template |
| 34.83.3 |
Property: Login Page (Federated OAuth2/OIDC) Template |
| 34.83.4 |
Property: Login Page Template |
| 34.83.5 |
Property: User Self Registration Template (Step 1) |
| 34.83.6 |
Property: User Self Registration Template (Step 2) |
| 34.83.7 |
Property: Session Management Page Template |
| 34.83.8 |
Property: Two Factor Authentication Page Template |
| 34.83.9 |
Property: Terms-of-service click-wrap Page Template |
| 34.83.10 |
Property: WebJar ID |
| 34.84.0 |
SMART Outbound Security: Terms of Service |
| 34.84.1 |
Property: Current version of terms. |
| 34.85.0 |
Two Factor Authentication |
| 34.85.1 |
Property: TOTP Issuer Name |
| 34.85.2 |
Property: Lock After Failed Attempts |
| 34.86.0 |
TLS / SSL (Encryption) |
| 34.86.1 |
Property: TLS Client Authentication |
| 34.86.2 |
Property: TLS Enabled |
| 34.86.3 |
Property: TLS KeyStore Filename |
| 34.86.4 |
Property: TLS KeyStore Key Alias |
| 34.86.5 |
Property: TLS KeyStore Key Password |
| 34.86.6 |
Property: TLS KeyStore Password |
| 34.86.7 |
Property: TLS Cipher Blacklist |
| 34.86.8 |
Property: TLS Cipher Whitelist |
| 34.86.9 |
Property: TLS Protocol Blacklist |
| 34.86.10 |
Property: TLS Protocol Whitelist |
| 34.86.11 |
Property: TLS TrustStore Filename |
| 34.86.12 |
Property: TLS TrustStore Password |
| 34.87.0 |
Trusted Client |
| 34.87.1 |
Property: Assert Permissions |
| 34.87.2 |
Property: Trusted Client Mode Enabled |
| 34.88.0 |
Transaction Log |
| 34.88.1 |
Property: Transaction Log Enabled |
| 34.88.2 |
Property: Event Blacklist |
| 34.88.3 |
Property: Event Whitelist |
| 34.88.4 |
Property: Persist Transaction Bodies (Global) |
| 34.88.5 |
Property: Persist Transaction Bodies: Incoming Request |
| 34.88.6 |
Property: Persist Transaction Bodies: Incoming Response |
| 34.88.7 |
Property: Truncate Transaction Bodies (bytes) |
| 34.89.0 |
User Self Registration |
| 34.89.1 |
Property: User Self Registration Script (File) |
| 34.89.2 |
Property: User Self Registration Script (Text) |
| 34.89.3 |
Property: User Self Registration Enabled |
| 35.0.0 |
Product Reference |
| 35.0.0 |
Enumerated Types |
| 35.0.1 |
Node And Module Status |
| 35.0.2 |
Transaction Log Outcomes |
| 35.0.3 |
Module Types |
| 36.0.0 |
Appendix |
| 36.0.0 |
Preparing a Linux Host |
| 36.0.1 |
Ubuntu Host with PostgreSQL / NGINX / Letsencrypt |
| 36.0.2 |
Install letsencrypt and obtain Certs (optional) |
| 36.0.3 |
Install nginx And Configure it to Front the Server |
| 36.0.4 |
Red Hat Enterprise Linux (RHEL) or CentOS |
| 36.1.0 |
Production Checklist |
| 36.1.1 |
Host Server Setup |
| 36.1.2 |
Network Infrastructure |
| 36.1.3 |
CDR Process Settings |
| 36.1.4 |
FHIR Server Performance |
| 36.1.5 |
Monitoring |
| 36.1.6 |
Security |
| 36.1.7 |
Message Broker |
| 36.1.8 |
Cluster Design |
| 36.2.0 |
Installing Smile CDR, NGINX and PostgreSQL in a Docker Stack |
| 36.2.1 |
Initial Setup of Docker and Context |
| 36.2.2 |
Prepare Configuration for Smile CDR Docker Service |
| 36.2.3 |
Prepare Configuration for NGINX Docker Service |
| 36.2.4 |
Prepare Configuration for PostgreSQL Docker Service |
| 36.2.5 |
Create Docker compose file for Smile CDR Docker stack |
| 36.2.6 |
Build and Launch Smile CDR Stack |
| 36.3.0 |
Deploying a Kubernetes Managed Cluster |
| 36.3.1 |
Overview of Smile CDR Kubernetes Deployment Process |
| 36.3.2 |
Pre-requisite Steps |
| 36.3.3 |
Configuring Kubernetes |
| 36.3.4 |
Service Definitions |
| 36.3.5 |
ConfigMap Definitions |
| 36.3.6 |
Deployment Definitions |
| 36.3.7 |
Deploying Smile CDR in a Kubernetes Cluster |
| 36.3.8 |
Configuring Reverse Proxy and Load Balancer |
| 36.3.9 |
Considerations When Deploying Smile CDR Using OpenShift |
| 36.4.0 |
Password Hashing Algorithms |
| 36.4.1 |
Available Algorithms |
| 36.5.0 |
Resource Paths |
| 36.6.0 |
JWT Signature Algorithms |
| 36.7.0 |
Inferno Considerations |