openehr-base 0.0.76

openEHR BASE foundation + base types, generated from BMM: generations v1_2 (BASE 1.2.0) and v1_3 (BASE 1.3.0, current)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

// @generated by openehr-codegen from BMM (`RESOURCE_ANNOTATIONS`) — DO NOT EDIT.
// SPDX-FileCopyrightText: Vernum Projecten B.V.
// SPDX-FileCopyrightText: openEHR Foundation
// SPDX-License-Identifier: Apache-2.0

//! The openEHR `RESOURCE_ANNOTATIONS` spec class, generated from the vendored BMM
//! meta-model.

/// Object representing annotations on an archetype.
///
/// These can be of various forms, with a documentation form defined so far, which has a multi-level tabular structure \[ \[ \[String value, String key\], path key\], language key\]. Example instance, showing the documentation structure.
///
/// --------
/// ```text
///     documentation = <
///         ["en"] = <
///            ["/data[id2]"] = <
///                ["ui"] = <"passthrough">
///            >
///            ["/data[id2]/items[id3]"] = <
///                ["design note"] = <"this is a design note on Statement">
///                ["requirements note"] = <"this is a requirements note on Statement">
///                ["medline ref"] = <"this is a medline ref on Statement">
///            >
///         >
///     >
/// ```
/// --------
///
/// Other sub-structures might have different keys, e.g.  based on programming languages, UI toolkits etc.
#[doc(alias = "RESOURCE_ANNOTATIONS")]
#[derive(Debug, Clone, PartialEq)]
pub struct ResourceAnnotations {
    /// Documentary annotations in a multi-level keyed structure.
    pub documentation: std::collections::BTreeMap<
        String,
        std::collections::BTreeMap<String, std::collections::BTreeMap<String, String>>,
    >,
}