fhirpathpy 2.0.0__tar.gz → 2.0.1__tar.gz

{fhirpathpy-2.0.0 → fhirpathpy-2.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fhirpathpy
-Version: 2.0.0
+Version: 2.0.1
 Summary: FHIRPath implementation in Python
 Keywords: fhir,fhirpath
 Author-email: "beda.software" <fhirpath@beda.software>
@@ -82,7 +82,7 @@ patient = {
 }
 
 # Evaluating FHIRPath
-result = evaluate(patient, "Patient.name.where(use='usual').given.first()", [])
+result = evaluate(patient, "Patient.name.where(use='usual').given.first()", {})
 # result: `['Jim']`
 ```
 
@@ -97,11 +97,11 @@ path (string): fhirpath expression, sample 'Patient.name.given'
 
 context (dict): a hash of variable name/value pairs.
 
-model (dict): The "model" data object specific to a domain, e.g. R4.
+model (dict): The "model" data object specific to a domain, e.g. R4. See Using data models documentation below.
 
-options (dict) - Custom options (see the documentation below)
+options (dict) - Custom options.
 
-options.userInvocationTable - a user invocation table used to replace any existing functions or define new ones (see User-defined functions documentation below)
+options.userInvocationTable - a user invocation table used to replace any existing functions or define new ones. See User-defined functions documentation below.
 
 ## compile
 Returns a function that takes a resource and an optional context hash (see "evaluate"), and returns the result of evaluating the given FHIRPath expression on that resource.  The advantage of this function over "evaluate" is that if you have multiple resources, the given FHIRPath expression will only be parsed once
@@ -110,14 +110,38 @@ Returns a function that takes a resource and an optional context hash (see "eval
 
 path (string) - the FHIRPath expression to be parsed.
 
-model (dict) - The "model" data object specific to a domain, e.g. R4.
+model (dict) - The "model" data object specific to a domain, e.g. R4. See Using data models documentation below.
 
 options (dict) - Custom options
 
-options.userInvocationTable - a user invocation table used to replace any existing functions or define new ones (see User-defined functions documentation below)
+options.userInvocationTable - a user invocation table used to replace any existing functions or define new ones. See User-defined functions documentation below.
+
+## Using data models
+
+The fhirpathpy library comes with pre-defined data models for FHIR versions DSTU2, STU3, R4, and R5. These models can be used within your project.
+
+Example:
+```python
+from fhirpathpy.models import models
+
+
+r4_model = models["r4"]
+
+patient = {
+  "resourceType": "Patient",
+  "deceasedBoolean": false,
+}
+
+result = evaluate(patient, "Patient.deceased", {}, r4_model)
+
+# result: `[False]`
+```
 
 ## User-defined functions
 
+The FHIRPath specification includes a set of built-in functions. However, if you need to extend the functionality by adding custom logic, you can define your own functions by providing a table of user-defined functions.
+
+Example:
 ```python
 user_invocation_table = {
     "pow": {
@@ -132,7 +156,8 @@ result = evaluate(
     options={"userInvocationTable": user_invocation_table},
 )
 
-# result: [25, 36, 49]
+# result: `[25, 36, 49]`
 ```
 
 It works similarly to [fhirpath.js](https://github.com/HL7/fhirpath.js/tree/master?tab=readme-ov-file#user-defined-functions)
+

{fhirpathpy-2.0.0 → fhirpathpy-2.0.1}/README.md

@@ -51,7 +51,7 @@ patient = {
 }
 
 # Evaluating FHIRPath
-result = evaluate(patient, "Patient.name.where(use='usual').given.first()", [])
+result = evaluate(patient, "Patient.name.where(use='usual').given.first()", {})
 # result: `['Jim']`
 ```
 
@@ -66,11 +66,11 @@ path (string): fhirpath expression, sample 'Patient.name.given'
 
 context (dict): a hash of variable name/value pairs.
 
-model (dict): The "model" data object specific to a domain, e.g. R4.
+model (dict): The "model" data object specific to a domain, e.g. R4. See Using data models documentation below.
 
-options (dict) - Custom options (see the documentation below)
+options (dict) - Custom options.
 
-options.userInvocationTable - a user invocation table used to replace any existing functions or define new ones (see User-defined functions documentation below)
+options.userInvocationTable - a user invocation table used to replace any existing functions or define new ones. See User-defined functions documentation below.
 
 ## compile
 Returns a function that takes a resource and an optional context hash (see "evaluate"), and returns the result of evaluating the given FHIRPath expression on that resource.  The advantage of this function over "evaluate" is that if you have multiple resources, the given FHIRPath expression will only be parsed once
@@ -79,14 +79,38 @@ Returns a function that takes a resource and an optional context hash (see "eval
 
 path (string) - the FHIRPath expression to be parsed.
 
-model (dict) - The "model" data object specific to a domain, e.g. R4.
+model (dict) - The "model" data object specific to a domain, e.g. R4. See Using data models documentation below.
 
 options (dict) - Custom options
 
-options.userInvocationTable - a user invocation table used to replace any existing functions or define new ones (see User-defined functions documentation below)
+options.userInvocationTable - a user invocation table used to replace any existing functions or define new ones. See User-defined functions documentation below.
+
+## Using data models
+
+The fhirpathpy library comes with pre-defined data models for FHIR versions DSTU2, STU3, R4, and R5. These models can be used within your project.
+
+Example:
+```python
+from fhirpathpy.models import models
+
+
+r4_model = models["r4"]
+
+patient = {
+  "resourceType": "Patient",
+  "deceasedBoolean": false,
+}
+
+result = evaluate(patient, "Patient.deceased", {}, r4_model)
+
+# result: `[False]`
+```
 
 ## User-defined functions
 
+The FHIRPath specification includes a set of built-in functions. However, if you need to extend the functionality by adding custom logic, you can define your own functions by providing a table of user-defined functions.
+
+Example:
 ```python
 user_invocation_table = {
     "pow": {
@@ -101,7 +125,7 @@ result = evaluate(
     options={"userInvocationTable": user_invocation_table},
 )
 
-# result: [25, 36, 49]
+# result: `[25, 36, 49]`
 ```
 
-It works similarly to [fhirpath.js](https://github.com/HL7/fhirpath.js/tree/master?tab=readme-ov-file#user-defined-functions)
+It works similarly to [fhirpath.js](https://github.com/HL7/fhirpath.js/tree/master?tab=readme-ov-file#user-defined-functions)

{fhirpathpy-2.0.0 → fhirpathpy-2.0.1}/fhirpathpy/__init__.py

@@ -5,7 +5,7 @@ from fhirpathpy.engine.util import arraify, get_data, set_paths, process_user_in
 from fhirpathpy.engine.nodes import FP_Type, ResourceNode
 
 __title__ = "fhirpathpy"
-__version__ = "2.0.0"
+__version__ = "2.0.1"
 __author__ = "beda.software"
 __license__ = "MIT"
 __copyright__ = "Copyright 2025 beda.software"

{fhirpathpy-2.0.0 → fhirpathpy-2.0.1}/fhirpathpy/engine/util.py

@@ -107,7 +107,7 @@ def process_user_invocation_table(table):
     return {
         name: {
             **entity,
-            "fn": lambda ctx, inputs, *args: entity["fn"](
+            "fn": lambda ctx, inputs, *args, __fn__=entity["fn"]: __fn__(
                 [get_data(i) for i in inputs], *args
             ),
         }