|
|
|
|
Example—review state and stage information in administrative data, metadata, and transaction output
In this example,
- DownloadAdminDataODM returns information about the groups to which the user mlynch is a member, and information about the group.
- DownloadMetadataODM returns information about the states and stages that are defined.
- GetTransactions returns information about changes to the status of a form.
DownloadAdminDataODM
In the administrative data, each user has a group reference which points at pf:GroupDef. pf:GroupDef defines the permissions.
The XML data that is returned indicates that user belongs to three groups. pf:GroupRef
<User OID="mlynch" UserType="Sponsor" pf:DBUID="12801" pf:GUID="{C651EA0D-B3A3-4DFE-B7E4-22B132D5FAAB}" pf:StudyLocale="en-US">
<LoginName>mlynch</LoginName>
<DisplayName>Melissa Lynch</DisplayName>
<FullName>Melissa Lynch</FullName>
<FirstName>Melissa</FirstName>
<LastName>Lynch</LastName>
<Address>
<Country>USA</Country>
</Address>
<Email>email@domain.test</Email>
<Fax>(555) 555-1212</Fax>
<Phone>(555) 555-1212</Phone>
<LocationRef LocationOID="13341" />
<LocationRef LocationOID="13375" />
<LocationRef LocationOID="13409" />
<LocationRef LocationOID="13443" />
<LocationRef LocationOID="13477" />
<LocationRef LocationOID="13511" />
<LocationRef LocationOID="13545" />
<LocationRef LocationOID="13579" />
<LocationRef LocationOID="13613" />
<pf:GroupRef GroupOID="6528" />
<pf:GroupRef GroupOID="13811" />
<pf:GroupRef GroupOID="13959" />
</User>
The following XML indicates that group CRA with OID 13959 has the permissions to assign and view review state.
<pf:GroupDef OID="13959" Name="CRA" GroupType="Rights">
<pf:Right Description="Print" />
<pf:Right Description="Monitor" />
<pf:Right Description="Reports" />
<pf:Right Description="View CRF" />
<pf:Right Description="View CRF Signature Information" />
<pf:Right Description="View Case Book Signature Information" />
<pf:Right Description="Data Export Listings" />
<pf:Right Description="Freeze a CRF" />
<pf:Right Description="Unfreeze a CRF" />
<pf:Right Description="Mark and Unmark a CRF as SVed" />
<pf:Right Description="Freeze a Case Book" />
<pf:Right Description="Unfreeze a Case Book" />
<pf:Right Description="Change Query State from Candidate to Open" />
<pf:Right Description="Change Query State from Candidate to Deleted" />
<pf:Right Description="Change Query State from Answered to Closed" />
<pf:Right Description="Enter Query in Candidate State" />
<pf:Right Description="Enter Query in Open State" />
<pf:Right Description="Re-issue Query in Candidate State" />
<pf:Right Description="Re-issue Query in Open State" />
<pf:Right Description="Reordering Of Patients" />
<pf:Right Description="Change Query State from Open to Closed" />
<pf:Right Description="Change Query State from Reissued Candidate to Closed" />
<pf:Right Description="Assign Review States" />
<pf:Right Description="View Review States" />
<pf:Right Description="Change Site SV Settings" />
</pf:GroupDef>
DownloadMetadataODM
The sample XML shows one review state and its stages
<pf:ReviewState pf:DBUID="14216" RefName="DataReview1" StateValue="1" Revision="335876530226035">
<pf:ReviewStage RefName="DataReview1.ReviewStage1" StageValue="0" Activated="1" Revision="335876530226035">
<pf:Name>
<TranslatedText xml:lang="en-US">Needs Review-2ndRevision</TranslatedText>
<TranslatedText xml:lang="ja-JP">?????</TranslatedText>
</pf:Name>
<pf:Mnemonic>
<TranslatedText xml:lang="en-US">RS1</TranslatedText>
<TranslatedText xml:lang="ja-JP">????S1</TranslatedText>
</pf:Mnemonic>
</pf:ReviewStage>
<pf:ReviewStage RefName="DataReview1.ReviewStage2" StageValue="1" Activated="1" Revision="335876530226035">
<pf:Name>
<TranslatedText xml:lang="en-US">Pending-2ndRevision</TranslatedText>
<TranslatedText xml:lang="ja-JP">??</TranslatedText>
</pf:Name>
<pf:Mnemonic>
<TranslatedText xml:lang="en-US">RS2</TranslatedText>
<TranslatedText xml:lang="ja-JP">????S2</TranslatedText>
</pf:Mnemonic>
</pf:ReviewStage>
<pf:ReviewStage RefName="DataReview1.ReviewStage3" StageValue="2" Activated="1" Revision="335876530226035">
<pf:Name>
<TranslatedText xml:lang="en-US">Reviewed-2ndRevision</TranslatedText>
<TranslatedText xml:lang="ja-JP">?????</TranslatedText>
</pf:Name>
<pf:Mnemonic>
<TranslatedText xml:lang="en-US">RS3</TranslatedText>
<TranslatedText xml:lang="ja-JP">????S3</TranslatedText>
</pf:Mnemonic>
</pf:ReviewStage>
<pf:Name>
<TranslatedText xml:lang="en-US">Data Review-2ndRevision</TranslatedText>
<TranslatedText xml:lang="ja-JP">???????</TranslatedText>
</pf:Name>
<pf:Mnemonic>
<TranslatedText xml:lang="en-US">R1</TranslatedText>
<TranslatedText xml:lang="ja-JP">????1</TranslatedText>
</pf:Mnemonic>
</pf:ReviewState>
GetTransactions
The sample XML shows the form status changes for a form.
<ResponseODM xmlns:pf="http://www.phaseforward.com/InFormAdapter/ODM/Extensions/2.0" xmlns="http://www.phaseforward.com/InFormAdapter/ODM/2.0">
ODM Description="StudyDesign" FileType="Transactional" FileOID="{A18E6CE1-11AB-4C6B-A4A8-63E31BD9025F}" CreationDateTime="2011-08-25T19:08:07+00:00" PriorFileOID="{69262641-61FC-4FA3-AAE8-5D34B8AC8A4E}" ODMVersion="1.3" Originator="system" pf:MappingVersion="V2" pf:HierarchicalOIDs="Yes" pf:InFormAdapterVersion="1.0.4254.25287" xmlns="http://www.cdisc.org/ns/odm/v1.3">
<ClinicalData StudyOID="StudyDesign" MetaDataVersionOID="Study Design 0.0.2" pf:TransactionGuid="{A18E6CE1-11AB-4C6B-A4A8-63E31BD9025F}" pf:Revision="335969315181037.000">
<SubjectData SubjectKey="14336" TransactionType="Upsert" pf:GUID="{EC5C716F-1AC3-49C0-88FE-A3AA33236EC1}">
<SiteRef LocationOID="13341" />
<StudyEventData StudyEventOID="vstCORE1">
<FormData FormOID="frmDOV">
<pf:FormStatus ReviewStageRefNchame="DataReview5.ReviewStage51" ReviewState="5" ReviewStage="0" ReviewStateRevision="335876536304035">
<AuditRecord>
<UserRef UserOID="lhill" />
<LocationRef LocationOID="Unknown" />
<DateTimeStamp>2011-08-25T17:48:35+00:00</DateTimeStamp>
<!--The next line is the comment provided when the review state is assigned to a subject form -->
<ReasonForChange>assign review state 5.0</ReasonForChange>
</AuditRecord>
</pf:FormStatus>
</FormData>
</StudyEventData>
</SubjectData>
</ClinicalData>
</ODM>
<Status>END</Status>
<Bookmark>{A18E6CE1-11AB-4C6B-A4A8-63E31BD9025F}</Bookmark>
<TransactionsProcessed>1</TransactionsProcessed>
</ResponseODM>
