helios-fhirpath 0.2.0

This is an implementation of HL7's FHIRPath Specification.
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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
//! Data models for FHIRPath server request and response handling
//!
//! This module defines the structures used for the FHIRPath server API,
//! following the specification in server-api.md for the fhirpath-lab
//! integration.

use serde::{Deserialize, Serialize};
use serde_json::Value;

// Use the ParameterValueAccessor trait from helios_fhir
use helios_fhir::ParameterValueAccessor;

/// Type alias for the version-independent Parameters container.
///
/// This alias provides backward compatibility while using the unified
/// VersionIndependentParameters from the helios_fhir crate.
pub type FhirPathParameters = helios_fhir::VersionIndependentParameters;

/// Individual parameter in the Parameters resource
#[derive(Debug, Deserialize, Serialize)]
pub struct Parameter {
    /// Name of the parameter
    pub name: String,

    /// String value (for simple parameters)
    #[serde(rename = "valueString", skip_serializing_if = "Option::is_none")]
    pub value_string: Option<String>,

    /// Boolean value
    #[serde(rename = "valueBoolean", skip_serializing_if = "Option::is_none")]
    pub value_boolean: Option<bool>,

    /// Resource value
    #[serde(skip_serializing_if = "Option::is_none")]
    pub resource: Option<Value>,

    /// Multi-part parameters (for variables)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub part: Option<Vec<ParameterPart>>,
}

/// Part of a multi-part parameter
#[derive(Debug, Deserialize, Serialize)]
pub struct ParameterPart {
    /// Name of the part
    pub name: String,

    /// String value
    #[serde(rename = "valueString", skip_serializing_if = "Option::is_none")]
    pub value_string: Option<String>,

    /// Any other value type
    #[serde(flatten)]
    pub value: Option<Value>,
}

/// Extracted parameters for processing
#[derive(Debug, Default)]
pub struct ExtractedParameters {
    /// The context expression to execute first
    pub context: Option<String>,

    /// The FHIRPath expression to execute
    pub expression: Option<String>,

    /// Whether to validate the expression
    pub validate: bool,

    /// Variables to pass to the expression
    pub variables: Vec<Variable>,

    /// The resource to execute against
    pub resource: Option<Value>,

    /// Terminology server URL
    pub terminology_server: Option<String>,
}

/// Variable definition
#[derive(Debug, Clone)]
pub struct Variable {
    /// Variable name
    pub name: String,

    /// Variable value
    pub value: Value,
}

/// Output result part
#[derive(Debug, Serialize)]
pub struct ResultPart {
    /// Name of the part (data type or "trace")
    pub name: String,

    /// String value for context path
    #[serde(rename = "valueString", skip_serializing_if = "Option::is_none")]
    pub value_string: Option<String>,

    /// Parts for complex results
    #[serde(skip_serializing_if = "Option::is_none")]
    pub part: Option<Vec<ResultValue>>,

    /// Extension for non-representable values
    #[serde(skip_serializing_if = "Option::is_none")]
    pub extension: Option<Vec<Extension>>,
}

/// Result value within a part
#[derive(Debug, Serialize)]
pub struct ResultValue {
    /// Name (data type)
    pub name: String,

    /// Various value types
    #[serde(rename = "valueString", skip_serializing_if = "Option::is_none")]
    pub value_string: Option<String>,

    #[serde(rename = "valueBoolean", skip_serializing_if = "Option::is_none")]
    pub value_boolean: Option<bool>,

    #[serde(rename = "valueInteger", skip_serializing_if = "Option::is_none")]
    pub value_integer: Option<i64>,

    #[serde(rename = "valueDecimal", skip_serializing_if = "Option::is_none")]
    pub value_decimal: Option<f64>,

    #[serde(rename = "valueDate", skip_serializing_if = "Option::is_none")]
    pub value_date: Option<String>,

    #[serde(rename = "valueDateTime", skip_serializing_if = "Option::is_none")]
    pub value_date_time: Option<String>,

    #[serde(rename = "valueTime", skip_serializing_if = "Option::is_none")]
    pub value_time: Option<String>,

    #[serde(rename = "valueQuantity", skip_serializing_if = "Option::is_none")]
    pub value_quantity: Option<Value>,

