Transcript
Page 1: Introduction to define - CDISCportal.cdisc.org/CDISC User Networks/Europe/English...The Great Gig in the Sky Money

1© Assero Limited, 2012

Introduction to

define.xml

Dave Iberson-Hurst

22nd March 2012

(based on a presentation given on 27th May 2010)

ESUG Webinar

© Assero Limited, 2012

Page 2: Introduction to define - CDISCportal.cdisc.org/CDISC User Networks/Europe/English...The Great Gig in the Sky Money

2© Assero Limited, 2012

Outline

• Introduction

• Purpose of define.xml

• XML

• How define works

• FAQ

• Q&A

Page 3: Introduction to define - CDISCportal.cdisc.org/CDISC User Networks/Europe/English...The Great Gig in the Sky Money

3© Assero Limited, 2012

Introduction

Page 4: Introduction to define - CDISCportal.cdisc.org/CDISC User Networks/Europe/English...The Great Gig in the Sky Money

4© Assero Limited, 2012

Introduction

Page 5: Introduction to define - CDISCportal.cdisc.org/CDISC User Networks/Europe/English...The Great Gig in the Sky Money

5© Assero Limited, 2012

Purpose

Page 6: Introduction to define - CDISCportal.cdisc.org/CDISC User Networks/Europe/English...The Great Gig in the Sky Money

6© Assero Limited, 2012

Purpose

• Describes

– What is included within the data

– Where did the data come from

– Derivations, code lists, annotated PDF etc to aid understanding

• Machine Readable

• Human Readable (after processing)

• To aid/inform the reviewer, unambiguous communication

Page 7: Introduction to define - CDISCportal.cdisc.org/CDISC User Networks/Europe/English...The Great Gig in the Sky Money

7© Assero Limited, 2012

Submission & eCTD

http://www.fda.gov/ForIndustry/DataStandards/StudyDataStandards/default.htm

Revision 2, June 2008

Page 8: Introduction to define - CDISCportal.cdisc.org/CDISC User Networks/Europe/English...The Great Gig in the Sky Money

8© Assero Limited, 2012

Submission & eCTD

http://www.fda.gov/Drugs/DevelopmentApprovalProcess/FormsSubmissionRequirements/ElectronicSubmissions/ucm153574.htm

Revision 2, June 2008

Page 9: Introduction to define - CDISCportal.cdisc.org/CDISC User Networks/Europe/English...The Great Gig in the Sky Money

9© Assero Limited, 2012

XML

Page 10: Introduction to define - CDISCportal.cdisc.org/CDISC User Networks/Europe/English...The Great Gig in the Sky Money

10© Assero Limited, 2012

Dark Side of the Moon

<CDCollection>

<CD TotalTime="45.02">

<Artist>Pink Floyd</Artist>

<Title>Dark Side of the Moon</Title>

<Track Label="1a">Speak To Me</Track>

<Track Label="1b">Breathe</Track>

<Track Label="2">On the Run</Track>

<Track Label="3">Time</Track>

<Track Label="4">The Great Gig in the Sky</Track>

<Track Label="5">Money</Track>

<Track Label="6">Us and Them</Track>

<Track Label="7">Any Colour You Like</Track>

<Track Label="8">Brain Damage</Track>

<Track Label="9">Eclipse</Track>

</CD>

</CDCollection>

Page 11: Introduction to define - CDISCportal.cdisc.org/CDISC User Networks/Europe/English...The Great Gig in the Sky Money

11© Assero Limited, 2012

Dark Side of the Moon

<CDCollection>

<CD TotalTime="45.02">

<Artist>Pink Floyd</Artist>

<Title>Dark Side of the Moon</Title>

<Track Label="1a">Speak To Me</Track>

<Track Label="1b">Breathe</Track>

<Track Label="2">On the Run</Track>

<Track Label="3">Time</Track>

<Track Label="4">The Great Gig in the Sky</Track>

<Track Label="5">Money</Track>

<Track Label="6">Us and Them</Track>

<Track Label="7">Any Colour You Like</Track>

<Track Label="8">Brain Damage</Track>

<Track Label="9">Eclipse</Track>

</CD>

</CDCollection>

Element

Attribute

Structure

Page 12: Introduction to define - CDISCportal.cdisc.org/CDISC User Networks/Europe/English...The Great Gig in the Sky Money

12© Assero Limited, 2012

