openEHR / specifications-ITS-JSON

JSON-Schema Specifications
Apache License 2.0
8 stars 5 forks source link

Replace the RM Json Schemas with ones generated from BMM #9

Closed pieterbos closed 3 years ago

pieterbos commented 3 years ago

Created using the code in https://github.com/openEHR/archie/pull/313

the RM version 1.0.3, 1.0.4 and 1.1.0 is included in this pull request. For each I added is a single-file version, the openehr_rm_1.1.0_all.json, plus one split up in multiple packages, just as the BMM files are organised.

There are some choices left to make, so leaving this as a Draft PR:

Creating this, I encountered the following two small issues:

I will fix them soon, but I did not want to postpone creating this, to discuss whether this is the right approach, or whether things will need to be changed.

And of course descriptions are still missing. As soon as the BMM files contain the documentation, this can be regenerated with descriptions in place.

sebastian-iancu commented 3 years ago

As a suggestion, can you rename files/folder to follow the pattern: components/{component}/{release}/{package}/{file.json} or just components/{component}/{release}/{package.json}

e.g. components/RM/Release-1.1.0/Ehr/all.json or components/RM/Release-1.1.0/Ehr.json; components/RM/Release-1.1.0/Data_types/all.json or components/RM/Release-1.1.0/Data_types.json instead of components/RM/RM-1.1.0/openehr_rm_data_types_1.1.0.json

This will help future maintenance or additions of new files, plus is consistent with ITS-XML. On the other hand I see you made it compliant with ITS-BMM. components/RM/Release-1.1.0/openehr_rm_data_types_110.bmm

Which one you think is better (for present as well as future)?

sebastian-iancu commented 3 years ago

PR #10 was merged into master, this is not needed anymore