openehr-sdt 0.0.128

openEHR Simplified Data Template formats (FLAT / STRUCTURED / Web Template), and template-independent RM-instance validation, hand-written over the openehr-its wire layer
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
40
41
42
43
44
45
46
47
48
49
50

// SPDX-FileCopyrightText: Cadasto B.V.
// SPDX-License-Identifier: BUSL-1.1

//! openEHR **Simplified Data Template** formats and the engines written over
#![allow(
    clippy::doc_markdown,
    reason = "module docs are prose with many proper nouns"
)]
//!
//! the ITS wire layer of `openehr_its`. Everything here is hand-written: the
//! specifications it implements are prose sub-specifications of ITS-REST with
//! no machine-readable model to generate from.
//!
//! - [`flat`] — **ITS-REST Formats**: openEHR Simplified Formats (FLAT /
//!   STRUCTURED data instances, the Web Template model). The
//!   *Formats* specification is a STABLE ITS-REST 1.1.0 sub-specification
//!   (`docs/specs/openehr/ITS-REST/docs/simplified_formats/`) over the
//!   Simplified Data Template (`simplified_data_template/`).
//! - [`rm_instance`] — the template-independent validation of a whole RM
//!   instance tree: the RM-invariant and terminology passes, the
//!   [`rm_instance::ValidationMessage`] report shape, and the composed
//!   [`rm_instance::validate_composition`] entry point. It composes the
//!   template pass of `flat::validation` over the RM pass, and
//!   `flat::validation` reads its report shape back, so the two are one layer.
//!
//! # Features
//!
//! `flat` is the content layer: it pulls `openehr_its` with its `opt14`
//! feature (canonical JSON, canonical XML and the OPT 1.4 reader) and the five
//! generated spec crates. `cache` adds the `moka` WebTemplate cache. The default
//! `full` is both. A `wasm32-unknown-unknown` consumer takes
//! `default-features = false, features = ["flat"]`.
//!
//! The SMART on openEHR scope grammar is `ferrohealth_smart::openehr::smart_scopes`,
//! in the family's authorization crate.

// Doctests are copy-paste templates: they must use `?`, never unwrap
// (C-QUESTION-MARK, https://rust-lang.github.io/api-guidelines/documentation.html#c-question-mark).
#![doc(test(attr(deny(warnings))))]
#[cfg(feature = "flat")]
pub mod flat;
#[cfg(feature = "flat")]
pub mod rm_instance;

/// The openEHR specification version this crate implements.
///
/// The ITS-REST release the Simplified Formats sub-specification belongs to. The pin is deliberately independent of the
/// crates.io package version, which is the crate's own `SemVer` line and moves
/// only with this implementation's code.
pub const SPEC_VERSION: &str = "1.1.0";