XML Schemas in Simple Terms

• Defines elements, attributes, data types etc.

and their relationships

• Provides the specification for an XML

document

• Enables validation of XML documents

Page 13: Introduction to define - CDISCportal.cdisc.org/CDISC User Networks/Europe/English...The Great Gig in the Sky Money

13© Assero Limited, 2012

Transformations

• XSL – Extensible Stylesheet Language

• Used to transform an XML document

• Requires a tool known as XSLT processor

• Focuses on presentation while XML focuses on

content and structure

XSLTProcessor

<?xml version="1.0"?>

<xsl:stylesheet version="1.0" ...

XML Document New Document

XSL Document

Page 14: Introduction to define - CDISCportal.cdisc.org/CDISC User Networks/Europe/English...The Great Gig in the Sky Money

14© Assero Limited, 2012

How define.xml Works

Page 15: Introduction to define - CDISCportal.cdisc.org/CDISC User Networks/Europe/English...The Great Gig in the Sky Money

15© Assero Limited, 2012

Define Specification

http://www.cdisc.org/define-xml

Page 16: Introduction to define - CDISCportal.cdisc.org/CDISC User Networks/Europe/English...The Great Gig in the Sky Money

16© Assero Limited, 2012

Metadata Submission Guidelines

http://www.cdisc.org/sdtm

Page 17: Introduction to define - CDISCportal.cdisc.org/CDISC User Networks/Europe/English...The Great Gig in the Sky Money

17© Assero Limited, 2012

Overall Structure

MetaDataVersion

ItemGroupDef - Domains

ItemDef - Variables

CodeList - Code lists

ODM

Study

GlobalVariables

Links and Variable Level

Page 18: Introduction to define - CDISCportal.cdisc.org/CDISC User Networks/Europe/English...The Great Gig in the Sky Money

18© Assero Limited, 2012

Overall Structure<ODM

xmlns="http://www.cdisc.org/ns/odm/v1.2"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns:xlink="http://www.w3.org/1999/xlink"

xmlns:def="http://www.cdisc.org/ns/def/v1.0"

xsi:schemaLocation="http://www.cdisc.org/ns/odm/v1.2 define1-0-0.xsd"

FileOID="Study1234"

ODMVersion="1.2"

FileType="Snapshot"

CreationDateTime="2004-07-28T12:34:13-06:00">

<Study OID="1234">

<GlobalVariables>

<StudyName>1234</StudyName>

<StudyDescription>1234 Data Definition</StudyDescription>

<ProtocolName>1234</ProtocolName>

</GlobalVariables>

<MetaDataVersion OID="CDISC.SDTM.3.1.0"

Name="Study 1234, Data Definitions"

Description="Study 1234, Data Definitions"

def:DefineVersion="1.0.0"

def:StandardName="CDISC SDTM"

def:StandardVersion="3.1.0">

... All the content is here ...

</MetaDataVersion>

</Study>

</ODM>

Page 19: Introduction to define - CDISCportal.cdisc.org/CDISC User Networks/Europe/English...The Great Gig in the Sky Money

19© Assero Limited, 2012

Domain Meta Data

• Dataset Name – 2 character prefix

• Description – The description for the domain

• Location – Folder and filename

• Structure – level of detail provided

• Purpose – Purpose

• Key Fields – Used to identify and index records

Page 20: Introduction to define - CDISCportal.cdisc.org/CDISC User Networks/Europe/English...The Great Gig in the Sky Money

20© Assero Limited, 2012

Domain Meta Data

<ItemGroupDef OID="DM"

Name="DM" Repeating="No"

IsReferenceData="No"

Purpose="Tabulation"

def:Label="Demographics"

def:Structure="One record per event per subject"

def:DomainKeys="STUDYID, USUBJID"

def:Class="Special Purpose"

def:ArchiveLocationID="Location.DM">

<ItemRef ItemOID="STUDYID"

OrderNumber="1" Mandatory="Yes" Role="Identifier"/>

<ItemRef ItemOID="DOMAIN"

OrderNumber="2" Mandatory="Yes" Role="Identifier"/>

<ItemRef ItemOID="USUBJID"

OrderNumber="3" Mandatory="Yes" Role="Identifier"/>

... More itemRefs Here ...

</ItemGroupDef>

Page 21: Introduction to define - CDISCportal.cdisc.org/CDISC User Networks/Europe/English...The Great Gig in the Sky Money

