Model Documentation
Class: AnalysisOutputCategorization
The AnalysisOutputCategorization class can be used to create sponsor-defined categorizations, where a categorization is a set of categories with a common topic. Defined categorizations are stored in the reporting event's analysisOutputCategorizations attribute. In its simplest form, a categorization is a list of categories, each of which is a label with an associated identifier value. However, it is possible to define 1 or more subcategorizations for any category. Each subcategorization is another instance of the AnalysisOutputCategorization class, with its own list of categories (each of which may again have subcategorizations).
The categories within any categorization (or subcategorization) may be used to categorize any analysis or output. Each analysis or output may be assigned to one or more categories by including the identifier value of the category in the categoryIds attribute of the analysis or output.
Example
Lines 2-10: | Show the "Group of Analyses" categorization with 3 categories:
|
Lines 12-19: | Show the "Estimand Analysis Type" categorization with 3 categories:
|
analysisOutputCategorizations: - id: Catn_01_Grp label: Group of Analyses categories: - id: Catn_01_Grp_1_Pop label: Population Description - id: Catn_01_Grp_2_Saf label: Safety - id: Catn_01_Grp_3_Eff label: Efficacy - id: Catn_02_Est label: Estimand Analysis Type categories: - id: Catn_02_Est_1_Prim label: Primary Estimator - id: Catn_02_Est_2_Sens label: Sensitivity Analysis - id: Catn_02_Est_3_Supp label: Supplementary Analysis
These categorization and category definitions could be represented in tabular form as shown in the following table where:
- Each instance of the AnalysisOutputCategory class is shown on a separate line, with values for the id and label attributes shown in the category_id and category_label columns, respectively.
- Attribute values each instance of the AnalysisOutputCategorization class are represented on each of the rows for the categories in the categorization.
id | label | category_id | category_label |
---|---|---|---|
Catn_01_Grp | Group of Analyses | Catn_01_Grp_1_Pop | Population Description |
Catn_01_Grp | Group of Analyses | Catn_01_Grp_2_Saf | Safety |
Catn_01_Grp | Group of Analyses | Catn_01_Grp_3_Eff | Efficacy |
Catn_02_Est | Estimand Analysis Type | Catn_02_Est_1_Prim | Primary Estimator |
Catn_02_Est | Estimand Analysis Type | Catn_02_Est_2_Sens | Sensitivity Analysis |
Catn_02_Est | Estimand Analysis Type | Catn_02_Est_3_Supp | Supplementary Analysis |
Lines 5, 18: | Show that both the "Summary of Subjects by Treatment" analysis and the "Summary of Demographics" output were categorized as "Population Description". |
Lines 10-11: | Show that the "Comparison of Change in Clinical Characteristic X by Treatment" analysis was categorized as both "Efficacy" and "Primary Estimand". |
Line 23: | Shows that the "Change in Clinical Characteristic X" output was categorized as "Efficacy". |
analyses: - id: An01_05_SAF_Summ_ByTrt name: Summary of Subjects by Treatment categoryIds: - Catn_01_Grp_1_Pop ... - id: An02_03_SAF_Summ_ByTrt name: Comparison of Change in Clinical Characteristic X by Treatment categoryIds: - Catn_01_Grp_3_Eff - Catn_02_Est_1_Prim ... ... outputs: - id: Out14-1-5 name: Summary of Demographics categoryIds: - Catn_01_Grp_1_Pop ... - id: Out14-2-3 name: Change in Clinical Characteristic X categoryIds: - Catn_01_Grp_3_Eff ...
Example
The categorization and category names represented here are only examples of ways in which a sponsor might choose to categorize, and subcategorize, the analyses or outputs included in a reporting event. While the categorizations chosen for this example are similar to Study Data Tabulation Model (SDTM) general observation classes and domains, this does not imply that analyses or outputs should be categorized by data class or data type as shown here.
In these line captions, categorization labels are shown in bold and category labels are shown in italics.:
Lines 2-4: |
|
Lines 5-7: |
|
Lines 8-10: |
|
Lines 11-12: |
|
Lines 13-15: |
|
Lines 16-18: |
|
Lines 19-20: |
|
Lines 21-22: |
|
Lines 23-24: |
|
Lines 25-27: |
|
Lines 28-30: |
|
Lines 31-32: |
|
Lines 33-34: |
|
analysisOutputCategorizations: - id: Catn_02_DClass label: Data Class categories: - id: Catn_02_Dclass_1_Sbj label: Subject-level subCategorizations: - id: Catn_03_SbjDType label: Subject-level Data Type categories: - id: Catn_03_SbjDType_1_Dm label: Demographics - id: Catn_02_Dclass_2_Evt label: Events subCategorizations: - id: Catn_04_EvtDType label: Events Data Type categories: - id: Catn_04_EvtDType_1_Ae label: Adverse Events - id: Catn_04_EvtDType_2_Ce label: Clinical Events - id: Catn_04_EvtDType_3_Ds label: Disposition - id: Catn_02_Dclass_3_Fnd label: Findings subCategorizations: - id: Catn_06_FndDType label: Findings Data Type categories: - id: Catn_06_FndDType_1_Vs label: Vital Signs - id: Catn_06_FndDType_2_Lb label: Laboratory Tests
These categorization and category definitions could be represented in tabular form as shown in the following table where:
- Each instance of the AnalysisOutputCategory class is shown on a separate line, with values for the id and label attributes shown in the "category_id" and "category_label" columns, respectively.
- Attribute values each instance of the AnalysisOutputCategorization class are represented on each of the rows for the categories in the categorization.
- For subcategorizations, the id value of the parent category is shown in the "parent_category_id" column.
id | label | parent_category_id | category_id | category_label |
---|---|---|---|---|
Catn_02_DClass | Data Class | Catn_02_Dclass_1_Sbj | Subject-level | |
Catn_02_DClass | Data Class | Catn_02_Dclass_2_Evt | Events | |
Catn_02_DClass | Data Class | Catn_02_Dclass_3_Fnd | Findings | |
Catn_03_SbjDType | Subject-level Data Type | Catn_02_Dclass_1_Sbj | Catn_03_SbjDType_1_Dm | Demographics |
Catn_04_EvtDType | Events Data Type | Catn_02_Dclass_2_Evt | Catn_04_EvtDType_1_Ae | Adverse Events |
Catn_04_EvtDType | Events Data Type | Catn_02_Dclass_2_Evt | Catn_04_EvtDType_2_Ce | Clinical Events |
Catn_04_EvtDType | Events Data Type | Catn_02_Dclass_2_Evt | Catn_04_EvtDType_3_Ds | Disposition |
Catn_06_FndDType | Findings Data Type | Catn_02_Dclass_3_Fnd | Catn_06_FndDType_1_Vs | Vital Signs |
Catn_06_FndDType | Findings Data Type | Catn_02_Dclass_3_Fnd | Catn_06_FndDType_2_Lb | Laboratory Tests |
Lines 4-6: | Show that the "Summary of Age by Treatment" analysis was categorized as:
|
Lines 12-15: | Show the "Summary of Observed and Change from Baseline by Scheduled Visits - Vital Signs" output was categorized as:
|
analyses: - id: An03_01_Age_Summ_ByTrt name: Summary of Age by Treatment categoryIds: - Catn_02_Dclass_1_Sbj - Catn_03_SbjDType_1_Dm ... ... outputs: - id: Out14-3-3-1a name: Summary of Observed and Change from Baseline by Scheduled Visits - Vital Signs categoryIds: - Catn_02_Dclass_3_Fnd - Catn_06_FndDType_1_Vs ...