Smile CDR v2024.05.PRE
On this page:
   44.41    FHIR Configuration 44.43    FHIR Endpoint Conversion   

44.42.1Consent Service

 

The Consent Service configuration category includes the following configurable options:

  • Consent Service Enabled

  • Java Consent Service Types

  • Consent Service Script (File)

  • Consent Service Script (Text)

44.42.2Property: Consent Service Enabled

 
Property Name Consent Service Enabled
Property Key
Property Type BOOLEAN
Description This is a switch to enable or disable the consent service for this module.
Applies to Modules
  • FHIR Gateway REST Endpoint
  • FHIR REST Endpoint (All FHIR Versions)
  • FHIR REST Endpoint (DSTU2 - Deprecated)
  • FHIR REST Endpoint (R3 - Deprecated)
  • FHIR REST Endpoint (R4 - Deprecated)
  • FHIR Storage (DSTU2 RDBMS)
  • FHIR Storage (MongoDB)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
  • Hybrid Providers REST Endpoint
Default Value false
Example Property
module.[MODULE_ID].config.consent_service.enabled = false

44.42.3Property: Java Consent Service Types

 
Property Name Java Consent Service Types
Property Key
Property Type STRING_MULTILINE
Description If set, provides a whitespace or comma separated list of Java class names to instantiate and use as consent service implementations. See Consent Service: Java API for more information. Note that if both JavaScript and Java based implementations are provided, the JavaScript implementations will be invoked first.
Applies to Modules
  • FHIR Gateway REST Endpoint
  • FHIR REST Endpoint (All FHIR Versions)
  • FHIR REST Endpoint (DSTU2 - Deprecated)
  • FHIR REST Endpoint (R3 - Deprecated)
  • FHIR REST Endpoint (R4 - Deprecated)
  • FHIR Storage (DSTU2 RDBMS)
  • FHIR Storage (MongoDB)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
  • Hybrid Providers REST Endpoint
Default Value (no default)
Example Property
module.[MODULE_ID].config.consent_service.java_types = 

44.42.4Property: Consent Service Script (File)

 
Property Name Consent Service Script (File)
Property Key
Property Type Resource Path
Description If set, supplies a set of callback functions that will be executed for the consent service. Values should be prefixed with file: or classpath:.
Applies to Modules
  • FHIR Gateway REST Endpoint
  • FHIR REST Endpoint (All FHIR Versions)
  • FHIR REST Endpoint (DSTU2 - Deprecated)
  • FHIR REST Endpoint (R3 - Deprecated)
  • FHIR REST Endpoint (R4 - Deprecated)
  • FHIR Storage (DSTU2 RDBMS)
  • FHIR Storage (MongoDB)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
  • Hybrid Providers REST Endpoint
Default Value (no default)
Example Property
module.[MODULE_ID].config.consent_service.script.file = 

44.42.5Property: Consent Service Script (Text)

 
Property Name Consent Service Script (Text)
Property Key
Property Type JAVASCRIPT
Description If set, supplies a set of callback functions that will be executed for the consent service.
Applies to Modules
  • FHIR Gateway REST Endpoint
  • FHIR REST Endpoint (All FHIR Versions)
  • FHIR REST Endpoint (DSTU2 - Deprecated)
  • FHIR REST Endpoint (R3 - Deprecated)
  • FHIR REST Endpoint (R4 - Deprecated)
  • FHIR Storage (DSTU2 RDBMS)
  • FHIR Storage (MongoDB)
  • FHIR Storage (R3 RDBMS)
  • FHIR Storage (R4 RDBMS)
  • FHIR Storage (R5 RDBMS)
  • Hybrid Providers REST Endpoint
Default Value (no default)
Example Property
module.[MODULE_ID].config.consent_service.script.text = 
   44.41    FHIR Configuration 44.43    FHIR Endpoint Conversion