21© Assero Limited, 2012

Domain Meta Data

<ItemGroupDef OID="DM"

Name="DM" Repeating="No"

IsReferenceData="No"

Purpose="Tabulation"

def:Label="Demographics"

def:Structure="One record per event per subject"

def:DomainKeys="STUDYID, USUBJID"

def:Class="Special Purpose"

def:ArchiveLocationID="Location.DM">

<ItemRef ItemOID="STUDYID"

OrderNumber="1" Mandatory="Yes" Role="Identifier"/>

<ItemRef ItemOID="DOMAIN"

OrderNumber="2" Mandatory="Yes" Role="Identifier"/>

<ItemRef ItemOID="USUBJID"

OrderNumber="3" Mandatory="Yes" Role="Identifier"/>

... More itemRefs Here ...

</ItemGroupDef>

Page 22: Introduction to define - CDISCportal.cdisc.org/CDISC User Networks/Europe/English...The Great Gig in the Sky Money

22© Assero Limited, 2012

Variable Meta Data

• Variable Name – 8 character name• Variable Description – The description• Type – Character String or Numeric• Format – Identifies controlled terminology or

presentation• Origin – Indicator of variable origin – CRF or Derived • Role – How variable is used within a dataset (ID, Topic,

Timing, Qualifier)• Comments – Used by sponsor to assist reviewer in

interpreting the data• Label – Variable Label• References – Computational Method, Code Lists & Value

Lists

Page 23: Introduction to define - CDISCportal.cdisc.org/CDISC User Networks/Europe/English...The Great Gig in the Sky Money

23© Assero Limited, 2012

Variable Meta Data<ItemDef OID="DOMAIN"

Name="DOMAIN"

DataType="text"

Length="2"

Origin="CRF Page"

Comment="DOMAIN ABBREVIATION"

def:Label="DOMAIN ABBREVIATION">

</ItemDef>

<ItemDef OID="STUDYID"

Name="STUDYID"

DataType="text"

Length="8"

Origin="CRF Page"

Comment="Demographics CRF Page 4"

def:Label="STUDY IDENTIFIER">

</ItemDef>

<ItemDef OID="SUBJID"

Name="SUBJID"

DataType="text"

Length="60"

Origin="CRF Page"

Comment="Demographics CRF Page 4"

def:Label="SUBJECT IDENTIFIER">

</ItemDef>

Page 24: Introduction to define - CDISCportal.cdisc.org/CDISC User Networks/Europe/English...The Great Gig in the Sky Money

24© Assero Limited, 2012

Variable Meta Data<ItemDef OID="DOMAIN"

Name="DOMAIN"

DataType="text"

Length="2"

Origin="CRF Page"

Comment="DOMAIN ABBREVIATION"

def:Label="DOMAIN ABBREVIATION">

</ItemDef>

<ItemDef OID="STUDYID"

Name="STUDYID"

DataType="text"

Length="8"

Origin="CRF Page"

Comment="Demographics CRF Page 4"

def:Label="STUDY IDENTIFIER">

</ItemDef>

<ItemDef OID="SUBJID"

Name="SUBJID"

DataType="text"

Length="60"

Origin="CRF Page"

Comment="Demographics CRF Page 4"

def:Label="SUBJECT IDENTIFIER">

</ItemDef>

Page 25: Introduction to define - CDISCportal.cdisc.org/CDISC User Networks/Europe/English...The Great Gig in the Sky Money

25© Assero Limited, 2012

Variable Meta Data <ItemDef OID="VS.VSTESTCD.FRAME“

Name="FRAME"

DataType="float“

Length="8“

SignificantDigits="1"

Origin="CRF Page“

Comment="Vital Signs CRF Page 4"

def:Label="Frame">

<CodeListRef CodeListOID="FRAME"/>

</ItemDef>

<CodeList OID="FRAME" Name="FRAME" DataType="text">

<CodeListItem CodedValue="S">

<Decode><TranslatedText xml:lang="en">Small</TranslatedText></Decode>

</CodeListItem>

<CodeListItem CodedValue="M">

<Decode><TranslatedText xml:lang="en">Medium</TranslatedText></Decode>

</CodeListItem>

<CodeListItem CodedValue="L">

<Decode><TranslatedText xml:lang="en">Large</TranslatedText></Decode>

