textual edits to readme #499
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
OpenEHR -> openEHR
and explain ADL2 abbreviation.
previous link was fixed to adl 2.2.0 release, which would require updating the link for every adl release. Which will probably be forgotten.
Old link was 404 due to changed url (removed /docs)
…rchie into joostholslag-readme-textual-edits
pieterbos
requested changes
May 11, 2023
There was a problem hiding this comment.
The changes to capital letters and explaining the ADL abbreviation looks good!
I am not sure we should change ADL 2 to ADL2. The specification uses both formats, see https://specifications.openehr.org/releases/AM/latest/ADL2.html .
And Operational Templates are not Operation Templates, see https://specifications.openehr.org/releases/AM/latest/OPT2.html, so I do not think that should be changed, although I think using the capital letters O and T consistently is a good change.
| Note that ADL 2 operational templates is fundamentally different from the ADL 1.4 OET/OPT format. What you used to achieve with OET/OPT is now built into ADL 2 as templates in combination with the operational template creation. See (the openEHR specification on templates)[http://openehr.org/releases/AM/latest/docs/ADL2/ADL2.html#_templates] on how to work with them. | ||
| You can create Operation Templates of your archetypes. Think of Operation Templates as something you generate from an archetype or template to more easily work with it. If you are creating an EHR implementation, these will likely be the most useful form of archetypes to work with. | ||
| openEHR Archetypes allow you to reuse structures inside your archetypes at several places. It also allows to embed other archetypes inside your archetype. Without Operation Templates, you would need to build support for these structures into all of your tools. Operational Templates fix this for you, by replacing the proxies for structure and embedded archetypes in the archetype with a copy of the actual embedded structure. For more information about Operation Templates, see (the documentation at the openEHR website)[https://specifications.openehr.org/releases/AM/latest/OPT2.html]. | ||
| Note that ADL 2 Operation Templates is fundamentally different from the ADL 1.4 OET/OPT format. What you used to achieve with OET/OPT is now built into ADL 2 as templates in combination with the Operational Template creation. See (the openEHR specification on templates)[http://openehr.org/releases/AM/latest/docs/ADL2/ADL2.html#_templates] on how to work with them. |
There was a problem hiding this comment.
This should be Operational Template, not Operation Template, see https://specifications.openehr.org/releases/AM/latest/OPT2.html
| @@ -452,7 +452,7 @@ The following features are experimental. This means its working or API will like | |||
|
|
|||
| ## Importing and converting ADL 1.4 files | |||
|
|
|||
| Starting from version 0.7, Archie can import ADL 1.4 files, and convert them to ADL 2. To do so, do the following: | |||
| Starting from version 0.7, Archie can import ADL 1.4 files, and convert them to ADL2. To do so, do the following: | |||
There was a problem hiding this comment.
ADL 2 has a space between ADL and 2
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.