Smile CDR v2024.08.PRE
On this page:
   46.43    FHIR Configuration
  • Configuration Categories
  • 46.0 Web Admin Console Settings
  • 46.1 appSphere
  • 46.2 Payer Config
  • 46.3 Initial appSphere Seeding
  • 46.4 Authentication Callback Scripts
  • 46.5 Auth: General for APIs
  • 46.6 User Authentication
  • 46.7 Auth: HTTP Basic
  • 46.8 Auth: OpenID Connect
  • 46.9 Browser Syntax Highlighting
  • 46.10 Camel
  • 46.11 Capability Statement (metadata)
  • 46.12 Care Gaps
  • 46.13 CDA Generation
  • 46.14 CDA Import
  • 46.15 CDA Interceptors
  • 46.16 CDA JavaScript Execution Scripts
  • 46.17 CDA Terminology
  • 46.18 CDS Hooks Definitions
  • 46.19 CDS Hooks On FHIR
  • 46.20 Channel Import
  • 46.21 Channel Retry
  • 46.22 Kafka
  • 46.23 Cluster Manager Maintenance
  • 46.24 Message Broker
  • 46.25 Cluster Level Security
  • 46.26 CQL
  • 46.27 Credentials
  • 46.28 Cross-Origin Resource Sharing (CORS)
  • 46.29 System to System Data Exchange
  • 46.30 Database
  • 46.31 Da Vinci Health Record Exchange
  • 46.32 DQM
  • 46.33 DTR
  • 46.34 EasyShare SMART Health Links
  • 46.35 Email Configuration
  • 46.36 Encounter Start CDS hook configuration
  • 46.37 MDM UI
  • 46.38 ETL Import: CSV Properties
  • 46.39 ETL Import: Source
  • 46.40 FHIR Binary Storage
  • 46.41 FHIR Bulk Operations
  • 46.42 Capability Statement
  • 46.43 FHIR Configuration
  • 46.44 Consent Service
  • 46.45 FHIR Endpoint Conversion
  • 46.46 FHIR Endpoint HFQL Support
  • 46.47 FHIR Endpoint Partitioning
  • 46.48 Resource Providers
  • 46.49 FHIR Endpoint Security
  • 46.50 Endpoint Terminology
  • 46.51 FHIR Gateway Cache
  • 46.52 FHIR Gateway Configuration
  • 46.53 FHIR Interceptors
  • 46.54 LiveBundle Service
  • 46.55 FHIR MDM Server
  • 46.56 FHIR Performance
  • 46.57 FHIR Performance Tracing
  • 46.58 FHIR Realtime Export
  • 46.59 Repository Validation
  • 46.60 FHIR Resource Types
  • 46.61 FHIR REST Endpoint
  • 46.62 FHIR Search
  • 46.63 Custom Resource Types
  • 46.64 IG Support
  • 46.65 MegaScale
  • 46.66 FHIR Storage Module Conditional Updates
  • 46.67 FHIR Storage Module Scheduled Tasks
  • 46.68 FHIR Validation Services
  • 46.69 FHIR Storage Package Registry
  • 46.70 FHIR Storage Partitioning
  • 46.71 Versioned References
  • 46.72 FHIR Subscription Delivery
  • 46.73 FHIR Subscription Persistence
  • 46.74 Amazon HealthLake REST Endpoint
  • 46.75 HL7 v2.x Mapper - Contained Resource
  • 46.76 HL7 v2.x Mapper - DG1
  • 46.77 HL7 v2.x Mapper - Forced Namespace Mode
  • 46.78 HL7 v2.x Mapper - General
  • 46.79 HL7 v2.x Mapper - Medications
  • 46.80 HL7 v2.x Mapper - OBR
  • 46.81 HL7 v2.x to FHIR Mapper - OBSERVATION Group
  • 46.82 HL7 v2.x Mapper - ORC
  • 46.83 HL7 v2.x to FHIR Mapper - ORDER_OBSERVATION Group
  • 46.84 HL7 v2.x Mapper - PID
  • 46.85 HL7 v2.x Mapper - PV1
  • 46.86 Listener Interceptors
  • 46.87 HL7 v2.x Listener Script
  • 46.88 HL7 v2.x Listening Endpoint
  • 46.89 HL7 v2.x MLLP Listener
  • 46.90 HL7 v2.x MLLP Sender
  • 46.91 FHIR to HL7 v2.x Mapper Script
  • 46.92 HL7 v2.x Outbound Mapping
  • 46.93 HTTP Access Log
  • 46.94 HTTP Listener
  • 46.95 HTTP Request Pool
  • 46.96 HTTP Security
  • 46.97 Hybrid Providers Definitions
  • 46.98 IG Support
  • 46.99 Initial User Seeding
  • 46.100 JavaScript Execution Environment
  • 46.101 JSON Web KeySet (JWKS)
  • 46.102 LDAP Authentication
  • 46.103 Smile CDR License
  • 46.104 Lucene FullText Indexing
  • 46.105 MDM
  • 46.106 Narrative Generator
  • 46.107 OpenID Connect Token Validation
  • 46.108 OpenID Connect (OIDC)
  • 46.109 Order Sign CDS hook configuration
  • 46.110 Payer to Payer
  • 46.111 Prior Authorization Coverage Requirement Discovery
  • 46.112 Prior Authorization Support
  • 46.113 Privacy Security Notice
  • 46.114 Provenance Injection
  • 46.115 Quality Payment Program (QPP)
  • 46.116 Realtime Export
  • 46.117 Endpoint Validation: Request Validating
  • 46.118 Scheduler Configuration
  • 46.119 Search Parameter Seeding
  • 46.120 SAML Provider
  • 46.121 Security Inbound Script
  • 46.122 Inbound SMART on FHIR Authentication
  • 46.123 Inbound SMART on FHIR Endpoints
  • 46.124 OAuth2/OIDC Federation
  • 46.125 SMART Callback Script
  • 46.126 Cross-Organizational Data Access Profile
  • 46.127 SMART Login Skin
  • 46.128 SMART Login Terms of Service
  • 46.129 SMART Authorization
  • 46.130 SMART Definitions Seeding
  • 46.131 Sessions
  • 46.132 Two Factor Authentication
  • 46.133 TLS / SSL (Encryption)
  • 46.134 Transaction Log
  • 46.135 Trusted Client
  • 46.136 User Self Registration
    • 46.45    FHIR Endpoint Conversion   
       Table of Contents

    Consent Service

    46.44.1Consent Service

     

    The Consent Service configuration category includes the following configurable options:

    • Consent Service Enabled

    • Java Consent Service Types

    • Consent Service Script (File)

    • Consent Service Script (Text)

    46.44.2Property: Consent Service Enabled

     
    Property Name Consent Service Enabled
    Property Key
    Property Type BOOLEAN
    Description This is a switch to enable or disable the consent service for this module.
    Applies to Modules
    • FHIR Gateway REST Endpoint
    • FHIR REST Endpoint (All FHIR Versions)
    • FHIR REST Endpoint (DSTU2 - Deprecated)
    • FHIR REST Endpoint (R3 - Deprecated)
    • FHIR REST Endpoint (R4 - Deprecated)
    • FHIR Storage (DSTU2 RDBMS)
    • FHIR Storage (MongoDB)
    • FHIR Storage (R3 RDBMS)
    • FHIR Storage (R4 RDBMS)
    • FHIR Storage (R5 RDBMS)
    • Hybrid Providers REST Endpoint
    Default Value false
    Example Property 
    module.[MODULE_ID].config.consent_service.enabled = false

    46.44.3Property: Java Consent Service Types

     
    Property Name Java Consent Service Types
    Property Key
    Property Type STRING_MULTILINE
    Description If set, provides a whitespace or comma separated list of Java class names to instantiate and use as consent service implementations. See Consent Service: Java API for more information. Note that if both JavaScript and Java based implementations are provided, the JavaScript implementations will be invoked first.
    Applies to Modules
    • FHIR Gateway REST Endpoint
    • FHIR REST Endpoint (All FHIR Versions)
    • FHIR REST Endpoint (DSTU2 - Deprecated)
    • FHIR REST Endpoint (R3 - Deprecated)
    • FHIR REST Endpoint (R4 - Deprecated)
    • FHIR Storage (DSTU2 RDBMS)
    • FHIR Storage (MongoDB)
    • FHIR Storage (R3 RDBMS)
    • FHIR Storage (R4 RDBMS)
    • FHIR Storage (R5 RDBMS)
    • Hybrid Providers REST Endpoint
    Default Value (no default)
    Example Property 
    module.[MODULE_ID].config.consent_service.java_types =

    46.44.4Property: Consent Service Script (File)

     
    Property Name Consent Service Script (File)
    Property Key
    Property Type Resource Path
    Description If set, supplies a set of callback functions that will be executed for the consent service. Values should be prefixed with file: or classpath:.
    Applies to Modules
    • FHIR Gateway REST Endpoint
    • FHIR REST Endpoint (All FHIR Versions)
    • FHIR REST Endpoint (DSTU2 - Deprecated)
    • FHIR REST Endpoint (R3 - Deprecated)
    • FHIR REST Endpoint (R4 - Deprecated)
    • FHIR Storage (DSTU2 RDBMS)
    • FHIR Storage (MongoDB)
    • FHIR Storage (R3 RDBMS)
    • FHIR Storage (R4 RDBMS)
    • FHIR Storage (R5 RDBMS)
    • Hybrid Providers REST Endpoint
    Default Value (no default)
    Example Property 
    module.[MODULE_ID].config.consent_service.script.file =

    46.44.5Property: Consent Service Script (Text)

     
    Property Name Consent Service Script (Text)
    Property Key
    Property Type JAVASCRIPT
    Description If set, supplies a set of callback functions that will be executed for the consent service.
    Applies to Modules
    • FHIR Gateway REST Endpoint
    • FHIR REST Endpoint (All FHIR Versions)
    • FHIR REST Endpoint (DSTU2 - Deprecated)
    • FHIR REST Endpoint (R3 - Deprecated)
    • FHIR REST Endpoint (R4 - Deprecated)
    • FHIR Storage (DSTU2 RDBMS)
    • FHIR Storage (MongoDB)
    • FHIR Storage (R3 RDBMS)
    • FHIR Storage (R4 RDBMS)
    • FHIR Storage (R5 RDBMS)
    • Hybrid Providers REST Endpoint
    Default Value (no default)
    Example Property 
    module.[MODULE_ID].config.consent_service.script.text =
       46.43    FHIR Configuration
  • Configuration Categories
  • 46.0 Web Admin Console Settings
  • 46.1 appSphere
  • 46.2 Payer Config
  • 46.3 Initial appSphere Seeding
  • 46.4 Authentication Callback Scripts
  • 46.5 Auth: General for APIs
  • 46.6 User Authentication
  • 46.7 Auth: HTTP Basic
  • 46.8 Auth: OpenID Connect
  • 46.9 Browser Syntax Highlighting
  • 46.10 Camel
  • 46.11 Capability Statement (metadata)
  • 46.12 Care Gaps
  • 46.13 CDA Generation
  • 46.14 CDA Import
  • 46.15 CDA Interceptors
  • 46.16 CDA JavaScript Execution Scripts
  • 46.17 CDA Terminology
  • 46.18 CDS Hooks Definitions
  • 46.19 CDS Hooks On FHIR
  • 46.20 Channel Import
  • 46.21 Channel Retry
  • 46.22 Kafka
  • 46.23 Cluster Manager Maintenance
  • 46.24 Message Broker
  • 46.25 Cluster Level Security
  • 46.26 CQL
  • 46.27 Credentials
  • 46.28 Cross-Origin Resource Sharing (CORS)
  • 46.29 System to System Data Exchange
  • 46.30 Database
  • 46.31 Da Vinci Health Record Exchange
  • 46.32 DQM
  • 46.33 DTR
  • 46.34 EasyShare SMART Health Links
  • 46.35 Email Configuration
  • 46.36 Encounter Start CDS hook configuration
  • 46.37 MDM UI
  • 46.38 ETL Import: CSV Properties
  • 46.39 ETL Import: Source
  • 46.40 FHIR Binary Storage
  • 46.41 FHIR Bulk Operations
  • 46.42 Capability Statement
  • 46.43 FHIR Configuration
  • 46.44 Consent Service
  • 46.45 FHIR Endpoint Conversion
  • 46.46 FHIR Endpoint HFQL Support
  • 46.47 FHIR Endpoint Partitioning
  • 46.48 Resource Providers
  • 46.49 FHIR Endpoint Security
  • 46.50 Endpoint Terminology
  • 46.51 FHIR Gateway Cache
  • 46.52 FHIR Gateway Configuration
  • 46.53 FHIR Interceptors
  • 46.54 LiveBundle Service
  • 46.55 FHIR MDM Server
  • 46.56 FHIR Performance
  • 46.57 FHIR Performance Tracing
  • 46.58 FHIR Realtime Export
  • 46.59 Repository Validation
  • 46.60 FHIR Resource Types
  • 46.61 FHIR REST Endpoint
  • 46.62 FHIR Search
  • 46.63 Custom Resource Types
  • 46.64 IG Support
  • 46.65 MegaScale
  • 46.66 FHIR Storage Module Conditional Updates
  • 46.67 FHIR Storage Module Scheduled Tasks
  • 46.68 FHIR Validation Services
  • 46.69 FHIR Storage Package Registry
  • 46.70 FHIR Storage Partitioning
  • 46.71 Versioned References
  • 46.72 FHIR Subscription Delivery
  • 46.73 FHIR Subscription Persistence
  • 46.74 Amazon HealthLake REST Endpoint
  • 46.75 HL7 v2.x Mapper - Contained Resource
  • 46.76 HL7 v2.x Mapper - DG1
  • 46.77 HL7 v2.x Mapper - Forced Namespace Mode
  • 46.78 HL7 v2.x Mapper - General
  • 46.79 HL7 v2.x Mapper - Medications
  • 46.80 HL7 v2.x Mapper - OBR
  • 46.81 HL7 v2.x to FHIR Mapper - OBSERVATION Group
  • 46.82 HL7 v2.x Mapper - ORC
  • 46.83 HL7 v2.x to FHIR Mapper - ORDER_OBSERVATION Group
  • 46.84 HL7 v2.x Mapper - PID
  • 46.85 HL7 v2.x Mapper - PV1
  • 46.86 Listener Interceptors
  • 46.87 HL7 v2.x Listener Script
  • 46.88 HL7 v2.x Listening Endpoint
  • 46.89 HL7 v2.x MLLP Listener
  • 46.90 HL7 v2.x MLLP Sender
  • 46.91 FHIR to HL7 v2.x Mapper Script
  • 46.92 HL7 v2.x Outbound Mapping
  • 46.93 HTTP Access Log
  • 46.94 HTTP Listener
  • 46.95 HTTP Request Pool
  • 46.96 HTTP Security
  • 46.97 Hybrid Providers Definitions
  • 46.98 IG Support
  • 46.99 Initial User Seeding
  • 46.100 JavaScript Execution Environment
  • 46.101 JSON Web KeySet (JWKS)
  • 46.102 LDAP Authentication
  • 46.103 Smile CDR License
  • 46.104 Lucene FullText Indexing
  • 46.105 MDM
  • 46.106 Narrative Generator
  • 46.107 OpenID Connect Token Validation
  • 46.108 OpenID Connect (OIDC)
  • 46.109 Order Sign CDS hook configuration
  • 46.110 Payer to Payer
  • 46.111 Prior Authorization Coverage Requirement Discovery
  • 46.112 Prior Authorization Support
  • 46.113 Privacy Security Notice
  • 46.114 Provenance Injection
  • 46.115 Quality Payment Program (QPP)
  • 46.116 Realtime Export
  • 46.117 Endpoint Validation: Request Validating
  • 46.118 Scheduler Configuration
  • 46.119 Search Parameter Seeding
  • 46.120 SAML Provider
  • 46.121 Security Inbound Script
  • 46.122 Inbound SMART on FHIR Authentication
  • 46.123 Inbound SMART on FHIR Endpoints
  • 46.124 OAuth2/OIDC Federation
  • 46.125 SMART Callback Script
  • 46.126 Cross-Organizational Data Access Profile
  • 46.127 SMART Login Skin
  • 46.128 SMART Login Terms of Service
  • 46.129 SMART Authorization
  • 46.130 SMART Definitions Seeding
  • 46.131 Sessions
  • 46.132 Two Factor Authentication
  • 46.133 TLS / SSL (Encryption)
  • 46.134 Transaction Log
  • 46.135 Trusted Client
  • 46.136 User Self Registration
    • 46.45    FHIR Endpoint Conversion