odmlib.arm_1_0 module

ARM (Analysis Results Metadata) 1.0 support. Extends Define-XML 2.1 with elements for describing analysis results, result displays, programming code, and analysis datasets.

ARM (Analysis Results Metadata) 1.0 model classes.

Extends Define-XML 2.1 with elements for describing analysis results, result displays, programming code, and analysis datasets. ARM is used in ADaM Define-XML documents to capture analysis metadata.

The ARM namespace is http://www.cdisc.org/ns/arm/v1.0.

All non-ARM-specific classes are re-exported from odmlib.define_2_1.model so that a single model import provides every element needed for a complete ARM-extended Define-XML document.

class odmlib.arm_1_0.model.TranslatedText(**kwargs)[source]

Bases: TranslatedText

ARM TranslatedText element (identical to Define-XML 2.1).

Parameters:: kwargs (Any)

lang: Descriptor for string-valued ODM attributes.

namespace = 'odm'

class odmlib.arm_1_0.model.Description(**kwargs)[source]

Bases: Description

ARM Description element (identical to Define-XML 2.1).

Parameters:: kwargs (Any)

TranslatedText

Descriptor for a list of child ODM elements.

Validates that all items assigned to the list are instances of the expected element class. Stored as a plain list in the instance.

Parameters:

element_class (type) – The class that all list items must be.
namespace (str) – XML namespace prefix (default: “odm”).

namespace = 'odm'

class odmlib.arm_1_0.model.Alias(**kwargs)[source]

Bases: Alias

ARM Alias element (identical to Define-XML 2.1).

Parameters:: kwargs (Any)

Context: Descriptor for string-valued ODM attributes.

Name: Descriptor for string-valued ODM attributes.

namespace = 'odm'

class odmlib.arm_1_0.model.StudyDescription(**kwargs)[source]

Bases: StudyDescription

ARM StudyDescription element (identical to Define-XML 2.1).

Parameters:: kwargs (Any)

namespace = 'odm'

class odmlib.arm_1_0.model.ProtocolName(**kwargs)[source]

Bases: ProtocolName

ARM ProtocolName element (identical to Define-XML 2.1).

Parameters:: kwargs (Any)

namespace = 'odm'

class odmlib.arm_1_0.model.StudyName(**kwargs)[source]

Bases: StudyName

ARM StudyName element (identical to Define-XML 2.1).

Parameters:: kwargs (Any)

namespace = 'odm'

class odmlib.arm_1_0.model.GlobalVariables(**kwargs)[source]

Bases: GlobalVariables

ARM GlobalVariables element (identical to Define-XML 2.1).

Parameters:: kwargs (Any)

StudyName

Descriptor for a single child ODM element.

Stores a reference to the element class and validates type on assignment. When accessed on an unset optional attribute, instantiates the element class with no arguments.

Parameters:

element_class (type) – The expected child element class.
namespace (str) – XML namespace prefix (default: “odm”).

StudyDescription

Descriptor for a single child ODM element.

Stores a reference to the element class and validates type on assignment. When accessed on an unset optional attribute, instantiates the element class with no arguments.

Parameters:

element_class (type) – The expected child element class.
namespace (str) – XML namespace prefix (default: “odm”).

ProtocolName

Descriptor for a single child ODM element.

Stores a reference to the element class and validates type on assignment. When accessed on an unset optional attribute, instantiates the element class with no arguments.

Parameters:

element_class (type) – The expected child element class.
namespace (str) – XML namespace prefix (default: “odm”).

namespace = 'odm'

class odmlib.arm_1_0.model.WhereClauseRef(**kwargs)[source]

Bases: WhereClauseRef

ARM WhereClauseRef element (def namespace).

Parameters:: kwargs (Any)

namespace = 'def'

WhereClauseOID

Descriptor for OID reference attributes.

References the OID of a definition element. Used on reference elements (e.g., ItemRef.ItemOID references ItemDef.OID).

class odmlib.arm_1_0.model.PDFPageRef(**kwargs)[source]

Bases: PDFPageRef

ARM PDFPageRef element (def namespace).

Parameters:: kwargs (Any)

namespace = 'def'

Type

String descriptor that validates against a dynamically-loaded set of permitted values.

Combines string type validation with value set membership checking. Used for attributes like FileType, Repeating, Mandatory, DataType, etc.

PageRefs: Descriptor for string-valued ODM attributes.

FirstPage

Descriptor for positive integer attributes (value > 0).

Combines integer type validation with positive value constraint. Used for Length, ItemGroupDataSeq, and similar attributes.

LastPage

Descriptor for positive integer attributes (value > 0).

Combines integer type validation with positive value constraint. Used for Length, ItemGroupDataSeq, and similar attributes.

Title: Descriptor for string-valued ODM attributes.

class odmlib.arm_1_0.model.DocumentRef(**kwargs)[source]

Bases: DocumentRef

ARM DocumentRef element (def namespace).

Parameters:: kwargs (Any)

namespace = 'def'

leafID: Descriptor for string-valued ODM attributes.

PDFPageRef

Descriptor for a list of child ODM elements.

Validates that all items assigned to the list are instances of the expected element class. Stored as a plain list in the instance.

Parameters:

element_class (type) – The class that all list items must be.
namespace (str) – XML namespace prefix (default: “odm”).

class odmlib.arm_1_0.model.title(**kwargs)[source]

Bases: title

ARM title element (def namespace).

Parameters:: kwargs (Any)

namespace = 'def'

class odmlib.arm_1_0.model.leaf(**kwargs)[source]

Bases: leaf

ARM leaf element (def namespace).

Parameters:: kwargs (Any)

namespace = 'def'

ID: Descriptor for XML ID attributes.

href: Descriptor for string-valued ODM attributes.

title

Descriptor for a single child ODM element.

Stores a reference to the element class and validates type on assignment. When accessed on an unset optional attribute, instantiates the element class with no arguments.

Parameters:

element_class (type) – The expected child element class.
namespace (str) – XML namespace prefix (default: “odm”).

