diff based on rerendered BMM (json) extracted from UML

docs/UML/classes/org.openehr.rm.common.archetyped.adoc

@@ -6,7 +6,7 @@ h|*Class*
 2+^h|*ARCHETYPED*
 
 h|*Description*
-2+a|Archetypes act as the configuration basis for the particular structures of instances defined by the reference model. To enable archetypes to be used to create valid data, key classes in the reference model act as  root  points for archetyping; accordingly, these classes have the `_archetype_details_` attribute set.
+2+a|Archetypes act as the configuration basis for the particular structures of instances defined by the reference model. To enable archetypes to be used to create valid data, key classes in the reference model act as  root  points for archetyping; accordingly, these classes have the `_archetype_details_` attribute set. 
 
 An instance of the class `ARCHETYPED` contains the relevant archetype identification information, allowing generating archetypes to be matched up with data instances.
 

docs/UML/classes/org.openehr.rm.common.attestation.adoc

@@ -8,8 +8,8 @@ h|*Class*
 h|*Description*
 2+a|Record an attestation of a party (the committer) to item(s) of record content. An attestation is an explicit signing by one healthcare agent of particular content for various particular purposes, including:
 
-* for authorisation of a controlled substance or procedure (e.g. sectioning of patient under mental health act);
-* witnessing of content by senior clinical professional;
+* for authorisation of a controlled substance or procedure (e.g. sectioning of patient under mental health act); 
+* witnessing of content by senior clinical professional; 
 * indicating acknowledgement of content by intended recipient, e.g. GP who ordered a test result.
 
 h|*Inherit*

docs/UML/classes/org.openehr.rm.common.authored_resource.adoc

@@ -31,6 +31,7 @@ a|Description and lifecycle information of the resource.
 h|*0..1*
 |*revision_history*: `<<_revision_history_class,REVISION_HISTORY>>`
 a|The revision history of the resource. Only required if `_is_controlled_ = True` (avoids large revision histories for informal or private editing situations).
+
 h|*Functions*
 ^h|*Signature*
 ^h|*Meaning*

docs/UML/classes/org.openehr.rm.common.imported_version.adoc

@@ -18,6 +18,7 @@ h|*Attributes*
 h|*1..1*
 |*item*: `<<_original_version_class,ORIGINAL_VERSION>>`
 a|The `ORIGINAL_VERSION` object that was imported.
+
 h|*Functions*
 ^h|*Signature*
 ^h|*Meaning*

docs/UML/classes/org.openehr.rm.common.link.adoc

@@ -8,7 +8,7 @@ h|*Class*
 h|*Description*
 2+a|The `LINK` type defines a logical relationship between two items, such as two `ENTRYs` or an `ENTRY` and a `COMPOSITION`. Links can be used across compositions, and across EHRs. Links can potentially be used between interior (i.e. non archetype root) nodes, although this probably should be prevented in archetypes. Multiple `LINKs` can be attached to the root object of any archetyped structure to give the effect of a 1->N link.
 
-1:1 and 1:N relationships between archetyped content elements (e.g. `ENTRYs`) can be expressed by using one, or more than one, respectively, `LINKs`. Chains of links can be used to see  problem threads  or other logical groupings of items.
+1:1 and 1:N relationships between archetyped content elements (e.g. `ENTRYs`) can be expressed by using one, or more than one, respectively, `LINKs`. Chains of links can be used to see  problem threads  or other logical groupings of items. 
 
 Links should be between archetyped structures only, i.e. between objects representing complete domain concepts because relationships between sub-elements of whole concepts are not necessarily meaningful, and may be downright confusing. Sensible links only exist between whole `ENTRYs`, `SECTIONs`, `COMPOSITIONs` and so on.
 

docs/UML/classes/org.openehr.rm.common.locatable.adoc

