Contents
What is the InForm Adapter software?
What is the InForm Adapter software?
The InForm Adapter interfaces
About namespaces
Location of .xsd files
Discrepancy interface
Overview: Discrepancy interface
Programming model and operations
SOAP header
SOAP header example
How requests are processed
Operations
GetSummaryCounts
Input parameters�GetSummaryCounts
Example request�GetSummaryCounts
Results�GetSummaryCounts
Example response�GetSummaryCounts
GetByCriteria
Input parameters�GetByCriteria
Example request�GetByCriteria
Results�GetByCriteria
Example response�GetByCriteria
GetByDiscrepancyGuid
Input parameters�GetByDiscrepancyGuid
Example request�GetByDiscrepancyGuid
Results�GetByDiscrepancyGuid
Example response�GetByDiscrepancyGuid
GetHistoryByDiscrepancyGuid
Input parameters�GetHistoryByDiscrepancyGuid
Example request�GetHistoryByDiscrepancyGuid
Results�GetHistoryByDiscrepancyGuid
Example response�GetHistoryByDiscrepancyGuid
GetByTransactionId
Input parameters�GetByTransactionId
Example request �GetByTransactionId
Results example response�GetByTransactionId
Issue
Input parameters�Issue
TransactionID GUID format
Example request�Issue
Discrepancies issued on mapped items
Results�Issue
Example response�Issue
Update
Input parameters�Update
Example request�Update
Results�Update
Example response�Update
Use cases
General use
ODM use
Structural representation of LSIDs
Location of LSID components in ODM extract files
Client dashboard use
Error messages from the Discrepancy interface
ODM Export Interface
Overview: ODM Export interface
ODM Export: XML schemas
SOAP header
Security information in the SOAP header
SOAP header example
Input parameters
Schema files provided with the ODM Export interface
Request directory
Response directory
Namespaces
Version extensions
ResponseODM
Error messages from the ODM Export interface
Public Web methods
Public Web Methods List
DownloadMetadataODM
Input parameters�DownloadMetadataODM
Example request�DownloadMetadataODM
Response�DownloadMetaDataODM
Internationalization�DownloadMetadataODM response
MeasurementUnit
Question
CodeList
TranslatedText in Mnemonic element
DownloadAdminDataODM
Input parameters�DownloadAdminDataODM
Example request�DownloadAdminDataODM
Response�DownloadAdminDataODM
Using a bookmark
Bookmark example
Internationalization�DownloadAdminDataODM response
Product Locale
User Study locale
Site Study locale
Site Study locale
FullName and DisplayName
TranslatedText in Mnemonic element
Meaning and LegalReason elements
GetSiteList
Input parameters�GetSiteList
Example request�GetSiteList
Response�GetSiteList
Internationalization�GetSiteList response
GetPatientList
Input parameters�GetPatientList
Example request�GetPatientList
Response�GetPatientList
GetPatientForms
Input parameters�GetPatientForms
Example request�GetPatientForms
Response�GetPatientForms
GetTransactions
Input parameters�GetTransactions
Example request�GetTransactions
Response�GetTransactions
Usage�Get Transactions
What happens after all transactions are processed?
GetTransactionStatus
Input parameters
Example request�GetTransactionStatus
Response�GetTransactionStatus
Examples of ODM Responses
Transactional Data�DownloadMetadataODM response
Transactional data�DownloadAdminDataODM response
GetSiteList example response
GetPatientList example response
GetPatientForms example response
GetTransactions example response - returning clinical data
GetTransactions example response - returning no clinical data
GetTransactionStatus example response
Oracle ODM extensions
Candidate element
CriticalForm element
Example�Criticalform
CriticalItems
CriticalItem
FormattedDateValue
FormStatus element
GroupDef element
Right element
GroupRef element
InFormItemData element
InFormItemDef element
InFormItemRef element
ItemStatus element
Query element
QueryStatus element
ReasonIncomplete element
ReviewState element
ReviewStage element
SubjectPool element
SubjectPoolChange element
SubjectStatus element
ProductLocale element
Oracle attributes that are applied to standard ODM elements
Revision, DBUID, and GUID attributes
Metadata
Clinical data and Association data
AdminData
Extensions that show control hierarchy and type
Elements and extensions for subject pools
Subject pool selection
Changes in the subject pool
Elements and extensions for review states and stages
Rights for review states
How review state and stage information is returned
Example�review state and stage information in administrative data, metadata, and transaction output
Elements and extensions change history
ODM mapping
About ODM mapping
Mapping of localized items
ODM
Example�ODM
Study
Example�Study
GlobalVariables
Example�GlobalVariables
BasicDefinitions
MeasurementUnit
TranslatedText
Example�BasicDefinitions
MetaDataVersion
StudyEventRef
Example�MetaDataVersion
StudyEventDef
Mnemonic
FormRef
Example�StudyEventDef
FormDef
Mnemonic
ItemGroupRef
Example�FormDef
ItemGroupDef
Example�ItemGroupDef
InformItemRef
Example�InformItemRef
ItemRef
Example�ItemGroupDef
InformItemDef
Example�InformItemDef
ItemDef
Data Type Table
MeasurementUnitRef
Question
Example�ItemDef
User
Example--User - mapping
GroupDef
Right
Example�GroupDef
Location
Mnemonic
Example�Location
CodeList
Example�CodeList
CodeListItem
Example�CodeListItem
MetaDataVersionRef
Example�MetaDataVersionRef
SignatureDef
Meaning
LegalReason
Example�SignatureDef
ClinicalData
How study versions are populated
Example�ClinicalData
Example�ClinicalData Sample Output
SubjectData
Signature
SiteRef
pf:SubjectPool
pf:SubjectPoolChange
pf:CriticalForm
pf:ReviewState
pf:ReviewStage
Example�SubjectData
Candidate
Example�Candidate
SubjectStatus
Example�SubjectStatus
StudyEventData
Example�StudyEventData
FormData
Signature
Example�FormData
FormStatus
Example�FormStatus
Signature
Example�Signature
ItemGroupData
Example�ItemGroupData
Annotation
Example�Annotation
ItemData
Example�ItemData
ItemStatus
Example�ItemStatus
InFormItemData
Example�InformItemData
AuditRecord
UserRef
Example�AuditRecord
Query
Example�Query
QueryStatus
Example�QueryStatus
Client programs for determining item completeness
Introduction
InForm item controls
Radio and Checkbox groups
Simple group control
Extensions show control hierarchy and type
Radio and Checkbox groups, with ODM metadata output
Group control, with ODM metadata output
Determining item completeness
Writing a client program to evaluate ItemData elements
Algorithms - pseudocode