RetrieveTransaction - Revision history

Admin at 15:48, 21 May 2016

2016-05-21T15:48:43Z

Ahenket: /* The dataset element */

2014-12-12T15:43:50Z

‎The dataset element

Ahenket: /* The query parameters */

2014-12-12T15:41:42Z

‎The query parameters

Ahenket: /* The Retrieve Transaction Service */

2014-12-12T15:41:16Z

‎The Retrieve Transaction Service

Mdegraauw: /* The query parameters */

2014-12-12T15:19:19Z

‎The query parameters

Mdegraauw: /* The Retrieve Transaction Service */

2014-12-12T15:19:03Z

‎The Retrieve Transaction Service

Mdegraauw: /* The dataset element */

2014-12-12T15:17:18Z

‎The dataset element

Mdegraauw: /* The dataset element */

2014-12-12T15:16:38Z

‎The dataset element

Mdegraauw: /* The valueSet element */

2014-12-12T15:15:37Z

‎The valueSet element

Mdegraauw: /* The Retrieve Transaction Service */

2014-12-12T15:11:38Z

‎The Retrieve Transaction Service

@@ Line 16: / Line 16: @@
 ==The dataset element==
 This element contains the following attributes:
-{| class="artdecor"
+{| class="artdecorwiki"
 ! Attribute !! Example !! Description
 |-
@@ Line 41: / Line 41: @@
 ==The concept element==
 This element contains the following attributes and elements. They are all taken from the concept as it occurs in the dataset, from the attributes which are added in the transaction or from elsewhere where indicated below. If a concept is inherited, all the attributes are completed from the inherited-from concept. History of concepts is omitted. Multi-lingual artefacts (name, desc) are filtered for one language (so there will be only one name child element).
-{| class="artdecor"
+{| class="artdecorwiki"
 ! Child !! From !! Description
 |-
@@ Line 74: / Line 74: @@
 ==The implementation element==
 This element contains the following attributes and elements.
-{| class="artdecor"
+{| class="artdecorwiki"
 ! Child !! Description
 |-
@@ Line 89: / Line 89: @@
 The conceptList will contain the child concepts from the valueSet, with the following additional information:
-{| class="artdecor"
+{| class="artdecorwiki"
 ! Child !! Description
 |-

@@ Line 35: / Line 35: @@
 |}
-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.
+If a 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. Below this will come concept children.

@@ Line 8: / Line 8: @@
 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
+* language (optional, default is the project's default language)
 * format ('xml' or 'html')
 * version (to retrieve a frozen release)

@@ Line 2: / Line 2: @@
 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).
 [[File:RT.png||Retrieve Transaction]]
 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:

@@ Line 3: / Line 3: @@
 [[File:RT.png||Retrieve Transaction]]
 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===
+==The query parameters==
 Retrieve Transaction will accept the following query parameters:
 * id (of either a transaction or a dataset)

@@ Line 12: / Line 12: @@
 * unfiltered (to influence the HTML display)
-===The dataset element===
+==The dataset element==
 This element contains the following attributes:
 {| class="artdecor"
@@ Line 37: / Line 37: @@
 The dataset element will contain name and desc elements from the original transaction or dataset. Below this will come concept children.
-===The concept element===
+==The concept element==
 This element contains the following attributes and elements. They are all taken from the concept as it occurs in the dataset, from the attributes which are added in the transaction or from elsewhere where indicated below. If a concept is inherited, all the attributes are completed from the inherited-from concept. History of concepts is omitted. Multi-lingual artefacts (name, desc) are filtered for one language (so there will be only one name child element).
 {| class="artdecor"
@@ Line 70: / Line 70: @@
 | valueSet || N.A. || See below
 |}
-===The implementation element===
+==The implementation element==
 This element contains the following attributes and elements.
 {| class="artdecor"
@@ Line 83: / Line 83: @@
 | templateLocation || The attributes (id, effectiveDate etc.) of the template that this concept matches onto, if any.
 |}
-===The valueSet element===
+==The valueSet element==
 Concepts of valueDomain type 'code' will have a valueSet element if a valueSet is associated. The valueSet element will contain all the attributes of the valueSet, and as children the terminologyAssociation used to find the valueSet, and the conceptList.

@@ Line 29: / Line 29: @@
 | @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. |}
+| @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.
 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.

@@ Line 90: / Line 90: @@
 |-
 | @localId || A unique sequential number. Thew number is not (and cannot be) maintained between releases. However, since code + codeSystem is cumbersome to in for instance an option/@value in an HTML select tag, localId is generated for such purposes. Only use there; in a database localId should never be used, use code and codeSystem there instead.
 | name || If this concept in the valueSet conceptList is mapped onto a concept in the valueDomain conceptList with a translation for the language under scope, a name child is generated with this name and an @language attribute. If no name is found, a name child is generated with the displayName and no @language attribute.