On this page:
   34.22    FHIR Configuration 34.24    FHIR Consent Service   

34.23Capability Statement

 

The Capability Statement configuration category includes the following configurable options:

  • Copyright Message

  • Implementation Description

  • Enable OpenAPI / Swagger Support

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

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

34.23.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
   34.22    FHIR Configuration 34.24    FHIR Consent Service