@@ -21,7 +21,7 @@ a|Runtime name of this fragment, used to build runtime paths. This is the term p
 
 h|*1..1*
 |*archetype_node_id*: `link:/releases/BASE/{base_release}/foundation_types.html#_string_class[String^]`
-a|Design-time archetype identifier of this node taken from its generating archetype; used to build archetype paths. Always in the form of an at-code, e.g.  `at0005`. This value enables a 'standardised' name for this node to be generated, by referring to the generating archetype local terminology.
+a|Design-time archetype identifier of this node taken from its generating archetype; used to build archetype paths. Always in the form of an at-code, e.g.  `at0005`. This value enables a 'standardised' name for this node to be generated, by referring to the generating archetype local terminology. 
 
 At an archetype root point, the value of this attribute is always the stringified form of the `_archetype_id_` found in the `_archetype_details_` object.
 
@@ -40,6 +40,7 @@ a|Details of archetyping used on this node.
 h|*0..1*
 |*feeder_audit*: `<<_feeder_audit_class,FEEDER_AUDIT>>`
 a|Audit trail from non-openEHR system of original commit of information forming the content of this node, or from a conversion gateway which has synthesised this node.
+
 h|*Functions*
 ^h|*Signature*
 ^h|*Meaning*

docs/UML/classes/org.openehr.rm.common.original_version.adoc

@@ -38,6 +38,7 @@ a|Set of attestations relating to this version.
 h|*0..1*
 |*data*: `T`
 a|Data content of this Version.
+
 h|*Functions*
 ^h|*Signature*
 ^h|*Meaning*

docs/UML/classes/org.openehr.rm.common.participation.adoc

@@ -6,7 +6,7 @@ h|*Class*
 2+^h|*PARTICIPATION*
 
 h|*Description*
-2+a|Model of a participation of a Party (any Actor or Role) in an activity.  Used to represent any participation of a Party in some activity, which is not  explicitly in the model, e.g. assisting nurse. Can be used to record past or  future participations.
+2+a|Model of a participation of a Party (any Actor or Role) in an activity.  Used to represent any participation of a Party in some activity, which is not  explicitly in the model, e.g. assisting nurse. Can be used to record past or  future participations. 
 
 Should not be used in place of more permanent relationships between demographic entities.
 

docs/UML/classes/org.openehr.rm.common.party_identified.adoc

@@ -8,7 +8,7 @@ h|*Class*
 h|*Description*
 2+a|Proxy data for an identified party other than the subject of the record, minimally consisting of human-readable identifier(s), such as name, formal (and possibly computable) identifiers such as NHS number, and an optional link to external data. There must be at least one of name, identifier or external_ref present.
 
-Used to describe parties where only identifiers may be known, and there is no entry at all in the demographic system (or even no demographic system). Typically for health care providers, e.g. name and provider number of an institution.
+Used to describe parties where only identifiers may be known, and there is no entry at all in the demographic system (or even no demographic system). Typically for health care providers, e.g. name and provider number of an institution. 
 
 Should not be used to include patient identifying information.
 

docs/UML/classes/org.openehr.rm.common.resource_description.adoc

@@ -13,7 +13,7 @@ h|*Attributes*
 ^h|*Meaning*
 
 h|*1..1*
-|*original_author*: `link:/releases/BASE/{base_release}/foundation_types.html#_hash_class[Hash^]<link:/releases/BASE/{base_release}/foundation_types.html#_string_class[String^], link:/releases/BASE/{base_release}/foundation_types.html#_string_class[String^]>`
+|*original_author*: `link:/releases/BASE/{base_release}/foundation_types.html#_hash_class[Hash^]<link:/releases/BASE/{base_release}/foundation_types.html#_string_class[String^],link:/releases/BASE/{base_release}/foundation_types.html#_string_class[String^]>`
 a|Original author of this resource, with all relevant details, including organisation.
 
 h|*0..1*
