On this page:
   35.25    FHIR Configuration
  • Configuration Categories
  • 35.0 Web Admin Console Settings
  • 35.1 App Management Tools
  • 35.2 Initial App Management Tools Seeding
  • 35.3 App Management Tools Email Server
  • 35.4 Authentication Callback Scripts
  • 35.5 Auth: General for APIs
  • 35.6 User Authentication
  • 35.7 Auth: HTTP Basic
  • 35.8 Auth: OpenID Connect
  • 35.9 Browser Syntax Highlighting
  • 35.10 Capability Statement (metadata)
  • 35.11 CDA Generation
  • 35.12 CDS Hooks
  • 35.13 Channel Import
  • 35.14 Channel Retry
  • 35.15 Cluster Manager Maintenance
  • 35.16 Cluster Manager Message Broker
  • 35.17 Cluster Manager Kafka
  • 35.18 Credentials
  • 35.19 Cross-Origin Resource Sharing (CORS)
  • 35.20 Database
  • 35.21 ETL Import: CSV Properties
  • 35.22 ETL Import: Source
  • 35.23 FHIR Binary Storage
  • 35.24 FHIR Bulk Operations
  • 35.25 FHIR Configuration
  • 35.26 FHIR Capability Statement
  • 35.27 FHIR Consent Service
  • 35.28 FHIR Endpoint Terminology
  • 35.29 FHIR LiveBundle Service
  • 35.30 FHIR Endpoint Conversion
  • 35.31 FHIR Endpoint Security
  • 35.32 Interceptors
  • 35.33 FHIR Endpoint Partitioning and Multitenancy
  • 35.34 FHIR Gateway Config
  • 35.35 FHIR MDM Server
  • 35.36 FHIR Storage Partitioning and Multitenancy
  • 35.37 FHIR Storage Package Registry
  • 35.38 Versioned References
  • 35.39 FHIR Performance
  • 35.40 FHIR Performance Tracing
  • 35.41 FHIR Storage Scheduled Tasks
  • 35.42 FHIR Realtime Export
  • 35.43 FHIR Resource Types
  • 35.44 FHIR REST Endpoint
  • 35.45 FHIR Search
  • 35.46 FHIR Interceptors
  • 35.47 FHIR Repository Validation
  • 35.48 FHIR Subscription Persistence
  • 35.49 FHIR Subscription Delivery
  • 35.50 FHIR Validation Services
  • 35.51 HL7 v2.x to FHIR Mapper - Forced Namespace Mode
  • 35.52 HL7 v2.x to FHIR Mapper - General
  • 35.53 HL7 v2.x Mapper - Medications
  • 35.54 HL7 v2.x to FHIR Mapper - OBR
  • 35.55 HL7 v2.x to FHIR Mapper - OBSERVATION Group
  • 35.56 HL7 v2.x to FHIR Mapper - ORDER_OBSERVATION Group
  • 35.57 HL7 v2.x to FHIR Mapper - PV1
  • 35.58 HL7 v2.x Listener Script
  • 35.59 HL7 v2.x MLLP Listener
  • 35.60 FHIR to HL7 v2.x Mapper Script
  • 35.61 HL7 v2.x Outbound Mapping
  • 35.62 HL7 v2.x MLLP Sender
  • 35.63 HTTP Access Log
  • 35.64 HTTP Listener
  • 35.65 HTTP Request Pool
  • 35.66 HTTP Security
  • 35.67 Hybrid Providers Definitions
  • 35.68 Initial User Seeding
  • 35.69 JSON Web KeySet (JWKS)
  • 35.70 LDAP Authentication
  • 35.71 Lucene FullText Indexing
  • 35.72 Narrative Generator
  • 35.73 Master Data Management
  • 35.74 OpenID Connect (OIDC)
  • 35.75 Realtime Export
  • 35.76 Request Validating
  • 35.77 Search Parameter Seeding
  • 35.78 Security Inbound Script
  • 35.79 Inbound SMART on FHIR Authentication
  • 35.80 Inbound SMART on FHIR Endpoints
  • 35.81 OpenID Connect Token Validation
  • 35.82 SAML Provider
  • 35.83 OAuth2/OIDC Federation
  • 35.84 SMART Authorization
  • 35.85 SMART Definitions Seeding
  • 35.86 Sessions
  • 35.87 SMART Outbound Security: Callback Script
  • 35.88 SMART Outbound Security: CODAP
  • 35.89 SMART Outbound Security: Login Skin
  • 35.90 SMART Outbound Security: Terms of Service
  • 35.91 Two Factor Authentication
  • 35.92 TLS / SSL (Encryption)
  • 35.93 Trusted Client
  • 35.94 Transaction Log
  • 35.95 User Self Registration
    • 35.27    FHIR Consent Service   
       Table of Contents

    FHIR Capability Statement

    35.26Capability Statement

     

    The Capability Statement configuration category includes the following configurable options:

    • Copyright Message

    • Implementation Description

    • Enable OpenAPI / Swagger Support

    35.26.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 =

    35.26.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

    35.26.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
       35.25    FHIR Configuration
  • Configuration Categories
  • 35.0 Web Admin Console Settings
  • 35.1 App Management Tools
  • 35.2 Initial App Management Tools Seeding
  • 35.3 App Management Tools Email Server
  • 35.4 Authentication Callback Scripts
  • 35.5 Auth: General for APIs
  • 35.6 User Authentication
  • 35.7 Auth: HTTP Basic
  • 35.8 Auth: OpenID Connect
  • 35.9 Browser Syntax Highlighting
  • 35.10 Capability Statement (metadata)
  • 35.11 CDA Generation
  • 35.12 CDS Hooks
  • 35.13 Channel Import
  • 35.14 Channel Retry
  • 35.15 Cluster Manager Maintenance
  • 35.16 Cluster Manager Message Broker
  • 35.17 Cluster Manager Kafka
  • 35.18 Credentials
  • 35.19 Cross-Origin Resource Sharing (CORS)
  • 35.20 Database
  • 35.21 ETL Import: CSV Properties
  • 35.22 ETL Import: Source
  • 35.23 FHIR Binary Storage
  • 35.24 FHIR Bulk Operations
  • 35.25 FHIR Configuration
  • 35.26 FHIR Capability Statement
  • 35.27 FHIR Consent Service
  • 35.28 FHIR Endpoint Terminology
  • 35.29 FHIR LiveBundle Service
  • 35.30 FHIR Endpoint Conversion
  • 35.31 FHIR Endpoint Security
  • 35.32 Interceptors
  • 35.33 FHIR Endpoint Partitioning and Multitenancy
  • 35.34 FHIR Gateway Config
  • 35.35 FHIR MDM Server
  • 35.36 FHIR Storage Partitioning and Multitenancy
  • 35.37 FHIR Storage Package Registry
  • 35.38 Versioned References
  • 35.39 FHIR Performance
  • 35.40 FHIR Performance Tracing
  • 35.41 FHIR Storage Scheduled Tasks
  • 35.42 FHIR Realtime Export
  • 35.43 FHIR Resource Types
  • 35.44 FHIR REST Endpoint
  • 35.45 FHIR Search
  • 35.46 FHIR Interceptors
  • 35.47 FHIR Repository Validation
  • 35.48 FHIR Subscription Persistence
  • 35.49 FHIR Subscription Delivery
  • 35.50 FHIR Validation Services
  • 35.51 HL7 v2.x to FHIR Mapper - Forced Namespace Mode
  • 35.52 HL7 v2.x to FHIR Mapper - General
  • 35.53 HL7 v2.x Mapper - Medications
  • 35.54 HL7 v2.x to FHIR Mapper - OBR
  • 35.55 HL7 v2.x to FHIR Mapper - OBSERVATION Group
  • 35.56 HL7 v2.x to FHIR Mapper - ORDER_OBSERVATION Group
  • 35.57 HL7 v2.x to FHIR Mapper - PV1
  • 35.58 HL7 v2.x Listener Script
  • 35.59 HL7 v2.x MLLP Listener
  • 35.60 FHIR to HL7 v2.x Mapper Script
  • 35.61 HL7 v2.x Outbound Mapping
  • 35.62 HL7 v2.x MLLP Sender
  • 35.63 HTTP Access Log
  • 35.64 HTTP Listener
  • 35.65 HTTP Request Pool
  • 35.66 HTTP Security
  • 35.67 Hybrid Providers Definitions
  • 35.68 Initial User Seeding
  • 35.69 JSON Web KeySet (JWKS)
  • 35.70 LDAP Authentication
  • 35.71 Lucene FullText Indexing
  • 35.72 Narrative Generator
  • 35.73 Master Data Management
  • 35.74 OpenID Connect (OIDC)
  • 35.75 Realtime Export
  • 35.76 Request Validating
  • 35.77 Search Parameter Seeding
  • 35.78 Security Inbound Script
  • 35.79 Inbound SMART on FHIR Authentication
  • 35.80 Inbound SMART on FHIR Endpoints
  • 35.81 OpenID Connect Token Validation
  • 35.82 SAML Provider
  • 35.83 OAuth2/OIDC Federation
  • 35.84 SMART Authorization
  • 35.85 SMART Definitions Seeding
  • 35.86 Sessions
  • 35.87 SMART Outbound Security: Callback Script
  • 35.88 SMART Outbound Security: CODAP
  • 35.89 SMART Outbound Security: Login Skin
  • 35.90 SMART Outbound Security: Terms of Service
  • 35.91 Two Factor Authentication
  • 35.92 TLS / SSL (Encryption)
  • 35.93 Trusted Client
  • 35.94 Transaction Log
  • 35.95 User Self Registration
    • 35.27    FHIR Consent Service