class odmlib.arm_1_0.model.SubClass(**kwargs)[source]

Bases: SubClass

ARM SubClass element (def namespace).

Parameters:: kwargs (Any)

namespace = 'def'

Name: Descriptor for the Name attribute of ODM elements.

ParentClass: Descriptor for string-valued ODM attributes.

class odmlib.arm_1_0.model.Class(**kwargs)[source]

Bases: Class

ARM Class element (def namespace).

Parameters:: kwargs (Any)

namespace = 'def'

Name: Descriptor for the Name attribute of ODM elements.

SubClass

Descriptor for a list of child ODM elements.

Validates that all items assigned to the list are instances of the expected element class. Stored as a plain list in the instance.

Parameters:

element_class (type) – The class that all list items must be.
namespace (str) – XML namespace prefix (default: “odm”).

class odmlib.arm_1_0.model.ItemRef(**kwargs)[source]

Bases: ItemRef

ARM ItemRef element (identical to Define-XML 2.1).

Parameters:: kwargs (Any)

ItemOID: Descriptor for string-valued ODM attributes.

OrderNumber

Descriptor for integer-valued ODM attributes.

Accepts int values and strings that convert to int (e.g., “42”). Used for OrderNumber, KeySequence, and similar integer attributes.

Mandatory

String descriptor that validates against a dynamically-loaded set of permitted values.

Combines string type validation with value set membership checking. Used for attributes like FileType, Repeating, Mandatory, DataType, etc.

KeySequence

Descriptor for integer-valued ODM attributes.

Accepts int values and strings that convert to int (e.g., “42”). Used for OrderNumber, KeySequence, and similar integer attributes.

MethodOID: Descriptor for string-valued ODM attributes.

Role: Descriptor for string-valued ODM attributes.

RoleCodeListOID: Descriptor for string-valued ODM attributes.

IsNonStandard

String descriptor that validates against a dynamically-loaded set of permitted values.

Combines string type validation with value set membership checking. Used for attributes like FileType, Repeating, Mandatory, DataType, etc.

HasNoData

String descriptor that validates against a dynamically-loaded set of permitted values.

Combines string type validation with value set membership checking. Used for attributes like FileType, Repeating, Mandatory, DataType, etc.

WhereClauseRef

Descriptor for a list of child ODM elements.

Validates that all items assigned to the list are instances of the expected element class. Stored as a plain list in the instance.

Parameters:

element_class (type) – The class that all list items must be.
namespace (str) – XML namespace prefix (default: “odm”).

namespace = 'odm'

class odmlib.arm_1_0.model.ItemGroupDef(**kwargs)[source]

Bases: ItemGroupDef

ARM ItemGroupDef element (identical to Define-XML 2.1).

Parameters:: kwargs (Any)

OID

Descriptor for OID (Object Identifier) attributes.

OIDs uniquely identify definition elements within a MetaDataVersion. Used on the OID attribute of *Def elements (e.g., ItemDef.OID).

Name: Descriptor for the Name attribute of ODM elements.

Repeating

String descriptor that validates against a dynamically-loaded set of permitted values.

Combines string type validation with value set membership checking. Used for attributes like FileType, Repeating, Mandatory, DataType, etc.

IsReferenceData

String descriptor that validates against a dynamically-loaded set of permitted values.

Combines string type validation with value set membership checking. Used for attributes like FileType, Repeating, Mandatory, DataType, etc.

SASDatasetName

Descriptor for SAS variable/dataset name attributes.

Validates that the value starts with a letter or underscore, contains only alphanumerics and underscores, and is at most 8 characters long. Used for SASFieldName, SASDatasetName, etc.

Domain: Descriptor for string-valued ODM attributes.

Purpose: Descriptor for string-valued ODM attributes.

Structure: Descriptor for string-valued ODM attributes.

ArchiveLocationID: Descriptor for string-valued ODM attributes.

CommentOID

Descriptor for OID reference attributes.

References the OID of a definition element. Used on reference elements (e.g., ItemRef.ItemOID references ItemDef.OID).

IsNonStandard

String descriptor that validates against a dynamically-loaded set of permitted values.

Combines string type validation with value set membership checking. Used for attributes like FileType, Repeating, Mandatory, DataType, etc.

StandardOID

Descriptor for OID reference attributes.

References the OID of a definition element. Used on reference elements (e.g., ItemRef.ItemOID references ItemDef.OID).

HasNoData

String descriptor that validates against a dynamically-loaded set of permitted values.

Combines string type validation with value set membership checking. Used for attributes like FileType, Repeating, Mandatory, DataType, etc.

Description

Descriptor for a single child ODM element.

Stores a reference to the element class and validates type on assignment. When accessed on an unset optional attribute, instantiates the element class with no arguments.

Parameters:

element_class (type) – The expected child element class.
namespace (str) – XML namespace prefix (default: “odm”).

ItemRef

Descriptor for a list of child ODM elements.

Validates that all items assigned to the list are instances of the expected element class. Stored as a plain list in the instance.

Parameters:

element_class (type) – The class that all list items must be.
namespace (str) – XML namespace prefix (default: “odm”).

Alias

Descriptor for a list of child ODM elements.

Validates that all items assigned to the list are instances of the expected element class. Stored as a plain list in the instance.

Parameters:

element_class (type) – The class that all list items must be.
namespace (str) – XML namespace prefix (default: “odm”).

Class

Descriptor for a single child ODM element.

Stores a reference to the element class and validates type on assignment. When accessed on an unset optional attribute, instantiates the element class with no arguments.

Parameters:

element_class (type) – The expected child element class.
namespace (str) – XML namespace prefix (default: “odm”).

leaf

Descriptor for a single child ODM element.

Stores a reference to the element class and validates type on assignment. When accessed on an unset optional attribute, instantiates the element class with no arguments.

Parameters:

element_class (type) – The expected child element class.
namespace (str) – XML namespace prefix (default: “odm”).

namespace = 'odm'

class odmlib.arm_1_0.model.CheckValue(**kwargs)[source]

