Skip to content

Utility

The utility module contains the object representations of the utility FHIRPath functions.

Now

Bases: FHIRPathFunction

A representation of the FHIRPath now() function.

Source code in fhircraft/fhir/path/engine/utility.py 
50
51
52
53
54
55
56
57
58
59
60
61
62
class Now(FHIRPathFunction):
    """
    A representation of the FHIRPath [`now()`](http://hl7.org/fhirpath/N1/#now-datetime) function.
    """
    def evaluate(self, *args, **kwargs) -> int:
        """
        Returns the current date and time, including timezone offset.

        Returns:
            DateTime: The current date and time, including timezone offset.        
        """ 
        now = datetime.now()
        return DateTime(now.year, now.month, now.day, now.hour, now.minute)

evaluate(*args, **kwargs)

Returns the current date and time, including timezone offset.

Returns:

Name Type Description
DateTime int

The current date and time, including timezone offset.
Source code in fhircraft/fhir/path/engine/utility.py 
54
55
56
57
58
59
60
61
62
def evaluate(self, *args, **kwargs) -> int:
    """
    Returns the current date and time, including timezone offset.

    Returns:
        DateTime: The current date and time, including timezone offset.        
    """ 
    now = datetime.now()
    return DateTime(now.year, now.month, now.day, now.hour, now.minute)

TimeOfDay

Bases: FHIRPathFunction

A representation of the FHIRPath timeOfDay() function.

Source code in fhircraft/fhir/path/engine/utility.py 
66
67
68
69
70
71
72
73
74
75
76
77
78
class TimeOfDay(FHIRPathFunction):
    """
    A representation of the FHIRPath [`timeOfDay()`](http://hl7.org/fhirpath/N1/#timeOfDay-time) function.
    """
    def evaluate(self, *args, **kwargs) -> int:
        """
        Returns the current time.

        Returns:
            Time: The current time.        
        """ 
        now = datetime.now()
        return Time(now.hour, now.minute)

evaluate(*args, **kwargs)

Returns the current time.

Returns:

Name Type Description
Time int

The current time.
Source code in fhircraft/fhir/path/engine/utility.py 
70
71
72
73
74
75
76
77
78
def evaluate(self, *args, **kwargs) -> int:
    """
    Returns the current time.

    Returns:
        Time: The current time.        
    """ 
    now = datetime.now()
    return Time(now.hour, now.minute)

Today

Bases: FHIRPathFunction

A representation of the FHIRPath Today() function.

Source code in fhircraft/fhir/path/engine/utility.py 
81
82
83
84
85
86
87
88
89
90
91
92
93
class Today(FHIRPathFunction):
    """
    A representation of the FHIRPath [`Today()`](http://hl7.org/fhirpath/N1/#today-date) function.
    """
    def evaluate(self, *args, **kwargs) -> int:
        """
        Returns the current date.

        Returns:
            Date: The current date.        
        """ 
        now = datetime.now()
        return DateTime(now.year, now.month, now.day)

evaluate(*args, **kwargs)

Returns the current date.

Returns:

Name Type Description
Date int

The current date.
Source code in fhircraft/fhir/path/engine/utility.py 
85
86
87
88
89
90
91
92
93
def evaluate(self, *args, **kwargs) -> int:
    """
    Returns the current date.

    Returns:
        Date: The current date.        
    """ 
    now = datetime.now()
    return DateTime(now.year, now.month, now.day)

Trace

Bases: FHIRPathFunction

A representation of the FHIRPath trace() function.

Attributes:

Name Type Description
name (str

Subtring query.
Source code in fhircraft/fhir/path/engine/utility.py 
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
class Trace(FHIRPathFunction):
    """
    A representation of the FHIRPath [`trace()`](http://hl7.org/fhirpath/N1/#tracename-string-projection-expression-collection) function.

    Attributes:
        name  (str): Subtring query.
    """
    def __init__(self, name: str, projection: Optional[FHIRPath] = None):
        self.name = name
        self.projection = projection

    def evaluate(self, collection: List[FHIRPathCollectionItem], *args, **kwargs) -> int:
        """
        Adds a `String` representation of the input collection to the diagnostic log, using the `name` argument
        as the name in the log. This log should be made available to the user in some appropriate fashion. Does not
        change the input, so returns the input collection as output.

        If the `projection` argument is used, the trace would log the result of evaluating the project expression on the input,
        but still return the input to the trace function unchanged.

        Args: 
            collection (List[FHIRPathCollectionItem])): The input collection.

        Returns:
            collection (List[FHIRPathCollectionItem])): The input collection.            
        """ 
        log_collection = collection
        if self.projection:
            log_collection = Select(self.projection).evaluate(collection, *args, **kwargs)
        logger.debug(f'{self.name} - {[str(item.value) if isinstance(item, FHIRPathCollectionItem) else str(item) for item in ensure_list(log_collection)]}')        
        return collection

evaluate(collection, *args, **kwargs)

Adds a String representation of the input collection to the diagnostic log, using the name argument as the name in the log. This log should be made available to the user in some appropriate fashion. Does not change the input, so returns the input collection as output.

If the projection argument is used, the trace would log the result of evaluating the project expression on the input, but still return the input to the trace function unchanged.

Parameters:

Name Type Description Default
collection List[FHIRPathCollectionItem]

The input collection.

 required

Returns:

Name Type Description
collection List[FHIRPathCollectionItem])

The input collection.
Source code in fhircraft/fhir/path/engine/utility.py 
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
def evaluate(self, collection: List[FHIRPathCollectionItem], *args, **kwargs) -> int:
    """
    Adds a `String` representation of the input collection to the diagnostic log, using the `name` argument
    as the name in the log. This log should be made available to the user in some appropriate fashion. Does not
    change the input, so returns the input collection as output.

    If the `projection` argument is used, the trace would log the result of evaluating the project expression on the input,
    but still return the input to the trace function unchanged.

    Args: 
        collection (List[FHIRPathCollectionItem])): The input collection.

    Returns:
        collection (List[FHIRPathCollectionItem])): The input collection.            
    """ 
    log_collection = collection
    if self.projection:
        log_collection = Select(self.projection).evaluate(collection, *args, **kwargs)
    logger.debug(f'{self.name} - {[str(item.value) if isinstance(item, FHIRPathCollectionItem) else str(item) for item in ensure_list(log_collection)]}')        
    return collection