</CodeListItem>

<CodeListItem CodedValue="XL">

<Decode><TranslatedText xml:lang="en">Extra large</TranslatedText></Decode>

</CodeListItem>

</CodeList>

Page 26: Introduction to define - CDISCportal.cdisc.org/CDISC User Networks/Europe/English...The Great Gig in the Sky Money

26© Assero Limited, 2012

Variable Meta Data <ItemDef OID="VS.VSTESTCD.FRAME“

Name="FRAME"

DataType="float“

Length="8“

SignificantDigits="1"

Origin="CRF Page“

Comment="Vital Signs CRF Page 4"

def:Label="Frame">

<CodeListRef CodeListOID="FRAME"/>

</ItemDef>

<CodeList OID="FRAME" Name="FRAME" DataType="text">

<CodeListItem CodedValue="S">

<Decode><TranslatedText xml:lang="en">Small</TranslatedText></Decode>

</CodeListItem>

<CodeListItem CodedValue="M">

<Decode><TranslatedText xml:lang="en">Medium</TranslatedText></Decode>

</CodeListItem>

<CodeListItem CodedValue="L">

<Decode><TranslatedText xml:lang="en">Large</TranslatedText></Decode>

</CodeListItem>

<CodeListItem CodedValue="XL">

<Decode><TranslatedText xml:lang="en">Extra large</TranslatedText></Decode>

</CodeListItem>

</CodeList>

Page 27: Introduction to define - CDISCportal.cdisc.org/CDISC User Networks/Europe/English...The Great Gig in the Sky Money

27© Assero Limited, 2012

Value Level Meta Data

• SDS Version 3 makes use of "Tall Skinny" structure. Findings domains consist of

– Test/Result pairs (xxTESTCD/xxORRES)

• Interpretation of information in the Results depends on the value of xxTESTCD

• Results for different tests may have different data types, formats, labels, etc

Page 28: Introduction to define - CDISCportal.cdisc.org/CDISC User Networks/Europe/English...The Great Gig in the Sky Money

28© Assero Limited, 2012

Value Level Meta Data

<def:ValueListDef OID="ValueList.VS.VSTESTCD">

<ItemRef ItemOID="VS.VSTESTCD.FRAME"

OrderNumber="10" Mandatory="No"/>

<ItemRef ItemOID="VS.VSTESTCD.HTRAW"

OrderNumber="11" Mandatory="No"/>

<ItemRef ItemOID="VS.VSTESTCD.WTRAW"

OrderNumber="12" Mandatory="No"/>

<ItemRef ItemOID="VS.VSTESTCD.MEANBP"

OrderNumber="13" Mandatory="No"/>

</def:ValueListDef>

Page 29: Introduction to define - CDISCportal.cdisc.org/CDISC User Networks/Europe/English...The Great Gig in the Sky Money

29© Assero Limited, 2012

Value Level Meta Data

<def:ValueListDef OID="ValueList.VS.VSTESTCD">

<ItemRef ItemOID="VS.VSTESTCD.FRAME"

OrderNumber="10" Mandatory="No"/>

<ItemRef ItemOID="VS.VSTESTCD.HTRAW"

OrderNumber="11" Mandatory="No"/>

<ItemRef ItemOID="VS.VSTESTCD.WTRAW"

OrderNumber="12" Mandatory="No"/>

<ItemRef ItemOID="VS.VSTESTCD.MEANBP"

OrderNumber="13" Mandatory="No"/>

</def:ValueListDef>

Page 30: Introduction to define - CDISCportal.cdisc.org/CDISC User Networks/Europe/English...The Great Gig in the Sky Money

30© Assero Limited, 2012

Additional Information

• Annotated CRF – Link to file containing

annotated CRF

• See draft Meta Data Guidelines (draft) at

http://www.cdisc.org/msg-draft

Page 31: Introduction to define - CDISCportal.cdisc.org/CDISC User Networks/Europe/English...The Great Gig in the Sky Money

31© Assero Limited, 2012

Annotated CRF

<def:AnnotatedCRF>

<def:DocumentRef leafID="blankcrf"/>

</def:AnnotatedCRF>

<def:leaf ID="blankcrf" xlink:href="blankcrf.pdf">

<def:title>Annotated Case Report Form</def:title>

</def:leaf>

Page 32: Introduction to define - CDISCportal.cdisc.org/CDISC User Networks/Europe/English...The Great Gig in the Sky Money

