Smile CDR v2023.02.PRE
On this page:
   39.28    FHIR Bulk Operations 39.30    FHIR Configuration   

39.29Capability Statement

 

The Capability Statement configuration category includes the following configurable options:

  • Copyright Message

  • Implementation Description

  • Enable OpenAPI / Swagger Support

  • Swagger-UI Custom CSS (Text)

  • Swagger-UI Logo URL

  • Swagger-UI Uses Resource Pages

  • Software Name

  • Software Version

39.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 = Copyright(c) by Example Organization

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

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

39.29.4Property: Swagger-UI Custom CSS (Text)

 
Property Name Swagger-UI Custom CSS (Text)
Property Key
Property Type STRING_MULTILINE
Description If specified, provides raw CSS text that will be served as a part of the Swagger-UI page.
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.openapi.swagger_ui.custom_css.text = 

39.29.5Property: Swagger-UI Logo URL

 
Property Name Swagger-UI Logo URL
Property Key
Property Type STRING
Description Specifies an image URL to use as the banner image on the Swagger-UI page. Note that astronaut.png may be used to display the Smile CDR astronaut adventurer, or raccoon.png may be used to display the HAPI FHIR raccoon mascot.
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 astronaut.png
Example Property
module.[MODULE_ID].config.fhir_endpoint_capabilty_statement.openapi.swagger_ui.logo_url = https://example.org/logo.png

39.29.6Property: Swagger-UI Uses Resource Pages

 
Property Name Swagger-UI Uses Resource Pages
Property Key
Property Type BOOLEAN
Description If enabled, Swagger-UI will be divided into individual pages for each supported resource type, as well as a page for system-level interactions. Disabling this can be helpful on servers where only a limited number of interactions and/or resource types are enabled. Disable this with caution if you have a large number of resource types and interactions enabled on your server, as this can lead to an unusable Swagger-UI page.
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.swagger_ui.use_resource_pages = true

39.29.7Property: Software Name

 
Property Name Software Name
Property Key
Property Type STRING
Description If set, provides the software name that will be exported in the server CapabilityStatement (as well as any generated OpenApi documentation). If not set, defaults to "Smile CDR".
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.software.name = 

39.29.8Property: Software Version

 
Property Name Software Version
Property Key
Property Type STRING
Description If set, provides the software version that will be exported in the server CapabilityStatement (as well as any generated OpenApi documentation). If not set, defaults to the current Smile CDR software version.
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.software.version = 
   39.28    FHIR Bulk Operations 39.30    FHIR Configuration