Smile CDR v2023.11.PRE
On this page:
   43.56    Repository Validation
  • Configuration Categories
  • 43.0 Web Admin Console Settings
  • 43.1 appSphere
  • 43.2 Payer Config
  • 43.3 Initial appSphere Seeding
  • 43.4 Authentication Callback Scripts
  • 43.5 Auth: General for APIs
  • 43.6 User Authentication
  • 43.7 Auth: HTTP Basic
  • 43.8 Auth: OpenID Connect
  • 43.9 Browser Syntax Highlighting
  • 43.10 Camel
  • 43.11 Capability Statement (metadata)
  • 43.12 Care Gaps
  • 43.13 CDA Generation
  • 43.14 CDA Import
  • 43.15 CDA Interceptors
  • 43.16 CDA JavaScript Execution Scripts
  • 43.17 CDA Terminology
  • 43.18 CDS Hooks Definitions
  • 43.19 Channel Import
  • 43.20 Channel Retry
  • 43.21 Kafka
  • 43.22 Cluster Manager Maintenance
  • 43.23 Message Broker
  • 43.24 Cluster Level Security
  • 43.25 CQL
  • 43.26 Credentials
  • 43.27 Cross-Origin Resource Sharing (CORS)
  • 43.28 Database
  • 43.29 Da Vinci Health Record Exchange
  • 43.30 DQM
  • 43.31 DTR
  • 43.32 Email Configuration
  • 43.33 Encounter Start CDS hook configuration
  • 43.34 MDM UI
  • 43.35 ETL Import: CSV Properties
  • 43.36 ETL Import: Source
  • 43.37 FHIR Binary Storage
  • 43.38 FHIR Bulk Operations
  • 43.39 Capability Statement
  • 43.40 FHIR Configuration
  • 43.41 Consent Service
  • 43.42 FHIR Endpoint Conversion
  • 43.43 FHIR Endpoint HFQL Support
  • 43.44 Interceptors
  • 43.45 FHIR Endpoint Partitioning
  • 43.46 Resource Providers
  • 43.47 FHIR Endpoint Security
  • 43.48 Endpoint Terminology
  • 43.49 FHIR Gateway Configuration
  • 43.50 FHIR Interceptors
  • 43.51 LiveBundle Service
  • 43.52 FHIR MDM Server
  • 43.53 FHIR Performance
  • 43.54 FHIR Performance Tracing
  • 43.55 FHIR Realtime Export
  • 43.56 Repository Validation
  • 43.57 FHIR Resource Types
  • 43.58 FHIR REST Endpoint
  • 43.59 FHIR Search
  • 43.60 Custom Resource Types
  • 43.61 IG Support
  • 43.62 MegaScale
  • 43.63 FHIR Storage Module Conditional Updates
  • 43.64 FHIR Storage Module Scheduled Tasks
  • 43.65 FHIR Validation Services
  • 43.66 FHIR Storage Package Registry
  • 43.67 FHIR Storage Partitioning
  • 43.68 Versioned References
  • 43.69 FHIR Subscription Delivery
  • 43.70 FHIR Subscription Persistence
  • 43.71 Amazon HealthLake REST Endpoint
  • 43.72 HL7 v2.x Mapper - Contained Resource
  • 43.73 HL7 v2.x Mapper - DG1
  • 43.74 HL7 v2.x Mapper - Forced Namespace Mode
  • 43.75 HL7 v2.x Mapper - General
  • 43.76 HL7 v2.x Mapper - Medications
  • 43.77 HL7 v2.x Mapper - OBR
  • 43.78 HL7 v2.x to FHIR Mapper - OBSERVATION Group
  • 43.79 HL7 v2.x to FHIR Mapper - ORDER_OBSERVATION Group
  • 43.80 HL7 v2.x Mapper - PID
  • 43.81 HL7 v2.x Mapper - PV1
  • 43.82 Listener Interceptors
  • 43.83 HL7 v2.x Listener Script
  • 43.84 HL7 v2.x MLLP Listener
  • 43.85 HL7 v2.x MLLP Sender
  • 43.86 FHIR to HL7 v2.x Mapper Script
  • 43.87 HL7 v2.x Outbound Mapping
  • 43.88 Da Vinci Health Record Exchange (HRex)
  • 43.89 HTTP Access Log
  • 43.90 HTTP Listener
  • 43.91 HTTP Request Pool
  • 43.92 HTTP Security
  • 43.93 Hybrid Providers Definitions
  • 43.94 Initial User Seeding
  • 43.95 JavaScript Execution Environment
  • 43.96 JSON Web KeySet (JWKS)
  • 43.97 LDAP Authentication
  • 43.98 Smile CDR License
  • 43.99 Lucene FullText Indexing
  • 43.100 MDM
  • 43.101 Narrative Generator
  • 43.102 OpenID Connect Token Validation
  • 43.103 OpenID Connect (OIDC)
  • 43.104 Order Sign CDS hook configuration
  • 43.105 Payer to Payer
  • 43.106 Prior Authorization Coverage Requirement Discovery
  • 43.107 Privacy Security Notice
  • 43.108 Provenance Injection
  • 43.109 Realtime Export
  • 43.110 Endpoint Validation: Request Validating
  • 43.111 Scheduler Configuration
  • 43.112 Search Parameter Seeding
  • 43.113 SAML Provider
  • 43.114 Security Inbound Script
  • 43.115 Inbound SMART on FHIR Authentication
  • 43.116 Inbound SMART on FHIR Endpoints
  • 43.117 OAuth2/OIDC Federation
  • 43.118 SMART Callback Script
  • 43.119 Cross-Organizational Data Access Profile
  • 43.120 SMART Login Skin
  • 43.121 SMART Login Terms of Service
  • 43.122 SMART Authorization
  • 43.123 SMART Definitions Seeding
  • 43.124 Sessions
  • 43.125 Two Factor Authentication
  • 43.126 TLS / SSL (Encryption)
  • 43.127 Transaction Log
  • 43.128 Trusted Client
  • 43.129 User Self Registration
    • 43.58    FHIR REST Endpoint   
       Table of Contents

    FHIR Resource Types

    43.57.1FHIR Resource Types

     

    The FHIR Resource Types configuration category includes the following configurable options:

    • Instance/Type History Enabled

    • Server History Enabled

    • Resource Types (whitelist)

    43.57.2Property: Instance/Type History Enabled

     
    Property Name Instance/Type History Enabled
    Property Key
    Property Type BOOLEAN
    Description If this setting is disabled, instance- and type-level history operations will be disabled. This means that change history will not be stored, which improves write performance.
    Applies to Modules
    • FHIR Storage (MongoDB)
    Default Value true
    Example Property 
    module.[MODULE_ID].config.history.instance.enabled = true

    43.57.3Property: Server History Enabled

     
    Property Name Server History Enabled
    Property Key
    Property Type BOOLEAN
    Description If this setting is disabled, server-level history operations will be disabled. This means that change history will not be stored, which improves write performance.
    Applies to Modules
    • FHIR Storage (MongoDB)
    Default Value true
    Example Property 
    module.[MODULE_ID].config.history.server.enabled = true

    43.57.4Property: Resource Types (whitelist)

     
    Property Name Resource Types (whitelist)
    Property Key
    Property Type STRING
    Description This property may be used to specify a comma-separated list of FHIR Resource types to be supported by this persistence module (e.g. Patient,Encounter,Practitioner). This configuration is required for MongoDB but optional for RDBMS implementations. For RDBMS implementations, leaving this configuration as null is the same as listing all resources supported by Smile CDR. Setting this parameter will constrain the resource types included in the capability statement for any endpoint pointing to this persistence module. As well, FHIR REST requests on the endpoint will be restricted to the resource types listed here. Note though that this parameter does not affect Bundle requests nor non-REST ingestion operations (e.g. ETL import).
    Applies to Modules
    • FHIR Storage (DSTU2 RDBMS)
    • FHIR Storage (MongoDB)
    • FHIR Storage (R3 RDBMS)
    • FHIR Storage (R4 RDBMS)
    • FHIR Storage (R5 RDBMS)
    Default Value Patient,Observation,Encounter,DiagnosticReport,Claim,ExplanationOfBenefit,Coverage,List
    Example Property 
    module.[MODULE_ID].config.resource_types.supported.whitelist = Patient,Observation,Encounter,DiagnosticReport,Claim,ExplanationOfBenefit,Coverage,List
       43.56    Repository Validation
  • Configuration Categories
  • 43.0 Web Admin Console Settings
  • 43.1 appSphere
  • 43.2 Payer Config
  • 43.3 Initial appSphere Seeding
  • 43.4 Authentication Callback Scripts
  • 43.5 Auth: General for APIs
  • 43.6 User Authentication
  • 43.7 Auth: HTTP Basic
  • 43.8 Auth: OpenID Connect
  • 43.9 Browser Syntax Highlighting
  • 43.10 Camel
  • 43.11 Capability Statement (metadata)
  • 43.12 Care Gaps
  • 43.13 CDA Generation
  • 43.14 CDA Import
  • 43.15 CDA Interceptors
  • 43.16 CDA JavaScript Execution Scripts
  • 43.17 CDA Terminology
  • 43.18 CDS Hooks Definitions
  • 43.19 Channel Import
  • 43.20 Channel Retry
  • 43.21 Kafka
  • 43.22 Cluster Manager Maintenance
  • 43.23 Message Broker
  • 43.24 Cluster Level Security
  • 43.25 CQL
  • 43.26 Credentials
  • 43.27 Cross-Origin Resource Sharing (CORS)
  • 43.28 Database
  • 43.29 Da Vinci Health Record Exchange
  • 43.30 DQM
  • 43.31 DTR
  • 43.32 Email Configuration
  • 43.33 Encounter Start CDS hook configuration
  • 43.34 MDM UI
  • 43.35 ETL Import: CSV Properties
  • 43.36 ETL Import: Source
  • 43.37 FHIR Binary Storage
  • 43.38 FHIR Bulk Operations
  • 43.39 Capability Statement
  • 43.40 FHIR Configuration
  • 43.41 Consent Service
  • 43.42 FHIR Endpoint Conversion
  • 43.43 FHIR Endpoint HFQL Support
  • 43.44 Interceptors
  • 43.45 FHIR Endpoint Partitioning
  • 43.46 Resource Providers
  • 43.47 FHIR Endpoint Security
  • 43.48 Endpoint Terminology
  • 43.49 FHIR Gateway Configuration
  • 43.50 FHIR Interceptors
  • 43.51 LiveBundle Service
  • 43.52 FHIR MDM Server
  • 43.53 FHIR Performance
  • 43.54 FHIR Performance Tracing
  • 43.55 FHIR Realtime Export
  • 43.56 Repository Validation
  • 43.57 FHIR Resource Types
  • 43.58 FHIR REST Endpoint
  • 43.59 FHIR Search
  • 43.60 Custom Resource Types
  • 43.61 IG Support
  • 43.62 MegaScale
  • 43.63 FHIR Storage Module Conditional Updates
  • 43.64 FHIR Storage Module Scheduled Tasks
  • 43.65 FHIR Validation Services
  • 43.66 FHIR Storage Package Registry
  • 43.67 FHIR Storage Partitioning
  • 43.68 Versioned References
  • 43.69 FHIR Subscription Delivery
  • 43.70 FHIR Subscription Persistence
  • 43.71 Amazon HealthLake REST Endpoint
  • 43.72 HL7 v2.x Mapper - Contained Resource
  • 43.73 HL7 v2.x Mapper - DG1
  • 43.74 HL7 v2.x Mapper - Forced Namespace Mode
  • 43.75 HL7 v2.x Mapper - General
  • 43.76 HL7 v2.x Mapper - Medications
  • 43.77 HL7 v2.x Mapper - OBR
  • 43.78 HL7 v2.x to FHIR Mapper - OBSERVATION Group
  • 43.79 HL7 v2.x to FHIR Mapper - ORDER_OBSERVATION Group
  • 43.80 HL7 v2.x Mapper - PID
  • 43.81 HL7 v2.x Mapper - PV1
  • 43.82 Listener Interceptors
  • 43.83 HL7 v2.x Listener Script
  • 43.84 HL7 v2.x MLLP Listener
  • 43.85 HL7 v2.x MLLP Sender
  • 43.86 FHIR to HL7 v2.x Mapper Script
  • 43.87 HL7 v2.x Outbound Mapping
  • 43.88 Da Vinci Health Record Exchange (HRex)
  • 43.89 HTTP Access Log
  • 43.90 HTTP Listener
  • 43.91 HTTP Request Pool
  • 43.92 HTTP Security
  • 43.93 Hybrid Providers Definitions
  • 43.94 Initial User Seeding
  • 43.95 JavaScript Execution Environment
  • 43.96 JSON Web KeySet (JWKS)
  • 43.97 LDAP Authentication
  • 43.98 Smile CDR License
  • 43.99 Lucene FullText Indexing
  • 43.100 MDM
  • 43.101 Narrative Generator
  • 43.102 OpenID Connect Token Validation
  • 43.103 OpenID Connect (OIDC)
  • 43.104 Order Sign CDS hook configuration
  • 43.105 Payer to Payer
  • 43.106 Prior Authorization Coverage Requirement Discovery
  • 43.107 Privacy Security Notice
  • 43.108 Provenance Injection
  • 43.109 Realtime Export
  • 43.110 Endpoint Validation: Request Validating
  • 43.111 Scheduler Configuration
  • 43.112 Search Parameter Seeding
  • 43.113 SAML Provider
  • 43.114 Security Inbound Script
  • 43.115 Inbound SMART on FHIR Authentication
  • 43.116 Inbound SMART on FHIR Endpoints
  • 43.117 OAuth2/OIDC Federation
  • 43.118 SMART Callback Script
  • 43.119 Cross-Organizational Data Access Profile
  • 43.120 SMART Login Skin
  • 43.121 SMART Login Terms of Service
  • 43.122 SMART Authorization
  • 43.123 SMART Definitions Seeding
  • 43.124 Sessions
  • 43.125 Two Factor Authentication
  • 43.126 TLS / SSL (Encryption)
  • 43.127 Transaction Log
  • 43.128 Trusted Client
  • 43.129 User Self Registration
    • 43.58    FHIR REST Endpoint