RetrieveTransaction

The Retrieve Transaction Service

Retrieve Transaction is conceived as a single view on the data in datasets, transactions, valuesets and (a little) templates, gathered together with the transaction as a starting point. This enables developers to have a single view on all - or most of - the data necessary to implement a transaction. Retrieve Transaction comes with both an HTML and a XML view. Here we'll focus on the XML view (the HTML view is nothing more than the data in the XML view, rendered as HTML).

Since Retrieve Transaction XML collects all the data from the various DECOR views, it can be a good starting point for code generation.

The Query parameters

Retrieve Transaction will accept the following query parameters:

• id (of either a transaction or a dataset)
• language (optional, default is the project's default language
• format ('xml' or 'html')
• version (to retrieve a frozen release)
• hidecolumns (to influence the HTML display)
• unfiltered (to influence the HTML display)

The dataset element

This element contains the following attributes:

Attribute	Example	Description
id	2.16.840.1.113883.3.1937.99.62.3.1.1	The id of the dataset which was filtered.
effectiveDate	2012-05-30T11:32:36	The effectiveDate of the dataset which was filtered.
statusCode	draft	The statusCode of the dataset which was filtered.
versionLabel	v2014.07	The versionLabel of the dataset which was filtered.
transactionId	2.16.840.1.113883.3.1937.99.62.3.4.2	The id of the transaction which was used to filter the dataset.
transactionEffectiveDate	2012-09-05T16:59:35	The effectiveDate of the transaction which was used to filter the dataset.
shortName	measurement_message"	A machine-processable name which can be used as an XML element name or SQL column name. Basically, the transaction (or dataset) name in lowercase, spaces to underscores, and odd characters removed. There is no 100% uniqueness guarantee (i.e. 'My name' and 'My [name]' will generate the same shortName. In most cases however, the name should be unique on a given level in the hierarchy.

If an dataset id is provided as query parameter, the dataset will not be filtered for a particular transaction. If a transaction id is provided, only those concepts will occur in the original dataset which are in this transaction as well.

The dataset element will contain name and desc elements from the original transaction or dataset.