Showing documentation for 2025.12.R03
On this page:
   CQL
  • Configuration Categories
  • Care Gaps
  • CQL
  • Measure Evaluation
  • Prior Authorization Documentation Templates and Requirements
  • Quality Payment Program (QPP)
    • Prior Authorization Documentation Templates and Requirements   
       Table of Contents

    Measure Evaluation

    Measure Evaluation

     

    The Measure Evaluation configuration category includes the following configurable options:

    • Apply Scoring

    • Subject Chunk Size

    • Measure Chunk Size

    • Measure Report default reporter

    • S3 Bucket Name

    • S3 Endpoint

    • S3 Access Key

    • S3 Region

    • S3 Secret Key

    • Additional Spark Properties

    • Spark AWS Access Key

    • Spark AWS Secret Key

    • Iceberg Catalog Type

    • Iceberg Catalog URI

    • Iceberg Catalog Warehouse

    • Spark Cluster Kind

    • Databricks Client ID

    • Databricks Client Secret

    • Databricks Workspace URL

    • Iceberg Output Table

    • Iceberg Source Table

    • Spark Master

    • S3 Subject CQL Results with Evaluated Resources

    • Threaded Subject Chunk Size

    • Number of Threads

    • Measure Report Reporter from Group

    • Include Patients from Related Managing Organizations

    Property: Apply Scoring

     
    Property Name Apply Scoring
    Property Key
    Property Type BOOLEAN
    Description Applies a scoring algorithm during measure evaluation.
    Applies to Modules
    Default Value true
    Example Property 
    module.[MODULE_ID].config.evaluate_measure.apply_scoring = true

    Property: Subject Chunk Size

     
    Property Name Subject Chunk Size
    Property Key
    Property Type NON_NEGATIVE_INTEGER
    Description The maximum quantity of subjects to process per batch2 job work-chunk. This allows for batch2 job work-chunks to optimally process a maximum volume of subjects in parallel, setting this value too high will maximize work-chunk throughput, but will slow processing speed.
    Applies to Modules
    Default Value 50
    Example Property 
    module.[MODULE_ID].config.evaluate_measure.chunksize = 50

    Property: Measure Chunk Size

     
    Property Name Measure Chunk Size
    Property Key
    Property Type NON_NEGATIVE_INTEGER
    Description The maximum quantity of measures that will be evaluated per batch2 job work-chunk during distributed measure evaluation request. This allows for batch2 job work-chunks to optimally process at a specific volume, setting this value too high will maximize work-chunk throughput, but slow processing speed. Example: If requesting 9 Measure resources to be evaluated, and 'Measure Chunk Size'= 4, it will create 3 Measure-Chunks: 1) Measures 1, 2, 3, 4. 2) Measures 5, 6, 7, 8. 3) Measure 9
    Applies to Modules
    Default Value 4
    Example Property 
    module.[MODULE_ID].config.evaluate_measure.num_measures_per_subject_chunk = 4

    Property: Measure Report default reporter

     
    Property Name Measure Report default reporter
    Property Key
    Property Type STRING
    Description The default value that will be added to MeasureReport.reporter field when executing Async $evaluate-measure operation. This should be a reference to Organization resource.
    Applies to Modules
    Default Value (no default)
    Example Property 
    module.[MODULE_ID].config.evaluate_measure.reporter =

    Property: S3 Bucket Name

     
    Property Name S3 Bucket Name
    Property Key
    Property Type STRING
    Description The AWS S3 bucket where Evaluation Type 'subject' results will be saved in distributed (batch2) mode. The Bucket must be created before referenced in configuration.
    Applies to Modules
    Default Value (no default)
    Example Property 
    module.[MODULE_ID].config.evaluate_measure.s3_bucket_name =

    Property: S3 Endpoint

     
    Property Name S3 Endpoint
    Property Key
    Property Type STRING
    Description S3 Endpoint is primarily used for local s3 server override of aws default endpoints. This is mainly used for testing purposes, standard use would rely on common aws endpoint for region (e.g., s3.us-east-1.amazonaws.com).
    Applies to Modules
    Default Value (no default)
    Example Property 
    module.[MODULE_ID].config.evaluate_measure.s3_endpoint =

    Property: S3 Access Key

     
    Property Name S3 Access Key
    Property Key
    Property Type STRING
    Description The S3 Access Key used to provide access to named S3 bucket. Recommend setting this value through environment variable to avoid exposing
    Applies to Modules
    Default Value (no default)
    Example Property 
    module.[MODULE_ID].config.evaluate_measure.s3_key =

    Property: S3 Region

     
    Property Name S3 Region
    Property Key
    Property Type STRING
    Description The S3 region code for where the S3 bucket is located. Example value: 'us-east-1'
    Applies to Modules
    Default Value us-east-1
    Example Property 
    module.[MODULE_ID].config.evaluate_measure.s3_region = us-east-1

    Property: S3 Secret Key

     
    Property Name S3 Secret Key
    Property Key
    Property Type STRING
    Description The S3 Secret used to provide access to named S3 bucket. Recommend setting this value through environment variable to avoid exposing
    Applies to Modules
    Default Value (no default)
    Example Property 
    module.[MODULE_ID].config.evaluate_measure.s3_secret_key =

    Property: Additional Spark Properties

     
    Property Name Additional Spark Properties
    Property Key
    Property Type STRING_MULTILINE
    Description Extra Spark settings applied to the session, one 'key=value' per line, for anything the settings above do not cover: S3 endpoints and path-style access, a catalog 'io-impl', or a Glue catalog via 'catalog-impl' (leave the Iceberg Catalog Type blank for that). Blank lines and lines beginning with '#' are ignored. Every key must start with 'spark.'; when porting a cqis-spark properties file, strip the leading 'iceberg.' from each key. Credentials are refused here because this field is not redacted on config export; use the AWS credential settings instead.
    Applies to Modules
    Default Value (no default)
    Example Property 
    module.[MODULE_ID].config.evaluate_measure.spark.additional_properties =

    Property: Spark AWS Access Key

     
    Property Name Spark AWS Access Key
    Property Key
    Property Type STRING
    Description AWS access key for the S3 storage backing the Iceberg warehouse, used only when the Spark Cluster Kind is 'LOCAL'. Applied to Hadoop S3A and, when a catalog is configured, to the Iceberg catalog's S3 file IO. Leave blank to use the AWS SDK default credential chain (IAM role or environment variables), which is the recommended configuration. Only takes effect when the Spark AWS Secret Key is also set.
    Applies to Modules
    Default Value (no default)
    Example Property 
    module.[MODULE_ID].config.evaluate_measure.spark.aws_access_key =

    Property: Spark AWS Secret Key

     
    Property Name Spark AWS Secret Key
    Property Key
    Property Type PASSWORD
    Description AWS secret key paired with the Spark AWS Access Key, used only when the Spark Cluster Kind is 'LOCAL'. Recommend setting this value through an environment variable to avoid exposing it. Only takes effect when the Spark AWS Access Key is also set.
    Applies to Modules
    Default Value (no default)
    Example Property 
    module.[MODULE_ID].config.evaluate_measure.spark.aws_secret_key =

    Property: Iceberg Catalog Type

     
    Property Name Iceberg Catalog Type
    Property Key
    Property Type STRING
    Description The kind of Iceberg catalog this node configures, used only when the Spark Cluster Kind is 'LOCAL' and refused when it is 'DATABRICKS', where Unity Catalog supplies the catalog. Choose: 'hadoop' for a filesystem warehouse, or 'rest' for an Iceberg REST catalog. Leave it blank for any other catalog, such as Glue, and configure that catalog through the Additional Spark Properties instead.
    Applies to Modules
    Default Value (no default)
    Example Property 
    module.[MODULE_ID].config.evaluate_measure.spark.catalog_type =

    Property: Iceberg Catalog URI

     
    Property Name Iceberg Catalog URI
    Property Key
    Property Type STRING
    Description Endpoint URL of the Iceberg REST catalog, such as 'http://localhost:8181'. Required when the Iceberg Catalog Type is 'rest', and ignored otherwise.
    Applies to Modules
    Default Value (no default)
    Example Property 
    module.[MODULE_ID].config.evaluate_measure.spark.catalog_uri =

    Property: Iceberg Catalog Warehouse

     
    Property Name Iceberg Catalog Warehouse
    Property Key
    Property Type STRING
    Description Warehouse location for the Iceberg catalog, such as '/tmp/warehouse' or 's3://warehouse/'. Required when the Iceberg Catalog Type is 'hadoop'. Ignored when the catalog type is blank.
    Applies to Modules
    Default Value (no default)
    Example Property 
    module.[MODULE_ID].config.evaluate_measure.spark.catalog_warehouse =

    Property: Spark Cluster Kind

     
    Property Name Spark Cluster Kind
    Property Key
    Property Type ENUM
    Values
    • NONE
    • LOCAL
    • DATABRICKS
    Description Where measure evaluation runs Spark, and whether it runs it at all. 'NONE' disables Spark evaluation and no other Spark setting is read. 'LOCAL' builds a Spark session inside this Smile CDR process, or attaches to the master named by the Spark Master setting, and this node configures the Iceberg catalog and storage credentials itself. 'DATABRICKS' submits the evaluation to a Databricks workspace, which supplies the Spark session, the Iceberg catalog and storage access, so the catalog and credential settings do not apply and the workspace host and service principal do instead.
    Applies to Modules
    Default Value NONE
    Example Property 
    module.[MODULE_ID].config.evaluate_measure.spark.cluster_kind = NONE

    Property: Databricks Client ID

     
    Property Name Databricks Client ID
    Property Key
    Property Type STRING
    Description The application id of the OAuth service principal the workspace runs evaluations as. Required together with the Databricks Client Secret when the Spark Cluster Kind is 'DATABRICKS', and refused otherwise. This is a workspace credential and is unrelated to the Spark AWS Access Key, which addresses S3 storage.
    Applies to Modules
    Default Value (no default)
    Example Property 
    module.[MODULE_ID].config.evaluate_measure.spark.databricks_client_id =

    Property: Databricks Client Secret

     
    Property Name Databricks Client Secret
    Property Key
    Property Type PASSWORD
    Description The OAuth secret paired with the Databricks Client ID. Recommend setting this value through an environment variable to avoid exposing it. Required together with the Databricks Client ID when the Spark Cluster Kind is 'DATABRICKS', and refused otherwise.
    Applies to Modules
    Default Value (no default)
    Example Property 
    module.[MODULE_ID].config.evaluate_measure.spark.databricks_client_secret =

    Property: Databricks Workspace URL

     
    Property Name Databricks Workspace URL
    Property Key
    Property Type STRING
    Description The Databricks workspace to submit evaluation runs to, such as 'https://example.cloud.databricks.com'. Required when the Spark Cluster Kind is 'DATABRICKS', and refused otherwise. Must be an 'https://' URL: the Databricks Jobs API is only reachable over TLS.
    Applies to Modules
    Default Value (no default)
    Example Property 
    module.[MODULE_ID].config.evaluate_measure.spark.databricks_host =

    Property: Iceberg Output Table

     
    Property Name Iceberg Output Table
    Property Key
    Property Type STRING
    Description The fully qualified Iceberg table evaluation writes its reports to, in 'catalog.namespace.table' form (for example 'prod.health.measure_reports'). Required when the Spark Cluster Kind is 'DATABRICKS', because a submitted run has nowhere else to put its results. The table must already exist.
    Applies to Modules
    Default Value (no default)
    Example Property 
    module.[MODULE_ID].config.evaluate_measure.spark.iceberg_output_table =

    Property: Iceberg Source Table

     
    Property Name Iceberg Source Table
    Property Key
    Property Type STRING
    Description The fully qualified Iceberg table holding the FHIR resources evaluation reads, in 'catalog.namespace.table' form (for example 'prod.health.fhir_resources'). Required unless the Spark Cluster Kind is 'NONE'. The table must already exist.
    Applies to Modules
    Default Value (no default)
    Example Property 
    module.[MODULE_ID].config.evaluate_measure.spark.iceberg_source_table =

    Property: Spark Master

     
    Property Name Spark Master
    Property Key
    Property Type STRING
    Description The Spark master URL, used only when the Spark Cluster Kind is 'LOCAL'. The default 'local[4]' runs Spark inside this Smile CDR process with four worker threads, which suits integration tests and demonstration data. Point it at a cluster, such as 'spark://host:7077', for anything larger, so the work runs on executors rather than on this node. Ignored when the cluster kind is 'DATABRICKS', where the workspace owns the Spark session.
    Applies to Modules
    Default Value local[4]
    Example Property 
    module.[MODULE_ID].config.evaluate_measure.spark.master = local[4]

    Property: S3 Subject CQL Results with Evaluated Resources

     
    Property Name S3 Subject CQL Results with Evaluated Resources
    Property Key
    Property Type BOOLEAN
    Description Show CQL Resources used to evaluate each Cql expression with CQL results. This functionality is for distributed (batch2) mode only. This feature requires S3 configurations.
    Applies to Modules
    Default Value false
    Example Property 
    module.[MODULE_ID].config.evaluate_measure.subject_cql_evaluated = false

    Property: Threaded Subject Chunk Size

     
    Property Name Threaded Subject Chunk Size
    Property Key
    Property Type NON_NEGATIVE_INTEGER
    Description The number of patients to batch per thread for parallel processing of data for measure evaluation. Example: If processing 1000 patients in a measure evaluation query, thread-Number =2, and Thread-Batch-Size is set to 500, then system will split 1000 patients into two batches of 500 patients, distribute query to two threads for processing, and collect results from threads when complete.
    Applies to Modules
    Default Value 25
    Example Property 
    module.[MODULE_ID].config.evaluate_measure.thread_batchsize = 25

    Property: Number of Threads

     
    Property Name Number of Threads
    Property Key
    Property Type NON_NEGATIVE_INTEGER
    Description The quantity of concurrent processors to make available from the system for measure evaluation operations & $care-gaps queries. Note: This value needs to be less than available processors on SmileCdr instance to perform optimally.
    Applies to Modules
    Default Value 2
    Example Property 
    module.[MODULE_ID].config.evaluate_measure.thread_number = 2

    Property: Measure Report Reporter from Group

     
    Property Name Measure Report Reporter from Group
    Property Key
    Property Type BOOLEAN
    Description If set to true, evaluate-measure operation will attempt to source MeasureReport.reporter from evaluate-measure operation's 'subject' or 'practitioner' parameter by using the Group's resource field, managingEntity. If unable to source reference from Group, MeasureReport reporter will use default dqm.evaluate_measure.reporter setting.
    Applies to Modules
    Default Value true
    Example Property 
    module.[MODULE_ID].config.evaluate_measure.use_group_ref = true

    Property: Include Patients from Related Managing Organizations

     
    Property Name Include Patients from Related Managing Organizations
    Property Key
    Property Type BOOLEAN
    Description If set to true, evaluate-measure subject parameter will collect Patient resources with a matching Patient.managingOrganization reference in addition to Organizations related by the Organization.partOf field.
    Applies to Modules
    Default Value false
    Example Property 
    module.[MODULE_ID].config.evaluate_measure.use_part_of_organizations = false
       CQL
  • Configuration Categories
  • Care Gaps
  • CQL
  • Measure Evaluation
  • Prior Authorization Documentation Templates and Requirements
  • Quality Payment Program (QPP)
    • Prior Authorization Documentation Templates and Requirements