Bases: CheckValue

ARM CheckValue element (identical to Define-XML 2.1).

Parameters:: kwargs (Any)

namespace = 'odm'

class odmlib.arm_1_0.model.FormalExpression(**kwargs)[source]

Bases: FormalExpression

ARM FormalExpression element (identical to Define-XML 2.1).

Parameters:: kwargs (Any)

Context: Descriptor for string-valued ODM attributes.

namespace = 'odm'

class odmlib.arm_1_0.model.RangeCheck(**kwargs)[source]

Bases: RangeCheck

ARM RangeCheck element (identical to Define-XML 2.1).

Parameters:: kwargs (Any)

Comparator

String descriptor that validates against a dynamically-loaded set of permitted values.

Combines string type validation with value set membership checking. Used for attributes like FileType, Repeating, Mandatory, DataType, etc.

SoftHard

String descriptor that validates against a dynamically-loaded set of permitted values.

Combines string type validation with value set membership checking. Used for attributes like FileType, Repeating, Mandatory, DataType, etc.

ItemOID

Descriptor for OID reference attributes.

References the OID of a definition element. Used on reference elements (e.g., ItemRef.ItemOID references ItemDef.OID).

CheckValue

Descriptor for a list of child ODM elements.

Validates that all items assigned to the list are instances of the expected element class. Stored as a plain list in the instance.

Parameters:

element_class (type) – The class that all list items must be.
namespace (str) – XML namespace prefix (default: “odm”).

namespace = 'odm'

class odmlib.arm_1_0.model.CodeListRef(**kwargs)[source]

Bases: CodeListRef

ARM CodeListRef element (identical to Define-XML 2.1).

Parameters:: kwargs (Any)

CodeListOID

Descriptor for OID reference attributes.

References the OID of a definition element. Used on reference elements (e.g., ItemRef.ItemOID references ItemDef.OID).

namespace = 'odm'

class odmlib.arm_1_0.model.ValueListRef(**kwargs)[source]

Bases: ValueListRef

ARM ValueListRef element (def namespace).

Parameters:: kwargs (Any)

namespace = 'def'

ValueListOID

Descriptor for OID reference attributes.

References the OID of a definition element. Used on reference elements (e.g., ItemRef.ItemOID references ItemDef.OID).

class odmlib.arm_1_0.model.Origin(**kwargs)[source]

Bases: Origin

ARM Origin element (def namespace).

Parameters:: kwargs (Any)

namespace = 'def'

Type

Descriptor that validates against an explicit list of permitted values.

Unlike ValidValues, the allowed values are provided at class definition time in the valid_values list argument.

Source

Descriptor that validates against an explicit list of permitted values.

Unlike ValidValues, the allowed values are provided at class definition time in the valid_values list argument.

Description

Descriptor for a single child ODM element.

Stores a reference to the element class and validates type on assignment. When accessed on an unset optional attribute, instantiates the element class with no arguments.

Parameters:

element_class (type) – The expected child element class.
namespace (str) – XML namespace prefix (default: “odm”).

DocumentRef

Descriptor for a list of child ODM elements.

Validates that all items assigned to the list are instances of the expected element class. Stored as a plain list in the instance.

Parameters:

element_class (type) – The class that all list items must be.
namespace (str) – XML namespace prefix (default: “odm”).

class odmlib.arm_1_0.model.ItemDef(**kwargs)[source]

Bases: ItemDef

ARM ItemDef element (identical to Define-XML 2.1).

Parameters:: kwargs (Any)

OID

Descriptor for OID (Object Identifier) attributes.

OIDs uniquely identify definition elements within a MetaDataVersion. Used on the OID attribute of *Def elements (e.g., ItemDef.OID).

Name: Descriptor for the Name attribute of ODM elements.

DataType

String descriptor that validates against a dynamically-loaded set of permitted values.

Combines string type validation with value set membership checking. Used for attributes like FileType, Repeating, Mandatory, DataType, etc.

Length

Descriptor for positive integer attributes (value > 0).

Combines integer type validation with positive value constraint. Used for Length, ItemGroupDataSeq, and similar attributes.

SignificantDigits

Descriptor for non-negative integer attributes (value >= 0).

Combines integer type validation with non-negative constraint. Used for SignificantDigits and similar attributes.

SASFieldName

Descriptor for SAS variable/dataset name attributes.

Validates that the value starts with a letter or underscore, contains only alphanumerics and underscores, and is at most 8 characters long. Used for SASFieldName, SASDatasetName, etc.

DisplayFormat: Descriptor for string-valued ODM attributes.

CommentOID

Descriptor for OID reference attributes.

References the OID of a definition element. Used on reference elements (e.g., ItemRef.ItemOID references ItemDef.OID).

Description

Descriptor for a single child ODM element.

Stores a reference to the element class and validates type on assignment. When accessed on an unset optional attribute, instantiates the element class with no arguments.

Parameters:

element_class (type) – The expected child element class.
namespace (str) – XML namespace prefix (default: “odm”).

CodeListRef

Descriptor for a single child ODM element.

Stores a reference to the element class and validates type on assignment. When accessed on an unset optional attribute, instantiates the element class with no arguments.

Parameters:

element_class (type) – The expected child element class.
namespace (str) – XML namespace prefix (default: “odm”).

Origin

Descriptor for a list of child ODM elements.

Validates that all items assigned to the list are instances of the expected element class. Stored as a plain list in the instance.

Parameters:

element_class (type) – The class that all list items must be.
namespace (str) – XML namespace prefix (default: “odm”).

ValueListRef

Descriptor for a single child ODM element.

Stores a reference to the element class and validates type on assignment. When accessed on an unset optional attribute, instantiates the element class with no arguments.

Parameters:

element_class (type) – The expected child element class.
namespace (str) – XML namespace prefix (default: “odm”).

Alias

Descriptor for a list of child ODM elements.

Validates that all items assigned to the list are instances of the expected element class. Stored as a plain list in the instance.

Parameters:

