class ItemGroupDef(ODM.ItemGroupDef):
OID = ODM.ItemGroupDef.OID
Name = ODM.ItemGroupDef.Name
Repeating = ODM.ItemGroupDef.Repeating
IsReferenceData = ODM.ItemGroupDef.IsReferenceData
SASDatasetName = ODM.ItemGroupDef.SASDatasetName
Domain = ODM.ItemGroupDef.Domain
Purpose = ODM.ItemGroupDef.Purpose
Structure = T.String(required=True, namespace="def")
ArchiveLocationID = T.String(namespace="def")
CommentOID = T.OIDRef(namespace="def")
IsNonStandard = T.ValueSetString(namespace="def")
StandardOID = T.OIDRef(namespace="def")
HasNoData = T.ValueSetString(namespace="def")
Description = ODM.ItemGroupDef.Description
ItemRef = ODM.ItemGroupDef.ItemRef
Alias = ODM.ItemGroupDef.Alias
Class = T.ODMObject(element_class=Class, namespace="def")
leaf = T.ODMObject(required=True, element_class=leaf, namespace="def")
def __len__(self):
return len(self.ItemRef)
def __getitem__(self, position):
return self.ItemRef[position]
def __iter__(self):
return iter(self.ItemRef)
class ItemGroupDef(OE.ODMElement):
""" represents ODM v2.0 ItemGroupDef and can serialize as JSON or XML"""
OID = T.OID(required=True)
Name = T.Name(required=True)
Repeating = T.ValueSetString(required=True)
Type = T.ValueSetString()
IsReferenceData = T.ValueSetString(required=False)
DatasetName = T.Name()
Domain = T.String()
Purpose = T.String()
CommentOID = T.OIDRef()
Description = T.ODMObject(element_class=Description)
ItemGroupRef = T.ODMListObject(element_class=ItemGroupRef)
ItemRef = T.ODMListObject(element_class=ItemRef)
WorkflowRef = T.ODMListObject(element_class=WorkflowRef)
Origin = T.ODMListObject(element_class=Origin)
Alias = T.ODMListObject(element_class=Alias)
def __len__(self):
return len(self.ItemRef)
def __getitem__(self, position):
return self.ItemRef[position]
def __iter__(self):
return iter(self.ItemRef)
class PDFPageRef(OE.ODMElement):
namespace = "def"
Type = T.ValueSetString(required=True)
PageRefs = T.String()
FirstPage = T.PositiveInteger()
LastPage = T.PositiveInteger()
Title = T.String()
class SourceItem(OE.ODMElement):
leadID = T.IDRef()
ItemGroupOID = T.OIDRef()
Resource = T.String()
Attribute = T.String()
Path = T.String()
Label = T.String()
class Study(OE.ODMElement):
""" v2.0 """
OID = T.String(required=True)
StudyName = T.String(required=True)
ProtocolName = T.String(required=True)
Description = T.ODMObject(required=True, element_class=Description)
MetaDataVersion = T.ODMListObject(required=False,
element_class=MetaDataVersion)
class Standard(OE.ODMElement):
namespace = "def"
OID = T.OID(required=True)
Name = T.Name(required=True)
Type = T.String(required=True)
PublishingSet = T.String()
Version = T.String(required=True)
Status = T.String()
CommentOID = T.OIDRef(namespace="def")
class ItemRef(OE.ODMElement):
ItemOID = T.String(required=True)
OrderNumber = T.Integer(required=False)
Mandatory = T.ValueSetString(required=True)
KeySequence = T.Integer(required=False)
MethodOID = T.String(required=False)
Role = T.String()
RoleCodeListOID = T.String()
CollectionExceptionConditionOID = T.String()
class KeySet(OE.ODMElement):
StudyOID = T.OIDRef(required=True)
SubjectKey = T.String()
StudyEventOID = T.OIDRef()
StudyEventRepeatKey = T.String()
FormOID = T.OIDRef()
FormRepeatKey = T.String()
ItemGroupOID = T.OIDRef()
ItemGroupRepeatKey = T.String()
ItemOID = T.OIDRef()
class EnumeratedItem(OE.ODMElement):
CodedValue = T.String(required=True)
ExtCodeID = T.String(required=True, namespace="nciodm")
CDISCSynonym = T.ODMListObject(element_class=CDISCSynonym,
namespace="nciodm")
CDISCDefinition = T.ODMObject(required=True,
element_class=CDISCDefinition,
namespace="nciodm")
PreferredTerm = T.ODMObject(required=True,
element_class=PreferredTerm,
namespace="nciodm")
class ODM(OE.ODMElement):
Description = T.String(required=False)
FileType = T.ValueSetString(required=True)
Granularity = T.ValueSetString(required=False)
FileOID = T.OID(required=True)
CreationDateTime = T.DateTimeString(required=True)
AsOfDateTime = T.DateTimeString(required=False)
ODMVersion = T.ValueSetString(required=False)
Originator = T.String(required=False)
SourceSystem = T.String(required=False)
SourceSystemVersion = T.String(required=False)
schemaLocation = T.String(required=False, namespace="xs")
Study = T.ODMListObject(element_class=Study)
class ODM(OE.ODMElement):
Description = T.String(required=False)
FileType = T.ValueSetString(required=True)
FileOID = T.OID(required=True)
CreationDateTime = T.DateTimeString(required=True)
PriorFileOID = T.OIDRef(required=False)
AsOfDateTime = T.DateTimeString(required=False)
ODMVersion = T.ValueSetString(required=False)
DatasetXMLVersion = T.ExtendedValidValues(required=True, valid_values=["1.0.0", "1.0.1"])
Originator = T.String(required=False)
SourceSystem = T.String(required=False)
SourceSystemVersion = T.String(required=False)
schemaLocation = T.String(required=False, namespace="xs")
ReferenceData = T.ODMListObject(element_class=ReferenceData)
ClinicalData = T.ODMObject(element_class=ClinicalData)
class CodeListItem(OE.ODMElement):
""" represents ODM CodeListItem element that is a child of CodeList and can serialize as JSON or XML """
CodedValue = T.String(required=True)
Rank = T.Float(required=False)
OrderNumber = T.Integer(required=False)
Decode = T.ODMObject(element_class=Decode)
Alias = T.ODMListObject(element_class=Alias)
class ItemDef(OE.ODMElement):
OID = T.OID(required=True)
Name = T.Name(required=True)
DataType = T.ValueSetString(required=True)
Length = T.PositiveInteger()
SignificantDigits = T.NonNegativeInteger()
SASFieldName = T.SASName()
SDSVarName = T.SASName()
Origin = T.String()
Comment = T.String()
Description = T.ODMObject(element_class=Description)
Question = T.ODMObject(element_class=Question)
ExternalQuestion = T.ODMObject(element_class=ExternalQuestion)
MeasurementUnitRef = T.ODMListObject(element_class=MeasurementUnitRef)
RangeCheck = T.ODMListObject(element_class=RangeCheck)
CodeListRef = T.ODMObject(element_class=CodeListRef)
Alias = T.ODMListObject(element_class=Alias)
class ODM(OE.ODMElement):
""" v2.0 """
Description = T.String(required=False)
FileType = T.ValueSetString(required=True)
Granularity = T.ValueSetString(required=False)
Archival = T.ValueSetString(required=False)
FileOID = T.OID(required=True)
CreationDateTime = T.DateTimeString(required=True)
PriorFileOID = T.OIDRef(required=False)
AsOfDateTime = T.DateTimeString(required=False)
ODMVersion = T.ValueSetString(required=False)
Originator = T.String(required=False)
SourceSystem = T.String(required=False)
SourceSystemVersion = T.String(required=False)
ID = T.ID()
Study = T.ODMListObject(element_class=Study)
AdminData = T.ODMListObject(element_class=AdminData)
class StudyEventData(OE.ODMElement):
StudyEventOID = T.OIDRef(required=True)
StudyEventRepeatKey = T.String(required=False)
TransactionType = T.ValueSetString(required=False)
AuditRecord = T.ODMObject(required=False, element_class=AuditRecord)
Signature = T.ODMObject(required=False, element_class=Signature)
Annotation = T.ODMListObject(required=False, element_class=Annotation)
FormData = T.ODMListObject(required=False, element_class=FormData)
class TestText(OE.ODMElement):
Name = T.String(required=True)
Label = T.Sized(required=True, max_length=4)
Range = T.Regex(required=False, pat="[0-4]-[0-9]")
Link = T.Url(required=False)
TestDateTime = T.IncompleteDateTimeString(required=False)
TestDate = T.IncompleteDateString(required=False)
TestTime = T.IncompleteTimeString(required=False)
class FormData(OE.ODMElement):
FormOID = T.OIDRef(required=True)
FormRepeatKey = T.String(required=False)
TransactionType = T.ValueSetString(required=False)
AuditRecord = T.ODMObject(required=False, element_class=AuditRecord)
Signature = T.ODMObject(required=False, element_class=Signature)
ArchiveLayout = T.ODMObject(required=False, element_class=ArchiveLayout)
Annotation = T.ODMListObject(required=False, element_class=Annotation)
ItemGroupData = T.ODMListObject(required=False, element_class=ItemGroupData)
class ItemData(OE.ODMElement):
ItemOID = T.OIDRef(required=True)
TransactionType = T.ValueSetString(required=False)
Value = T.String(required=False)
IsNull = T.ValueSetString(required=False)
AuditRecord = T.ODMObject(required=False, element_class=AuditRecord)
Signature = T.ODMObject(required=False, element_class=Signature)
MeasurementUnitRef = T.ODMObject(required=False, element_class=MeasurementUnitRef)
Annotation = T.ODMListObject(required=False, element_class=Annotation)
class SubjectData(OE.ODMElement):
SubjectKey = T.String(required=True)
TransactionType = T.ValueSetString(required=False)
AuditRecord = T.ODMObject(required=False, element_class=AuditRecord)
Signature = T.ODMObject(required=False, element_class=Signature)
InvestigatorRef = T.ODMObject(required=False, element_class=InvestigatorRef)
SiteRef = T.ODMObject(required=False, element_class=SiteRef)
Annotation = T.ODMListObject(required=False, element_class=Annotation)
StudyEventData = T.ODMListObject(required=False, element_class=StudyEventData)
class MetaDataVersion(ODM.MetaDataVersion):
OID = ODM.MetaDataVersion.OID
Name = ODM.MetaDataVersion.Name
Description = ODM.MetaDataVersion.Description
DefineVersion = T.ValueSetString(required=True, namespace="def")
StandardName = T.String(required=True, namespace="def")
StandardVersion = T.String(required=True, namespace="def")
AnnotatedCRF = T.ODMObject(element_class=AnnotatedCRF, namespace="def")
SupplementalDoc = T.ODMObject(element_class=SupplementalDoc,
namespace="def")
ValueListDef = T.ODMListObject(element_class=ValueListDef, namespace="def")
WhereClauseDef = T.ODMListObject(element_class=WhereClauseDef,
namespace="def")
ItemGroupDef = ODM.MetaDataVersion.ItemGroupDef
ItemDef = ODM.MetaDataVersion.ItemDef
CodeList = ODM.MetaDataVersion.CodeList
MethodDef = ODM.MetaDataVersion.MethodDef
CommentDef = T.ODMListObject(element_class=CommentDef, namespace="def")
leaf = T.ODMListObject(element_class=leaf, namespace="def")
class ODM(OE.ODMElement):
Description = T.String(required=False)
FileType = T.ValueSetString(required=True)
Granularity = T.ValueSetString(required=False)
Archival = T.ValueSetString(required=False)
FileOID = T.OID(required=True)
CreationDateTime = T.DateTimeString(required=True)
PriorFileOID = T.OIDRef(required=False)
AsOfDateTime = T.DateTimeString(required=False)
ODMVersion = T.ValueSetString(required=False)
Originator = T.String(required=False)
SourceSystem = T.String(required=False)
SourceSystemVersion = T.String(required=False)
schemaLocation = T.String(required=False, namespace="xs")
ID = T.ID()
Study = T.ODMListObject(element_class=Study)
AdminData = T.ODMListObject(element_class=AdminData)
ReferenceData = T.ODMListObject(element_class=ReferenceData)
ClinicalData = T.ODMListObject(element_class=ClinicalData)
Association = T.ODMListObject(element_class=Association)
class CodeList(ODM.CodeList):
OID = ODM.CodeList.OID
Name = ODM.CodeList.Name
DataType = ODM.CodeList.DataType
IsNonStandard = T.ValueSetString(namespace="def")
StandardOID = T.String(namespace="def")
SASFormatName = ODM.CodeList.SASFormatName
CommentOID = T.OIDRef(namespace="def")
Description = ODM.CodeList.Description
CodeListItem = ODM.CodeList.CodeListItem
EnumeratedItem = ODM.CodeList.EnumeratedItem
ExternalCodeList = ODM.CodeList.ExternalCodeList
Alias = ODM.CodeList.Alias
class ItemGroupDef(OE.ODMElement):
OID = T.OID(required=True)
Name = T.Name(required=True)
Repeating = T.ValueSetString(required=True)
IsReferenceData = T.ValueSetString(required=False)
SASDatasetName = T.SASName()
Domain = T.String()
Origin = T.String()
Purpose = T.String()
Comment = T.String()
Description = T.ODMObject(element_class=Description)
ItemRef = T.ODMListObject(element_class=ItemRef)
Alias = T.ODMListObject(element_class=Alias)
def __len__(self):
return len(self.ItemRef)
def __getitem__(self, position):
return self.ItemRef[position]
def __iter__(self):
return iter(self.ItemRef)
class ItemDef(ODM.ItemDef):
OID = ODM.ItemDef.OID
Name = ODM.ItemDef.Name
DataType = ODM.ItemDef.DataType
Length = ODM.ItemDef.Length
SignificantDigits = ODM.ItemDef.SignificantDigits
SASFieldName = ODM.ItemDef.SASFieldName
DisplayFormat = T.String(namespace="def")
CommentOID = T.OIDRef(namespace="def")
Description = ODM.ItemDef.Description
CodeListRef = ODM.ItemDef.CodeListRef
Origin = T.ODMListObject(element_class=Origin, namespace="def")
ValueListRef = T.ODMObject(element_class=ValueListRef, namespace="def")
Alias = T.ODMListObject(element_class=Alias)
class MetaDataVersion(OE.ODMElement):
OID = T.OID(required=True)
Name = T.Name(required=True)
Description = T.String(required=False)
Include = T.ODMObject(element_class=Include)
Protocol = T.ODMObject(element_class=Protocol)
StudyEventDef = T.ODMListObject(element_class=StudyEventDef)
FormDef = T.ODMListObject(element_class=FormDef)
ItemGroupDef = T.ODMListObject(element_class=ItemGroupDef)
ItemDef = T.ODMListObject(element_class=ItemDef)
CodeList = T.ODMListObject(element_class=CodeList)
Presentation = T.ODMListObject(element_class=Presentation)
ConditionDef = T.ODMListObject(element_class=ConditionDef)
MethodDef = T.ODMListObject(element_class=MethodDef)
class CodeList(OE.ODMElement):
OID = T.OID(required=True)
Name = T.Name(required=True)
DataType = T.ValueSetString(required=True)
ExtCodeID = T.String(required=True, namespace="nciodm")
CodeListExtensible = T.ValueSetString(required=True, namespace="nciodm")
Description = T.ODMObject(element_class=Description)
EnumeratedItem = T.ODMListObject(element_class=EnumeratedItem)
CDISCSubmissionValue = T.ODMObject(required=True,
element_class=CDISCSubmissionValue,
namespace="nciodm")
CDISCSynonym = T.ODMObject(required=True,
element_class=CDISCSynonym,
namespace="nciodm")
PreferredTerm = T.ODMObject(required=True,
element_class=PreferredTerm,
namespace="nciodm")
class ItemDef(OE.ODMElement):
""" represents ODM v2.0 ItemDef and can serialize as JSON or XML - ordering of properties matters """
OID = T.OID(required=True)
Name = T.Name(required=True)
DataType = T.ValueSetString(required=True)
Length = T.PositiveInteger()
FractionDigits = T.NonNegativeInteger()
DatasetVarName = T.Name()
SDSVarName = T.SASName()
CommentOID = T.String()
Description = T.ODMObject(element_class=Description)
Question = T.ODMObject(element_class=Question)
ExternalQuestion = T.ODMObject(element_class=ExternalQuestion)
MeasurementUnitRef = T.ODMListObject(element_class=MeasurementUnitRef)
RangeCheck = T.ODMListObject(element_class=RangeCheck)
CodeListRef = T.ODMObject(element_class=CodeListRef)
Alias = T.ODMListObject(element_class=Alias)
class StudyEventData(OE.ODMElement):
StudyEventOID = T.OIDRef(required=True)
StudyEventRepeatKey = T.String(required=False)
TransactionType = T.ValueSetString(required=False)
AuditRecord = T.ODMObject(required=False, element_class=AuditRecord)
Signature = T.ODMObject(required=False, element_class=Signature)
Annotation = T.ODMListObject(required=False, element_class=Annotation)
FormData = T.ODMListObject(required=False, element_class=FormData)
def __len__(self):
return len(self.FormData)
def __getitem__(self, position):
return self.FormData[position]
def __iter__(self):
return iter(self.FormData)
class ItemGroupData(OE.ODMElement):
ItemGroupOID = T.OIDRef(required=True)
ItemGroupRepeatKey = T.String(required=False)
TransactionType = T.ValueSetString(required=False)
AuditRecord = T.ODMObject(required=False, element_class=AuditRecord)
Signature = T.ODMObject(required=False, element_class=Signature)
ArchiveLayout = T.ODMObject(required=False, element_class=ArchiveLayout)
Annotation = T.ODMListObject(required=False, element_class=Annotation)
ItemData = T.ODMListObject(required=False, element_class=ItemData)
def __len__(self):
return len(self.ItemData)
def __getitem__(self, position):
return self.ItemData[position]
def __iter__(self):
return iter(self.ItemData)
class StudyEventDef(OE.ODMElement):
OID = T.OID(required=True)
Name = T.Name(required=True)
Repeating = T.ValueSetString(required=True)
Type = T.ValueSetString(required=True)
Category = T.String(required=False)
Description = T.ODMObject(element_class=Description)
FormRef = T.ODMListObject(element_class=FormRef)
Alias = T.ODMListObject(element_class=Alias)
def __len__(self):
""" returns the number of FormRefs in an StudyEventDef object as the length """
return len(self.FormRef)
def __getitem__(self, position):
""" creates an iterator from an StudyEventDef object that returns the FormRef in position """
return self.FormRef[position]
def __iter__(self):
return iter(self.FormRef)
