amendment-record

openEHR Specification Amendment Record Authoring

The amendment record tracks every change to an openEHR specification document. It appears as master00-amendment_record.adoc in each spec directory within the specifications-XX repositories (RM, AM, BASE, LANG, PROC, SM, QUERY, CNF, TERM, ITS-*) and is included in master.adoc after the front matter. The conventions here are specific to the openEHR specification ecosystem and its Jira-based change management process.

For detailed lookups — Jira project keys, CR/PR linking phrasing, release-boundary placement, multi-raiser formatting, multi-change grouping, and detail-text style — see references/conventions.md.

File Structure

= Amendment Record

[cols="1,6,2,2", options="header"]
|===
|Issue|Details|Raiser|Completed

|[[latest_issue]]N.N.N
|{Details of most recent change.}
|{Raiser name(s)}
|[[latest_issue_date]]dd Mon yyyy

|
|{Details of previous change.}
|{Raiser name(s)}
|dd Mon yyyy

4+^h|*XX Release N.N.N*

|N.N.N
|{Details of change in previous release.}
|{Raiser name(s)}
|dd Mon yyyy

|===

The four columns are Issue (version, only on the first entry of a group; blank for subsequent entries in the same version), Details (change description + Jira refs), Raiser (name(s)), and Completed (dd Mon yyyy).

Critical Rules

Anchors

Two anchors are mandatory and must appear on the first (most recent) entry:

• [[latest_issue]] — immediately before the issue version number
• [[latest_issue_date]] — immediately before the completion date

doc_id_block.adoc in the front matter references them to display the current revision and date. If missing or misplaced, the front matter shows incorrect information.

|[[latest_issue]]5.2.1
|{spec_tickets}/SPECRM-87[SPECRM-87^]: Support tags; ...
|S Iancu, +
B Naess
|[[latest_issue_date]]17 Nov 2022

Entry Order

Entries are most-recent-first. New entries go at the top of the table (immediately after the header row). Mark release boundaries with a full-width row — see references/conventions.md.