Smile CDR v2022.08.PRE
On this page:
   37.28    FHIR Bulk Operations
  • Configuration Categories
  • 37.0 Web Admin Console Settings
  • 37.1 appSphere
  • 37.2 Payer Config
  • 37.3 Initial appSphere Seeding
  • 37.4 Authentication Callback Scripts
  • 37.5 Auth: General for APIs
  • 37.6 User Authentication
  • 37.7 Auth: HTTP Basic
  • 37.8 Auth: OpenID Connect
  • 37.9 Browser Syntax Highlighting
  • 37.10 Capability Statement (metadata)
  • 37.11 CDA Generation
  • 37.12 CDA Import
  • 37.13 CDS Hooks Definitions
  • 37.14 Channel Import
  • 37.15 Channel Retry
  • 37.16 Kafka
  • 37.17 Smile CDR License
  • 37.18 Cluster Manager Maintenance
  • 37.19 Message Broker
  • 37.20 Cluster Level Security
  • 37.21 Credentials
  • 37.22 Cross-Origin Resource Sharing (CORS)
  • 37.23 Database
  • 37.24 Email Configuration
  • 37.25 ETL Import: CSV Properties
  • 37.26 ETL Import: Source
  • 37.27 FHIR Binary Storage
  • 37.28 FHIR Bulk Operations
  • 37.29 Capability Statement
  • 37.30 FHIR Configuration
  • 37.31 Consent Service
  • 37.32 FHIR Endpoint Conversion
  • 37.33 Interceptors
  • 37.34 FHIR Endpoint Partitioning
  • 37.35 Custom Resource Providers
  • 37.36 FHIR Endpoint Security
  • 37.37 Endpoint Terminology
  • 37.38 FHIR Gateway Configuration
  • 37.39 FHIR Interceptors
  • 37.40 LiveBundle Service
  • 37.41 FHIR MDM Server
  • 37.42 FHIR Performance
  • 37.43 FHIR Performance Tracing
  • 37.44 FHIR Realtime Export
  • 37.45 Repository Validation
  • 37.46 FHIR Resource Types
  • 37.47 FHIR REST Endpoint
  • 37.48 FHIR Search
  • 37.49 FHIR Storage Module Scheduled Tasks
  • 37.50 FHIR Validation Services
  • 37.51 FHIR Storage Package Registry
  • 37.52 FHIR Storage Partitioning
  • 37.53 Versioned References
  • 37.54 FHIR Subscription Delivery
  • 37.55 FHIR Subscription Persistence
  • 37.56 Amazon HealthLake REST Endpoint
  • 37.57 HL7 v2.x Mapper - Contained Resource
  • 37.58 HL7 v2.x Mapper - DG1
  • 37.59 HL7 v2.x Mapper - Forced Namespace Mode
  • 37.60 HL7 v2.x Mapper - General
  • 37.61 HL7 v2.x Mapper - Medications
  • 37.62 HL7 v2.x Mapper - OBR
  • 37.63 HL7 v2.x to FHIR Mapper - OBSERVATION Group
  • 37.64 HL7 v2.x to FHIR Mapper - ORDER_OBSERVATION Group
  • 37.65 HL7 v2.x Mapper - PID
  • 37.66 HL7 v2.x Mapper - PV1
  • 37.67 HL7 v2.x Listener Script
  • 37.68 HL7 v2.x MLLP Listener
  • 37.69 HL7 v2.x MLLP Sender
  • 37.70 FHIR to HL7 v2.x Mapper Script
  • 37.71 HL7 v2.x Outbound Mapping
  • 37.72 HTTP Access Log
  • 37.73 HTTP Listener
  • 37.74 HTTP Request Pool
  • 37.75 HTTP Security
  • 37.76 Hybrid Providers Definitions
  • 37.77 Initial User Seeding
  • 37.78 JavaScript Execution Environment
  • 37.79 JSON Web KeySet (JWKS)
  • 37.80 LDAP Authentication
  • 37.81 Lucene FullText Indexing
  • 37.82 MDM
  • 37.83 Narrative Generator
  • 37.84 OpenID Connect Token Validation
  • 37.85 OpenID Connect (OIDC)
  • 37.86 Provenance Injection
  • 37.87 Realtime Export
  • 37.88 Endpoint Validation: Request Validating
  • 37.89 Search Parameter Seeding
  • 37.90 SAML Provider
  • 37.91 Security Inbound Script
  • 37.92 Inbound SMART on FHIR Authentication
  • 37.93 Inbound SMART on FHIR Endpoints
  • 37.94 OAuth2/OIDC Federation
  • 37.95 SMART Callback Script
  • 37.96 Cross-Organizational Data Access Profile
  • 37.97 SMART Login Skin
  • 37.98 SMART Login Terms of Service
  • 37.99 SMART Authorization
  • 37.100 SMART Definitions Seeding
  • 37.101 Sessions
  • 37.102 Two Factor Authentication
  • 37.103 TLS / SSL (Encryption)
  • 37.104 Transaction Log
  • 37.105 Trusted Client
  • 37.106 User Self Registration
    • 37.30    FHIR Configuration   
       Table of Contents

    Capability Statement

    37.29Capability Statement

     

    The Capability Statement configuration category includes the following configurable options:

    • Copyright Message

    • Implementation Description

    • Enable OpenAPI / Swagger Support

    37.29.1Property: Copyright Message

     
    Property Name Copyright Message
    Property Key
    Property Type STRING_MULTILINE
    Description Use this field to supply a copyright message that will be included in the generated CapabilityStatement. Markdown is permitted in this field.
    Applies to Modules
    • FHIR Gateway REST Endpoint
    • FHIR REST Endpoint (DSTU2)
    • FHIR REST Endpoint (R3)
    • FHIR REST Endpoint (R4)
    • Hybrid Providers REST Endpoint
    Default Value (no default)
    Example Property 
    module.[MODULE_ID].config.fhir_endpoint_capabilty_statement.copyright =

    37.29.2Property: Implementation Description

     
    Property Name Implementation Description
    Property Key
    Property Type STRING
    Description This field will populate the CapabilityStatement.implementation.description field in the generated CapabilityStatement. Use this field to supply a description of the nature/purpose/name of this server.
    Applies to Modules
    • FHIR Gateway REST Endpoint
    • FHIR REST Endpoint (DSTU2)
    • FHIR REST Endpoint (R3)
    • FHIR REST Endpoint (R4)
    • Hybrid Providers REST Endpoint
    Default Value FHIR Endpoint powered by Smile CDR
    Example Property 
    module.[MODULE_ID].config.fhir_endpoint_capabilty_statement.implementation.description = FHIR Endpoint powered by Smile CDR

    37.29.3Property: Enable OpenAPI / Swagger Support

     
    Property Name Enable OpenAPI / Swagger Support
    Property Key
    Property Type BOOLEAN
    Description If enabled, this server will automatically generate OpenAPI (aka Swagger) documentation, and enable a Swagger UI display module.
    Applies to Modules
    • FHIR Gateway REST Endpoint
    • FHIR REST Endpoint (DSTU2)
    • FHIR REST Endpoint (R3)
    • FHIR REST Endpoint (R4)
    • Hybrid Providers REST Endpoint
    Default Value true
    Example Property 
    module.[MODULE_ID].config.fhir_endpoint_capabilty_statement.openapi.enabled = true
       37.28    FHIR Bulk Operations
  • Configuration Categories
  • 37.0 Web Admin Console Settings
  • 37.1 appSphere
  • 37.2 Payer Config
  • 37.3 Initial appSphere Seeding
  • 37.4 Authentication Callback Scripts
  • 37.5 Auth: General for APIs
  • 37.6 User Authentication
  • 37.7 Auth: HTTP Basic
  • 37.8 Auth: OpenID Connect
  • 37.9 Browser Syntax Highlighting
  • 37.10 Capability Statement (metadata)
  • 37.11 CDA Generation
  • 37.12 CDA Import
  • 37.13 CDS Hooks Definitions
  • 37.14 Channel Import
  • 37.15 Channel Retry
  • 37.16 Kafka
  • 37.17 Smile CDR License
  • 37.18 Cluster Manager Maintenance
  • 37.19 Message Broker
  • 37.20 Cluster Level Security
  • 37.21 Credentials
  • 37.22 Cross-Origin Resource Sharing (CORS)
  • 37.23 Database
  • 37.24 Email Configuration
  • 37.25 ETL Import: CSV Properties
  • 37.26 ETL Import: Source
  • 37.27 FHIR Binary Storage
  • 37.28 FHIR Bulk Operations
  • 37.29 Capability Statement
  • 37.30 FHIR Configuration
  • 37.31 Consent Service
  • 37.32 FHIR Endpoint Conversion
  • 37.33 Interceptors
  • 37.34 FHIR Endpoint Partitioning
  • 37.35 Custom Resource Providers
  • 37.36 FHIR Endpoint Security
  • 37.37 Endpoint Terminology
  • 37.38 FHIR Gateway Configuration
  • 37.39 FHIR Interceptors
  • 37.40 LiveBundle Service
  • 37.41 FHIR MDM Server
  • 37.42 FHIR Performance
  • 37.43 FHIR Performance Tracing
  • 37.44 FHIR Realtime Export
  • 37.45 Repository Validation
  • 37.46 FHIR Resource Types
  • 37.47 FHIR REST Endpoint
  • 37.48 FHIR Search
  • 37.49 FHIR Storage Module Scheduled Tasks
  • 37.50 FHIR Validation Services
  • 37.51 FHIR Storage Package Registry
  • 37.52 FHIR Storage Partitioning
  • 37.53 Versioned References
  • 37.54 FHIR Subscription Delivery
  • 37.55 FHIR Subscription Persistence
  • 37.56 Amazon HealthLake REST Endpoint
  • 37.57 HL7 v2.x Mapper - Contained Resource
  • 37.58 HL7 v2.x Mapper - DG1
  • 37.59 HL7 v2.x Mapper - Forced Namespace Mode
  • 37.60 HL7 v2.x Mapper - General
  • 37.61 HL7 v2.x Mapper - Medications
  • 37.62 HL7 v2.x Mapper - OBR
  • 37.63 HL7 v2.x to FHIR Mapper - OBSERVATION Group
  • 37.64 HL7 v2.x to FHIR Mapper - ORDER_OBSERVATION Group
  • 37.65 HL7 v2.x Mapper - PID
  • 37.66 HL7 v2.x Mapper - PV1
  • 37.67 HL7 v2.x Listener Script
  • 37.68 HL7 v2.x MLLP Listener
  • 37.69 HL7 v2.x MLLP Sender
  • 37.70 FHIR to HL7 v2.x Mapper Script
  • 37.71 HL7 v2.x Outbound Mapping
  • 37.72 HTTP Access Log
  • 37.73 HTTP Listener
  • 37.74 HTTP Request Pool
  • 37.75 HTTP Security
  • 37.76 Hybrid Providers Definitions
  • 37.77 Initial User Seeding
  • 37.78 JavaScript Execution Environment
  • 37.79 JSON Web KeySet (JWKS)
  • 37.80 LDAP Authentication
  • 37.81 Lucene FullText Indexing
  • 37.82 MDM
  • 37.83 Narrative Generator
  • 37.84 OpenID Connect Token Validation
  • 37.85 OpenID Connect (OIDC)
  • 37.86 Provenance Injection
  • 37.87 Realtime Export
  • 37.88 Endpoint Validation: Request Validating
  • 37.89 Search Parameter Seeding
  • 37.90 SAML Provider
  • 37.91 Security Inbound Script
  • 37.92 Inbound SMART on FHIR Authentication
  • 37.93 Inbound SMART on FHIR Endpoints
  • 37.94 OAuth2/OIDC Federation
  • 37.95 SMART Callback Script
  • 37.96 Cross-Organizational Data Access Profile
  • 37.97 SMART Login Skin
  • 37.98 SMART Login Terms of Service
  • 37.99 SMART Authorization
  • 37.100 SMART Definitions Seeding
  • 37.101 Sessions
  • 37.102 Two Factor Authentication
  • 37.103 TLS / SSL (Encryption)
  • 37.104 Transaction Log
  • 37.105 Trusted Client
  • 37.106 User Self Registration
    • 37.30    FHIR Configuration