Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: updates to v2.0 and adding JSON section

ODM 2.0 can be serialized as either XML or JSON.

XML File Conformity

An XML file conforms to the ODM 12.3.2 0 standard only if it satisfies all the criteria detailed in this standard. These criteria include both syntactic constraints and semantic ones.

The syntactic constraints for ODM 2.0 XML files are:

  1. The ODM file must be a well-formed XML file. See the XML standard for details.
  2. The ODM file must conform to the XML Namespace standard. See the XML Namespace standard for details.
  3. The ODM file must contain only elements and attributes defined in the ODM standard schema or in a valid vendor extension schema, and must satisfy the rules about element nesting and the formats of attribute values and element bodies.
  4. The ODM file must contain a prolog and a single (top-level) ODM element., and it is best practice 
  5. The ODM file must use the ODM 12.3 0 namespace, which is "http://www.cdisc.org/ns/odm/v1v2.30"
  6. The ODMVersion attribute on the top level ODM element must be set to "12.3.20"
  7. The ODM file should begin with a prolog, or XML declaration, as this is considered a best practice 

The schema for version 12.3.2 0 of the ODM can be found at httphttps://www.cdisc.org/standards/schemasfoundational/odm/v1.3odm-v2-0. This final version of this specification will be posted at httphttps://www.cdisc.org/standards/data-exchange/odm.



Info

Example of prolog and top level ODM element:


Code Block
<?xml version="1.0" encoding="UTF-8"?>
<ODM xmlns="http://www.cdisc.org/ns/odm/v1v2.30"
    xmlns:ds="http://www.w3.org/2000/09/xmldsig#"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 
    xsi:schemaLocation="http://www.cdisc.org/ns/odm/v1v2.30 ODM1ODM2-30-20.xsd"
 
    ODMVersion="12.3.20"
    FileOID="000-00-0000"
    FileType="Transactional"
    Description="Sample ItemData Extension"
 
    AsOfDateTime="2013-02-04T07:57:00"
    CreationDateTime="2013-02-06T10:30:00">


...

The semantic constraints are expressed throughout the rest of this document.

The ODM version 12.3 0 XML Schema file can be used with a validating XML parser to test that an ODM file is syntactically valid. To ensure semantic correctness the use of an ODM-specific validation application is recommended.

JSON File Conformity

TODO

Pagenav2