Class: StudyEventRef

This element references a StudyEventDef as it occurs within a specific version of a study. The list of StudyEventRefs identifies the types of study events that are allowed to occur within the study.

URI: odm:StudyEventRef

erDiagram
StudyEventRef {
    positiveInteger orderNumber  
    YesOrNo mandatory  
}
ConditionDef {
    oid OID  
    nameType name  
}
Alias {
    text context  
    text name  
}
FormalExpression {
    text context  
}
MethodSignature {

}
Description {

}
CommentDef {
    oid OID  
}
StudyEventDef {
    oid OID  
    nameType name  
    YesOrNo repeating  
    EventType type  
    text category  
}
Coding {
    text code  
    uriorcurie system  
    text systemName  
    text systemVersion  
    text label  
    uriorcurie href  
    uriorcurie ref  
    text commentOID  
}
WorkflowRef {

}
ItemGroupRef {
    positiveInteger orderNumber  
    YesOrNo mandatory  
}

StudyEventRef ||--|| StudyEventDef : "studyEventOID"
StudyEventRef ||--|o ConditionDef : "collectionExceptionConditionOID"
ConditionDef ||--|o CommentDef : "commentOID"
ConditionDef ||--|o Description : "description"
ConditionDef ||--|o MethodSignature : "methodSignature"
ConditionDef ||--}o FormalExpression : "formalExpression"
ConditionDef ||--}o Alias : "alias"
FormalExpression ||--|o Code : "code"
FormalExpression ||--|o ExternalCodeLib : "externalCodeLib"
MethodSignature ||--}o Parameter : "parameter"
MethodSignature ||--}o ReturnValue : "returnValue"
Description ||--}o TranslatedText : "translatedText"
CommentDef ||--|o Description : "description"
CommentDef ||--}o DocumentRef : "documentRef"
StudyEventDef ||--|o CommentDef : "commentOID"
StudyEventDef ||--|o Description : "description"
StudyEventDef ||--}o ItemGroupRef : "itemGroupRef"
StudyEventDef ||--|o WorkflowRef : "workflowRef"
StudyEventDef ||--}o Coding : "coding"
StudyEventDef ||--}o Alias : "alias"
WorkflowRef ||--|| WorkflowDef : "workflowOID"
ItemGroupRef ||--|| ItemGroupDef : "itemGroupOID"
ItemGroupRef ||--|o MethodDef : "methodOID"
ItemGroupRef ||--|o ConditionDef : "collectionExceptionConditionOID"

Slots

Name Cardinality* and Range Description Inheritance
studyEventOID 1..1
StudyEventDef		 Reference to the StudyEventDef . direct
orderNumber 0..1
positiveInteger		 Indicates the order in which this StudyEventDef appears in Metadata displays ... direct
mandatory 1..1
YesOrNo		 The Mandatory flag indicates that the clinical data for the containing MetaDa... direct
collectionExceptionConditionOID 0..1
ConditionDef		 Reference to a ConditionDef If the CollectionExceptionConditionOID attribute ... direct

* See LinkML documentation for cardinality definitions.

Usages

used by used in type used
StudyEventGroupDef studyEventRef range StudyEventRef

See Also

Identifier and Mapping Information

Schema Source

  • from schema: http://www.cdisc.org/ns/odm/v2.0

Mappings

Mapping Type Mapped Value
self odm:StudyEventRef
native odm:StudyEventRef

LinkML Source

Direct

name: StudyEventRef
description: This element references a StudyEventDef as it occurs within a specific
  version of a study. The list of StudyEventRefs identifies the types of study events
  that are allowed to occur within the study.
