Smile CDR v2024.05.PRE
On this page:
   45.58    Repository Validation 45.60    FHIR REST Endpoint   

45.59.1FHIR Resource Types

 

The FHIR Resource Types configuration category includes the following configurable options:

  • Instance/Type History Enabled

  • Server History Enabled

  • Resource Types (whitelist)

45.59.2Property: Instance/Type History Enabled

 
Property Name Instance/Type History Enabled
Property Key
Property Type BOOLEAN
Description If this setting is disabled, instance- and type-level history operations will be disabled. This means that change history will not be stored, which improves write performance.
Applies to Modules
  • FHIR Storage (MongoDB)
Default Value true
Example Property
module.[MODULE_ID].config.history.instance.enabled = true

45.59.3Property: Server History Enabled

 
Property Name Server History Enabled
Property Key
Property Type BOOLEAN
Description If this setting is disabled, server-level history operations will be disabled. This means that change history will not be stored, which improves write performance.
Applies to Modules
  • FHIR Storage (MongoDB)
Default Value true
Example Property
module.[MODULE_ID].config.history.server.enabled = true

45.59.4Property: Resource Types (whitelist)

 
Property Name Resource Types (whitelist)
Property Key
Property Type STRING
Description This property may be used to specify a comma-separated list of FHIR Resource types to be supported by this persistence module (e.g. Patient,Encounter,Practitioner). This configuration is required for MongoDB but optional for RDBMS implementations. For RDBMS implementations, leaving this configuration as null is the same as listing all resources supported by Smile CDR. Setting this parameter will constrain the resource types included in the capability statement for any endpoint pointing to this persistence module. As well, FHIR REST requests on the endpoint will be restricted to the resource types listed here. Note though that this parameter does not affect Bundle requests nor non-REST ingestion operations (e.g. ETL import).
Applies to Modules
  • FHIR Storage (DSTU2 RDBMS)
  • FHIR Storage (MongoDB)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
Default Value Patient,Observation,Encounter,DiagnosticReport,Claim,ExplanationOfBenefit,Coverage,List
Example Property
module.[MODULE_ID].config.resource_types.supported.whitelist = Patient,Observation,Encounter,DiagnosticReport,Claim,ExplanationOfBenefit,Coverage,List
   45.58    Repository Validation 45.60    FHIR REST Endpoint