element_class (type) – The class that all list items must be.
namespace (str) – XML namespace prefix (default: “odm”).

namespace = 'odm'

class odmlib.arm_1_0.model.Decode(**kwargs)[source]

Bases: Decode

ARM Decode element (identical to Define-XML 2.1).

Parameters:: kwargs (Any)

TranslatedText

Descriptor for a list of child ODM elements.

Validates that all items assigned to the list are instances of the expected element class. Stored as a plain list in the instance.

Parameters:

element_class (type) – The class that all list items must be.
namespace (str) – XML namespace prefix (default: “odm”).

namespace = 'odm'

class odmlib.arm_1_0.model.CodeListItem(**kwargs)[source]

Bases: CodeListItem

ARM CodeListItem element (identical to Define-XML 2.1).

Parameters:: kwargs (Any)

CodedValue: Descriptor for string-valued ODM attributes.

Rank

Descriptor for float-valued ODM attributes.

Accepts float, int, and string values that convert to float. Used for Rank attributes in CodeListItem and EnumeratedItem.

OrderNumber

Descriptor for integer-valued ODM attributes.

Accepts int values and strings that convert to int (e.g., “42”). Used for OrderNumber, KeySequence, and similar integer attributes.

ExtendedValue

String descriptor that validates against a dynamically-loaded set of permitted values.

Combines string type validation with value set membership checking. Used for attributes like FileType, Repeating, Mandatory, DataType, etc.

Description

Descriptor for a single child ODM element.

Stores a reference to the element class and validates type on assignment. When accessed on an unset optional attribute, instantiates the element class with no arguments.

Parameters:

element_class (type) – The expected child element class.
namespace (str) – XML namespace prefix (default: “odm”).

Decode

Descriptor for a single child ODM element.

Stores a reference to the element class and validates type on assignment. When accessed on an unset optional attribute, instantiates the element class with no arguments.

Parameters:

element_class (type) – The expected child element class.
namespace (str) – XML namespace prefix (default: “odm”).

Alias

Descriptor for a list of child ODM elements.

Validates that all items assigned to the list are instances of the expected element class. Stored as a plain list in the instance.

Parameters:

element_class (type) – The class that all list items must be.
namespace (str) – XML namespace prefix (default: “odm”).

namespace = 'odm'

class odmlib.arm_1_0.model.EnumeratedItem(**kwargs)[source]

Bases: EnumeratedItem

ARM EnumeratedItem element (identical to Define-XML 2.1).

Parameters:: kwargs (Any)

CodedValue: Descriptor for string-valued ODM attributes.

Rank

Descriptor for float-valued ODM attributes.

Accepts float, int, and string values that convert to float. Used for Rank attributes in CodeListItem and EnumeratedItem.

OrderNumber

Descriptor for integer-valued ODM attributes.

Accepts int values and strings that convert to int (e.g., “42”). Used for OrderNumber, KeySequence, and similar integer attributes.

ExtendedValue

String descriptor that validates against a dynamically-loaded set of permitted values.

Combines string type validation with value set membership checking. Used for attributes like FileType, Repeating, Mandatory, DataType, etc.

Description

Descriptor for a single child ODM element.

Stores a reference to the element class and validates type on assignment. When accessed on an unset optional attribute, instantiates the element class with no arguments.

Parameters:

element_class (type) – The expected child element class.
namespace (str) – XML namespace prefix (default: “odm”).

Alias

Descriptor for a list of child ODM elements.

Validates that all items assigned to the list are instances of the expected element class. Stored as a plain list in the instance.

Parameters:

element_class (type) – The class that all list items must be.
namespace (str) – XML namespace prefix (default: “odm”).

namespace = 'odm'

class odmlib.arm_1_0.model.ExternalCodeList(**kwargs)[source]

Bases: ExternalCodeList

ARM ExternalCodeList element (identical to Define-XML 2.1).

Parameters:: kwargs (Any)

Dictionary: Descriptor for string-valued ODM attributes.

Version: Descriptor for string-valued ODM attributes.

ref: Descriptor for string-valued ODM attributes.

href: Descriptor for string-valued ODM attributes.

namespace = 'odm'

class odmlib.arm_1_0.model.CodeList(**kwargs)[source]

Bases: CodeList

ARM CodeList element (identical to Define-XML 2.1).

Parameters:: kwargs (Any)

OID

Descriptor for OID (Object Identifier) attributes.

OIDs uniquely identify definition elements within a MetaDataVersion. Used on the OID attribute of *Def elements (e.g., ItemDef.OID).

Name: Descriptor for the Name attribute of ODM elements.

DataType

String descriptor that validates against a dynamically-loaded set of permitted values.

Combines string type validation with value set membership checking. Used for attributes like FileType, Repeating, Mandatory, DataType, etc.

IsNonStandard

String descriptor that validates against a dynamically-loaded set of permitted values.

Combines string type validation with value set membership checking. Used for attributes like FileType, Repeating, Mandatory, DataType, etc.

StandardOID: Descriptor for string-valued ODM attributes.

SASFormatName

Descriptor for SAS format name attributes.

Validates that the value starts with a letter, underscore, or $, contains only alphanumerics, underscores, and dots, and is at most 8 characters long. Used for SASFormatName.

CommentOID

Descriptor for OID reference attributes.

References the OID of a definition element. Used on reference elements (e.g., ItemRef.ItemOID references ItemDef.OID).

Description

Descriptor for a single child ODM element.

Stores a reference to the element class and validates type on assignment. When accessed on an unset optional attribute, instantiates the element class with no arguments.

Parameters:

element_class (type) – The expected child element class.
namespace (str) – XML namespace prefix (default: “odm”).

CodeListItem

Descriptor for a list of child ODM elements.

Validates that all items assigned to the list are instances of the expected element class. Stored as a plain list in the instance.

Parameters:

element_class (type) – The class that all list items must be.
namespace (str) – XML namespace prefix (default: “odm”).

EnumeratedItem

Descriptor for a list of child ODM elements.

Validates that all items assigned to the list are instances of the expected element class. Stored as a plain list in the instance.

