Versionering för openEHR-arketyper
Innehållsförteckning
Versionshistorik
Version | Datum | Beskrivning | Ansvarig |
1.0 | 2024-05-28 | Publicerat första version. Efter beslut om att använda samma versionering för arketyper fram till version 1.0.0 som för templates | openEHR Sverige |
1.1 | 2026-09-15 | Utvidgning av version 1.0 för att inkludera en guide om hur versionering görs i Archetype Designer. | openEHR Sverige |
1 Syfte
Syftet med detta dokument är att dokumentera hur vi i openEHR Sverige vill jobba med versionering för openEHR-arketyper fram till version 1.0, för att:
underlätta och effektivisera arbetet med arketyper
ha ett underlag att ta vidare till olika forum för att jobba för gemensamma överenskommelser kring detta.
2 Flöde
Flödet beskriver versionering av en arketyp fram till version 1.0.0. Versionering av en arketyp från och med version 1.0.0 ska följa internationella riktlinjer för arketypversioneringen.
2.1 Hög-nivå-översikt
Använd flödet Alpha-version → RC-version → Publicerad version, iterativt för varje ny arketyp som ska utvecklas.
2.2 Detaljerad beskrivning – flöde för versioner (Alpha-version → RC-version → Publicerad version)
2.2.1 Alpha-version: preliminär (pre-release) arketyp-version
En ny arketyp börjar som en preliminär arketyp-version och namnges då med alpha-suffix, dvs. t.ex. 1.0.0-alpha för en första preliminär version som senare ska publiceras som version 1.0.0. Arketypen stegas inom alpha-versionen med ett nummer-suffix (dvs. till 1.0.0-alpha.2 etc.) tills att man har en version som är tillräckligt stabil för att kunna vara en release candidate (se nedan). Ändringar som leder till en stegning inom alpha-versionen kan vara allt från enkla rättningar av stavfel till icke bakåt-kompatibla ändringar.
Det går även bra att börja på major-version 0, dvs. på version 0.x.y, så länge man endast arbetar i Archetype Designer.
2.2.2 RC-version: Release Candidate av arketyp-version
När man har en release candidate, dvs. man tror att man har en version som är tillräckligt stabil för att kunna börja användas kliniskt så skapar man en rc-version, t.ex. 1.0.0-rc.1. Sedan testar man denna i testmiljö och utvärderar, och justerar vid behov till ytterligare rc-versioner.
2.2.3 Publicerad version
När RC-versionen är verifierad och redo för release skapas en 1.0.0 version av arketypen.
3 Lathund för versionering i Archetype Designer
För att spara en ny version av en arketyp i Archetype Designer så får användaren navigera till “Tabbed” → “Attribution” i arbetsvyn för arketypen. Här rekommenderas följande åtgärder:
Generera om build_uid:
Vid en ny version bör Build Uid genereras på nytt. Detta görs genom att klicka på knappen som är inringad på bilden nedan.
Stega upp revisionen:
För att ändra versionen på arketypen så klickar användaren på nuvarande version på raden “revision” och skriver manuellt om till en uppstegad version.
Skriv gärna en rad om vad du ändrat, och gärna på engelska: