Smile CDR v2024.08.PRE
On this page:
   6.3    FHIRWeb Console
  • FHIR Storage
  • 6.0 Concepts in Smile CDR
  • 6.1 FHIR Storage Modules
  • 6.2 FHIR Endpoint Module
  • 6.3 FHIRWeb Console
  • 6.4 OpenAPI / Swagger Support
  • 6.5 FHIR Endpoint Customization
  • 6.6 Resource IDs
  • 6.7 Search Parameters
  • 6.8 Search Parameter Features
  • 6.9 Phonetic Search Parameters
  • 6.10 Search Parameter Tuning
  • 6.11 Search Parameter Reindexing
  • 6.12 Searching for Data
  • 6.13 Creating Data
  • 6.14 Reading Data
  • 6.15 Updating Data
  • 6.16 Deleting Data
  • 6.17 Binary Data
  • 6.18 Request Tracing and Provenance
  • 6.19 FHIR Versions
  • 6.20 Resource Versions and Versioned References
  • 6.21 Tags, Profiles, and Security Labels
  • 6.22 Partitioning and Multitenancy
  • 6.23 Custom Resource Types
  • 6.24 Batch and Scheduled Jobs
    • 6.5    FHIR Endpoint Customization   
       Table of Contents

    OpenAPI / Swagger Support

    6.4.1OpenAPI / Swagger Support

     

    All Smile CDR FHIR Endpoint modules (FHIR Endpoint, FHIR Gateway, Hybrid Providers) support automatic generation of OpenAPI (aka Swagger) documentation. This documentation describes the FHIR operations, parameters, and request/response details supported by the API.

    This support can be enabled and disabled by setting the Enable OpenAPI / Swagger Support setting on the appropriate FHIR Endpoint module.

    With this setting enabled, you may wish to set the other Capability Statement Settings as well, as these will control the information exported by the OpenAPI document.

    6.4.2Swagger UI

     

    One of the primary uses for OpenAPI documentation is to power the Swagger UI tool.

    When OpenAPI support is enabled on a Smile CDR FHIR Endpoint, a customized version of Swagger UI will be automatically served by the FHIR Endpoint at: [baseUrl]/swagger-ui/, where [baseUrl] is the Fixed Value for Endpoint Base URL property. To ensure the API Docs load correctly, this property must include any context paths in the URL e.g. https://apis.example.org/fhir-request

    6.4.3OpenID Connect Support

     

    If OpenID Connect authentication is enabled on a Smile CDR FHIR Endpoint, the Swagger UI will allow users to authenticate themselves through that protocol.

    The following configuration parameters must be set to support the authentication process through Swagger:

    • The ANONYMOUS user must be granted the FHIR_CAPABILITIES permission.
    • For each OpenID Connect Client that will access the Swagger UI, the list of Authorized Redirect URLs must contain the value [baseUrl]/swagger-ui/oauth2-redirect.html.
    • The SMART Outbound Security module must have Cross-Origin Resource Sharing ( CORS) enabled, and the list of CORS Allowed Request Headers must include the value x-requested-with.

    6.4.4Limitations

     

    Smile CDR support for OpenAPI has the following known limitations:

    • Complete schema definitions are not yet supplied for FHIR Resources.
       6.3    FHIRWeb Console
  • FHIR Storage
  • 6.0 Concepts in Smile CDR
  • 6.1 FHIR Storage Modules
  • 6.2 FHIR Endpoint Module
  • 6.3 FHIRWeb Console
  • 6.4 OpenAPI / Swagger Support
  • 6.5 FHIR Endpoint Customization
  • 6.6 Resource IDs
  • 6.7 Search Parameters
  • 6.8 Search Parameter Features
  • 6.9 Phonetic Search Parameters
  • 6.10 Search Parameter Tuning
  • 6.11 Search Parameter Reindexing
  • 6.12 Searching for Data
  • 6.13 Creating Data
  • 6.14 Reading Data
  • 6.15 Updating Data
  • 6.16 Deleting Data
  • 6.17 Binary Data
  • 6.18 Request Tracing and Provenance
  • 6.19 FHIR Versions
  • 6.20 Resource Versions and Versioned References
  • 6.21 Tags, Profiles, and Security Labels
  • 6.22 Partitioning and Multitenancy
  • 6.23 Custom Resource Types
  • 6.24 Batch and Scheduled Jobs
    • 6.5    FHIR Endpoint Customization