Parameters:

element_class (type) – The class that all list items must be.
namespace (str) – XML namespace prefix (default: “odm”).

ExternalCodeList

Descriptor for a single child ODM element.

Stores a reference to the element class and validates type on assignment. When accessed on an unset optional attribute, instantiates the element class with no arguments.

Parameters:

element_class (type) – The expected child element class.
namespace (str) – XML namespace prefix (default: “odm”).

Alias

Descriptor for a list of child ODM elements.

Validates that all items assigned to the list are instances of the expected element class. Stored as a plain list in the instance.

Parameters:

element_class (type) – The class that all list items must be.
namespace (str) – XML namespace prefix (default: “odm”).

namespace = 'odm'

class odmlib.arm_1_0.model.MethodDef(**kwargs)[source]

Bases: MethodDef

ARM MethodDef element (identical to Define-XML 2.1).

Parameters:: kwargs (Any)

OID

Descriptor for OID (Object Identifier) attributes.

OIDs uniquely identify definition elements within a MetaDataVersion. Used on the OID attribute of *Def elements (e.g., ItemDef.OID).

Name: Descriptor for the Name attribute of ODM elements.

Type

String descriptor that validates against a dynamically-loaded set of permitted values.

Combines string type validation with value set membership checking. Used for attributes like FileType, Repeating, Mandatory, DataType, etc.

Description

Descriptor for a single child ODM element.

Stores a reference to the element class and validates type on assignment. When accessed on an unset optional attribute, instantiates the element class with no arguments.

Parameters:

element_class (type) – The expected child element class.
namespace (str) – XML namespace prefix (default: “odm”).

FormalExpression

Descriptor for a list of child ODM elements.

Validates that all items assigned to the list are instances of the expected element class. Stored as a plain list in the instance.

Parameters:

element_class (type) – The class that all list items must be.
namespace (str) – XML namespace prefix (default: “odm”).

DocumentRef

Descriptor for a list of child ODM elements.

Validates that all items assigned to the list are instances of the expected element class. Stored as a plain list in the instance.

Parameters:

element_class (type) – The class that all list items must be.
namespace (str) – XML namespace prefix (default: “odm”).

namespace = 'odm'

class odmlib.arm_1_0.model.AnnotatedCRF(**kwargs)[source]

Bases: AnnotatedCRF

ARM AnnotatedCRF element (def namespace).

Parameters:: kwargs (Any)

namespace = 'def'

DocumentRef

Descriptor for a single child ODM element.

Stores a reference to the element class and validates type on assignment. When accessed on an unset optional attribute, instantiates the element class with no arguments.

Parameters:

element_class (type) – The expected child element class.
namespace (str) – XML namespace prefix (default: “odm”).

class odmlib.arm_1_0.model.SupplementalDoc(**kwargs)[source]

Bases: SupplementalDoc

ARM SupplementalDoc element (def namespace).

Parameters:: kwargs (Any)

namespace = 'def'

DocumentRef

Descriptor for a list of child ODM elements.

Validates that all items assigned to the list are instances of the expected element class. Stored as a plain list in the instance.

Parameters:

element_class (type) – The class that all list items must be.
namespace (str) – XML namespace prefix (default: “odm”).

class odmlib.arm_1_0.model.WhereClauseDef(**kwargs)[source]

Bases: WhereClauseDef

ARM WhereClauseDef element (def namespace).

Parameters:: kwargs (Any)

namespace = 'def'

OID

Descriptor for OID (Object Identifier) attributes.

OIDs uniquely identify definition elements within a MetaDataVersion. Used on the OID attribute of *Def elements (e.g., ItemDef.OID).

CommentOID

Descriptor for OID reference attributes.

References the OID of a definition element. Used on reference elements (e.g., ItemRef.ItemOID references ItemDef.OID).

RangeCheck

Descriptor for a list of child ODM elements.

Validates that all items assigned to the list are instances of the expected element class. Stored as a plain list in the instance.

Parameters:

element_class (type) – The class that all list items must be.
namespace (str) – XML namespace prefix (default: “odm”).

class odmlib.arm_1_0.model.ValueListDef(**kwargs)[source]

Bases: ValueListDef

ARM ValueListDef element (def namespace).

Parameters:: kwargs (Any)

namespace = 'def'

OID

Descriptor for OID (Object Identifier) attributes.

OIDs uniquely identify definition elements within a MetaDataVersion. Used on the OID attribute of *Def elements (e.g., ItemDef.OID).

Description

Descriptor for a single child ODM element.

Stores a reference to the element class and validates type on assignment. When accessed on an unset optional attribute, instantiates the element class with no arguments.

Parameters:

element_class (type) – The expected child element class.
namespace (str) – XML namespace prefix (default: “odm”).

ItemRef

Descriptor for a list of child ODM elements.

Validates that all items assigned to the list are instances of the expected element class. Stored as a plain list in the instance.

Parameters:

element_class (type) – The class that all list items must be.
namespace (str) – XML namespace prefix (default: “odm”).

class odmlib.arm_1_0.model.CommentDef(**kwargs)[source]

Bases: CommentDef

ARM CommentDef element (def namespace).

Parameters:: kwargs (Any)

namespace = 'def'

OID

Descriptor for OID (Object Identifier) attributes.

OIDs uniquely identify definition elements within a MetaDataVersion. Used on the OID attribute of *Def elements (e.g., ItemDef.OID).

Description

Descriptor for a single child ODM element.

Stores a reference to the element class and validates type on assignment. When accessed on an unset optional attribute, instantiates the element class with no arguments.

Parameters:

element_class (type) – The expected child element class.
namespace (str) – XML namespace prefix (default: “odm”).

DocumentRef

Descriptor for a list of child ODM elements.

Validates that all items assigned to the list are instances of the expected element class. Stored as a plain list in the instance.

Parameters:

element_class (type) – The class that all list items must be.
namespace (str) – XML namespace prefix (default: “odm”).

class odmlib.arm_1_0.model.Standard(**kwargs)[source]

