The metadata for a study is defined in a series of MetaDataVersion elements. Through this mechanism (multiple MetaDataVersion elements), the model supports the incremental deployment of "mid-stream study changes," and thus can handle a situation where multiple versions of the metadata are being used simultaneously (e.g., due to delays in IRB approval at various sites).

The way metadata versioning works is as follows. An individual Study element may contain multiple MetaDataVersions, reflecting 1 or more mid-stream study design changes. The initial version contains a full set of metadata. Each subsequent version typically contains only modified or newly added metadata elements, inheriting the previous metadata by an explicit reference. The same metadata elements in different versions will have the same OID. This approach is used to allow the older versions of the metadata to remain intact, while simultaneously providing a concise way to represent changes.

A metadata version defines the types of study structural elements, workflows, event timings, study event groups, study events, item groups, and items that form the study data.

Element NameMetaDataVersion
Parent ElementsStudy
Element XPath(s)

/ODM/Study/MetaDataVersion

Element Textual ValueNone
AttributesOID, Name, CommentOID
Child Elements
Usage/Business Rules
  • Business Rule(s):
    • Required when ODM/@Granularity is in  (All | Metadata).
  • Other Information:

    • The Include element references a prior metadata version. This causes all the definitions in that prior metadata version to be automatically included in this one. Any of the included definitions can be replaced (overridden) by explicitly giving a new version of the definition (with the same OID) in the new metadata version. See Section 3.2.2.1.1, Include, for more information on how the Include element works. New definitions (with new OIDs) can be added in the same way.

AttributeSchema Datatype or EnumerationUsageDefinitionBusiness Rules
OIDoidRequiredUnique identifier.
NamenameRequiredMetaDataVersion name.
CommentOIDoidrefOptionalReference to a CommentDef element.Must match a CommentDef/@OID child element.

  • No labels