fml-check 0.2.0

Type checker for the FHIR Mapping Language: element paths, types, variables and group calls
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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189

//! What the checker reports, against the embedded core definitions.
#![cfg(feature = "fhirschema")]

use fml_check::{CoreDefinitions, Release, check};
use fml_syntax::{LineIndex, parse};

/// Diagnostics as `line:column message`. Maps without a `url` get one at the end, so the lines
/// of the source stay where they are.
fn diagnostics(source: &str, release: Release) -> String {
    let with_identity;
    let source = if source.contains("/// url") {
        source
    } else {
        with_identity = format!(
            "{source}\n/// url = 'http://example.org/StructureMap/test'\n/// name = 'test'\n"
        );
        &with_identity
    };
    let parse = parse(source);
    assert!(parse.diagnostics().is_empty(), "{:?}", parse.diagnostics());
    let index = LineIndex::new(source);
    check(&parse.tree(), &CoreDefinitions::new(release))
        .iter()
        .map(|d| {
            let at = index.line_col(source, d.range.start());
            format!("{}:{} {}", at.line + 1, at.col + 1, d.message)
        })
        .collect::<Vec<_>>()
        .join("\n")
}

#[test]
fn reports_what_cannot_work() {
    let source = r#"uses "http://hl7.org/fhir/StructureDefinition/Patient" alias P as source
uses "http://hl7.org/fhir/StructureDefinition/Basic" alias B as target
uses "http://hl7.org/fhir/StructureDefinition/NoSuchThing" as source

group Main(source src : P, target tgt : B) {
  src.nmae -> tgt.code;
  src.deceased : string as d -> tgt.subject;
  src.name as n -> tgt.extension as e, e.value = create('Quantity'), e.url = create('DomainResource');
  src.gender as g -> src.gender = g "writesSource";
  src.contact as c -> tgt.extension as e then Contact(c, e) "contact";
  src.birthDate as b -> tgt.created = truncate(b) "arity";
  src.id as i -> tgt.id = copy(missing) "unknownVariable";
  src.link as l then Missing(l) "unknownGroup";
}

group Contact(source src, target tgt) {
  src.relationshp -> tgt.url;
  src.name as n -> tgt.value = create('HumanName') "name";
}
"#;
    insta::assert_snapshot!(diagnostics(source, Release::R5), @r"
    3:6 unknown structure `http://hl7.org/fhir/StructureDefinition/NoSuchThing`
    6:7 `Patient` has no element `nmae`
    7:16 `string` is not a type of `Patient.deceased`; it is boolean, dateTime
    8:85 `DomainResource` is abstract and cannot be created
    9:22 `src` is a source variable; a target writes into a target variable
    11:39 `truncate` takes 2 argument(s), found 1
    12:32 unknown variable `missing`
    13:22 group `Missing` is not declared and nothing is imported
    17:7 `Patient.contact` has no element `relationshp`
    ");
}

#[test]
fn accepts_valid_maps() {
    let source = r#"uses "http://hl7.org/fhir/4.0/StructureDefinition/Bundle" alias BundleR4 as source
uses "http://hl7.org/fhir/5.0/StructureDefinition/Bundle" alias BundleR5 as target
let fallback = 'none';

group Bundle(source src : BundleR4, target tgt : BundleR5) extends Resource <<type+>> {
  src.type -> tgt.type;
  src.entry as s -> tgt.entry as t then {
    s.fullUrl -> t.fullUrl;
    s.resource -> t.resource;
    s.response as rs -> t.response as rt then {
      rs.outcome : OperationOutcome -> rt.outcome "outcome";
      rs.status as v -> rt.status = truncate(v, fallback) "status";
    } "response";
  } "entry";
  src.signature as s -> tgt.signature as t then Signature(s, t) "signature";
}

group Signature(source src, target tgt) {
  src.when -> tgt.when;
  src.who -> tgt.who;
  src.data as d -> tgt.data = d "data";
}

group Resource(source src, target tgt) {
  src.id -> tgt.id;
  src.meta -> tgt.meta;
}

group string(source src : string, target tgt : string) <<type+>> {
  src.value as v -> tgt.value = v "value";
}
"#;
    assert_eq!(diagnostics(source, Release::R5), "");
}

#[test]
fn untyped_groups_are_checked_with_their_call_types() {
    let source = r#"uses "http://hl7.org/fhir/StructureDefinition/Questionnaire" as source
uses "http://hl7.org/fhir/StructureDefinition/Questionnaire" as target

group Main(source src : Questionnaire, target tgt : Questionnaire) {
  src.item as s -> tgt.item as t then Item(s, t) "item";
}

group Item(source src, target tgt) {
  src.linkId -> tgt.linkId;
  src.item as s -> tgt.item as t then Item(s, t) "nested";
  src.answer -> tgt.answer;
}
"#;
    insta::assert_snapshot!(
        diagnostics(source, Release::R4),
        @r"
    11:7 `Questionnaire.item` has no element `answer`
    11:21 `Questionnaire.item` has no element `answer`
    "
    );
}

#[test]
fn checks_element_paths_inside_fhirpath() {
    let source = r#"uses "http://hl7.org/fhir/StructureDefinition/Account" as source
uses "http://hl7.org/fhir/StructureDefinition/Account" as target

group Main(source src : Account, target tgt : Account) {
  src.relatedAccount as ra where (ra.relationship.exists(system = 'x' and code = 'parent')) -> tgt.name = 'a' "wrong";
  src.relatedAccount as ra where (relationship.coding.exists(system = 'x' and code = 'parent')) -> tgt.name = 'b' "right";
  src.coverage as c where (c.coverage.resolve().exists() and $this.priority > 0) -> tgt.name = (c.coverage.display) "deep";
  src.name as n -> tgt.description = (n.lenght().toString()) "functionsAreNotChecked";
  src.status as s where (statuss = 'active') -> tgt.status = s "typo";
}
"#;
    insta::assert_snapshot!(diagnostics(source, Release::R5), @r"
    5:58 `CodeableConcept` has no element `system`
    5:75 `CodeableConcept` has no element `code`
    9:26 `code` has no element `statuss`
    ");
}

#[test]
fn reports_what_the_ig_requires_of_names_and_signatures() {
    let source = r#"/// url = 'http://example.org/StructureMap/x'
uses "http://hl7.org/fhir/StructureDefinition/Patient" alias P as source
uses "http://hl7.org/fhir/StructureDefinition/Basic" alias B as target

group Base(source src : P, target tgt : B) {
  src.id as v -> tgt.id = v "id";
}

group Derived(source src : P, target out : B, source extra) extends Base {
  src.id as v -> out.id = v "id";
}

group Typed(source src : P, target tgt : string) extends Base <<types>> {
}

group Default(target tgt : B, source src : P) <<type+>> {
}
"#;
    insta::assert_snapshot!(diagnostics(source, Release::R5), @r"
    1:1 the map has no `name`: add `/// name = '…'`
    9:1 group `Derived` extends `Base` but has no parameter `tgt`; it needs the parameters of `Base`
    10:3 rule name `id` is used twice in the map
    13:1 group `Typed` extends `Base` but has `tgt` as `string`, not `B`; it needs the parameters of `Base`
    16:1 default group `Default` needs two typed parameters, a source and then a target; it is not used as a default
    ");
}

#[test]
fn reports_repeated_constants_and_reserved_names() {
    let source = r#"let base = 'a';
let base = 'b';

group G(source src, target type) {
}
"#;
    insta::assert_snapshot!(diagnostics(source, Release::R5), @r"
    2:1 constant `base` is declared twice
    4:21 `type` is a reserved keyword
    ");
}