Previous Topic

Next Topic

Book Contents

Response—GetTransactions

Returns an XmlElement that contains the subject transaction data (such as form submissions) for subjects who match the specified patient ID. The subject data is located under the /ODM/ClinicalData XPath in the returned XML.

GetTransactions response

Node/Attribute name

Description

Description

The description of the study.

FileType

For InForm data, FileType is always Transactional, indicating that an InForm transaction is returned.

FileOID

A unique identifier for the file.

Consists of the study.name followed by a GUID. For example:

pfst/{345C8404-9656-425B-BA03-EE92D7E1FE91}

 

PriorFileOID

An identifier for the transaction that was retrieved by the previous API call.

CreationDateTime

The date and time when the API call was made.

ODMVersion

The version of the ODM schema of the returned data.

Originator

The ID of the user who made the API call.

TransactionsProcessed

Indicates the number of transactions that were considered by the method.

Note: This number is not the same as the number of clinical data transactions that are returned. Some transactions do not contain clinical data.

Bookmark

The bookmark that must be passed into the next call to GetTransactions. Indicates the point in the transaction log after which the processing should begin.

For more information, see Usage—GetTransactions.

MetaDataVersionOID

Identifier for the study version of the form in the InForm system.

If the form does not contain a study version, MetaDataVersion is returned with the value "Undefined."

This represents the column EditionDescription found in the pf_volumeEdition table.

If there is no volumeEdition associated with a particular site the value is "Undefined."

For more information, see:

Send Feedback