Skip to contents

Define a Hierarchical Rollup Specification

Usage

hierarchical_rollup(
  name,
  domain = "Drug",
  root_vocabulary = NULL,
  roots = NULL,
  target_vocabulary = NULL,
  expansion_direction = "descendants",
  include_retired_maps_to = TRUE,
  exclude_dose_forms = NULL,
  combination_policy = "attribute_all",
  rules = NULL,
  source_file = NULL,
  source_file_hash = NULL
)

Arguments

name

Name of the clinical rollup (e.g. 'antidiabetic_agents').

domain

Clinical domain ('Drug', 'Condition', 'Measurement', 'Procedure').

root_vocabulary

Vocabulary ID of roots (e.g. 'ATC', 'SNOMED', 'LOINC').

roots

Vector of root concept codes or IDs.

target_vocabulary

Target vocabulary ID (default 'RxNorm' for Drug).

expansion_direction

'descendants' | 'ancestors' | NULL.

include_retired_maps_to

Logical. Include backward 'Maps to' deprecated concepts.

exclude_dose_forms

Character vector of dose forms to exclude (e.g. 'Topical', 'Ophthalmic').

combination_policy

Combination product attribution policy ('attribute_all' | 'split' | 'disallow').

rules

Optional list of concept_pattern objects.

source_file

Optional path to the source file from which this rollup was loaded.

source_file_hash

Optional cryptographic SHA-256 hash of the source file.

Value

A list representing the hierarchical rollup.