    #[serde(rename = "valueHumanName", skip_serializing_if = "Option::is_none")]
    pub value_human_name: Option<Value>,

    /// Extension for JSON representation of complex values
    #[serde(skip_serializing_if = "Option::is_none")]
    pub extension: Option<Vec<Extension>>,
}

/// Extension for JSON values that can't be represented as FHIR types
#[derive(Debug, Serialize)]
pub struct Extension {
    /// Extension URL
    pub url: String,

    /// String value containing JSON
    #[serde(rename = "valueString")]
    pub value_string: String,
}

/// Helper to create JSON value extension
pub fn create_json_extension(value: &Value) -> Extension {
    Extension {
        url: "http://fhir.forms-lab.com/StructureDefinition/json-value".to_string(),
        value_string: serde_json::to_string_pretty(value).unwrap_or_default(),
    }
}

/// Extract parameters from the input Parameters resource
pub fn extract_parameters(params: FhirPathParameters) -> Result<ExtractedParameters, String> {
    let mut extracted = ExtractedParameters::default();

    // Process parameters based on version
    match params {
        #[cfg(feature = "R4")]
        FhirPathParameters::R4(parameters) => {
            extract_parameters_from_r4(parameters, &mut extracted)?;
        }
        #[cfg(feature = "R4B")]
        FhirPathParameters::R4B(parameters) => {
            extract_parameters_from_r4b(parameters, &mut extracted)?;
        }
        #[cfg(feature = "R5")]
        FhirPathParameters::R5(parameters) => {
            extract_parameters_from_r5(parameters, &mut extracted)?;
        }
        #[cfg(feature = "R6")]
        FhirPathParameters::R6(parameters) => {
            extract_parameters_from_r6(parameters, &mut extracted)?;
        }
        #[allow(unreachable_patterns)]
        _ => {
            return Err(
                "FHIR version of Parameters resource is not enabled in this build".to_string(),
            );
        }
    }

    if extracted.expression.is_none() {
        return Err("Missing required parameter: expression".to_string());
    }

    if extracted.resource.is_none() {
        return Err("Missing required parameter: resource".to_string());
    }

    Ok(extracted)
}

#[cfg(feature = "R4")]
fn extract_parameters_from_r4(
    parameters: helios_fhir::r4::Parameters,
    extracted: &mut ExtractedParameters,
) -> Result<(), String> {
    for param in parameters.parameter.unwrap_or_default() {
        process_parameter_r4(&param, extracted)?;
    }
    Ok(())
}

#[cfg(feature = "R4")]
fn process_parameter_r4(
    param: &helios_fhir::r4::ParametersParameter,
    extracted: &mut ExtractedParameters,
) -> Result<(), String> {
    let name = param.name.value.as_deref().unwrap_or("");

    match name {
        "context" => {
            extracted.context = param
                .value
                .as_ref()
                .and_then(|v| v.as_string())
                .map(|s| s.to_string());
        }
        "expression" => {
            extracted.expression = param
                .value
                .as_ref()
                .and_then(|v| v.as_string())
                .map(|s| s.to_string());
        }
        "validate" => {
            extracted.validate = param
                .value
                .as_ref()
                .and_then(|v| v.as_boolean())
                .unwrap_or(false);
        }
        "variables" => {
            if let Some(parts) = &param.part {
                for part in parts {
                    if let Some(name) = &part.name.value {
                        let value = if let Some(val) = &part.value {
                            // Convert parameter value to JSON
                            parameter_value_to_json_r4(val)
                        } else {
                            Value::Null
                        };

                        extracted.variables.push(Variable {
                            name: name.to_string(),
                            value,
                        });
                    }
                }
            }
        }
        "resource" => {
            extracted.resource = param
                .resource
                .as_ref()
                .and_then(|r| serde_json::to_value(r).ok());
        }
        "terminologyServer" => {
            extracted.terminology_server = param
                .value
                .as_ref()
                .and_then(|v| v.as_string())
                .map(|s| s.to_string());
        }
        _ => {
            // Ignore unknown parameters
        }
    }

    Ok(())
}

