Analysis Results Standard (ARS)
Logical model to support both the prospective specification of analyses and the fully contextualized representation of the results of the analyses.
URI: https://www.cdisc.org/ars/1-0 Name: ars_ldm
Schema Diagram
erDiagram
ReportingEvent {
string id
integer version
string name
string description
string label
}
Output {
string id
integer version
string name
string description
string label
}
AnalysisOutputProgrammingCode {
string context
string code
}
AnalysisOutputCodeParameter {
stringList value
string name
string description
string label
}
DocumentReference {
}
PageRef {
PageRefTypeEnum refType
string label
stringList pageNames
integerList pageNumbers
integer firstPage
integer lastPage
}
ReferenceDocument {
string id
uri location
string name
string description
string label
}
AnalysisOutputCategory {
string id
string label
}
AnalysisOutputCategorization {
string id
string label
}
OrderedDisplay {
integer order
}
OutputDisplay {
string id
integer version
string displayTitle
string name
string description
string label
}
DisplaySection {
DisplaySectionTypeEnum sectionType
}
OrderedDisplaySubSection {
integer order
}
DisplaySubSection {
string id
string text
}
OutputFile {
uri location
string style
string name
string description
string label
}
ExtensibleTerminologyTerm {
string controlledTerm
}
SponsorTerm {
string id
string submissionValue
string description
}
GlobalDisplaySection {
DisplaySectionTypeEnum sectionType
}
Analysis {
string id
integer version
string dataset
string variable
string name
string description
string label
}
OperationResult {
string rawValue
string formattedValue
}
ResultGroup {
string groupValue
}
Group {
string id
string name
string description
string label
integer level
integer order
}
CompoundGroupExpression {
ExpressionLogicalOperatorEnum logicalOperator
}
SubClause {
integer level
integer order
string subClauseId
}
WhereClauseCompoundExpression {
ExpressionLogicalOperatorEnum logicalOperator
}
WhereClauseCondition {
string dataset
string variable
ConditionComparatorEnum comparator
stringList value
}
GroupingFactor {
string id
string groupingDataset
string groupingVariable
boolean dataDriven
string name
string description
string label
}
Operation {
string id
integer order
string resultPattern
string name
string description
string label
}
ReferencedOperationRelationship {
string id
string description
}
ReferencedAnalysisOperation {
}
AnalysisMethod {
string id
string name
string description
string label
}
AnalysisProgrammingCodeTemplate {
string context
string code
}
TemplateCodeParameter {
string valueSource
stringList value
string name
string description
string label
}
OrderedGroupingFactor {
integer order
boolean resultsByGroup
}
DataSubset {
string id
string name
string description
string label
integer level
integer order
}
CompoundSubsetExpression {
ExpressionLogicalOperatorEnum logicalOperator
}
AnalysisSet {
string id
string name
string description
string label
integer level
integer order
}
CompoundSetExpression {
ExpressionLogicalOperatorEnum logicalOperator
}
TerminologyExtension {
string id
ExtensibleTerminologyEnum enumeration
}
ListOfContents {
string name
string description
string label
}
NestedList {
}
OrderedListItem {
integer level
integer order
string name
string description
string label
}
ReportingEvent ||--|| ListOfContents : "mainListOfContents"
ReportingEvent ||--}o ListOfContents : "otherListsOfContents"
ReportingEvent ||--}o ReferenceDocument : "referenceDocuments"
ReportingEvent ||--}o TerminologyExtension : "terminologyExtensions"
ReportingEvent ||--}o AnalysisOutputCategorization : "analysisOutputCategorizations"
ReportingEvent ||--}o AnalysisSet : "analysisSets"
ReportingEvent ||--}o DataSubset : "dataSubsets"
ReportingEvent ||--}o GroupingFactor : "analysisGroupings"
ReportingEvent ||--}o AnalysisMethod : "methods"
ReportingEvent ||--}o Analysis : "analyses"
ReportingEvent ||--}o GlobalDisplaySection : "globalDisplaySections"
ReportingEvent ||--}o Output : "outputs"
Output ||--}o OutputFile : "fileSpecifications"
Output ||--}| OrderedDisplay : "displays"
Output ||--}o AnalysisOutputCategory : "categoryIds"
Output ||--}o DocumentReference : "documentRefs"
Output ||--|o AnalysisOutputProgrammingCode : "programmingCode"
AnalysisOutputProgrammingCode ||--|o DocumentReference : "documentRef"
AnalysisOutputProgrammingCode ||--}o AnalysisOutputCodeParameter : "parameters"
DocumentReference ||--|| ReferenceDocument : "referenceDocumentId"
DocumentReference ||--}o PageRef : "pageRefs"
AnalysisOutputCategory ||--}o AnalysisOutputCategorization : "subCategorizations"
AnalysisOutputCategorization ||--}| AnalysisOutputCategory : "categories"
OrderedDisplay ||--|| OutputDisplay : "display"
OutputDisplay ||--}o DisplaySection : "displaySections"
DisplaySection ||--}o OrderedDisplaySubSection : "orderedSubSections"
OrderedDisplaySubSection ||--|o DisplaySubSection : "subSection"
OrderedDisplaySubSection ||--|o DisplaySubSection : "subSectionId"
OutputFile ||--|o ExtensibleTerminologyTerm : "fileType"
ExtensibleTerminologyTerm ||--|o SponsorTerm : "sponsorTermId"
GlobalDisplaySection ||--}o DisplaySubSection : "subSections"
Analysis ||--|| ExtensibleTerminologyTerm : "reason"
Analysis ||--|| ExtensibleTerminologyTerm : "purpose"
Analysis ||--}o DocumentReference : "documentRefs"
Analysis ||--}o AnalysisOutputCategory : "categoryIds"
Analysis ||--|o AnalysisSet : "analysisSetId"
Analysis ||--|o DataSubset : "dataSubsetId"
Analysis ||--}o OrderedGroupingFactor : "orderedGroupings"
Analysis ||--|| AnalysisMethod : "methodId"
Analysis ||--}o ReferencedAnalysisOperation : "referencedAnalysisOperations"
Analysis ||--|o AnalysisOutputProgrammingCode : "programmingCode"
Analysis ||--}o OperationResult : "results"
OperationResult ||--|| Operation : "operationId"
OperationResult ||--}o ResultGroup : "resultGroups"
ResultGroup ||--|| GroupingFactor : "groupingId"
ResultGroup ||--|o Group : "groupId"
Group ||--|o WhereClauseCondition : "condition"
Group ||--|o CompoundGroupExpression : "compoundExpression"
CompoundGroupExpression ||--}o SubClause : "whereClauses"
SubClause ||--|o WhereClauseCondition : "condition"
SubClause ||--|o WhereClauseCompoundExpression : "compoundExpression"
WhereClauseCompoundExpression ||--}o SubClause : "whereClauses"
GroupingFactor ||--}o Group : "groups"
Operation ||--}o ReferencedOperationRelationship : "referencedOperationRelationships"
ReferencedOperationRelationship ||--|| ExtensibleTerminologyTerm : "referencedOperationRole"
ReferencedOperationRelationship ||--|| Operation : "operationId"
ReferencedOperationRelationship ||--|o Analysis : "analysisId"
ReferencedAnalysisOperation ||--|| ReferencedOperationRelationship : "referencedOperationRelationshipId"
ReferencedAnalysisOperation ||--|| Analysis : "analysisId"
AnalysisMethod ||--}o DocumentReference : "documentRefs"
AnalysisMethod ||--}| Operation : "operations"
AnalysisMethod ||--|o AnalysisProgrammingCodeTemplate : "codeTemplate"
AnalysisProgrammingCodeTemplate ||--|o DocumentReference : "documentRef"
AnalysisProgrammingCodeTemplate ||--}o TemplateCodeParameter : "parameters"
OrderedGroupingFactor ||--|| GroupingFactor : "groupingId"
DataSubset ||--|o WhereClauseCondition : "condition"
DataSubset ||--|o CompoundSubsetExpression : "compoundExpression"
CompoundSubsetExpression ||--}o SubClause : "whereClauses"
AnalysisSet ||--|o WhereClauseCondition : "condition"
AnalysisSet ||--|o CompoundSetExpression : "compoundExpression"
CompoundSetExpression ||--}o SubClause : "whereClauses"
TerminologyExtension ||--}| SponsorTerm : "sponsorTerms"
ListOfContents ||--|| NestedList : "contentsList"
NestedList ||--}o OrderedListItem : "listItems"
OrderedListItem ||--|o Analysis : "analysisId"
OrderedListItem ||--|o Output : "outputId"
OrderedListItem ||--|o NestedList : "sublist"
Classes
Classes provide templates for organizing data. Data objects instantiate classes in the schema. Each class has a set of slots (aka fields, attributes) that are applicable to it. See LinkML documentation for more information.
| Class | Description |
|---|---|
| NamedObject | An object with a name |
| ReportingEvent | A set of analyses and outputs created to meet a specific reporting requiremen... |
| ListOfContents | A structured list of analyses and outputs included in the reporting event |
| NestedList | A list of items (analyses or outputs) that may be organized within sub-lists |
| LevelOrder | An abstract class containing attributes used to position class instances with... |
| OrderedListItem | An item (analysis, output or sub-list) ordered relative to other items within... |
| ReferenceDocument | An external document containing supporting documentation or programming code |
| TerminologyExtension | An extensible set of controlled terminology that has been extended with at le... |
| SponsorTerm | A sponsor-defined term that is included in an extensible set of controlled te... |
| ExtensibleTerminologyTerm | The term used for an attribute whose terminology is extensible |
| AnalysisOutputCategorization | A set of related implementer-defined categories that can be used to categoriz... |
| AnalysisOutputCategory | An implementer-defined category of analyses/outputs, which may include one or... |
| WhereClause | Selection criteria defined as either a simple condition ([variable] [comparat... |
| WhereClauseCondition | A simple selection criterion exressed as [dataset] |
| ReferencedWhereClause | An abstract class indicating an identified where clause (i |
| SubClause | An abstract class containing all attributes that may be specified for a sub-c... |
| WhereClauseCompoundExpression | An abstract class representing a compound expression consisting of either two... |
| AnalysisSet | A set of subjects whose data are to be included in the main analyses |
| ReferencedAnalysisSet | An AnalysisSet referenced by identifier (subClauseId) as the sub-clause o... |
| CompoundSetExpression | A compound expression consisting of either two or more sub-clauses combined w... |
| DataSubset | A subset of data identified by selection criteria for inclusion in the analys... |
| ReferencedDataSubset | A DataSubset referenced by identifier (subClauseId) as the sub-clause of ... |
| CompoundSubsetExpression | A compound expression consisting of either two or more sub-clauses combined w... |
| GroupingFactor | A factor used to subdivide either the subject population or data records in a... |
| Group | A subdivision of the subject population or analysis dataset record set based ... |
| ReferencedGroup | A Group referenced by identifier (subClauseId) as the sub-clause of a com... |
| CompoundGroupExpression | A compound expression consisting of either two or more sub-clauses combined w... |
| AnalysisMethod | A set of one or more statistical operations |
| DocumentReference | A reference to an external document |
| PageRef | A reference to a specific part of a document as indicated by a list of one or... |
| PageNumberListRef | One or more individual pages in the reference document, referenced by page nu... |
| PageNumberRangeRef | A range of pages in the reference document, indicated by the first and last p... |
| PageNameRef | One or more pages in the reference document, referenced by named destination |
| Operation | A statistical operation that produces a single analysis result value as part ... |
| ReferencedOperationRelationship | A reference to a statistical operation whose results are used in the calculat... |
| OperationRole | The role that the referenced operation's result plays in the calculation of t... |
| SponsorOperationRole | The sponsor-defined role that the referenced operation's result plays in the ... |
| AnalysisProgrammingCodeTemplate | Programming statements and/or a reference to a used as a template for creatio... |
| CodeParameter | A replacement parameter whose value is substituted in template programming co... |
| TemplateCodeParameter | A replacement parameter whose value is substituted in template programming co... |
| Analysis | An analysis that is designed to meet a requirement of the reporting event |
| AnalysisReason | The rationale for performing this analysis |
| SponsorAnalysisReason | The sponsor-defined rationale for performing this analysis |
| AnalysisPurpose | The purpose of the analysis within the body of evidence (e |
| SponsorAnalysisPurpose | The sponsor-defined purpose of the analysis within the body of evidence (e |
| OrderedGroupingFactor | A reference to a defined factor by which subjects or data records are grouped... |
| ReferencedAnalysisOperation | An indication of the analysis that contains results of a referenced operation |
| AnalysisOutputProgrammingCode | Programming statements and/or a reference to the program used to perform a sp... |
| AnalysisOutputCodeParameter | A parameter whose value is used in programming code for a specific analysis o... |
| OperationResult | The result of an analysis method operation performed on a subdivision of subj... |
| ResultGroup | For the specified grouping factor, an indication of the specific group of sub... |
| GlobalDisplaySection | A global definition for part of a tabular display containing one or more piec... |
| DisplaySubSection | An occurrence of a display section containing text |
| Output | A report of results and their evaluation based on planned analyses performed ... |
| OutputFile | A file containing analysis output displays |
| OutputFileType | The file format of the file containing output from analyses |
| SponsorOutputFileType | The sponsor-defined file format of the file containing output from analyses |
| OrderedDisplay | A display ordered with respect to other displays in an analysis output |
| OutputDisplay | A tabular representation of the results of one or more analyses |
| DisplaySection | A part of a tabular display containing one or more pieces of informational te... |
| OrderedDisplaySubSection | A single subsection ordered with respect to other subsections in the same sec... |
| OrderedSubSection | A subsection ordered with respect to other subsections of the same type |
| OrderedSubSectionRef | A reference to a subsection defined either globally or in another display sec... |
Slots
Slots (aka attributes, fields, columns, properties) can be associated with classes to specify what fields instances of that class can have. Slots operate the same way as “fields” in traditional object languages and the same ways as “columns” in spreadsheets and relational databases. See LinkML documentation here and here for more information.
| Slot | Description |
|---|---|
| name | The name for the instance of the class |
| description | A textual description of the instance of the class |
| label | A short informative description that may be used for display |
| id | The assigned identifying value for the instance of the class |
| version | An ordinal indicating the version of the identified instance of the class |
| mainListOfContents | The main list of the analyses and outputs defined for the reporting event |
| otherListsOfContents | Other lists of the analyses and outputs defined for the reporting event |
| contentsList | A structured list of the analyses and outputs defined for the reporting event |
| referenceDocuments | External documents containing information referenced for the reporting event |
| terminologyExtensions | Any sponsor-defined extensions to extensible terminology |
| analysisOutputCategorizations | Sets of related implementer-defined categories that can be used to categorize... |
| analysisSets | The analysis sets (subject populations) defined for the reporting event |
| dataSubsets | Subsets of data identified by selection criteria for inclusion in analysis de... |
| analysisGroupings | Characteristics used to subdivide the subject population (e |
| methods | The defined methods used to analyze any analysis variable |
| analyses | The analyses defined for the reporting event |
| globalDisplaySections | Display section specifications that may be applied to any display |
| outputs | The outputs defined for the reporting event |
| listItems | Items in the list |
| level | The level of the entry within a hierarchical structure |
| order | The ordinal of the instance with respect to other instances |
| sublist | A sub-list of items (analyses or outputs) that may be further organized withi... |
| analysisId | The identifier of the referenced analysis |
| outputId | The identifier of the referenced output |
| location | A path (relative or absolute) indicating the location of the file |
| enumeration | The name of the extensible enumeration |
| sponsorTerms | The sponsor-defined terms added to the extensible terminology |
| submissionValue | The specific value expected for submissions |
| controlledTerm | One of the permissible values from the referenced enumeration |
| sponsorTermId | The identifier of the referenced sponsor term |
| categories | Implementer-defined categories of analyses/outputs, each of which may include... |
| subCategorizations | Sets of related implementer-defined sub-categories that can be used to catego... |
| condition | A simple selection criterion exressed as [dataset] |
| compoundExpression | A compound expression that combines or negates where clauses |
| dataset | The name of the analysis dataset |
| variable | The name of the variable |
| comparator | Comparison operator indicating how the variable is compared to the value(s) |
| value | The prespecified value or values |
| subClauseId | The identifier of the analysis set, data subset or group referenced in the co... |
| logicalOperator | The boolean operator that is used to combine (AND, OR) or negate (NOT) the wh... |
| whereClauses | A list of one or more where clauses (selection criteria) to be combined or ne... |
| groupingDataset | For groupings based on a single variable, a reference to the dataset containi... |
| groupingVariable | For groupings based on a single variable, a reference to the dataset variable... |
| dataDriven | Indicates whether the groups defined by the grouping are prespecified (false)... |
| groups | The pre-specified groups within the grouping |
| documentRefs | References to external documents containing additional information |
| operations | The calculations performed for the method |
| codeTemplate | Template programming statements used to perform the statistical operations fo... |
| referenceDocumentId | The identifier of the referenced document |
| pageRefs | A list of references to specific parts of a document, which may be referenced... |
| refType | The type of reference for page references |
| pageNames | One or more named document references which each correspond with a page |
| pageNumbers | One or more page numbers |
| firstPage | The page number of the first page in a range of pages |
| lastPage | The page number of the last page in a range of pages |
| referencedOperationRelationships | Relationships to other operations indicating how the result of the referenced... |
| resultPattern | The default pattern or format to apply to the result for display |
| referencedOperationRole | The role that the referenced operation's result plays in the calculation of t... |
| operationId | The identifier of the referenced operation |
| context | The name and version of the computer language used for the actual programming... |
| code | Programming statements used to perform the specific analysis |
| documentRef | A reference to the document containing programming code |
| parameters | Replacement parameters that are referenced in the programming code or program... |
| valueSource | A reference to the prespecified source of the value for the parameter |
| reason | The rationale for performing this analysis |
| purpose | The purpose of the analysis within the body of evidence (e |
| categoryIds | References to any implementer-defined categories that apply to the analysis o... |
| analysisSetId | The identifier of the referenced analysis set |
| dataSubsetId | The identifier of the referenced data subset |
| orderedGroupings | An ordered list of grouping factors used in the analysis |
| methodId | A reference to the set of one or more statistical operations performed for th... |
| referencedAnalysisOperations | Indications of which analysis contains the results for each referenced operat... |
| programmingCode | Programming statements used to perform the specific analysis or create the sp... |
| results | The results of the analysis |
| groupingId | The identifier of the referenced subject or data grouping factor |
| resultsByGroup | Indicates whether a result is expected for each group in the grouping |
| referencedOperationRelationshipId | The identifier of the defined referenced operation relationship |
| resultGroups | The group values associated with the result |
| rawValue | The raw result value (e |
| formattedValue | The result value formatted for display according to the resultPattern |
| groupId | The identifier of a referenced predefined group within a grouping |
| groupValue | The data value used as a group within a data-driven grouping |
| sectionType | The type of display section that contains one or more pieces of informational... |
| subSections | A list of defined pieces of information text that may be displayed in display... |
| text | The text to be displayed in the display section |
| fileSpecifications | Specifications of output files |
| displays | An ordered list of the displays included in the output |
| fileType | The format of the output file |
| style | Reference to the specification of the style used for the output |
| display | A display contained in the output |
| displayTitle | Display description which uniquely identifies the display in the report |
| displaySections | The parts of the display containing one or more pieces of informational text ... |
| orderedSubSections | An ordered list of the informational text to display in the display section |
| subSection | A defined piece of information text to display in a display section |
| subSectionId | The identifier of the referenced subsection |
Enumerations
Enumerations are common features in modeling frameworks. These can be thought of as a “drop-down” of permissible values for a field/slot. See LinkML documentation for more information.
| Enumeration | Description |
|---|---|
| OutputFileTypeEnum | The file format of the file containing output from analyses |
| ExpressionLogicalOperatorEnum | Boolean operators denoting a logical operation (e |
| ConditionComparatorEnum | Comparison operators indicating how the value of a variable is compared to a ... |
| DisplaySectionTypeEnum | Types of display section that contain one or more pieces of informational tex... |
| OperationRoleEnum | The role that the referenced operation's result plays in the calculation of t... |
| AnalysisReasonEnum | The rationale for performing this analysis |
| AnalysisPurposeEnum | The purpose of the analysis within the body of evidence (e |
| ExtensibleTerminologyEnum | Extensible ARS enumerations |
| PageRefTypeEnum | Type of reference for page references |
Types
Types in LinkML are scalar data values such as strings, integers, floats, and so on. See LinkML documentation for more information.
| Type | Description |
|---|---|
| String | A character string |
| Integer | An integer |
| Boolean | A binary (true or false) value |
| Float | A real number that conforms to the xsd:float specification |
| Double | A real number that conforms to the xsd:double specification |
| Decimal | A real number with arbitrary precision that conforms to the xsd:decimal speci... |
| Time | A time object represents a (local) time of day, independent of any particular... |
| Date | a date (year, month and day) in an idealized calendar |
| Datetime | The combination of a date and time |
| DateOrDatetime | Either a date or a datetime |
| Uriorcurie | a URI or a CURIE |
| Curie | a compact URI |
| Uri | a complete URI |
| Ncname | Prefix part of CURIE |
| Objectidentifier | A URI or CURIE that represents an object in the model |
| Nodeidentifier | A URI, CURIE or BNODE that represents a node in a model |
Subsets
Elements of a schema can be partitioned into named subsets. These have no semantic meaning, but they can be useful for tagging parts of a schema for different purposes. See LinkML documentation for more information.
| Subset | Description |
|---|---|