Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Each data element has an optional TransactionType attribute

...

: either Insert,

...

 Update,

...

 Remove,

...

 Upsert,

...

or Context.

A TransactionType of Insert means that the data entity is new (does not currently exist in the study) and must be added to the study data along with all the properties provided. It is an error if the data entity already exists, or if the data entity's parent does not exist.

A TransactionType of Update means that the data entity already exists and must be modified to have the new properties provided. Properties not mentioned are not modified. It is an error if the data entity does not exist.

A TransactionType of Remove means that the data entity already exists and must be deleted along with all its properties and children. It is an error if the data entity does not exist.

...

.

A TransactionType of Upsert is the same as Update if the data entity exists, and the same as Insert otherwise.

...

Note:

...

Upsert allows the sender to ignore whether the data entity exists or not

...

, a capability that may be needed by certain data collection systems.

...

 

...


A TransactionType of Context means that the data is explicitly being resent for context purposes only. An example of this would be sending an ItemGroup containing demographic data every time (with a TransactionType of Context) to permit matching and checking of Patient patient IDs between the sender and receiver systems.

A child element that does not specify its own TransactionType inherits the TransactionType of its parent. The TransactionType of a top-level data element must be explicit.

Transaction processing proceeds in the order in which data elements appear in the ODM document. If two 2 transactions for an entity are included in an ODM document, they are applied in the order in which they appear.

...

If a Snapshot document includes a TransactionType, only TransactionType=Insert is permitted.

Info

Note: The use of the word "delete" in this section does not imply that all records of the data entity are expunged, just that the next transaction on that entity (if any) must be an Insert rather than Update or Remove.

Pagenav2