#[cfg(feature = "R4")]
fn parameter_value_to_json_r4(value: &helios_fhir::r4::ParametersParameterValue) -> Value {
    // Convert FHIR parameter value to JSON
    // This is a simplified conversion - in production, you'd handle all value types
    match value {
        helios_fhir::r4::ParametersParameterValue::String(s) => s
            .value
            .as_ref()
            .map(|v| Value::String(v.clone()))
            .unwrap_or(Value::Null),
        helios_fhir::r4::ParametersParameterValue::Boolean(b) => {
            b.value.map(Value::Bool).unwrap_or(Value::Null)
        }
        helios_fhir::r4::ParametersParameterValue::Integer(i) => i
            .value
            .map(|v| Value::Number(serde_json::Number::from(v)))
            .unwrap_or(Value::Null),
        helios_fhir::r4::ParametersParameterValue::Decimal(d) => {
            serde_json::to_value(d).unwrap_or(Value::Null)
        }
        _ => {
            // For other types, serialize to JSON
            serde_json::to_value(value).unwrap_or(Value::Null)
        }
    }
}

#[cfg(feature = "R4B")]
fn extract_parameters_from_r4b(
    parameters: helios_fhir::r4b::Parameters,
    extracted: &mut ExtractedParameters,
) -> Result<(), String> {
    for param in parameters.parameter.unwrap_or_default() {
        let name = param.name.value.as_deref().unwrap_or("");

        match name {
            "context" => {
                extracted.context = param
                    .value
                    .as_ref()
                    .and_then(|v| v.as_string())
                    .map(|s| s.to_string());
            }
            "expression" => {
                extracted.expression = param
                    .value
                    .as_ref()
                    .and_then(|v| v.as_string())
                    .map(|s| s.to_string());
            }
            "validate" => {
                extracted.validate = param
                    .value
                    .as_ref()
                    .and_then(|v| v.as_boolean())
                    .unwrap_or(false);
            }
            "variables" => {
                if let Some(parts) = &param.part {
                    for part in parts {
                        if let Some(name) = &part.name.value {
                            let value = if let Some(val) = &part.value {
                                parameter_value_to_json_r4b(val)
                            } else {
                                Value::Null
                            };

                            extracted.variables.push(Variable {
                                name: name.to_string(),
                                value,
                            });
                        }
                    }
                }
            }
            "resource" => {
                extracted.resource = param
                    .resource
                    .as_ref()
                    .and_then(|r| serde_json::to_value(r).ok());
            }
            "terminologyServer" => {
                extracted.terminology_server = param
                    .value
                    .as_ref()
                    .and_then(|v| v.as_string())
                    .map(|s| s.to_string());
            }
            _ => {}
        }
    }
    Ok(())
}

#[cfg(feature = "R4B")]
fn parameter_value_to_json_r4b(value: &helios_fhir::r4b::ParametersParameterValue) -> Value {
    match value {
        helios_fhir::r4b::ParametersParameterValue::String(s) => s
            .value
            .as_ref()
            .map(|v| Value::String(v.clone()))
            .unwrap_or(Value::Null),
        helios_fhir::r4b::ParametersParameterValue::Boolean(b) => {
            b.value.map(Value::Bool).unwrap_or(Value::Null)
        }
        helios_fhir::r4b::ParametersParameterValue::Integer(i) => i
            .value
            .map(|v| Value::Number(serde_json::Number::from(v)))
            .unwrap_or(Value::Null),
        helios_fhir::r4b::ParametersParameterValue::Decimal(d) => {
            serde_json::to_value(d).unwrap_or(Value::Null)
        }
        _ => serde_json::to_value(value).unwrap_or(Value::Null),
    }
}

#[cfg(feature = "R5")]
fn extract_parameters_from_r5(
    parameters: helios_fhir::r5::Parameters,
    extracted: &mut ExtractedParameters,
) -> Result<(), String> {
    for param in parameters.parameter.unwrap_or_default() {
        let name = param.name.value.as_deref().unwrap_or("");

        match name {
            "context" => {
                extracted.context = param
                    .value
                    .as_ref()
                    .and_then(|v| v.as_string())
                    .map(|s| s.to_string());
            }
            "expression" => {
                extracted.expression = param
                    .value
                    .as_ref()
                    .and_then(|v| v.as_string())
                    .map(|s| s.to_string());
            }
            "validate" => {
                extracted.validate = param
                    .value
                    .as_ref()
                    .and_then(|v| v.as_boolean())
                    .unwrap_or(false);
            }
            "variables" => {
                if let Some(parts) = &param.part {
                    for part in parts {
                        if let Some(name) = &part.name.value {
                            let value = if let Some(val) = &part.value {
                                parameter_value_to_json_r5(val)
                            } else {
                                Value::Null
                            };

                            extracted.variables.push(Variable {
                                name: name.to_string(),
                                value,
                            });
                        }
                    }
                }
            }
            "resource" => {
                extracted.resource = param
                    .resource
                    .as_ref()
                    .and_then(|r| serde_json::to_value(r).ok());
            }
            "terminologyServer" => {
                extracted.terminology_server = param
                    .value
                    .as_ref()
                    .and_then(|v| v.as_string())
                    .map(|s| s.to_string());
            }
            _ => {}
        }
    }
    Ok(())
}

