Versioning of archetypes using the Archetype Editor

Hi!

I’m trying to learn how to use the Archetype Editor software and there is one thing I just can’t understand – and I haven’t found any description of this in the documentation (yet):

How does versioning of archetypes work in the Archetype Editor?

An example: The archetype openEHR-EHR-OBSERVATION.body_weight.v1.adl is in versjon 1 according to the “v1” ending. If I open it in the Archetype Editor, change it and save it, it still has the ending v1; what should I have done to make it “v2”? Isn’t this supposed used to keep a history of changes to the archetype?

I’ve tried to change the description details authorship lifecycle, but this didn’t change anything. Or maybe I’ve done something “wrong”…

If there is any documentation on this that I’ve missed – please direct me to the right place to find it! J

Regards
Annette Lund Lillegaard

DIPS ASA
8037 BODØ
Mobil (+47) 975 89 115
http://www.dips.no

Denne meldingen er bare ment for mottakeren, og kan inneholde fortrolige opplysninger eller annen privat informasjon.
Hvis du mottar denne ved en feil, vær så vennlig å varsle avsender og slett meldingen.

Hi Annette,

You could select, file-> save as:

“openEHR-EHR-OBSERVATION.body_weight.v2.adl”

Then the archetype editor should produce a pop up window to warn that:

“The Archetype Id and the Archetype file name must be the same!”

At this point you can select that last option that should state:

“Use Archetype file name” openEHR-EHR-OBSERVATION.body_weight.v2

Hope this helps.

Regards
John

John George
Interoperability Developer
Data Standards and Products
NHS Connecting for Health
2nd Floor Princes Exchange Princes Square LEEDS LS1 4HY

Tel: 0113 397 4193
Mobile: 07917228247
www.cfh.nhs.uk

Hi Annette,

In addition to John’s response, please keep in mind that not every change to an archetype will require a new version of an archetype.

Many changes are just compatible revisions which do not require a new version at all.
Also as long as an archetype isn’t published and in use somewhere, there would be no point in increasing the version number even if it is a breaking (incompatible) change.

The Clinical Knowledge Manager would warn you if you upload an archetype that
a) has been published and
b) where the modified archetype is incompatible to the current latest archetype in CKM.

In this case, CKM would suggest to
a) (possibly) deprecate the v1 archetype
b) increase the version of the revised archetype to v2

In the archetype revision history you can always compare two revisions of an archetype to see the changes and the compatibility of two revisions

To document changes to each and every revision of an archetype - instead of frequently increasing the version number - the revision_history of the archetype could be used (although this is rarely done at the moment I believe)

Regards
Sebastian

One further addition: if you were not using CKM, you would use a normal version mechanism like Subversion, Mercurial etc, and track changes just as for a software file. The ‘version id’ in an archetype (perhaps badly named in hindsight) is not for tracking all changes done by authors, but for distinguishing certain kinds of change made to an archetype. It should only be incremented when a ‘breaking change’ is made (one that makes the archetype incompatible with existing data created with the previous version of the archetype) - effectively creating a new archetype.

  • thomas beale