@@ -29,7 +29,7 @@ h|*0..1*
 a|URI of package to which this resource belongs.
 
 h|*0..1*
-|*other_details*: `link:/releases/BASE/{base_release}/foundation_types.html#_hash_class[Hash^]<link:/releases/BASE/{base_release}/foundation_types.html#_string_class[String^], link:/releases/BASE/{base_release}/foundation_types.html#_string_class[String^]>`
+|*other_details*: `link:/releases/BASE/{base_release}/foundation_types.html#_hash_class[Hash^]<link:/releases/BASE/{base_release}/foundation_types.html#_string_class[String^],link:/releases/BASE/{base_release}/foundation_types.html#_string_class[String^]>`
 a|Additional non language-senstive resource meta-data, as a list of name/value pairs.
 
 h|*1..1*

docs/UML/classes/org.openehr.rm.common.resource_description_item.adoc

@@ -37,11 +37,11 @@ h|*0..1*
 a|Optional copyright statement for the resource as a knowledge resource.
 
 h|*0..1*
-|*original_resource_uri*: `link:/releases/BASE/{base_release}/foundation_types.html#_hash_class[Hash^]<link:/releases/BASE/{base_release}/foundation_types.html#_string_class[String^], link:/releases/BASE/{base_release}/foundation_types.html#_string_class[String^]>`
+|*original_resource_uri*: `link:/releases/BASE/{base_release}/foundation_types.html#_hash_class[Hash^]<link:/releases/BASE/{base_release}/foundation_types.html#_string_class[String^],link:/releases/BASE/{base_release}/foundation_types.html#_string_class[String^]>`
 a|URIs of original clinical document(s) or description of which resource is a formalisation, in the language of this description item; keyed by meaning.
 
 h|*0..1*
-|*other_details*: `link:/releases/BASE/{base_release}/foundation_types.html#_hash_class[Hash^]<link:/releases/BASE/{base_release}/foundation_types.html#_string_class[String^], link:/releases/BASE/{base_release}/foundation_types.html#_string_class[String^]>`
+|*other_details*: `link:/releases/BASE/{base_release}/foundation_types.html#_hash_class[Hash^]<link:/releases/BASE/{base_release}/foundation_types.html#_string_class[String^],link:/releases/BASE/{base_release}/foundation_types.html#_string_class[String^]>`
 a|Additional language-senstive resource metadata, as a list of name/value pairs.
 
 h|*Invariants*

docs/UML/classes/org.openehr.rm.common.revision_history.adoc

@@ -15,6 +15,7 @@ h|*Attributes*
 h|*1..1*
 |*items*: `link:/releases/BASE/{base_release}/foundation_types.html#_list_class[List^]<<<_revision_history_item_class,REVISION_HISTORY_ITEM>>>`
 a|The items in this history in most-recent-last order.
+
 h|*Functions*
 ^h|*Signature*
 ^h|*Meaning*

docs/UML/classes/org.openehr.rm.common.revision_history_item.adoc

@@ -19,4 +19,7 @@ a|Version identifier for this revision.
 h|*1..1*
 |*audits*: `link:/releases/BASE/{base_release}/foundation_types.html#_list_class[List^]<<<_audit_details_class,AUDIT_DETAILS>>>`
 a|The audits for this revision; there will always be at least one commit audit (which may itself be an `ATTESTATION`), there may also be further attestations.
+
+h|*Invariants*
+2+a|__Audit_valid__: `not audits.is_empty`
 |===

docs/UML/classes/org.openehr.rm.common.translation_details.adoc

@@ -17,15 +17,15 @@ h|*1..1*
 a|Language of the translation.
 
 h|*1..1*
-|*author*: `link:/releases/BASE/{base_release}/foundation_types.html#_hash_class[Hash^]<link:/releases/BASE/{base_release}/foundation_types.html#_string_class[String^], link:/releases/BASE/{base_release}/foundation_types.html#_string_class[String^]>`
+|*author*: `link:/releases/BASE/{base_release}/foundation_types.html#_hash_class[Hash^]<link:/releases/BASE/{base_release}/foundation_types.html#_string_class[String^],link:/releases/BASE/{base_release}/foundation_types.html#_string_class[String^]>`
 a|Translator name and other demographic details.
 
 h|*0..1*
 |*accreditaton*: `link:/releases/BASE/{base_release}/foundation_types.html#_string_class[String^]`
 a|Accreditation of translator, usually a national translator's registration or association membership id.
 
 h|*0..1*
-|*other_details*: `link:/releases/BASE/{base_release}/foundation_types.html#_hash_class[Hash^]<link:/releases/BASE/{base_release}/foundation_types.html#_string_class[String^], link:/releases/BASE/{base_release}/foundation_types.html#_string_class[String^]>`
+|*other_details*: `link:/releases/BASE/{base_release}/foundation_types.html#_hash_class[Hash^]<link:/releases/BASE/{base_release}/foundation_types.html#_string_class[String^],link:/releases/BASE/{base_release}/foundation_types.html#_string_class[String^]>`
 a|Any other meta-data.
 
 h|*Invariants*

docs/UML/classes/org.openehr.rm.common.version.adoc

@@ -23,6 +23,7 @@ a|OpenPGP digital signature or digest of content committed in this Version.
 h|*1..1*
 |*commit_audit*: `<<_audit_details_class,AUDIT_DETAILS>>`
 a|Audit trail corresponding to the committal of this version to the `VERSIONED_OBJECT`.
+
 h|*Functions*
 ^h|*Signature*
 ^h|*Meaning*
@@ -41,7 +42,6 @@ h|*1..1 +
 (abstract)*
 |*data* (): `T`
 a|The data of this Version.
-Original content of this Version.
 
 h|*1..1 +
 (abstract)*
@@ -51,8 +51,6 @@ a|Lifecycle state of this version; coded by openEHR vocabulary `version lifecycl
 h|*1..1*
 |*canonical_form* (): `link:/releases/BASE/{base_release}/foundation_types.html#_string_class[String^]`
 a|A canonical serial form of this Version, suitable for generating reliable hashes and signatures.
-Canonical form of Version object, created by serialising all attributes except
-signature.
 
 h|*1..1*
 |*owner_id* (): `link:/releases/BASE/{base_release}/base_types.html#_hier_object_id_class[HIER_OBJECT_ID^]` +
@@ -65,6 +63,9 @@ h|*1..1*
 a|True if this Version represents a branch. Derived from `_uid_` attribute.
 
 h|*Invariants*
+2+a|__Owner_id_valid__: `owner_id.value.is_equal (uid.object_id.value)`
+
+h|
 2+a|__Preceding_version_uid_validity__: `uid.version_tree_id.is_first xor preceding_version_uid /= Void`
 
 h|

docs/UML/classes/org.openehr.rm.common.versioned_object.adoc

@@ -23,6 +23,7 @@ a|Reference to object to which this version container belongs, e.g. the id of th
 h|*1..1*
 |*time_created*: `link:/releases/RM/{rm_release}/data_types.html#_dv_date_time_class[DV_DATE_TIME^]`
 a|Time of initial creation of this versioned object.
+
 h|*Functions*
 ^h|*Signature*
 ^h|*Meaning*
@@ -36,7 +37,7 @@ h|*1..1*
 a|Return a list of ids of all versions in this object.
 
 h|*1..1*
-|*all_versions* (): `link:/releases/BASE/{base_release}/foundation_types.html#_list_class[List^]<<<_version_class,VERSION>>>`
+|*all_versions* (): `link:/releases/BASE/{base_release}/foundation_types.html#_list_class[List^]<<<_version_class,VERSION>><T>>`
 a|Return a list of all versions in this object.
 
 h|*1..1*
@@ -102,7 +103,7 @@ an_audit: `<<_audit_details_class,AUDIT_DETAILS>>[1]`, +
 a_lifecycle_state: `link:/releases/RM/{rm_release}/data_types.html#_dv_coded_text_class[DV_CODED_TEXT^][1]`, +
 a_data: `T[1]`, +
 signing_key: `link:/releases/BASE/{base_release}/foundation_types.html#_string_class[String^][1]` +
-): `void` +
+): `link:/classes/void[void] ` +
  +
 __Pre__: `all_version_ids.has (a_preceding_version_uid) or else version_count = 0`
 a|Add a new original version.
@@ -117,7 +118,7 @@ a_lifecycle_state: `link:/releases/RM/{rm_release}/data_types.html#_dv_coded_tex
 a_data: `T[1]`, +
 an_other_input_uids: `link:/releases/BASE/{base_release}/foundation_types.html#_list_class[List^]<link:/releases/BASE/{base_release}/base_types.html#_object_version_id_class[OBJECT_VERSION_ID^]>[1]`, +
 signing_key: `link:/releases/BASE/{base_release}/foundation_types.html#_string_class[String^][1]` +
-): `void` +
+): `link:/classes/void[void] ` +
  +
 __Pre__: `all_version_ids.has (a_preceding_version_uid) or else version_count = 0`
 a|Add a new original merged version. This commit function adds a parameter containing the ids of other versions merged into the current one.
@@ -127,15 +128,15 @@ h|*1..1*
 a_contribution: `link:/releases/BASE/{base_release}/base_types.html#_object_ref_class[OBJECT_REF^][1]`, +
 an_audit: `<<_audit_details_class,AUDIT_DETAILS>>[1]`, +
 a_version: `<<_original_version_class,ORIGINAL_VERSION>>[1]` +
-): `void`
+): `link:/classes/void[void] `
 a|Add a new imported version. Details of version id etc come from the `ORIGINAL_VERSION` being committed.
 
 h|*1..1*
 |*commit_attestation* ( +
 an_attestation: `<<_attestation_class,ATTESTATION>>[1]`, +
 a_ver_id: `link:/releases/BASE/{base_release}/base_types.html#_object_version_id_class[OBJECT_VERSION_ID^][1]`, +
 signing_key: `link:/releases/BASE/{base_release}/foundation_types.html#_string_class[String^][1]` +
-): `void` +
+): `link:/classes/void[void] ` +
  +
 __Pre__: `has_version_id(a_ver_id)
 and is_original_version(a_ver_id)`

docs/UML/classes/org.openehr.rm.composition.activity.adoc

@@ -26,9 +26,9 @@ May be omitted if:
 
 h|*1..1*
 |*action_archetype_id*: `link:/releases/BASE/{base_release}/foundation_types.html#_string_class[String^]`
-a|Perl-compliant regular expression pattern, enclosed in  '//' delimiters, indicating the valid identifiers of archetypes for Actions corresponding to this Activity specification.
+a|Perl-compliant regular expression pattern, enclosed in  '//' delimiters, indicating the valid identifiers of archetypes for Actions corresponding to this Activity specification. 
 
-Defaults to  `/.*/`, meaning any archetype.
+Defaults to  `/.*/`, meaning any archetype.
 
 h|*1..1*
 |*description*: `link:/releases/RM/{rm_release}/data_structures.html#_item_structure_class[ITEM_STRUCTURE^]`

docs/UML/classes/org.openehr.rm.composition.admin_entry.adoc

@@ -8,7 +8,7 @@ h|*Class*
 h|*Description*
 2+a|Entry subtype for administrative information, i.e. information about setting up the clinical process, but not itself clinically relevant. Archetypes will define contained information.
 
-Used for administrative details of admission, episode, ward location, discharge, appointment (if not stored in a practice management or appointments system).
+Used for administrative details of admission, episode, ward location, discharge, appointment (if not stored in a practice management or appointments system). 
 
 Not to be used for any clinically significant information.
 
@@ -22,5 +22,4 @@ h|*Attributes*
 h|*1..1*
 |*data*: `link:/releases/RM/{rm_release}/data_structures.html#_item_structure_class[ITEM_STRUCTURE^]`
 a|Content of the Admin Entry.
-The data of the Entry; modelled in archetypes.
 |===

docs/UML/classes/org.openehr.rm.composition.composition.adoc

@@ -28,7 +28,7 @@ a|Name of territory in which this Composition was written. Coded from openEHR  c
 
 h|*1..1*
 |*category*: `link:/releases/RM/{rm_release}/data_types.html#_dv_coded_text_class[DV_CODED_TEXT^]`
-a|Temporal category of this Composition, i.e.
+a|Temporal category of this Composition, i.e. 
 
 * `431|persistent|` - of potential life-time validity;
 * `451|episodic|` - valid over the life of a care episode;
@@ -47,6 +47,7 @@ a|The person primarily responsible for the content of the Composition (but not n
 h|*0..1*
 |*content*: `link:/releases/BASE/{base_release}/foundation_types.html#_list_class[List^]<<<_content_item_class,CONTENT_ITEM>>>`
 a|The content of this Composition.
+
 h|*Functions*
 ^h|*Signature*
 ^h|*Meaning*
@@ -58,6 +59,9 @@ a|True if category is `431&#124;persistent&#124;`, False otherwise. Useful for f
 h|*Invariants*
 2+a|__Category_validity__: `terminology (Terminology_id_openehr).has_code_for_group_id (Group_id_composition_category, category.defining_code)`
 
+h|
+2+a|__Is_persistent_validity__: `is_persistent implies context = Void`
+
 h|
 2+a|__Territory_valid__: `code_set(Code_set_id_countries).has_code(territory)`
 

docs/UML/classes/org.openehr.rm.composition.entry.adoc

@@ -35,23 +35,24 @@ a|Identifier of externally held workflow engine data for this workflow execution
 
 h|*1..1*
 |*subject*: `link:/releases/RM/{rm_release}/common.html#_party_proxy_class[PARTY_PROXY^]`
-a|Id of human subject of this `ENTRY`, e.g.:
+a|Id of human subject of this `ENTRY`, e.g.: 
 
-* organ donor
-* foetus
-* a family member
+* organ donor 
+* foetus 
+* a family member 
 * another clinically relevant person.
 
 h|*0..1*
 |*provider*: `link:/releases/RM/{rm_release}/common.html#_party_proxy_class[PARTY_PROXY^]`
-a|Optional identification of provider of the information in this `ENTRY`, which might be:
+a|Optional identification of provider of the information in this `ENTRY`, which might be: 
 
-* the patient
-* a patient agent, e.g. parent, guardian
-* the clinician
-* a device or software
+* the patient 
+* a patient agent, e.g. parent, guardian 
+* the clinician 
+* a device or software 
 
 Generally only used when the recorder needs to make it explicit. Otherwise, Composition composer and other participants are assumed.
+
 h|*Functions*
 ^h|*Signature*
 ^h|*Meaning*

docs/UML/classes/org.openehr.rm.composition.evaluation.adoc

@@ -6,7 +6,7 @@ h|*Class*
 2+^h|*EVALUATION*
 
 h|*Description*
-2+a|Entry type for evaluation statements. Used for all kinds of statements which evaluate other information, such as interpretations of observations, diagnoses, differential diagnoses, hypotheses, risk assessments, goals and plans.
+2+a|Entry type for evaluation statements. Used for all kinds of statements which evaluate other information, such as interpretations of observations, diagnoses, differential diagnoses, hypotheses, risk assessments, goals and plans. 
 
 Should not be used for actionable statements such as medication orders - these are represented using the `INSTRUCTION` type.