Bases: Standard

ARM Standard element (def namespace).

Parameters:: kwargs (Any)

namespace = 'def'

OID

Descriptor for OID (Object Identifier) attributes.

OIDs uniquely identify definition elements within a MetaDataVersion. Used on the OID attribute of *Def elements (e.g., ItemDef.OID).

Name: Descriptor for the Name attribute of ODM elements.

Type: Descriptor for string-valued ODM attributes.

PublishingSet: Descriptor for string-valued ODM attributes.

Version: Descriptor for string-valued ODM attributes.

Status: Descriptor for string-valued ODM attributes.

CommentOID

Descriptor for OID reference attributes.

References the OID of a definition element. Used on reference elements (e.g., ItemRef.ItemOID references ItemDef.OID).

class odmlib.arm_1_0.model.Standards(**kwargs)[source]

Bases: Standards

ARM Standards element (def namespace).

Parameters:: kwargs (Any)

namespace = 'def'

Standard

Descriptor for a list of child ODM elements.

Validates that all items assigned to the list are instances of the expected element class. Stored as a plain list in the instance.

Parameters:

element_class (type) – The class that all list items must be.
namespace (str) – XML namespace prefix (default: “odm”).

class odmlib.arm_1_0.model.Documentation(**kwargs)[source]

Bases: ODMElement

ARM Documentation element containing descriptive text and references.

Provides documentation for an analysis result, including a description and references to external documents (e.g., SAP sections).

Parameters:: kwargs (Any)

Description: Textual description of the documentation.

DocumentRef: References to external documents.

namespace = 'arm'

Description

Descriptor for a single child ODM element.

Stores a reference to the element class and validates type on assignment. When accessed on an unset optional attribute, instantiates the element class with no arguments.

Parameters:

element_class (type) – The expected child element class.
namespace (str) – XML namespace prefix (default: “odm”).

DocumentRef

Descriptor for a list of child ODM elements.

Validates that all items assigned to the list are instances of the expected element class. Stored as a plain list in the instance.

Parameters:

element_class (type) – The class that all list items must be.
namespace (str) – XML namespace prefix (default: “odm”).

class odmlib.arm_1_0.model.Code(**kwargs)[source]

Bases: ODMElement

ARM Code element containing programming code text.

Holds the actual source code text for an analysis (e.g., SAS code).

Parameters:: kwargs (Any)

_content

The programming code text content.

Type:: str

namespace = 'arm'

class odmlib.arm_1_0.model.ProgrammingCode(**kwargs)[source]

Bases: ODMElement

ARM ProgrammingCode element describing analysis code.

Contains the programming context (e.g., “SAS version 9.2”), the code itself, and optional references to code documentation.

Parameters:: kwargs (Any)

Context

Programming language/environment context.

Type:: str

Code: The programming code content.

DocumentRef: References to external code documentation.

namespace = 'arm'

Context: alias of String

Code

Descriptor for a single child ODM element.

Stores a reference to the element class and validates type on assignment. When accessed on an unset optional attribute, instantiates the element class with no arguments.

Parameters:

element_class (type) – The expected child element class.
namespace (str) – XML namespace prefix (default: “odm”).

DocumentRef

Descriptor for a list of child ODM elements.

Validates that all items assigned to the list are instances of the expected element class. Stored as a plain list in the instance.

Parameters:

element_class (type) – The class that all list items must be.
namespace (str) – XML namespace prefix (default: “odm”).

class odmlib.arm_1_0.model.AnalysisVariable(**kwargs)[source]

Bases: ODMElement

ARM AnalysisVariable element referencing a variable used in analysis.

Parameters:: kwargs (Any)

ItemOID

OID reference to the ItemDef for this variable.

Type:: str, required

namespace = 'arm'

ItemOID

Descriptor for OID reference attributes.

References the OID of a definition element. Used on reference elements (e.g., ItemRef.ItemOID references ItemDef.OID).

class odmlib.arm_1_0.model.AnalysisDataset(**kwargs)[source]

Bases: ODMElement

ARM AnalysisDataset element describing a dataset used in analysis.

References an ItemGroupDef and optionally filters rows via a WhereClauseRef. Contains the list of analysis variables used from this dataset.

Parameters:: kwargs (Any)

ItemGroupOID

OID reference to the ItemGroupDef.

Type:: str, required

WhereClauseRef: Optional row filter clause.

AnalysisVariable: List of variables from this dataset used in the analysis.

namespace = 'arm'

ItemGroupOID

Descriptor for OID reference attributes.

References the OID of a definition element. Used on reference elements (e.g., ItemRef.ItemOID references ItemDef.OID).

WhereClauseRef

Descriptor for a single child ODM element.

Stores a reference to the element class and validates type on assignment. When accessed on an unset optional attribute, instantiates the element class with no arguments.

Parameters:

element_class (type) – The expected child element class.
namespace (str) – XML namespace prefix (default: “odm”).

AnalysisVariable

Descriptor for a list of child ODM elements.

Validates that all items assigned to the list are instances of the expected element class. Stored as a plain list in the instance.

Parameters:

element_class (type) – The class that all list items must be.
namespace (str) – XML namespace prefix (default: “odm”).

class odmlib.arm_1_0.model.AnalysisDatasets(**kwargs)[source]

Bases: ODMElement

ARM AnalysisDatasets container for analysis dataset references.

Parameters:: kwargs (Any)

CommentOID

Optional OID reference to a CommentDef.

Type:: str

AnalysisDataset: List of analysis datasets.

namespace = 'arm'

CommentOID

Descriptor for OID reference attributes.

References the OID of a definition element. Used on reference elements (e.g., ItemRef.ItemOID references ItemDef.OID).

AnalysisDataset

Descriptor for a list of child ODM elements.

Validates that all items assigned to the list are instances of the expected element class. Stored as a plain list in the instance.

Parameters:

element_class (type) – The class that all list items must be.
namespace (str) – XML namespace prefix (default: “odm”).

