search

ehrbase / documentation

Apache License 2.0
3 stars 11 forks source link

Feature/add flat documentation3 #39

Closed stefanspiska closed 2 years ago

wolandscat commented 2 years ago

@birgerhaarbrandt alerted me to this change...

Q1: I see things like conformance_section, conformance_observation etc - what does that mean?

Q2: Also, I see .../any_event/DV_QUANTITY/... what is the DV_QUANTITY in this case?

stefanspiska commented 2 years ago

@birgerhaarbrandt alerted me to this change...

Q1: I see things like conformance_section, conformance_observation etc - what does that mean?

Q2: Also, I see .../any_event/DV_QUANTITY/... what is the DV_QUANTITY in this case?

All example are bases on the template https://github.com/ehrbase/openEHR_SDK/blob/develop/test-data/src/main/resources/operationaltemplate/conformance_ehrbase.de.v0.opt

in which we named each rm object is named like its class

stefanspiska commented 2 years ago

Unbenannt

wolandscat commented 2 years ago

So in the above, a path like .../any_event/DV_QUANTITY/ is really a shortened version of .../events[id3]/data[id4]/items[id12]/value. I would expect to see something like .../any_event/items/weight, assuming id12 = weight. I don't think a path like .../any_event/DV_QUANTITY/ is any use - it appears to be derived from the tool visualisation, which is not quite the same as the shape of the data hierarchy.

stefanspiska commented 2 years ago

@wolandscat

see https://github.com/ehrbase/documentation/blob/feature/add_flat_documentation3/source/09_flat/00_description/index.rst

A Flat path is simply the id of the webtemplate nodes put together.

Where the Id of a Node in the webtemplate is the name of the opt node (normalized and made uniqe) where additional some node like (History and Element) form the opt are left out from the webtemplate.

That's the way it was defined by better and that the way the community is using it.

wolandscat commented 2 years ago

Well there we see paths like conformance-ehrbase.de.v0/conformance_section/conformance_observation/any_event:0/dv_quantity|magnitude - problem is we don't know what that means (could be weight, heart rate, or anything) - there can easily be more than one child of type DV_QUANTITY below any_event. So I can't see how this will work. I'll do some external checking...

Also, the idea for data types is the compact format - see here.

wolandscat commented 2 years ago

Ah - I see - it is some test template that has data type names for the leaf ELEMENTs. Very strange!