On this page:
   35.38    FHIR Storage Package Registry 35.40    FHIR Performance   

35.39Versioned References

 

The Versioned References configuration category includes the following configurable options:

  • Allow Versioned References at All Paths

  • Allow Versioned References at Paths

  • Automatically Version References at Paths

  • Respect Versioned References for _include

35.39.1Property: Allow Versioned References at All Paths

 
Property Name Allow Versioned References at All Paths
Property Key
Property Type BOOLEAN
Description Enables versioned references for all references in all resources. This setting does not force references to be versioned, but does prevent Smile CDR from filtering versions off of references that are supplied by clients. See Allow Versioned References for more information.
Applies to Modules
  • FHIR Gateway REST Endpoint
  • FHIR Storage (DSTU2 Relational)
  • FHIR Storage (MongoDB)
  • FHIR Storage (R3 Relational)
  • FHIR Storage (R4 Relational)
  • Hybrid Providers REST Endpoint
Default Value false
Example Property
module.[MODULE_ID].config.versioned_references.allow_all = false

35.39.2Property: Allow Versioned References at Paths

 
Property Name Allow Versioned References at Paths
Property Key
Property Type STRING_MULTILINE
Description Enables versioned references at one or more whitespace-separated resource paths. This setting does not force references to be versioned, but does prevent Smile CDR from filtering versions off of references that are supplied by clients. See Allow Versioned References for more information.
Applies to Modules
  • FHIR Gateway REST Endpoint
  • FHIR Storage (DSTU2 Relational)
  • FHIR Storage (MongoDB)
  • FHIR Storage (R3 Relational)
  • FHIR Storage (R4 Relational)
  • Hybrid Providers REST Endpoint
Default Value (no default)
Example Property
module.[MODULE_ID].config.versioned_references.allow_at_paths = Observation.subject

35.39.3Property: Automatically Version References at Paths

 
Property Name Automatically Version References at Paths
Property Key
Property Type STRING_MULTILINE
Description Causes Smile CDR to modify any resource references at the given paths to add the current version of the target resource if no version is supplied. See Automatically Version References for more information.
Applies to Modules
  • FHIR Gateway REST Endpoint
  • FHIR Storage (DSTU2 Relational)
  • FHIR Storage (MongoDB)
  • FHIR Storage (R3 Relational)
  • FHIR Storage (R4 Relational)
  • Hybrid Providers REST Endpoint
Default Value (no default)
Example Property
module.[MODULE_ID].config.versioned_references.auto_at_paths = Observation.subject

35.39.4Property: Respect Versioned References for _include

 
Property Name Respect Versioned References for _include
Property Key
Property Type BOOLEAN
Description If enabled, Smile CDR will attempt to respect any versioned references when performing a search that uses the FHIR _include feature.
Applies to Modules
  • FHIR Gateway REST Endpoint
  • FHIR Storage (DSTU2 Relational)
  • FHIR Storage (MongoDB)
  • FHIR Storage (R3 Relational)
  • FHIR Storage (R4 Relational)
  • Hybrid Providers REST Endpoint
Default Value false
Example Property
module.[MODULE_ID].config.versioned_references.respect_for_search_includes = false
   35.38    FHIR Storage Package Registry 35.40    FHIR Performance