Module health.fhir.r4utils.fhirpath
ballerinax/health.fhir.r4utils.fhirpath Ballerina library
1.0.0
FHIR R4 Utils FHIRPath module
Module Overview
This module provides processors and utilities for implementing FHIR Path for accessing and manipulating FHIR resources.
Functions
createFhirPathError
Isolated Function
Method to create a FHIRPathError
Parameters
- errorMsg string - the reason for the occurence of error
- fhirPath string? - the fhirpath expression that is being evaluated
Return Type
- error - the error object
evaluateFhirPath
Isolated Function
function evaluateFhirPath(map<json> fhirResource, string fhirPathExpression) returns string|json|int|float|boolean|byte|errorEvaluate the fhirpath expression.
getFhirPathResult
Isolated Function
function getFhirPathResult(map<json> fhirResource, string fhirPath) returns FhirPathResultClient method to access utils package for fhirpath evaluation.
Parameters
- fhirResource map<json> - requested fhir resource
- fhirPath string - fhirpath requested for evaluvation
Return Type
- FhirPathResult - result of the fhirpath expression
Records
health.fhir.r4utils.fhirpath: arrayAccessToken
Sub type of token for array access tokens.
Fields
- Fields Included from * Token
- value string
- anydata...
- index int - index of the array element
health.fhir.r4utils.fhirpath: FhirPathResult
Client record to hold the results of fhirpath evaluation.
Fields
- resultenError string? - Error message if the result is an error
health.fhir.r4utils.fhirpath: Token
Basic token type.
Fields
- value string - value of the token
Errors
health.fhir.r4utils.fhirpath: FHIRPathError
Distinct
FhirPathError is the error object that is returned when an error occurs during the evaluation of a FHIRPath expression.