Root element.
| Element Name | ExternalCodeLib |
|---|---|
| Parent Element(s) | None |
| Element XPath(s) | /ODM |
| Element Textual Value | None |
| Usage | Required. Root element. |
| Attributes | FileType, Granularity, Context, FileOID, CreationDateTime, PriorFileOID, AsOfDateTime, ODMVersion, Originator, SourceSystem, SourceSystemVersion, Description, ID |
| Child Elements | (Study*, AdminData*, ReferenceData*, ClinicalData*, Association*, ds:Signature*) |
Attributes:
Attribute | Schema Datatype or Enumeration | Usage | Definition | Business Rules |
|---|---|---|---|---|
| ID | ID | (Required|Optional) | If a Signature element is contained within a Signatures element, the ID attribute is required. |
Body:
| (Study*, AdminData*, ReferenceData*, ClinicalData*, Association*, ds:Signature*) |
Attributes:
| Attribute | Schema Datatype or Enumeration | Usage | Definition | Business Rules |
|---|---|---|---|---|
| FileType | ( Snapshot | Transactional | Query) | Required | Snapshot means that the document contains only the current state of the data and metadata it describes, and no transactional history. A Snapshot document may include only one instruction per data point. For clinical data, TransactionType in a Snapshot file must either not be present or be Insert. Transactional means that the document may contain more than one instruction per data point. Use a Transactional document to send both what the current state of the data is, and how it came to be there. Query means the document contains only ClinicalData/Query elements. It is intended to be used to provide Query information to accompany ClinicalData in a separate SnapShot Clinical Data document. | |
| Granularity | ( All | Metadata | AdminData | ReferenceData | AllClinicalData | SingleSite | SingleSubject ) | Optional | 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. All means the entire study; Metadata means the MetaDataVersion element; AdminData and ReferenceData mean the corresponding elements; AllClinicalData, SingleSite, and SingleSubject are successively more tightly focused subset of the study's clinical data. If these shorthand categories are not sufficient, use the Description attribute to give details. | |
| Context | (Archive| Submission | Exchange) ODM2DEV-53 - Getting issue details... STATUS | Optional | Indicates the intended usage of the ODM document. Archive - indicates that the file is intended to meet the requirements of an electronic record as defined in 21 CFR 11. See Single Files and Collections for an fuller discussion of the meaning of this attribute, as well as its interaction with other ODM attributes. FileType must be Transactional when Context is Archive. Submission - indciates that the file is intended to be used for regulatory submission. DataExchange - indicates that the file was generated to be imported into an ODM compliant system. | |
| Deprecated | ||||
| FileOID | oid | Required | A unique identifier for this file. | |
| CreationDateTime | datetime | Required | Time of creation of the file containing the document. | |
| PriorFileOID | oidref | Optional | Reference to the previous file (if any) in a series. | |
| AsOfDateTime | datetime | Optional | The date/time at which the source database was queried in order to create this document. | |
| ODMVersion | ( 1.2 | 1.2.1 | 1.3 | 1.3.1 | 1.3.2 | 2.0) | Required | The version of the ODM standard used. | |
| Originator | text | Optional | The organization that generated the ODM file. | |
| SourceSystem | text | Optional | The computer system or database management system that is the source of the information in this file. | |
| SourceSystemVersion | text | Optional | The version of the "SourceSystem" above. | |
| Description | text | Optional | The sender should use the Description attribute to record any information that will help the receiver interpret the document correctly. | |
| ID | ID | Optional | May be used by the ds:Signature element to refer back to this element. |
The AsOfDateTime is the latest date/time of any new or updated data in the ODM file. This attribute is implied, and if omitted, it is assumed that the AsOfDateTime is equal to the CreationDateTime. It is an error to supply an AsOfDateTime that is later than the CreationDateTime.
The ODMVersion attribute was not defined in ODM 1.1, so a missing ODMVersion should be interpreted as "1.1".
Documents based on ODM 2.0 must have ODMVersion="2.0" set in order to use the new features in this version. Documents based on ODM 1.3.2 must have ODMVersion="1.3.2" set in order to use the new features in this version. Documents based on ODM 1.2.0 must have ODMVersion="1.2", documents based ODM 1.3.0 must have ODMVersion="1.3" and documents based on ODM 1.3.1 must have ODMVersion="1.3.1" for backwards compatibility purposes.
There is an extended discussion of these attributes in the section titled Single Files and Collections.