eehrxf 0.3.0

The European interoperability software component of an EHR system under Regulation (EU) 2025/327: the format-neutral dataset model of the priority categories read from the Xt-EHR EHDS logical models, and the European electronic health record exchange format in FHIR R4, mapped from openEHR by FHIRconnect
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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125

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

//! One section of a document: its slot, its narrative, its entries and the
//! reason it has none.

use fhir_types::r4::codeable_concept::CodeableConcept;

use super::form::Slot;

/// Why a section has no entry (FHIR R4 `list-empty-reason`).
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[non_exhaustive]
pub enum EmptyReason {
    /// `nilknown`: there is nothing to record.
    NilKnown,
    /// `unavailable`: the information is not available.
    Unavailable,
}

impl EmptyReason {
    /// Returns the code.
    #[must_use]
    pub const fn code(self) -> &'static str {
        match self {
            Self::NilKnown => "nilknown",
            Self::Unavailable => "unavailable",
        }
    }
}

/// The reason a section has no entry, as the document holds it.
#[derive(Debug, Clone, PartialEq, Eq)]
pub(super) enum Emptied {
    /// The `list-empty-reason` code the caller gave.
    Coded(EmptyReason),
    /// The `emptyReason` a mapping run wrote, kept whole.
    Mapped(CodeableConcept),
}

/// One section of the document.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Section {
    pub(super) slot: &'static Slot,
    pub(super) paragraphs: Vec<String>,
    pub(super) entries: Vec<String>,
    pub(super) authors: Vec<String>,
    pub(super) empty: Option<Emptied>,
}

impl Section {
    /// Creates the section of `slot`, its generated narrative the
    /// `paragraphs`, with no entry and no author.
    #[must_use]
    pub fn new(slot: &'static Slot, paragraphs: Vec<String>) -> Self {
        Self {
            slot,
            paragraphs,
            entries: Vec::new(),
            authors: Vec::new(),
            empty: None,
        }
    }

    /// Returns the slot.
    #[must_use]
    pub const fn slot(&self) -> &'static Slot {
        self.slot
    }

    /// Returns this section with the entry `full_url`, the `fullUrl` of a
    /// resource the document holds ([`super::Document::add`]).
    #[must_use]
    pub fn with_entry(mut self, full_url: String) -> Self {
        self.entries.push(full_url);
        self
    }

    /// Returns this section with the author `full_url`, the `fullUrl` of a
    /// resource the document holds.
    #[must_use]
    pub fn with_author(mut self, full_url: String) -> Self {
        self.authors.push(full_url);
        self
    }

    /// Returns this section with `reason` as the reason it has no entry,
    /// which the document writes only while it has none (`cmp-2`). A
    /// [`super::form::SectionRule::Reasoned`] rule of the document's form
    /// requires it of a section with no entry.
    #[must_use]
    pub fn empty_because(mut self, reason: EmptyReason) -> Self {
        self.empty = Some(Emptied::Coded(reason));
        self
    }
}

/// One section a mapping run wrote, placed in the document's form.
///
/// It holds the slot the section's LOINC code names, the `fullUrl` of each
/// entry it references, as [`super::Document::with_mapped_composition`]
/// added them, and the `emptyReason` the run wrote.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct MappedSection {
    /// The slot of the form the section's code names.
    pub slot: &'static Slot,
    /// The `fullUrl` of each entry, in the section's order.
    pub entries: Vec<String>,
    /// The `emptyReason` the run wrote on the section, when it wrote one.
    pub empty_reason: Option<CodeableConcept>,
}

impl MappedSection {
    /// Returns the document section of this mapped section, its generated
    /// narrative the `paragraphs`, holding every entry and the run's
    /// `emptyReason`.
    #[must_use]
    pub fn into_section(self, paragraphs: Vec<String>) -> Section {
        Section {
            entries: self.entries,
            empty: self.empty_reason.map(Emptied::Mapped),
            ..Section::new(self.slot, paragraphs)
        }
    }
}