You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
**`column_prefix_map`** — maps the `--` variable prefix to the dataset domain (e.g. `{"--": "AE"}`), resolving placeholders like `--SEQ` → `AESEQ`.
341
341
342
-
**External dictionaries** — pass an `ExternalDictionariesContainer` to `RulesEngine` if validating rules that require MedDRA, WHODrug, LOINC, UNII, MedRT, or SNOMED. See the [External Dictionary Reference](https://cdisc-org.github.io/conformance-rules-editor/#/exdictionary).
342
+
**External dictionaries** — pass an `ExternalDictionariesContainer` to `RulesEngine` if validating rules that require MedDRA, WHODrug, LOINC, UNII, MedRT, or SNOMED. See the [External Dictionary Reference](https://cdisc-org.github.io/cdisc-open-rules/#/exdictionary).
343
343
344
344
**Dask** — set `max_dataset_size=0` when initializing `DataServiceFactory` to force Dask processing for all datasets.
Copy file name to clipboardExpand all lines: docs/contributing.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ Conformance rules are maintained separately in [`cdisc-open-rules`](https://gith
12
12
- Report an issue with an existing rule's logic
13
13
- Contribute a rule implementation
14
14
15
-
Please open an issue or pull request in that repository. Rule authoring can also be done through the hosted [CORE Rule Editor](https://cdisc-org.github.io/conformance-rules-editor).
15
+
Please open an issue or pull request in that repository.
16
16
17
17
For questions about rule contribution workflows, post in [GitHub Discussions](https://github.com/cdisc-org/cdisc-rules-engine/discussions).
Copy file name to clipboardExpand all lines: resources/schema/rule-merged/Operations.json
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -117,7 +117,7 @@
117
117
"properties": {
118
118
"operator": {
119
119
"const": "get_codelist_attributes",
120
-
"markdownDescription": "\nFetches controlled terminology attribute values from CT packages based on row-specific CT package and version references. The operation constructs CT package names based on the standard being validated and the values in the `name` and `version` columns (e.g., SDTMIG \u2192 \"sdtmct-{version}\"). When the `name` column contains \"CDISC\" or \"CDISC CT\", it uses the validation run's standard to determine the package prefix and the version found in the cell of the specified column. The operation extracts all codes matching the specified ct_attribute from the package.\n\n**Required Parameters:**\n\n- `ct_attribute`: Attribute to extract - `\"Term CCODE\"`, `\"Codelist CCODE\"`, `\"Term Value\"`, `\"Codelist Value\"`, or `\"Term Preferred Term\"`\n- `name`: Column containing CT reference (e.g., \"TSVCDREF\") - identifies which terminology system is referenced\n- `version`: Column containing CT version (e.g., \"TSVCDVER\")\n\n```yaml\n- id: $VALID_TERM_CODES\n name: TSVCDREF\n operator: get_codelist_attributes\n ct_attribute: Term CCODE\n version: TSVCDVER\n```\n\n**Note:** due to editor not containing the cache, if using this operator in rule editor, you must put the ctpackage versions contained within your data in the library tab for it work properly in editor.\n"
120
+
"markdownDescription": "\nFetches controlled terminology attribute values from CT packages based on row-specific CT package and version references. The operation constructs CT package names based on the standard being validated and the values in the `name` and `version` columns (e.g., SDTMIG \u2192 \"sdtmct-{version}\"). When the `name` column contains \"CDISC\" or \"CDISC CT\", it uses the validation run's standard to determine the package prefix and the version found in the cell of the specified column. The operation extracts all codes matching the specified ct_attribute from the package.\n\n**Required Parameters:**\n\n- `ct_attribute`: Attribute to extract - `\"Term CCODE\"`, `\"Codelist CCODE\"`, `\"Term Value\"`, `\"Codelist Value\"`, or `\"Term Preferred Term\"`\n- `name`: Column containing CT reference (e.g., \"TSVCDREF\") - identifies which terminology system is referenced\n- `version`: Column containing CT version (e.g., \"TSVCDVER\")\n\n```yaml\n- id: $VALID_TERM_CODES\n name: TSVCDREF\n operator: get_codelist_attributes\n ct_attribute: Term CCODE\n version: TSVCDVER\n```\n\n**Note:** if using this operator with excel data, you must put the ctpackage versions contained within your data in the library tab for it work properly.\n"
Copy file name to clipboardExpand all lines: resources/schema/rule/ExDictionary.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# External Dictionaries
2
2
3
-
External dictionaries provide standardized terminology and coding systems for medical terms, drugs, and laboratory tests. This guide covers how to integrate and validate external dictionaries in both the Command Line Interface (CLI) and Rule Editor.
3
+
External dictionaries provide standardized terminology and coding systems for medical terms, drugs, and laboratory tests. This guide covers how to integrate and validate external dictionaries in both the Command Line Interface (CLI).
4
4
5
5
## Supported Dictionaries
6
6
@@ -123,7 +123,7 @@ Directory must contain the `Loinc.csv` with capital 'L'
Copy file name to clipboardExpand all lines: resources/schema/rule/Operations.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -168,7 +168,7 @@ Fetches controlled terminology attribute values from CT packages based on row-sp
168
168
version: TSVCDVER
169
169
```
170
170
171
-
**Note:** due to editor not containing the cache, if using this operator in rule editor, you must put the ctpackage versions contained within your data in the library tab for it work properly in editor.
171
+
**Note:** if using this operator with excel data, you must put the ctpackage versions contained within your data in the library tab for it work properly.
Copy file name to clipboardExpand all lines: resources/schema/rule/customrules.md
+3-143Lines changed: 3 additions & 143 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,119 +1,21 @@
1
-
# Custom Editor Columns and Custom Rules
1
+
# CDISC Custom Rule Extensions
2
2
3
-
This guide explains how to extend CDISC rule definitions with custom attributes and how to access these attributes using the custom columns editor syntax.
3
+
This guide explains how to extend CDISC rule definitions with your own custom attributes while maintaining compatibility with the core CDISC schema structure.
4
4
5
5
## Table of Contents
6
6
7
-
-[Custom Columns in Editor Syntax](#custom-columns-in-editor-syntax)
8
-
-[Overview and Basic Syntax](#overview-and-basic-syntax)
9
-
-[Identifying Arrays in YAML](#identifying-arrays-in-yaml)
10
-
-[Identifying Arrays in JSON](#identifying-arrays-in-json)
11
7
-[Custom Attributes Overview](#overview)
12
8
-[What Can and Cannot Be Changed](#what-can-and-cannot-be-changed)
13
9
-[Custom Schema Attributes](#custom-attributes)
14
-
-[Custom Columns in Editor Syntax](#custom-columns-in-editor-syntax)
15
10
-[Adding a Custom Organization](#adding-a-custom-organization)
16
11
-[Example Rule with Custom Attributes](#example-rule-with-custom-attributes)
17
-
-[Filtering Rules with Custom Columns](#filtering-rules-with-custom-columns)
18
12
-[Validation](#validation)
19
13
-[Best Practices](#best-practices)
20
14
-[FAQ](#faq)
21
15
22
-
## Custom Columns in Editor Syntax
23
-
24
-
Custom columns allow you to query nested rule structures, including arrays, using a simple path syntax. This allows for better access and filtering for both standard and custom attributes.
25
-
26
-
## Overview and Basic Syntax
27
-
28
-
Custom columns allow you to query nested rule structures, including arrays, using a simple path syntax. All custom column paths use `.` to separate each nested object property of the rule and use `@` to denote array elements.
29
-
30
-
The general rules for constructing paths:
31
-
32
-
1. The path is **case-sensitive**
33
-
2. The `@` symbol must come directly before the array name
34
-
3. Array notation must be used to access array elements
35
-
4. The path must reflect the exact structure of your data
36
-
37
-
### Identifying Arrays in YAML
38
-
39
-
When viewing a YAML document, you can identify arrays by looking for these indicators:
40
-
41
-
1.**Hyphen (-) at the Start**: Arrays elements are marked with a leading hyphen
42
-
43
-
```yaml
44
-
Authorities: #This is an array
45
-
- Organization: "Org1"# This is an element within the array
46
-
Standards: #This is an array (within the Authorities Array)
47
-
- Name: "Standard1"# This is also an element within the array
48
-
- Name: "Standard2"# Another element within the array
49
-
```
50
-
51
-
This means the Authorities array contains elements with Organization and Standards Properties on them. Similarly, Standards is an array with each element in the array having a Name property.
52
-
53
-
2. **No Hyphen**: Regular object properties don't have a hyphen
54
-
55
-
```yaml
56
-
Core:
57
-
Id: "123"
58
-
Status: "Active"
59
-
```
60
-
61
-
### Example YAML with Path Mapping
62
-
63
-
```yaml
64
-
Authorities:
65
-
- Organization: "Org1"# @Authorities.Organization
66
-
Standards:
67
-
- Name: "Standard1"# @Authorities.@Standards.Name
68
-
Core:
69
-
Id: "123"# Core.Id
70
-
Status: "Active"# Core.Status
71
-
```
72
-
73
-
The presence of hyphens (-) is your key indicator that you need to use @ notation in your custom path
74
-
75
-
### Identifying Arrays in JSON
76
-
77
-
You can also inspect the rule json looking for `[` square brackets to denote arrays.
This guide explains how to extend CDISC rule definitions with your own custom attributes while maintaining compatibility with the core CDISC schema structure, and how to access these attributes using the custom columns editor syntax.
113
-
114
16
## Overview
115
17
116
-
The CDISC Rules Engine schema supports custom extensions to help organizations better categorize, manage, and filter rules. These extensions maintain compatibility with standard CDISC rule definitions while adding organizational metadata tailored to your specific needs. The custom columns editor syntax allows you to query and filter these properties using a simple path notation.
18
+
The CDISC Rules Engine schema supports custom extensions to help organizations better categorize, manage, and filter rules. These extensions maintain compatibility with standard CDISC rule definitions while adding organizational metadata tailored to your specific needs.
117
19
118
20
## What Can and Cannot Be Changed
119
21
@@ -300,14 +202,6 @@ If you want to formally define custom properties in your schema (recommended for
300
202
- Provide validation rules or constraints for each property
301
203
- Share the documentation with all teams that will be using the rules
302
204
303
-
### Accessing Custom Properties
304
-
305
-
To access your custom properties in the editor using custom columns:
0 commit comments