In the first ODM Tutorial I concentrated only on the study design MetaData elements of the ODM and didn't cover AdminData at all.
What is AdminData?
The ODM AdminData element is a container for information about Users and Locations (Study sites) that have involvement in the collection of the clinical data.
In an ODM file AdminData appears inside the ODM element. You’ll see that AdminData appears at the same level as Study because they are logically independent, Study does not rely on AdminData and AdminData does not rely on Study.
xmlns:ds="http://www.w3.org/2000/09/xmldsig#"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xml="http://www.w3.org/XML/1998/namespace"
ODMVersion="1.3"
FileOID="000-00-0000"
FileType="Snapshot"
CreationDateTime="2009-02-20T06:56:00">
<Study OID="ST.001">
...study elements ...
</Study>
<AdminData>
...admindata elements...
</AdminData>
</ODM>
AdminData has a single optional attribute, StudyOID which references the study which this AdminData is related to.
An ODM file can contain more than one Study and more than one set of AdminData. If no StudyOID is provided then it's assumed that the AdminData is relevant for all studies in this ODM file.
Here I'm going to be explicit and make it clear that this AdminData is related to the study:
…contents…
</AdminData>
AdminData may contain User, Location and SignatureDef elements. We'll look at each.
Users
A User is defined as someone who has access to the data collection system, this usually means Sponsor or Investigator users. ODM 1.3 allows the collection of various details about a user but most of them are optional. Here is the minimal valid User element:
A User is required only to have an OID. This is enough to identify a user in AuditRecords and Signatures that appear in the ClinicalData section of an ODM file.
Although enough to identify a user uniquely, you will likely want to give some other clue as to what role the user takes in the study. The ODM provides the optional UserType attribute for this purpose. It can take one of the following values: Sponsor, Investigator, Lab or Other.
That isn’t giving us much information about the user so you might want to include their LoginName, Firstname and Lastname? The ODM provides for that:
UserType="Investigator"
LoginName="mfields"
FirstName="Martin"
LastName="Fields">
</User>
If you want to provide more information about a user there are many fields that can be completed.
UserType="Investigator"
LoginName="mfields"
DisplayName="Martin Fields"
FullName="Martin John Fields"
FirstName="Martin"
LastName="Fields"
Organization="MGH"
<Address>
<StreetName>Massachusetts General Hospital</StreetName>
<StreetName>55 Fruit Street</StreetName>
<City>Boston</City>
<StateProv>Massachusetts</StateProv>
<PostalCode></PostalCode>
<Country>USA</Country>
<OtherText></OtherText>
</Address>
<Email>mfields@example.com</Email>
<Email>martyfields@home.example.com</Email>
<Picture PictureFileName="mfields.jpg"
ImageType="jpeg"/>
<Pager></Pager>
<Fax></Fax>
<Phone>1-999-999-9999</Phone>
<Phone>1-888-888-8888</Phone>
<LocationRef LocationOID="LD.MGH"/>
<Certificate>
<!-- Optional, reserved for future use -->
</Certificate>
</User>
Except for the OID, all the above fields are optional. Lets talk about a few of them.
The Address element deserves some discussion of its own. Although you can link a user to a Location via the LocationRef (and we'll get to that) a user might have separate contact information so the optional Address element provides it.
See that I included two StreetName elements, that's valid.
It's also possible to have multiple Email, Pager and Fax elements but there is currently no way to show that one is a home, cell or work contact. My advice would be to list the primary ones first, the order doesn’t have any inherent meaning in the ODM but when reading the XML file processing tools will generally read them in the order listed.
Before we talk about LocationRefs, a comment about Certificate elements. This element is a placeholder in the ODM 1.3, it could be used in conjunction with Public/Private key encryption to hold the users Public key. This would allow Digital Signatures made with the Private key to be verified. See the Wikipedia article on Public Key Cryptography for a full treatment of this subject.
LocationRefs
A User element can contain zero or more LocationRef elements.
<LocationRef LocationOID="LD.MGH"/>
</User>
These each have a LocationOID attribute which references a Location by its OID.
A Location is a building where something related to the study happens. Usually it will be a Physicians office where study data is collected but it can also be a Sponsor office. Each LocationRef indicates that the user has an association with that Location. The meaning of that association isn’t explicit in the ODM it’s implied by the UserType. We don’t know if a User is a CRA or an Investigator for a site but we can probably work it out from a Sponsor or Site UserType if it’s provided.
Locations
LocationRefs relate to Locations. A Location element appears at the same level as the User elements under AdminData. Here is a complete Location example:
Name="MGH"
LocationType="Site">
<!-- Must have at least one MetaDataVersionRef -->
<MetaDataVersionRef StudyOID="ST.001"
MetaDataVersionOID="MD.001"
EffectiveDate="2009-11-01"/>
</Location>
You might find it surprising that a User can have an Address but a Location can't. I'm confused myself, maybe one of the ODM guru's will comment and explain it.
The LocationType for a site is optional and can be one of Sponsor, Site, CRO, Lab or Other.
Something that isn't optional is the MetaDataVersionRef. It references the MetaDataVersion (no Def postfix) inside the Study. In this case we're saying that the MGH location accepted MetaDataVersion MD.001 in the Study ST.001 on the 1st November 2009. The date definition follows the YYYY-MM-DD convention and not the more precise datetime e.g. 2009-11-01T09:34:01 but it is probably precise enough.
Anyone in this business will tell you that study amendments are common. As new MetaDataVersions are made available Locations will start to use them, maybe on different dates based on Institutional Review Board agreement. A Location might end up with a number of MetaDataVersionRef elements, each showing at what time they accepted and started using each MetaDataVersion for the study:
Name="MGH"
LocationType="Site">
<MetaDataVersionRef StudyOID="ST.001"
MetaDataVersionOID="MD.001"
EffectiveDate="2009-11-01"/>
<MetaDataVersionRef StudyOID="ST.001"
MetaDataVersionOID="MD.002"
EffectiveDate="2009-12-14"/>
</Location>
SignatureDefs
The final type of element that can appear inside AdminData is a SignatureDef. This element defines the meaning of signatures that can be applied to Clinical Data.
Methodology="Electronic">
<Meaning>Investigator Signature</Meaning>
<LegalReason>
The signer agrees and attests that the
data is an accurate representation of the source.
</LegalReason>
</SignatureDef>
A SignatureDef can be referenced in a Clinical Data SignatureRef as the why part of the who (UserRef), why (SignatureRef), when (Date), where (LocationRef) combination that makes up a signature.
The Methodology attribute can be Electronic or Digital. A digital signature is based on a cryptographic key (e.g. the Private key of a Public/Private Public Key Encryption pair). An eclinical system that relies on the entry of a username/password combination alone to establish a signature is generally using the Electronic signature method.
A SignatureDef is required to have a Meaning element which contains a short description of the purpose of the signature (e.g. Approval, Review, Verification etc) and the Legalese of what the user is agreeing to when they apply that kind of a signature. An eclinical system will display the LegalReason along with the opportunity to apply a signature.
Wrap Up
There we have it. The AdminData element of the CDISC ODM 1.3 isn't too complicated and there are many optional elements.
Here is a partial ODM file that wraps up all the examples. Good luck in your own CDISC ODM adventures.
xmlns:ds="http://www.w3.org/2000/09/xmldsig#"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xml="http://www.w3.org/XML/1998/namespace"
ODMVersion="1.3"
FileOID="000-00-0000"
FileType="Snapshot"
CreationDateTime="2009-12-28T06:56:00">
<AdminData StudyOID=”ST.001”>
<User OID="UD.MFIELDS"
UserType="Investigator"
LoginName="mfields"
DisplayName="Martin Fields"
FullName="Martin John Fields"
FirstName="Martin"
LastName="Fields"
Organization="M.G.H"
<Address>
<StreetName>
Massachusetts General Hospital
</StreetName>
<StreetName>55 Fruit Street</StreetName>
<City>Boston</City>
<StateProv>Massachusetts</StateProv>
<PostalCode></PostalCode>
<Country>USA</Country>
<OtherText></OtherText>
</Address>
<Email>mfields@example.com</Email>
<Email>martyfields@home.example.com</Email>
<Picture PictureFileName="mfields.jpg"
ImageType="jpeg"/>
<Pager></Pager>
<Fax></Fax>
<Phone>1-999-999-9999</Phone>
<Phone>1-888-888-8888</Phone>
<LocationRef LocationOID="LD.MGH"/>
<Certificate/>
</User>
<Location OID="LD.MGH"
Name="MGH"
LocationType="Site">
<MetaDataVersionRef StudyOID="ST.001"
MetaDataVersionOID="MD.001"
EffectiveDate="2009-11-01"/>
<MetaDataVersionRef StudyOID="ST.001"
MetaDataVersionOID="MD.002"
EffectiveDate="2009-12-14"/>
</Location>
<SignatureDef OID="SIGD.001"
Methodology="Electronic">
<Meaning>Investigator Signature</Meaning>
<LegalReason>
The signer agrees and attests that the
data is an accurate representation of the source.
</LegalReason>
</SignatureDef>
</AdminData>
</ODM>