An ODM document (file) can be viewed as a set of instructions describing how to modify a target database so that it can be brought into alignment with a source database. A single ODM document could contain all the information about the source database—all the subjects, all the metadata, all the clinical data, and all the changes to each item of clinical data. However, it is not always convenient to create such a large document. So we allow a series of ODM files to incrementally provide this information. |
Each ODM document has a FileOID attribute (see Section 3.2, ODM). The FileOID should uniquely identify the document.
An ODM document can also have a PriorFileOID attribute. This attribute gives the FileOID of the immediately preceding file in a series. Thus, a collection of files linked by PriorFileOID can be used to incrementally describe a source database. (Of course, the first document in the series has no PriorFileOID attribute.) |
Data in one file of a series is allowed to depend on definitions contained in an earlier file in the series. If a file contains either ReferenceData or ClinicalData then that file must either contain the necessary metadata definitions to interpret that data directly, or there must be a previous file in the series that contains these definitions. Similarly, if a file contains ClinicalData or ReferenceData, the file must either contain the administrative data referenced in the audit and signature records, or there must be a previous file in the series that contains that data.
A tree-structured collection of ODM files (where more than 1 file references the same prior file) is also allowed. An ODM document (or collection) can contain information on more than 1 study. To simplify the discussion, we will occasionally write as if only 1 study was present. If a file (or collection of files) contains multiple studies, the rules should be applied to each of the studies independently. Note:
|
Other File AttributesAs implied above, most ODM documents will contain only part of the total information (current and historical) held in the source database. The information that is sent in a given document can vary along several dimensions. Some examples of the contents of a document are:
Because of this variability, it is also important that each document describe itself, so that the consumer of the document knows what to expect of it. To address these needs, the ODM element has several attributes for describing the current document. The CreationDateTime attribute indicates when the ODM document was created. In contrast, the AsOfDateTime attribute tells when the document content was accurate by specifying the date/time at which the source database was queried to create the ODM document. This is of particular importance when a series of files is used to give an evolving view of a changing database. The FileType and Granularity attributes allow the document sender to define the scope, across time and data, that a particular document spans. When the Context attribute is set to Archive it allows the sender to assert that the contents of the document meet a specific set of criteria that qualifies it as an electronic record defined in the FDA 21 CFR 11 regulations (https://www.fda.gov/regulatory-information/). This section details the values these attributes can take, and discusses the use of the values in a single document and in a series of documents. |
An ODM document's FileType must be either Snapshot or Transactional. A Snapshot document shows how to recreate the current state of the source database with respect to the included data, but does not show how it got to be in that state over time. A Transactional document shows, for each included entity, both the latest state of the source database, and (optionally) some prior states of that entity in the source database. The TransactionType attribute need not be present in a Snapshot document. When processing a Transactional document, the rules for ordering a set of transactions for a single data point are those described in Section 2.12, Clinical Data Element Ordering.
An ODM document's Granularity is intended to give the sender a shorthand way to describe the breadth of the information in the document, for certain common types of documents.
Here are the intended meanings of these categories:
Category | Document contains |
All | Any and all types of data and metadata |
Metadata | Metadata only |
AdminData | Admin data only |
ReferenceData | Reference data only |
AllClinicalData | Clinical data only |
SingleSite | Clinical data for a single site only |
SingleSubject | Clinical data for a single subject only |
If these shorthand categories are not sufficient, use the document's Description attribute to give details.
The Context attribute is optional and indicates the intended usage of the ODM document. Context may be set to Archive, Submission, or Exchange. Context=Archive indicates that the file is intended to meet the requirements of an electronic record as defined in 21 CFR 11. Context=Submission indciates that the file is intended to be used as part of a regulatory submission. Context=Exchange indicates that the file was generated to be imported into an ODM compliant system. |
Context=Archive requires