AQL Result Set work area

• Ocean (XML, see Ocean Informatics EHR Service Interface#DataStructures)

• Marand (JSON, see below)

• DIPS  (JSON, see below)

• All the LiU-EEE-specific schemas are at https://github.com/LiU-IMT/EEE/tree/master/src/main/xsd

  • Our experimental result format for queries of XML data (originally intended for openEHR AQL queries) in that directory is at https://github.com/LiU-IMT/EEE/blob/master/src/main/xsd/xml-result-v1.xsd It was inspired by SPARQL's result set at http://www.w3.org/TR/rdf-sparql-XMLres/

  • ...but agreeing on a JSON-format is probably more urgent than for XML.

  • The JSON format for SPARQL might be a useful input for thought though, see  http://www.w3.org/TR/2013/REC-sparql11-results-json-20130321/ The "head" and "bindings" stuff using vairables from the query might be interesting. The SPARQL response looks a bit more like the Marand than the DIPS version. I am not sure that using terms like "rows" and "columns" (like in the DIPS-version) is the best for tree-shaped NoSQL data (even though they are logically some kind of rows).

•  Archie (has RM serialization in JSON & XML)

• Code24 (see below)

• CaboLabs (see below)

There is some meta-data at the beginning:

• href: href of the call

• aql: the AQL client sent

• executedAql: AQL the server executed - this will have potential parameters replaced
  
  
  

Resultset is a simple array of rows with one object per column. Columns names are taken from AQL select aliases, if none is present then just 0-based column index prefixed by a hash-sign (#) is used instead, i.e.: #0 for first column, etc.

JSON format used here for the RM is also used for other operations. Here is an example where we select an Observation rather than simple DATA_VALUEs:

Attribute names are snake-case (like defined in MagicDraw). We also add attribute @class to every object to define the exact class used for the object. Class names are all upper case and also snake-case. 

DIPS Arena EHR ResultSet

Below it the resultset from DIPS Arena EHR Server. The query used is the same as in the Marand example above. 

Arena EHR Server supports both JSON and XML on the query resource. The JSON is shown below and a XML examples is here: Arena EHR Server API

Archie can serialize RM Objects to XML using the standard openEHR RM XSD, or it can be used to serialize to JSON. The format we have now is very similar that the one Marand uses: snake_cased attribute names, type names as the same notation as the RM specs.

The code to serialize to this format or parse it to RM Objects is present in Archie starting from version 0.2.1

Code24 

Code24 does not have yet implemented AQL, but most probably it will be ready in Q3/Q4 2016. Intention is to follow the same JSON as Marand's example above. The current RESTApi that we have at this time is published at http://rest.base24.nl/docs

CaboLabs

We do XML to JSON automatically. Our result sets have different forms, one oriented to COMPOSITIONS one oriented to DATATYPES.

COMPOSITIONS

DATATYPES (the result set can be not grouped, grouped by path (good for charting), grouped by composition (good for table display))

Open

Open