32© Assero Limited, 2012

Exampleshttp://www.cdisc.org/define-xml

Page 33: Introduction to define - CDISCportal.cdisc.org/CDISC User Networks/Europe/English...The Great Gig in the Sky Money

33© Assero Limited, 2012

FAQ

Page 34: Introduction to define - CDISCportal.cdisc.org/CDISC User Networks/Europe/English...The Great Gig in the Sky Money

34© Assero Limited, 2012

Define is an ODM Extension?

• Define.xml is built from the components used

by CDISC to build the Operational Data Model

(ODM)

• The ODM is used to transport Case Report

Form (CRF) data

• Define.xnl is used to transport tabulation

metadata

• They are quite different use cases

Page 35: Introduction to define - CDISCportal.cdisc.org/CDISC User Networks/Europe/English...The Great Gig in the Sky Money

35© Assero Limited, 2012

Same Components, Different Use

Page 36: Introduction to define - CDISCportal.cdisc.org/CDISC User Networks/Europe/English...The Great Gig in the Sky Money

36© Assero Limited, 2012

Define is an ODM Extension?

Page 37: Introduction to define - CDISCportal.cdisc.org/CDISC User Networks/Europe/English...The Great Gig in the Sky Money

37© Assero Limited, 2012

Define is Machine Readable?

• Define.xml is built using XML technology

• A computer can consume and process (and

understand) the information within the

define.xml file

Page 38: Introduction to define - CDISCportal.cdisc.org/CDISC User Networks/Europe/English...The Great Gig in the Sky Money

38© Assero Limited, 2012

Define is Machine Readable?

Page 39: Introduction to define - CDISCportal.cdisc.org/CDISC User Networks/Europe/English...The Great Gig in the Sky Money

39© Assero Limited, 2012

Define is Human Readable?

• As we said, define.xml is built using XML

technology

• A computer can consume and process (and

understand) the information within the

define.xml file

• But using style sheet technology we can also

transform the XML into a form that humans

can understand

Page 40: Introduction to define - CDISCportal.cdisc.org/CDISC User Networks/Europe/English...The Great Gig in the Sky Money

40© Assero Limited, 2012

Define is Human Readable?

Page 41: Introduction to define - CDISCportal.cdisc.org/CDISC User Networks/Europe/English...The Great Gig in the Sky Money

41© Assero Limited, 2012

What tools do I use with define.xml?

http://www.cdisc.org/define-xml

Page 42: Introduction to define - CDISCportal.cdisc.org/CDISC User Networks/Europe/English...The Great Gig in the Sky Money

42© Assero Limited, 2012

What tools do I use with define.xml?

Slide courtesy of Formedix Limited

Page 43: Introduction to define - CDISCportal.cdisc.org/CDISC User Networks/Europe/English...The Great Gig in the Sky Money

43© Assero Limited, 2012

Tools• OpenCDISC

– Validator

– http://www.opencdisc.org/

• XML4Pharma – CDISC Define.xml Checker

– http://www.xml4pharma.com/CDISC_Define_Checker/index.html

• SAS tool set– http://www.sas.com/industry/pharma/cdisc/

• Formedix– Origin Submission Modeller

– http://www.formedix.com/cms/index.php?option=com_content&task=view&id=28&Itemid=53

• Entimo– entmICE DARE

– http://www.entimo.com/solution/entimICE_DARE.html

• Octagon– Checkpoint

– http://www.octagonresearch.com/checkpoint-data-validation.html

Page 44: Introduction to define - CDISCportal.cdisc.org/CDISC User Networks/Europe/English...The Great Gig in the Sky Money

44© Assero Limited, 2012

Summary

Page 45: Introduction to define - CDISCportal.cdisc.org/CDISC User Networks/Europe/English...The Great Gig in the Sky Money

45© Assero Limited, 2012

Purpose

• Describes

– What is included within the data

– Where did the data come from

– Derivations, code lists, annotated PDF etc to aid understanding

• Machine Readable

• Human Readable (after processing)

• To aid/inform the reviewer, unambiguous communication

Page 46: Introduction to define - CDISCportal.cdisc.org/CDISC User Networks/Europe/English...The Great Gig in the Sky Money

46© Assero Limited, 2012

Q&A

[email protected]

www.assero.co.uk

@Assero_UK


Top Related