from_schema: http://www.cdisc.org/ns/odm/v2.0
see_also:
- https://wiki.cdisc.org/display/PUB/StudyEventRef
rank: 1000
slots:
- studyEventOID
- orderNumber
- mandatory
- collectionExceptionConditionOID
slot_usage:
  studyEventOID:
    name: studyEventOID
    description: Reference to the StudyEventDef .
    comments:
    - 'Required

      range: oidref

      Must match the OID attribute for a StudyEventDef in the Study/MetaDataVersion.'
    domain_of:
    - StudyEventRef
    - AbsoluteTimingConstraint
    - StudyEventData
    - KeySet
    range: StudyEventDef
    required: true
  orderNumber:
    name: orderNumber
    description: Indicates the order in which this StudyEventDef appears in Metadata
      displays or data entry applications. OrderNumbers provide an ordering on the
      StudyEventDefs for use whenever a list of StudyEventDefs is presented to a user.
      They do not imply anything about event scheduling, time ordering, or data correctness.
      Order of execution and timing between study events and groups of study events
      must be defined in WorkflowDef elements. Scheduling will be realized in StudyTiming
      and its child elements that reference StudyEventGroups.
    comments:
    - 'Optional

      range: positiveInteger

      The StudyEventRefs within a StudyEventGroup must not have duplicate OrderNumber
      values.'
    domain_of:
    - StudyEventGroupRef
    - StudyEventRef
    - ItemGroupRef
    - ItemRef
    - CodeListItem
    - Parameter
    - ReturnValue
    - StudyEndPointRef
    range: positiveInteger
  mandatory:
    name: mandatory
    description: The Mandatory flag indicates that the clinical data for the containing
      MetaDataVersion would be incomplete without an instance of this type of Study
      Event for each subject per the study protocol. ODM clinical data files that
      are incomplete in this sense may be considered incomplete for study review and
      analysis purposes.
    comments:
    - 'Required

      enum values: (Yes | No)

      The data for each subject in the study must include a StudyEventData element
      with this StudyEventOID, when the value is "Yes".'
    domain_of:
    - StudyEventGroupRef
    - StudyEventRef
    - ItemGroupRef
    - ItemRef
    range: YesOrNo
    required: true
  collectionExceptionConditionOID:
    name: collectionExceptionConditionOID
    description: Reference to a ConditionDef If the CollectionExceptionConditionOID
      attribute is provided, it references a ConditionDef that describes the circumstances
      under which data for this study event should not be collected.
    comments:
    - 'Optional

      range: oidref

      The CollectionExceptionConditionOID value must match the OID attribute for a
      ConditionDef in this Study/MetaDataVersion.'
    domain_of:
    - StudyEventGroupRef
    - StudyEventRef
    - ItemGroupRef
    - ItemRef
    range: ConditionDef
class_uri: odm:StudyEventRef

Induced

name: StudyEventRef
description: This element references a StudyEventDef as it occurs within a specific
  version of a study. The list of StudyEventRefs identifies the types of study events
  that are allowed to occur within the study.
from_schema: http://www.cdisc.org/ns/odm/v2.0
see_also:
- https://wiki.cdisc.org/display/PUB/StudyEventRef
rank: 1000
slot_usage:
  studyEventOID:
    name: studyEventOID
    description: Reference to the StudyEventDef .
    comments:
    - 'Required

      range: oidref

      Must match the OID attribute for a StudyEventDef in the Study/MetaDataVersion.'
    domain_of:
    - StudyEventRef
    - AbsoluteTimingConstraint
    - StudyEventData
    - KeySet
    range: StudyEventDef
    required: true
  orderNumber:
    name: orderNumber
    description: Indicates the order in which this StudyEventDef appears in Metadata
      displays or data entry applications. OrderNumbers provide an ordering on the
      StudyEventDefs for use whenever a list of StudyEventDefs is presented to a user.
      They do not imply anything about event scheduling, time ordering, or data correctness.
      Order of execution and timing between study events and groups of study events
      must be defined in WorkflowDef elements. Scheduling will be realized in StudyTiming
      and its child elements that reference StudyEventGroups.
    comments:
    - 'Optional

      range: positiveInteger

      The StudyEventRefs within a StudyEventGroup must not have duplicate OrderNumber
      values.'
    domain_of:
    - StudyEventGroupRef
    - StudyEventRef
    - ItemGroupRef
    - ItemRef
    - CodeListItem
    - Parameter
    - ReturnValue
    - StudyEndPointRef
    range: positiveInteger
  mandatory:
    name: mandatory
    description: The Mandatory flag indicates that the clinical data for the containing
      MetaDataVersion would be incomplete without an instance of this type of Study
      Event for each subject per the study protocol. ODM clinical data files that
      are incomplete in this sense may be considered incomplete for study review and
      analysis purposes.
    comments:
    - 'Required

      enum values: (Yes | No)

      The data for each subject in the study must include a StudyEventData element
      with this StudyEventOID, when the value is "Yes".'
    domain_of:
    - StudyEventGroupRef
    - StudyEventRef
    - ItemGroupRef
    - ItemRef
    range: YesOrNo
    required: true
  collectionExceptionConditionOID:
    name: collectionExceptionConditionOID
    description: Reference to a ConditionDef If the CollectionExceptionConditionOID
      attribute is provided, it references a ConditionDef that describes the circumstances
      under which data for this study event should not be collected.
    comments:
    - 'Optional

      range: oidref

      The CollectionExceptionConditionOID value must match the OID attribute for a
      ConditionDef in this Study/MetaDataVersion.'
    domain_of:
    - StudyEventGroupRef
    - StudyEventRef
    - ItemGroupRef
    - ItemRef
    range: ConditionDef
