Smile CDR v2023.05.PRE
On this page:
   6.4    OpenAPI / Swagger Support
  • 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 Searching for Data
  • 6.12 Creating Data
  • 6.13 Reading Data
  • 6.14 Updating Data
  • 6.15 Deleting Data
  • 6.16 Binary Data
  • 6.17 Request Tracing and Provenance
  • 6.18 FHIR Versions
  • 6.19 Versioned Resource References
  • 6.20 Tags, Profiles, and Security Labels
  • 6.21 Clinical Quality Language (CQL)
  • 6.22 Partitioning and Multitenancy
  • 6.23 Custom Resource Types
    • 6.6    Resource IDs   
       Table of Contents

    FHIR Endpoint Customization

    6.5FHIR Endpoint Customization

     

    FHIR Endpoint modules (including the standard FHIR Endpoint module, as well as including Hybrid Providers and FHIR Gateway modules) can be customized in order to provide the functionality and experience you need.

    6.5.1Customizing Available Interactions

     

    The Allowed Interactions setting can be used to customize the specific FHIR interactions which are available through a FHIR Endpoint module. This is typically used in cases where an endpoint is being made available for a specific purpose (e.g. a read-only API for specific resource types) and all unrelated interactions should not appear in the generated CapabilityStatement and OpenApi documentation.

    Values for this setting are a whitespace- or newline-separated list of interaction specifications, using the following possible formats:

    • [resourceType]:[interaction] – Use this form to allow type- and instance level interactions, such as create, read, and patch. For example, the spec Patient:create allows the Patient create operation (i.e. POST /Patient).
    • $[operation-name] - Use this form to allow operations (at any level) by name. For example, the spec $diff permits the Diff Operation to be applied at both the server and instance-level.

    Note that the spec does not differentiate between the read and vread interactions. If one is permitted the other will also be permitted.

    For example, the following allowed interactions spec allows read-only access to two resource types as well as access to the diff and validation operations:

    Patient:read
Patient:search
Patient:history
Observation:read
Observation:search
Observation:history
$diff
$validate

    6.5.2Customizing CapabilityStatement and OpenApi

     

    FHIR Servers produce a CapabilityStatement resource document which describes electronically the capabilities that the server offers.

    In order to customize your server's appearance:

    • If the endpoint should only advertise a limited set of capabilities, Customizing Available Interactions can be useful.
    • The CapabilityStatement Configuration Settings on the FHIR Endpoint module can be used to customize the description and related properties in the CapabilityStatement.
       6.4    OpenAPI / Swagger Support
  • 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 Searching for Data
  • 6.12 Creating Data
  • 6.13 Reading Data
  • 6.14 Updating Data
  • 6.15 Deleting Data
  • 6.16 Binary Data
  • 6.17 Request Tracing and Provenance
  • 6.18 FHIR Versions
  • 6.19 Versioned Resource References
  • 6.20 Tags, Profiles, and Security Labels
  • 6.21 Clinical Quality Language (CQL)
  • 6.22 Partitioning and Multitenancy
  • 6.23 Custom Resource Types
    • 6.6    Resource IDs