On this page:

1.1 Table of Contents

 

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.1.0 Table of Contents
1.2.0 Changelog
1.2.1 Smile CDR 2019 . 02 . R01 (Gale)
1.2.2 Smile CDR 2018 . 11 . R01 (Food)
1.2.3 Smile CDR 2018 . 09 . R01 (Economist)
1.2.4 Smile CDR 2018 . 05 . R01 (Dromedário)
1.2.5 Smile CDR 2018 . 03 . R01 (Crouton)
1.2.6 Smile CDR 2017 . 11 . R01 (Buccaneer)
1.2.7 Smile CDR 2017 . 09 . R01 (Aardvark)
1.2.8 Smile CDR 2017 . 07 . R01
2.0.0 Getting Started
2.1.0 Basic Concepts
2.1.1 Nodes and Modules
2.1.2 The Cluster Manager Module
2.1.3 Module Dependencies
2.2.0 Platform Requirements
2.2.1 Server Requirements
2.2.2 Java Requirements
2.2.3 Database Requirements
2.2.4 Network Infrastructure
2.3.0 Installing Smile CDR
2.3.1 Installing to Linux / OSX
2.3.2 Basic Configuration
2.3.3 Quick Start
2.3.4 The Initial Configuration
2.3.5 The Node Configuration Properties File
2.3.6 Module Property Source
2.3.7 Variable Substitution
2.3.8 Configuring Your Database
2.3.9 Starting the CDR
2.4.0 Tuning your Installation
2.4.1 Memory Settings
2.5.0 System Logging
2.5.1 Changing Logging Settings
2.6.0 Preparing the Message Broker
2.6.1 Subscription Queues
2.6.2 Subscription Queue Names
2.7.0 Kafka Subscriptions
2.7.1 Subscription Matcher Module
2.7.2 Subscription Topic Names
2.8.0 Upgrading Smile CDR
3.0.0 Tutorial and Tour
3.1.0 Preamble and Setup
3.1.1 Getting Up to Speed
3.1.2 Preparing Your Instance
3.1.3 Accessing the Web Admin Console
3.1.4 Enabling Anonymous Access to the FHIR Endpoint
3.1.5 Uploading Sample FHIR Resources
3.2.0 FHIR Basics
3.2.1 Resources
3.2.2 Datatypes
3.2.3 Parts of a Resource
3.2.4 Encodings (MIME Types, Wire Formats)
3.3.0 FHIR Search Queries
3.3.1 How Searching Works
3.3.2 Basic Searching : Finding Patients
3.3.3 References : Finding Encounters
3.3.4 Quantities : Finding Laboratory Values
3.3.5 Dates and Times : Narrowing Your Search Window
3.3.6 Paging Search Results
3.3.7 Sorting Search Results
3.3.8 Fulltext Searching
3.3.9 The Patient $everything Search (Across Patient Chart)
3.4.0 FHIR CRUD Operations
3.4.1 Testing Tools
3.4.2 FHIR Create
3.4.3 FHIR Update
3.4.4 FHIR Read / vRead
3.4.5 FHIR Delete
3.5.0 SMART on FHIR Apps
3.5.1 Accessing the Web Admin Console
3.5.2 Creating a Client Definition
3.5.3 Launch SMART on FHIR Growth Chart App
3.6.0 Processing HL7 v2.x Feeds
3.6.1 Transmitting to Smile CDR
3.6.2 ORU (Observation Result) Messages
3.6.3 ADT (Admission/Discharge/Transfer) Messages
4.0.0 FHIR Storage
4.1.0 Concepts in Smile CDR
4.1.1 The FHIR Storage Module
4.1.2 The FHIR REST Endpoint Module
4.1.3 Clustering
4.1.4 Basic Configurations
4.2.0 FHIR Storage (Relational) Module
4.2.1 Preparing for a New Installation
4.2.2 Creating the Module
4.2.3 Configuration
4.3.0 FHIR Endpoint Module
4.3.1 Creating the Module
4.3.2 Configuration
4.4.0 FHIRWeb Console
4.4.1 Architecture
4.4.2 Security
4.4.3 Creating the Module
4.4.4 Using the Console
4.4.5 Configuration
4.5.0 Performance and Caching
4.5.1 The Query Cache
4.5.2 Search Counts
4.6.0 Resource IDs
4.6.1 Server Assigned IDs
4.6.2 Client Assigned IDs
4.7.0 Search Parameters
4.7.1 Search Parameter Concepts
4.7.2 Default Search Parameters
4.7.3 Defining Paths Using FHIRPath
4.7.4 Managing Search Parameters
4.7.5 An Example Search Parameter
4.7.6 Enforcing Uniqueness
4.7.7 Unique Composite Search Parameters
4.7.8 Search Parameter Statistics
4.8.0 Subscription
4.8.1 Smile CDR Subscription Architecture
4.8.2 Criteria
4.8.3 Channel Types
4.8.4 Channel Type : rest - hook
4.8.5 Channel Type : email
4.8.6 Other Channel Types
4.8.7 Manually Triggering Subscriptions
4.8.8 Subscription Activation
4.8.9 In - Memory Matching
4.8.10 Replication Mode
4.8.11 Strip Version IDs
4.8.12 Delivering Latest Version
4.8.13 Custom Delivery Class
4.8.14 Troubleshooting
4.9.0 Terminology
4.9.1 Uploading External Terminologies
4.9.2 Uploading LOINC
4.9.3 Uploading SNOMED CT
4.10.0 Multitenancy
4.11.0 Updating Data
4.11.1 Tag Retention
4.12.0 Deleting Data
4.12.1 The $expunge Operation
4.13.0 Interceptors
4.13.1 Coding and Deploying Interceptors
4.13.2 Starter Project
4.13.3 Example : Attribute Enhancement
4.14.0 Binary Data
4.14.1 Serving Raw Media Resources
5.0.0 FHIR Hybrid Providers
5.1.0 Hybrid Providers
5.1.1 Architecture
5.1.2 Resource Providers
5.1.3 The Spring Context Config Class
5.1.4 Building Your Hybrid Providers
5.1.5 Deploying Your Hybrid Providers
5.1.6 Accessing Security Attributes
5.1.7 Exceptions
5.1.8 Example Project
6.0.0 FHIR Gateway
6.1.0 FHIR Gateway
6.1.1 Gateway Architecture
6.1.2 Creating a FHIR Gateway Endpoint
6.1.3 Invoking Operations
6.1.4 Request/Response Translation
7.0.0 Security
7.1.0 Security in Smile CDR
7.1.1 Inbound Security Module
7.1.2 FHIR Listener Module
7.1.3 Admin Modules
7.1.4 Auth Directory
7.1.5 Audit Database
7.1.6 Outbound Security Modules
7.2.0 Inbound Security Module
7.2.1 Permissions
7.2.2 Callback Script
7.3.0 Local Inbound Security Module
7.3.1 Configuration : Credentials
7.3.2 Caching
7.4.0 LDAP Inbound Security Module
7.4.1 Requirements
7.4.2 Permissions
7.4.3 Callback Scripts
7.4.4 Configuration
7.5.0 Scripted Inbound Security Module
7.5.1 Script Format
7.5.2 Script Examples
7.6.0 Trusted Client Mode
7.6.1 Configuring Trusted Client Mode
7.6.2 Making Trusted Client Requests
7.6.3 Automatically Creating Users
7.7.0 Roles and Permissions
7.7.1 System - Defined Roles
7.7.2 System - Defined Permissions
7.8.0 Callback Scripts
7.8.1 Method : onAuthenticateSuccess
7.9.0 SMART on FHIR: Introduction
7.9.1 The SMART Launch Sequence
7.9.2 The Interactive Launch Process
7.9.3 Authorization Flows / Grant Types
7.9.4 Launch Context Scopes
7.9.5 Launch Scopes
7.9.6 The OpenID and Profile Scopes
7.10.0 SMART on FHIR: Scopes
7.10.1 Launch Scopes
7.10.2 The OpenID and Profile Scopes
7.11.0 SMART on FHIR: Auth Flows
7.11.1 Launch Flow : Authorization Code
7.11.2 Launch Flow : Implicit Grant
7.11.3 Launch Flow : Resource Owner Password Credentials
7.11.4 Non - Interactive User Flow : Cross - Organization Data Access Profile
7.11.5 System Flow : Client Credentials
7.11.6 System Flow : Refresh
7.12.0 SMART on FHIR: Endpoints
7.12.1 Server Metadata Endpoint
7.12.2 UserInfo Endpoint
7.13.0 SMART on FHIR: Smile CDR Support
7.13.1 Supported Scopes
7.13.2 Scope Permission Model
7.13.3 Online / Offline Access
7.14.0 SMART Outbound Security Module
7.14.1 Setting Up This Module
7.14.2 Configuring Clients
7.14.3 Client Secrets
7.14.4 SMART Callback Script
7.14.5 Client Credentials Grant
7.14.6 Cross - Organization Data Access Profile Grant
7.14.7 Approving Scopes
7.14.8 Skinning the Server
7.15.0 SMART Inbound Security Module
7.15.1 Architecture
7.15.2 Requirements
7.15.3 Setting Up This Module
7.15.4 Accepting Tokens
7.15.5 Accepting Internal Access Tokens
7.15.6 Accepting External Access Tokens
7.15.7 Creating a Server Definition
7.16.0 SMART Session Management
7.16.1 Token Revocation Endpoint
7.16.2 User Logout Endpoint
7.17.0 Anonymous Access
7.18.0 Security Recipes
7.18.1 App : Local Users with HTTP Basic Authentication
7.19.0 Troubleshooting Security
8.0.0 Clustering
8.1.0 Designing a Cluster
8.1.1 Module Design
8.1.2 Adding and Removing Nodes
8.1.3 Multi - Master Clusters
9.0.0 HL7 v2.x Support
9.1.0 Introduction
9.1.1 Inbound HL7 v2 . x Support
9.1.2 Outbound HL7 v2 . x Support
9.2.0 Inbound Messaging
9.2.1 Callback Scripts
9.3.0 Outbound Messaging
9.3.1 Enriching Message Conversion using Scripts
9.3.2 Using Persisted MessageHeader Resources
9.4.0 Transactions
9.4.1 ADT (Patient Administration) Domain
9.4.2 ORM (Orders) Domain
9.4.3 ORU (Results) Domain
9.4.4 RDE/RAS (Pharmacy) Domain
9.5.0 Structure Definitions
9.5.1 Structure : ADT _ A01
9.5.2 Structure : ADT _ A02
9.5.3 Structure : ADT _ A03
9.5.4 Structure : ADT _ A05
9.5.5 Structure : ADT _ A06
9.5.6 Structure : ADT _ A09
9.5.7 Structure : ADT _ A12
9.5.8 Structure : ADT _ A17
9.5.9 Structure : ADT _ A21
9.5.10 Structure : ADT _ A30
9.5.11 Structure : ADT _ A38
9.5.12 Structure : ADT _ A39
9.5.13 Structure : ADT _ A44
9.5.14 Structure : ADT _ A45
9.5.15 Structure : ADT _ A54
9.5.16 Structure : ADT _ A60
9.5.17 Structure : ADT _ A61
9.5.18 Structure : ORM _ O01
9.5.19 Structure : ORU _ R01
9.5.20 Structure : RAS _ O17
9.5.21 Structure : RDE _ O11
9.6.0 Segment Definitions
9.6.1 Segment : MSH (Message Header)
9.6.2 Segment : PID (Patient)
9.6.3 Segment : PV1 (Visit/Encounter)
9.6.4 Segment : ROL (Role)
9.6.5 Segment : DG1 (Diagnosis)
9.6.6 Segment : PR1 (Procedure)
9.6.7 Segment : MRG (Merge Patient Information)
9.6.8 Segment : GT1 (Guarantor)
9.6.9 Segment : IN1 (Insurance)
9.6.10 Segment : IN2 (Insurance Additional Information)
9.6.11 Segment : ORC (Order Control)
9.6.12 Segment : OBR (Observation Request)
9.6.13 Segment : OBX (Observation)
9.6.14 Segment : NK1 (Next of Kin / Patient Contact)
9.6.15 Segment : NTE (Note)
9.6.16 Segment : RXA (Pharmacy Administration)
9.6.17 Segment : RXC (Pharmacy Component)
9.6.18 Segment : RXE (Pharmacy Encoded Order)
9.6.19 Segment : RXR (Pharmacy Route)
9.6.20 Segment : IAM (Patient Adverse Reaction)
9.6.21 Segment : SPM (Specimen)
9.6.22 Segment : ZXT (Non - Standard)
9.6.23 A Note about Extra Components
9.7.0 Table Definitions
9.7.1 Table 0001 : Administrative Sex
9.7.2 Table 0002 : Marital Status
9.7.3 Table 0004 : Visit Class
9.7.4 Table 0038 : Order Status
9.7.5 Table 0052 : Diagnosis Type
9.7.6 Table 0063 : v2 Relationship
9.7.7 Table 0074 : Dianostic Service Section ID
9.7.8 Table 0078 : Observation Interpretation Codes
9.7.9 Table 0085 : Observation Status
9.7.10 Table 0119 : Order Control
9.7.11 Table 0125 : Observation Value Type
9.7.12 Table 0127 : Allergen Type
9.7.13 Table 0128 : Allergen Severity
9.7.14 Table 0131 : v2 Contact Role
9.7.15 Table 0136 : Yes/No
9.7.16 Table 0166 : RX Component Type
9.7.17 Table 0190 : Address Type
9.7.18 Table 0200 : Name Type Code
9.7.19 Table 0201 : Telecom Use
9.7.20 Table 0202 : Telecom Equipment Type
9.7.21 Table 0203 : Identifier Type
9.7.22 Table 0271 : Result Status
9.7.23 Table 0322 : Completion Status
9.7.24 Table 0438 : Allergy Clinical Status Code
9.8.0 Naming System Mapping
9.8.1 Default Mappings
9.8.2 Using NamingSystem for Mapping Identifiers
9.9.0 Processing Results Feeds
9.9.1 Unsolicited Observation Request (ORU^R01)
9.10.0 Protocol
9.10.1 ER7 (Pipe - Delimited) Format
9.10.2 Minimal Lower Layer Protocol (MLLP) Transport
9.10.3 Character Encoding / Charsets
10.0.0 CDA Exchange Module
10.1.0 Introduction
10.2.0 JavaScript Templates
10.2.1 The simplest CDA template script
10.2.2 Adding header information to our CDA template script
10.2.3 Adding and populating a section in our CDA template script
10.2.4 Using the Fhir . search () API to dynamically populate sections
10.2.5 Specifying input parameters
10.2.6 More complicated input parameters
10.2.7 Putting it all together
10.3.0 Rest API Operations
10.3.1 Endpoints for configuring templates
10.3.2 Endpoints for applying templates
10.4.0 Available Document and Section Types
10.4.1 Valid Document Types
10.4.2 Valid Resources for the header
10.4.3 Valid Section Types and Sources
10.4.4 Allergy and Intolerances Section
10.4.5 Medications Section
10.4.6 Problem Section
10.4.7 Results Section
10.4.8 Social History Section
10.4.9 Vital Signs Section
10.4.10 Dialysis Prescription Section
10.4.11 Reason for Referral Section
10.5.0 Further Reading
11.0.0 Bulk Operations
11.1.0 ETL Importer
11.1.1 Importing CSV Data
11.1.2 Ingesting Data
12.0.0 Monitoring
12.1.0 Monitoring Basics
12.1.1 HTTP Endpoint Health Check
12.1.2 Runtime Health Checks
13.0.0 JSON Admin Endpoints
13.1.0 JSON Admin API
13.1.1 Security
13.1.2 Format
13.2.0 Audit Log Endpoint
13.2.1 Fetch Audit Log
13.2.2 Fetch Individual Event
13.3.0 Bulk Import Endpoint
13.3.1 Process ETL File
13.4.0 CDA Exchange Endpoint
13.4.1 Create CDA Template
13.4.2 Update CDA Template
13.4.3 Update CDA Template script via text
13.4.4 View CDA Template (s)
13.4.5 Delete CDA template
13.4.6 Use / Apply CDA Template
13.4.7 Create CDA from Composition/Bundle
13.4.8 Example CDA Template
13.5.0 Module Config Endpoint
13.5.1 Fetch Config : Module Property File
13.5.2 Fetch Config : All Modules
13.5.3 Fetch Config : Single Module
13.5.4 Create Module
13.5.5 Set Module Config
13.5.6 Start Module
13.5.7 Stop Module
13.5.8 Restart Module
13.5.9 Archive Module
13.6.0 OpenID Connect Clients Endpoint
13.6.1 Fetch All Clients
13.6.2 Fetch Individual Client by Client ID
13.6.3 Create Client
13.6.4 Update Client
13.7.0 OpenID Connect Servers Endpoint
13.7.1 Fetch All Servers
13.7.2 Find Individual Server by Issuer ID
13.7.3 Create Server
13.7.4 Update Server
13.8.0 Runtime Status Endpoint
13.8.1 Fetch Complete Node Status Information
13.8.2 Fetch All Runtime Health Checks
13.9.0 Transaction Log Endpoint
13.9.1 Fetch Transaction Log
13.9.2 Fetch Individual Event
13.10.0 User Management Endpoint
13.10.1 Search for Users (All Modules)
13.10.2 Search for Users (Specific Module)
13.10.3 Create User
13.10.4 Update User
14.0.0 Product Configuration
14.1.0 HTTP Server Setup
14.1.1 Respecting Forward Headers
14.1.2 Specifying a Custom Context Path
14.1.3 Enabling TLS (HTTPS / SSL)
14.1.4 Selecting Ciphers and Protocol
14.1.5 Enabling TLS Mutual Authentication (Client Auth)
14.1.6 Access Logs
14.1.7 Frame Options
14.2.0 Audit/Transaction Logs
14.2.1 Audit Log
14.2.2 Transaction Log
15.0.0 Modules
15.1.0 CDA Exchange
15.1.1 Configuration Categories
15.2.0 Cluster Manager
15.2.1 Configuration Categories
15.3.0 ETL Importer
15.3.1 Configuration Categories
15.4.0 FHIR REST Endpoint (DSTU2)
15.4.1 Configuration Categories
15.5.0 FHIR REST Endpoint (R3)
15.5.1 Configuration Categories
15.6.0 FHIR Storage (DSTU2 Relational)
15.6.1 Configuration Categories
15.7.0 FHIR Storage (R3 Relational)
15.7.1 Configuration Categories
15.8.0 Subscription Matcher (R3)
15.8.1 Configuration Categories
15.9.0 Subscription Matcher (R4)
15.9.1 Configuration Categories
15.10.0 FHIRWeb Console
15.10.1 Configuration Categories
15.11.0 HL7 v2.x Listening Endpoint
15.11.1 Configuration Categories
15.12.0 HL7 v2.x Sending Endpoint
15.12.1 Configuration Categories
15.13.0 JSON Admin API
15.13.1 Configuration Categories
15.14.0 LDAP Inbound Security
15.14.1 Configuration Categories
15.15.0 Local Inbound Security
15.15.1 Configuration Categories
15.16.0 Scripted Inbound Security
15.16.1 Configuration Categories
15.17.0 SMART App Host
15.17.1 Configuration Categories
15.18.0 SMART Inbound Security
15.18.1 Configuration Categories
15.19.0 SMART Outbound Security
15.19.1 Configuration Categories
15.20.0 Web Admin Console
15.20.1 Configuration Categories
16.0.0 Java Execution Environment
16.1.0 Security Attributes
17.0.0 JavaScript Execution Environment
17.1.0 Introduction
17.2.0 Converter API
17.2.1 Method : hl7v2TsToFhirDate (dt) ;
17.2.2 Method : hl7v2TsToFhirDateTime (ts) ;
17.2.3 Method : hl7v2TsToFhirDateTime (ts, impliedTimeZone) ;
17.2.4 Method : urlDecode (string) ;
17.2.5 Method : urlEncode (string) ;
17.3.0 Environment API
17.4.0 Exceptions API
17.4.1 Method : Exceptions . newTrustedException (theMessage)
17.4.2 Method : Exceptions . newTrustedException (theStatusCode, theMessage)
17.5.0 FHIR REST API
17.5.1 Method : create (resource)
17.5.2 Method : read (url)
17.5.3 Method : search () . forResource (resourceType)
17.5.4 Method : transaction (IBundleBuilder theTransaction)
17.5.5 Method : translate ()
17.5.6 Method : update (resource)
17.5.7 Authentication
17.6.0 FHIR Model API
17.6.1 Method : ResourceBuilder . build (resourceType)
17.6.2 Working with Resources
17.6.3 Working with Composition resources
17.6.4 Working with Bundle resources
17.6.5 Contained Resources
17.7.0 HL7 v2.x Mapping API
17.7.1 Parsing Raw Field Values
17.7.2 Working with Z - Segments
17.8.0 HTTP API
17.8.1 Request Creation Methods
17.8.2 Request Execution Methods
17.8.3 Response Processing Methods
17.9.0 Log API
17.9.1 Methods : debug (string) , info (string) , warn (string) , error (string)
17.10.0 Composition Resource API
17.10.1 Method : set * (value)
17.10.2 Method : setDate (epoch)
17.10.3 Method : setType (documentType)
17.10.4 Method : addSection (sectionType)
17.11.0 Composition Section API
17.11.1 Method : populate (List <Resource> resources)
17.11.2 Method : setTitle (title)
17.11.3 Method : setCode (system, code, display)
17.12.0 TransactionBuilder API
17.12.1 Method : newTransactionBuilder ()
17.12.2 Method : create (resource)
17.12.3 Method Chain : createConditional (resource) . onToken (parameter, system, value)
17.12.4 Method Chain : updateConditional (resource) . onToken (parameter, system, value)
17.12.5 Methods : toXml () , toXml (prettyPrint) , toJson () , toJson (prettyPrint)
17.12.6 Fhir . transaction (transaction)
17.13.0 Util API
17.13.1 Method : sleep (millis)
17.14.0 UUID API
17.14.1 Method : newPlaceholderId ()
17.15.0 Callback Models
17.15.1 AssociatedResource
17.15.2 AuthenticationContext
17.15.3 AuthenticationFailure
17.15.4 GrantedAuthority
17.15.5 Hl7V2GeneratedMessageContext
17.15.6 Hl7V2ReceivedMessageConversionResult
17.15.7 Hl7V2ReceivedMessage
17.15.8 LaunchContext
17.15.9 LaunchResourceId
17.15.10 OAuth2ClientDetails
17.15.11 OAuth2ClientSecret
17.15.12 OAuth2Clients
17.15.13 OAuth2Server
17.15.14 OAuth2Servers
17.15.15 ScriptAuthenticationOutcomeFactory
17.15.16 SecurityInLdapAuthenticationContext
17.15.17 SecurityInSmartAuthenticationContext
17.15.18 SmartCodapAuthorizationRequest
17.15.19 SmartOnPostAuthorizeDetails
17.15.20 UserSessionDetails
18.0.0 Database Administration
18.1.0 Database Design
18.1.1 Cluster Manager Database
18.1.2 FHIR Relational Storage
18.2.0 Setting Up PostgreSQL
18.2.1 Supported Versions
18.2.2 Setting up a Cluster Manager Database
18.2.3 Setting up a FHIR Storage (Relational) Database
18.3.0 Setting Up MySQL or MariaDB
18.3.1 Supported Versions
18.3.2 Setting up a Cluster Manager Database
18.3.3 Setting up a FHIR Storage (Relational) Database
18.4.0 Setting Up Oracle
18.4.1 Supported Versions
18.4.2 Setting up a Cluster Manager Database
18.4.3 Setting up a FHIR Storage (Relational) Database
18.5.0 Setting Up SQL Server (MSSQL)
18.5.1 Supported Versions
18.5.2 Setting up a Cluster Manager Database
18.5.3 Setting up a FHIR Storage (Relational) Database
19.0.0 Configuration Categories
19.1.0 Web Admin Console Settings
19.1.1 Property : Transaction Log - Event Body Display Mode
19.2.0 Authentication Callback Scripts
19.2.1 Property : Authentication Callback Script (Text)
19.2.2 Property : Authentication Callback Script (File)
19.3.0 Auth: General for APIs
19.3.1 Property : Allow Anonymous Access
19.3.2 Property : Anonymous Account Username
19.4.0 Auth: General for Web
19.5.0 Auth: HTTP Basic
19.5.1 Property : HTTP Basic Security
19.5.2 Property : HTTP Basic Realm
19.6.0 Auth: OpenID Connect
19.6.1 Property : OpenID Connect Security
19.7.0 Browser Syntax Highlighting
19.7.1 Property : Browser Syntax Highlighting Enabled
19.7.2 Property : Show Request Headers
19.7.3 Property : Show Response Headers
19.8.0 Capability Statement (metadata)
19.8.1 Property : Include Resource Counts
19.8.2 Property : Cache Resource Counts (Mins)
19.9.0 Cluster Manager Maintenance
19.9.1 Property : Audit Log Enabled
19.9.2 Property : Transaction Log Enabled
19.9.3 Property : Persist Transaction Bodies
19.9.4 Property : Transaction Log Retention (Days)
19.9.5 Property : Stats Retention (Days) - Minute Level
19.9.6 Property : Stats Retention (Days) - Hour Level
19.9.7 Property : Stats Retention (Days) - Day Level
19.10.0 Cluster Manager Message Broker
19.10.1 Property : Message Broker Type
19.10.2 Property : Message Broker Username
19.10.3 Property : Message Broker Password
19.10.4 Property : Message Broker Address
19.10.5 Property : Consumers Per Delivery Queue
19.10.6 Property : Matching Queue Consumers
19.11.0 Credentials
19.11.1 Property : Password Encoding Scheme
19.11.2 Property : Cache Successful Credentials
19.11.3 Property : Case - Sensitive Usernames
19.11.4 Property : Case - Sensitive Passwords
19.11.5 Property : Create Unknown Users
19.11.6 Property : Minimum Password Requirements
19.11.7 Property : Password Mismatch Error
19.12.0 Cross-Origin Resource Sharing (CORS)
19.12.1 Property : CORS Enabled
19.12.2 Property : CORS Origins
19.13.0 Database
19.13.1 Property : Database Type
19.13.2 Property : Database Connection URL
19.13.3 Property : Database Username
19.13.4 Property : Database Password
19.13.5 Property : Schema Update Mode
19.13.6 Property : Min Idle Connections
19.13.7 Property : Max Idle Connections
19.13.8 Property : Max Total Connections
19.13.9 Property : Max Wait (Seconds)
19.13.10 Property : Default Query Timeout (Seconds)
19.13.11 Property : Pool Prepared Statements
19.14.0 ETL Import: CSV Properties
19.14.1 Property : CSV File Delimiter
19.14.2 Property : Parse Quotes
19.15.0 ETL Import: Source
19.15.1 Property : Import Source
19.15.2 Property : Mapping Script
19.15.3 Property : Worker Thread Count
19.15.4 Property : Worker Row Hashing Function
19.16.0 FHIR Configuration
19.16.1 Property : Allow Multiple Delete Enabled
19.16.2 Property : Allow Inline Match URL References Enabled
19.16.3 Property : Allow External References Enabled
19.16.4 Property : Enforce Referential Integrity on Write
19.16.5 Property : Enforce Referential Integrity on Delete
19.16.6 Property : Auto - Create Placeholder Reference Targets
19.16.7 Property : Mark Resources for Reindexing after SearchParameter change
19.16.8 Property : Server ID Mode
19.16.9 Property : Client ID Mode
19.16.10 Property : Enforce Reference Target Types
19.16.11 Property : Expunge Operation Enabled
19.17.0 FHIR Endpoint Conversion
19.17.1 Property : Versioned API Mode
19.18.0 FHIR Gateway Target
19.19.0 FHIR Gateway Cache
19.20.0 FHIR Multitenancy
19.20.1 Property : Multitenancy Mode
19.20.2 Property : Tenant IDs
19.21.0 FHIR Performance
19.21.1 Property : Reuse Cached Results Timeout (Millis)
19.21.2 Property : Expire Search Results After Minutes
19.21.3 Property : Index Missing Search Params
19.21.4 Property : Default Total Calculation Mode
19.21.5 Property : Suppress Scheduled Maintenance Jobs
19.22.0 FHIR Resource Types
19.22.1 Property : Resource Types (whitelist)
19.23.0 FHIR REST Endpoint
19.23.1 Property : Fixed Value for Endpoint Base URL
19.23.2 Property : Pretty - Print by Default
19.23.3 Property : Default Encoding
19.23.4 Property : Default Prefer Return
19.23.5 Property : Interceptor Bean Types
19.23.6 Property : Serve Raw Media Resources
19.24.0 FHIR Search
19.24.1 Property : Fetch Size (Default Maximum)
19.24.2 Property : Page Size (Default)
19.24.3 Property : Page Size (Maximum)
19.24.4 Property : Allow : contains Searches
19.25.0 FHIR Interceptors
19.25.1 Property : Interceptor Bean Types
19.25.2 Property : FHIR storage Callback Script (Text)
19.25.3 Property : FHIR storage Callback Script (File)
19.26.0 FHIR Subscription
19.26.1 Property : REST Hook Subscription Enabled
19.26.2 Property : Email Subscription Enabled
19.26.3 Property : Email SMTP Hostname
19.26.4 Property : Email SMTP Port
19.26.5 Property : Email SMTP Username
19.26.6 Property : Email SMTP Password
19.26.7 Property : Kafka Subscription Enabled
19.26.8 Property : Kafka Topic
19.26.9 Property : Kafka Bootstrap Address
19.27.0 HL7 v2.x to FHIR Mapper - Forced Namespace Mode
19.27.1 Property : Forced Namespace Mode : Patient System
19.27.2 Property : Forced Namespace Mode : Encounter System
19.28.0 HL7 v2.x to FHIR Mapper - General
19.28.1 Property : Inferred TimeZone When Not Present
19.28.2 Property : Creation Mode - Practitioner
19.28.3 Property : Patient Primary Identifier Search Parameter
19.28.4 Property : Mapper Bean Types
19.29.0 HL7 v2.x Mapper - Medications
19.29.1 Property : Use Standalone Medications with Administered Code
19.29.2 Property : Use Standalone Medications with Component Code
19.29.3 Property : Use Standalone Medications with Give Code
19.30.0 HL7 v2.x to FHIR Mapper - OBR
19.30.1 Property : Observation Identification Mode
19.30.2 Property : Use <strong> OBR - 2 </strong> as Primary Identifier
19.30.3 Property : Use <strong> OBR - 3 </strong> as Primary Identifier
19.31.0 HL7 v2.x to FHIR Mapper - OBSERVATION Group
19.31.1 Property : OBSERVATION Group Text Delimiter - OBX
19.31.2 Property : OBSERVATION Group Text Delimiter - NTE
19.32.0 HL7 v2.x to FHIR Mapper - ORDER_OBSERVATION Group
19.32.1 Property : ORDER _ OBSERVATION Group Text Delimiter - NTE
19.33.0 HL7 v2.x to FHIR Mapper - PV1
19.33.1 Property : Treat <strong> PV1 - 3 </strong> and <strong> PV1 - 6 </strong> Patient Locations as Single Atomic Locations
19.34.0 HL7 v2.x Listener Script
19.34.1 Property : Listener Processing Script (Text)
19.34.2 Property : Listener Processing Script (File)
19.35.0 HL7 v2.x MLLP Listener
19.35.1 Property : HL7 v2 . x Listener Port
19.35.2 Property : Charset : Respect MSH - 18
19.35.3 Property : Charset : Forced
19.35.4 Property : Unprocessable Message Handling
19.36.0 FHIR to HL7 v2.x Mapper Script
19.36.1 Property : HL7 v2 . x Conversion Mapper Script (Text)
19.36.2 Property : HL7 v2 . x Conversion Mapper Script (File)
19.37.0 HL7 v2.x MLLP Sender
19.37.1 Property : HL7 v2 . x Destination Host
19.37.2 Property : HL7 v2 . x Destination Port
19.37.3 Property : Send Timeout (millis)
19.37.4 Property : Map Identifiers using NamingSystem
19.37.5 Property : Use Persisted Message Headers
19.37.6 Property : Retry message on NAK
19.37.7 Property : Delay Between Failed Deliveries (millis)
19.38.0 HTTP Access Log
19.38.1 Property : Appenders
19.39.0 HTTP Listener
19.39.1 Property : Listener Port
19.39.2 Property : Context Path
19.39.3 Property : Respect Forward Headers
19.40.0 HTTP Request Pool
19.40.1 Property : Thread Pool Minimum Size
19.40.2 Property : Thread Pool Maximum Size
19.41.0 HTTP Security
19.41.1 Property : Pin Host
19.41.2 Property : Suppress Platform Information
19.41.3 Property : Suppress Error Details
19.41.4 Property : Block HTTP HEAD
19.41.5 Property : Block HTTP OPTIONS
19.41.6 Property : Frame Options (Allow From)
19.42.0 Hybrid Providers Definitions
19.42.1 Property : Spring Context Config Class
19.42.2 Property : FHIR Version
19.43.0 Initial User Seeding
19.43.1 Property : Initial Seed Username
19.43.2 Property : Initial Seed Password
19.44.0 JSON Web KeySet (JWKS)
19.44.1 Property : Signing JWKS (File)
19.44.2 Property : Signing JWKS (Text)
19.44.3 Property : Signing Key ID
19.45.0 LDAP Authentication
19.45.1 Property : LDAP Server URL
19.45.2 Property : System User DN
19.45.3 Property : System User Password
19.45.4 Property : Native Permission User Attribute
19.45.5 Property : User Attribute : Given Name
19.45.6 Property : User Attribute : Family Name
19.45.7 Property : Global Permissions
19.45.8 Property : Base DN for Groups
19.45.9 Property : Search Groups Recursively
19.45.10 Property : Authentication : User Base DN
19.45.11 Property : Authentication : User Query
19.45.12 Property : Require Group DN
19.46.0 Lucene FullText Indexing
19.46.1 Property : Lucene Enabled
19.46.2 Property : Lucene Index Directory
19.46.3 Property : FullText Index Delay (Secs)
19.46.4 Property : FullText Indexing Pass Size
19.46.5 Property : Use In - Memory Lucene Indexing Only
19.47.0 Narrative Generator
19.48.0 OpenID Connect (OIC)
19.48.1 Property : Client Secret Encoding
19.48.2 Property : Issuer URL
19.48.3 Property : Cache Authorizations (millis)
19.49.0 Request Validating
19.49.1 Property : Request Validating Enabled
19.49.2 Property : Fail On Severity
19.49.3 Property : Validation Tags Enabled
19.49.4 Property : Validation Response Headers Enabled
19.49.5 Property : Require Explicit Profile Definition Enabled
19.50.0 Inbound SMART on FHIR Authentication
19.50.1 Property : Trust Intra - Cluster SMART Tokens from Module (s)
19.50.2 Property : Authentication Cache Timeout (Seconds)
19.50.3 Property : Prevent Token KeyID Reuse
19.50.4 Property : Require Key Expiry
19.51.0 Inbound SMART on FHIR Endpoints
19.51.1 Property : Token Endpoint
19.51.2 Property : Authorization Endpoint
19.52.0 Security Inbound Script
19.52.1 Property : Script (Text)
19.52.2 Property : Script (File)
19.53.0 Sessions
19.53.1 Property : Use In - Memory Sessions
19.53.2 Property : Session Timeout (Mins)
19.53.3 Property : Session Scavenger Interval (Millis)
19.54.0 SMART Outbound Security: Callback Script
19.54.1 Property : Post Authorization Script (Text)
19.54.2 Property : Post Authorization Script (File)
19.55.0 SMART Outbound Security: CODAP
19.55.1 Property : Enable Cross - Organization Data Access Profile
19.55.2 Property : CODAP Authorization Script (Text)
19.55.3 Property : CODAP Authorization Script (File)
19.56.0 SMART Outbound Security: Login Skin
19.56.1 Property : WebJar ID
19.56.2 Property : Login Page Template
19.56.3 Property : Approval Page Template
19.56.4 Property : Error Page Template
19.57.0 TLS / SSL (Encryption)
19.57.1 Property : TLS Enabled
19.57.2 Property : TLS KeyStore Filename
19.57.3 Property : TLS KeyStore Password
19.57.4 Property : TLS KeyStore Key Alias
19.57.5 Property : TLS KeyStore Key Password
19.57.6 Property : TLS Client Authentication
19.57.7 Property : TLS TrustStore Filename
19.57.8 Property : TLS TrustStore Password
19.57.9 Property : TLS Cipher Whitelist
19.57.10 Property : TLS Cipher Blacklist
19.57.11 Property : TLS Protocol Whitelist
19.57.12 Property : TLS Protocol Blacklist
19.58.0 Trusted Client
19.58.1 Property : Trusted Client Mode Enabled
19.58.2 Property : Assert Permissions
19.59.0 Miscellaneous Categories
19.59.1 Additional Configuration
19.59.2 Dependencies
20.0.0 Smile CDR CLI (smileutil)
20.1.0 Introduction
20.2.0 HL7 v2.x Analyze Flat File
20.2.1 Usage
20.2.2 Options
20.3.0 Migrate Database
20.3.1 Options
20.3.2 Examples
20.4.0 HL7 v2.x Transmit Flat File
20.4.1 Usage
20.4.2 Options
20.5.0 Synchronize FHIR Servers
20.5.1 Usage
20.5.2 Options
20.5.3 Selecting Resources to Synchronize
20.5.4 Using a Search as the Source
20.5.5 Using a Directory as the Source
20.5.6 Prefixing Numeric IDs
20.5.7 Synchronization Modes
20.5.8 Uploading Synthea (Synthetic Generated) Resources
20.5.9 Setting up a Resource Gold Master
20.6.0 Upload Sample Dataset
20.6.1 Usage
20.6.2 Options
20.7.0 Upload CSV Bulk Import File
20.7.1 Usage
20.7.2 Options
20.7.3 Sending Batches for a Single File
20.8.0 Upload Terminology
20.8.1 Usage
20.8.2 Options
20.9.0 Validate FHIR Resources
20.9.1 Usage
20.9.2 Options
20.9.3 Profile Mode
20.9.4 Schema and Schematron Mode
20.10.0 Import CSV to ConceptMap
20.10.1 Usage
20.10.2 Options
20.11.0 Export ConceptMap to CSV
20.11.1 Usage
20.11.2 Options
21.0.0 Product Reference
21.1.0 Enumerated Types
21.1.1 Node And Module Status
21.1.2 Transaction Log Event Types
21.1.3 Transaction Log Event SubTypes
21.1.4 Transaction Log Outcomes
21.1.5 Module Types
22.0.0 Appendix
22.1.0 Preparing a Linux Host
22.1.1 Ubuntu Host with PostgreSQL / NGINX / Letsencrypt
22.1.2 Install letsencrypt and obtain Certs (optional)
22.1.3 Install nginx And Configure it to Front the Server
22.1.4 Red Hat Enterprise Linux (RHEL) or CentOS
22.2.0 Troubleshooting Logs
22.2.1 HTTP Troubleshooting Log
22.2.2 Security Troubleshooting Log
22.2.3 Subscription Troubleshooting Log