class odmlib.arm_1_0.model.AnalysisResult(**kwargs)[source]

Bases: ODMElement

ARM AnalysisResult element describing a single analysis result.

Captures the reason and purpose for the analysis, along with documentation, programming code, and the datasets involved.

Parameters:: kwargs (Any)

OID

Unique identifier for this analysis result.

Type:: str, required

ParameterOID

OID reference to the parameter variable.

Type:: str

AnalysisReason

Reason for the analysis (e.g., “SPECIFIED IN SAP”, “DATA DRIVEN”).

Type:: str, required

AnalysisPurpose

Purpose of the analysis (e.g., “PRIMARY OUTCOME MEASURE”).

Type:: str, required

Description: Textual description of the analysis.

AnalysisDatasets: Datasets used in this analysis.

Documentation: Supporting documentation and references.

ProgrammingCode: Code used to produce this result.

namespace = 'arm'

OID

Descriptor for OID (Object Identifier) attributes.

OIDs uniquely identify definition elements within a MetaDataVersion. Used on the OID attribute of *Def elements (e.g., ItemDef.OID).

ParameterOID

Descriptor for OID reference attributes.

References the OID of a definition element. Used on reference elements (e.g., ItemRef.ItemOID references ItemDef.OID).

AnalysisReason

Descriptor that validates against an explicit list of permitted values.

Unlike ValidValues, the allowed values are provided at class definition time in the valid_values list argument.

AnalysisPurpose

Descriptor that validates against an explicit list of permitted values.

Unlike ValidValues, the allowed values are provided at class definition time in the valid_values list argument.

Description

Descriptor for a single child ODM element.

Stores a reference to the element class and validates type on assignment. When accessed on an unset optional attribute, instantiates the element class with no arguments.

Parameters:

element_class (type) – The expected child element class.
namespace (str) – XML namespace prefix (default: “odm”).

AnalysisDatasets

Descriptor for a single child ODM element.

Stores a reference to the element class and validates type on assignment. When accessed on an unset optional attribute, instantiates the element class with no arguments.

Parameters:

element_class (type) – The expected child element class.
namespace (str) – XML namespace prefix (default: “odm”).

Documentation

Descriptor for a single child ODM element.

Stores a reference to the element class and validates type on assignment. When accessed on an unset optional attribute, instantiates the element class with no arguments.

Parameters:

element_class (type) – The expected child element class.
namespace (str) – XML namespace prefix (default: “odm”).

ProgrammingCode

Descriptor for a single child ODM element.

Stores a reference to the element class and validates type on assignment. When accessed on an unset optional attribute, instantiates the element class with no arguments.

Parameters:

element_class (type) – The expected child element class.
namespace (str) – XML namespace prefix (default: “odm”).

class odmlib.arm_1_0.model.ResultDisplay(**kwargs)[source]

Bases: ODMElement

ARM ResultDisplay element representing a display of analysis results.

Groups one or more AnalysisResult elements that share a common display (e.g., a table or figure in a clinical study report).

Parameters:: kwargs (Any)

OID

Unique identifier for this result display.

Type:: str, required

Name

Human-readable name of the display.

Type:: str, required

Description: Textual description of the display.

DocumentRef: References to the display location in external documents.

AnalysisResult: List of analysis results shown in this display.

namespace = 'arm'

OID

Descriptor for OID (Object Identifier) attributes.

OIDs uniquely identify definition elements within a MetaDataVersion. Used on the OID attribute of *Def elements (e.g., ItemDef.OID).

Name: Descriptor for the Name attribute of ODM elements.

Description

Descriptor for a single child ODM element.

Stores a reference to the element class and validates type on assignment. When accessed on an unset optional attribute, instantiates the element class with no arguments.

Parameters:

element_class (type) – The expected child element class.
namespace (str) – XML namespace prefix (default: “odm”).

DocumentRef

Descriptor for a list of child ODM elements.

Validates that all items assigned to the list are instances of the expected element class. Stored as a plain list in the instance.

Parameters:

element_class (type) – The class that all list items must be.
namespace (str) – XML namespace prefix (default: “odm”).

AnalysisResult

Descriptor for a list of child ODM elements.

Validates that all items assigned to the list are instances of the expected element class. Stored as a plain list in the instance.

Parameters:

element_class (type) – The class that all list items must be.
namespace (str) – XML namespace prefix (default: “odm”).

class odmlib.arm_1_0.model.AnalysisResultDisplays(**kwargs)[source]

Bases: ODMElement

ARM AnalysisResultDisplays container at the MetaDataVersion level.

Top-level ARM element that holds all ResultDisplay elements for an ADaM Define-XML document.

Parameters:: kwargs (Any)

ResultDisplay: List of result displays.

namespace = 'arm'

ResultDisplay

Descriptor for a list of child ODM elements.

Validates that all items assigned to the list are instances of the expected element class. Stored as a plain list in the instance.

Parameters:

element_class (type) – The class that all list items must be.
namespace (str) – XML namespace prefix (default: “odm”).

class odmlib.arm_1_0.model.MetaDataVersion(**kwargs)[source]

Bases: MetaDataVersion

ARM-extended MetaDataVersion adding AnalysisResultDisplays.

Extends the Define-XML 2.1 MetaDataVersion with the ARM AnalysisResultDisplays element.

Parameters:: kwargs (Any)

OID

Descriptor for OID (Object Identifier) attributes.

OIDs uniquely identify definition elements within a MetaDataVersion. Used on the OID attribute of *Def elements (e.g., ItemDef.OID).

Name: Descriptor for the Name attribute of ODM elements.

Description: Descriptor for string-valued ODM attributes.

DefineVersion

String descriptor that validates against a dynamically-loaded set of permitted values.

Combines string type validation with value set membership checking. Used for attributes like FileType, Repeating, Mandatory, DataType, etc.

CommentOID

Descriptor for OID reference attributes.

References the OID of a definition element. Used on reference elements (e.g., ItemRef.ItemOID references ItemDef.OID).

Standards

Descriptor for a single child ODM element.

