serialization syntax of openEHR instance data

Technical (archive)
1

Hello,
Is there a documentation of the syntax how openEHR EHR data is serialized ? I would be interested in a concrete example of an EHR-API-GET-call and the returned String in XML or JSON which can be used as transfer medium between applications or as a storage format. It would be beneficial if the example EHR would contain some commonly used archetypes and some usual demographics data.
I have taken a look at https://openehr.github.io/specifications-ITS-REST/ehr.html and at the "EHR Extract Information Model" but I haven't found something that satified me in this matter.
Greeting
Georg

2

You may want to look at the XSDs here on Github and JSON schemas (emerging) here.

3

Adding to Thomas comments,

  1. Yes, XML XSDs should be the source of truth here
  2. You can use the openEHR Toolkit to generate instances in XML from an OPT http://server001.cloudehrserver.com/cot/

That helps testing and verifying formats.

4

The question asked by George Fette is that he wants to see an example of an OpenEhr dataset in XML or JSON containing demographics and commonly used archetypes.

Best regards
Bert

---- Pablo Pazos wrote ----

Adding to Thomas comments,

  1. Yes, XML XSDs should be the source of truth here
  2. You can use the openEHR Toolkit to generate instances in XML from an OPT http://server001.cloudehrserver.com/cot/

That helps testing and verifying formats.

5

Dear Georg, my answer is a bit cumbersome, sorry for that, but it is the best I can give with not too much effort.

Go to one of the Marand websites, there is (at least it was, a few years ago, last time I looked) their API published in a kind of Open API format, which gives you opportunity to experiment with the API and thus also see the JSON datasets.

Best regard
Bert

---- Bert Verhees wrote ----

The question asked by George Fette is that he wants to see an example of an OpenEhr dataset in XML or JSON containing demographics and commonly used archetypes.

Best regards
Bert

---- Pablo Pazos wrote ----

Adding to Thomas comments,

  1. Yes, XML XSDs should be the source of truth here
  2. You can use the openEHR Toolkit to generate instances in XML from an OPT http://server001.cloudehrserver.com/cot/

That helps testing and verifying formats.

6

Hello,
Thank you all. The .xsds are already very useful. And the Toolkit also looks beneficial for what I want to do.
Greetings
Georg

7

The toolkit is great, very impressive work.

Also, I found the API-exporer from Marand in which you can test and look at API's

https://www.ehrscape.com/api-explorer.html

Both sides together should give you enough tooling about how OpenEhr is supposed to work in the technical details.

Bert

8

Please let me know if you find any issues when using it: https://github.com/ppazos/openEHR-OPT/issues