#[cfg(feature = "R5")]
fn parameter_value_to_json_r5(value: &helios_fhir::r5::ParametersParameterValue) -> Value {
    match value {
        helios_fhir::r5::ParametersParameterValue::String(s) => s
            .value
            .as_ref()
            .map(|v| Value::String(v.clone()))
            .unwrap_or(Value::Null),
        helios_fhir::r5::ParametersParameterValue::Boolean(b) => {
            b.value.map(Value::Bool).unwrap_or(Value::Null)
        }
        helios_fhir::r5::ParametersParameterValue::Integer(i) => i
            .value
            .map(|v| Value::Number(serde_json::Number::from(v)))
            .unwrap_or(Value::Null),
        helios_fhir::r5::ParametersParameterValue::Decimal(d) => {
            serde_json::to_value(d).unwrap_or(Value::Null)
        }
        _ => serde_json::to_value(value).unwrap_or(Value::Null),
    }
}

#[cfg(feature = "R6")]
fn extract_parameters_from_r6(
    parameters: helios_fhir::r6::Parameters,
    extracted: &mut ExtractedParameters,
) -> Result<(), String> {
    for param in parameters.parameter.unwrap_or_default() {
        let name = param.name.value.as_deref().unwrap_or("");

        match name {
            "context" => {
                extracted.context = param
                    .value
                    .as_ref()
                    .and_then(|v| v.as_string())
                    .map(|s| s.to_string());
            }
            "expression" => {
                extracted.expression = param
                    .value
                    .as_ref()
                    .and_then(|v| v.as_string())
                    .map(|s| s.to_string());
            }
            "validate" => {
                extracted.validate = param
                    .value
                    .as_ref()
                    .and_then(|v| v.as_boolean())
                    .unwrap_or(false);
            }
            "variables" => {
                if let Some(parts) = &param.part {
                    for part in parts {
                        if let Some(name) = &part.name.value {
                            let value = if let Some(val) = &part.value {
                                parameter_value_to_json_r6(val)
                            } else {
                                Value::Null
                            };

                            extracted.variables.push(Variable {
                                name: name.to_string(),
                                value,
                            });
                        }
                    }
                }
            }
            "resource" => {
                extracted.resource = param
                    .resource
                    .as_ref()
                    .and_then(|r| serde_json::to_value(r).ok());
            }
            "terminologyServer" => {
                extracted.terminology_server = param
                    .value
                    .as_ref()
                    .and_then(|v| v.as_string())
                    .map(|s| s.to_string());
            }
            _ => {}
        }
    }
    Ok(())
}

#[cfg(feature = "R6")]
fn parameter_value_to_json_r6(value: &helios_fhir::r6::ParametersParameterValue) -> Value {
    match value {
        helios_fhir::r6::ParametersParameterValue::String(s) => s
            .value
            .as_ref()
            .map(|v| Value::String(v.clone()))
            .unwrap_or(Value::Null),
        helios_fhir::r6::ParametersParameterValue::Boolean(b) => {
            b.value.map(Value::Bool).unwrap_or(Value::Null)
        }
        helios_fhir::r6::ParametersParameterValue::Integer(i) => i
            .value
            .map(|v| Value::Number(serde_json::Number::from(v)))
            .unwrap_or(Value::Null),
        helios_fhir::r6::ParametersParameterValue::Decimal(d) => {
            serde_json::to_value(d).unwrap_or(Value::Null)
        }
        _ => serde_json::to_value(value).unwrap_or(Value::Null),
    }
}