Stores a reference to the element class and validates type on assignment. When accessed on an unset optional attribute, instantiates the element class with no arguments.

Parameters:

element_class (type) – The expected child element class.
namespace (str) – XML namespace prefix (default: “odm”).

AnnotatedCRF

Descriptor for a single child ODM element.

Stores a reference to the element class and validates type on assignment. When accessed on an unset optional attribute, instantiates the element class with no arguments.

Parameters:

element_class (type) – The expected child element class.
namespace (str) – XML namespace prefix (default: “odm”).

SupplementalDoc

Descriptor for a single child ODM element.

Stores a reference to the element class and validates type on assignment. When accessed on an unset optional attribute, instantiates the element class with no arguments.

Parameters:

element_class (type) – The expected child element class.
namespace (str) – XML namespace prefix (default: “odm”).

ValueListDef

Descriptor for a list of child ODM elements.

Validates that all items assigned to the list are instances of the expected element class. Stored as a plain list in the instance.

Parameters:

element_class (type) – The class that all list items must be.
namespace (str) – XML namespace prefix (default: “odm”).

WhereClauseDef

Descriptor for a list of child ODM elements.

Validates that all items assigned to the list are instances of the expected element class. Stored as a plain list in the instance.

Parameters:

element_class (type) – The class that all list items must be.
namespace (str) – XML namespace prefix (default: “odm”).

ItemGroupDef

Descriptor for a list of child ODM elements.

Validates that all items assigned to the list are instances of the expected element class. Stored as a plain list in the instance.

Parameters:

element_class (type) – The class that all list items must be.
namespace (str) – XML namespace prefix (default: “odm”).

ItemDef

Descriptor for a list of child ODM elements.

Validates that all items assigned to the list are instances of the expected element class. Stored as a plain list in the instance.

Parameters:

element_class (type) – The class that all list items must be.
namespace (str) – XML namespace prefix (default: “odm”).

CodeList

Descriptor for a list of child ODM elements.

Validates that all items assigned to the list are instances of the expected element class. Stored as a plain list in the instance.

Parameters:

element_class (type) – The class that all list items must be.
namespace (str) – XML namespace prefix (default: “odm”).

MethodDef

Descriptor for a list of child ODM elements.

Validates that all items assigned to the list are instances of the expected element class. Stored as a plain list in the instance.

Parameters:

element_class (type) – The class that all list items must be.
namespace (str) – XML namespace prefix (default: “odm”).

CommentDef

Descriptor for a list of child ODM elements.

Validates that all items assigned to the list are instances of the expected element class. Stored as a plain list in the instance.

Parameters:

element_class (type) – The class that all list items must be.
namespace (str) – XML namespace prefix (default: “odm”).

leaf

Descriptor for a list of child ODM elements.

Validates that all items assigned to the list are instances of the expected element class. Stored as a plain list in the instance.

Parameters:

element_class (type) – The class that all list items must be.
namespace (str) – XML namespace prefix (default: “odm”).

AnalysisResultDisplays

Descriptor for a single child ODM element.

Stores a reference to the element class and validates type on assignment. When accessed on an unset optional attribute, instantiates the element class with no arguments.

Parameters:

element_class (type) – The expected child element class.
namespace (str) – XML namespace prefix (default: “odm”).

namespace = 'odm'

class odmlib.arm_1_0.model.Study(**kwargs)[source]

Bases: Study

ARM-extended Study element.

Parameters:: kwargs (Any)

OID: Descriptor for string-valued ODM attributes.

GlobalVariables

Descriptor for a single child ODM element.

Stores a reference to the element class and validates type on assignment. When accessed on an unset optional attribute, instantiates the element class with no arguments.

Parameters:

element_class (type) – The expected child element class.
namespace (str) – XML namespace prefix (default: “odm”).

MetaDataVersion

Descriptor for a single child ODM element.

Stores a reference to the element class and validates type on assignment. When accessed on an unset optional attribute, instantiates the element class with no arguments.

Parameters:

element_class (type) – The expected child element class.
namespace (str) – XML namespace prefix (default: “odm”).

namespace = 'odm'

class odmlib.arm_1_0.model.ODM(**kwargs)[source]

Bases: ODM

ARM-extended ODM root element.

Parameters:: kwargs (Any)

FileType

Descriptor that validates against an explicit list of permitted values.

Unlike ValidValues, the allowed values are provided at class definition time in the valid_values list argument.

FileOID

Descriptor for OID (Object Identifier) attributes.

OIDs uniquely identify definition elements within a MetaDataVersion. Used on the OID attribute of *Def elements (e.g., ItemDef.OID).

CreationDateTime

Descriptor for ISO 8601 datetime strings.

Validates format: YYYY-MM-DDTHH:MM:SS[.sss][Z|±HH:MM]

Used for CreationDateTime, AsOfDateTime, and similar attributes.

AsOfDateTime

Descriptor for ISO 8601 datetime strings.

Validates format: YYYY-MM-DDTHH:MM:SS[.sss][Z|±HH:MM]

Used for CreationDateTime, AsOfDateTime, and similar attributes.

ODMVersion

Descriptor that validates against an explicit list of permitted values.

Unlike ValidValues, the allowed values are provided at class definition time in the valid_values list argument.

Originator: Descriptor for string-valued ODM attributes.

SourceSystem: Descriptor for string-valued ODM attributes.

SourceSystemVersion: Descriptor for string-valued ODM attributes.

schemaLocation: Descriptor for string-valued ODM attributes.

Context

String descriptor that validates against a dynamically-loaded set of permitted values.

Combines string type validation with value set membership checking. Used for attributes like FileType, Repeating, Mandatory, DataType, etc.

ID: Descriptor for XML ID attributes.

Study

Descriptor for a single child ODM element.

Stores a reference to the element class and validates type on assignment. When accessed on an unset optional attribute, instantiates the element class with no arguments.

Parameters:

element_class (type) – The expected child element class.
namespace (str) – XML namespace prefix (default: “odm”).

namespace = 'odm'