attributes:
  studyEventOID:
    name: studyEventOID
    description: Reference to the StudyEventDef .
    comments:
    - 'Required

      range: oidref

      Must match the OID attribute for a StudyEventDef in the Study/MetaDataVersion.'
    from_schema: http://www.cdisc.org/ns/odm/v2.0
    rank: 1000
    alias: studyEventOID
    owner: StudyEventRef
    domain_of:
    - StudyEventRef
    - AbsoluteTimingConstraint
    - StudyEventData
    - KeySet
    range: StudyEventDef
    required: true
  orderNumber:
    name: orderNumber
    description: Indicates the order in which this StudyEventDef appears in Metadata
      displays or data entry applications. OrderNumbers provide an ordering on the
      StudyEventDefs for use whenever a list of StudyEventDefs is presented to a user.
      They do not imply anything about event scheduling, time ordering, or data correctness.
      Order of execution and timing between study events and groups of study events
      must be defined in WorkflowDef elements. Scheduling will be realized in StudyTiming
      and its child elements that reference StudyEventGroups.
    comments:
    - 'Optional

      range: positiveInteger

      The StudyEventRefs within a StudyEventGroup must not have duplicate OrderNumber
      values.'
    from_schema: http://www.cdisc.org/ns/odm/v2.0
    rank: 1000
    alias: orderNumber
    owner: StudyEventRef
    domain_of:
    - StudyEventGroupRef
    - StudyEventRef
    - ItemGroupRef
    - ItemRef
    - CodeListItem
    - Parameter
    - ReturnValue
    - StudyEndPointRef
    range: positiveInteger
  mandatory:
    name: mandatory
    description: The Mandatory flag indicates that the clinical data for the containing
      MetaDataVersion would be incomplete without an instance of this type of Study
      Event for each subject per the study protocol. ODM clinical data files that
      are incomplete in this sense may be considered incomplete for study review and
      analysis purposes.
    comments:
    - 'Required

      enum values: (Yes | No)

      The data for each subject in the study must include a StudyEventData element
      with this StudyEventOID, when the value is "Yes".'
    from_schema: http://www.cdisc.org/ns/odm/v2.0
    rank: 1000
    alias: mandatory
    owner: StudyEventRef
    domain_of:
    - StudyEventGroupRef
    - StudyEventRef
    - ItemGroupRef
    - ItemRef
    range: YesOrNo
    required: true
  collectionExceptionConditionOID:
    name: collectionExceptionConditionOID
    description: Reference to a ConditionDef If the CollectionExceptionConditionOID
      attribute is provided, it references a ConditionDef that describes the circumstances
      under which data for this study event should not be collected.
    comments:
    - 'Optional

      range: oidref

      The CollectionExceptionConditionOID value must match the OID attribute for a
      ConditionDef in this Study/MetaDataVersion.'
    from_schema: http://www.cdisc.org/ns/odm/v2.0
    rank: 1000
    alias: collectionExceptionConditionOID
    owner: StudyEventRef
    domain_of:
    - StudyEventGroupRef
    - StudyEventRef
    - ItemGroupRef
    - ItemRef
    range: ConditionDef
class_uri: odm:StudyEventRef