core.parsexfhirquery | Medplum

parseXFhirQuery() function

Parses an extended FHIR search criteria string (i.e. application/x-fhir-query).

Signature:

export declare function parseXFhirQuery(query: string, variables: Record<string, TypedValue>, context?: TypedValue[]): SearchRequest;

Parameters

Parameter Type Description
query string The X-Fhir-Query string to parse
variables Record<string, TypedValue > Values to pass into embedded FHIRPath expressions
context TypedValue (Optional) The context collection to evaluate over

Returns:
SearchRequest
The parsed search request

Example

Evaluating a FHIRPath subexpression

const query = 'Patient?name={{ %patient.name }}';

const variables = { patient: { name: 'John Doe' } };

const request = parseXFhirQuery(query, variables);

console.log(request.filters[0].value); // "John Doe"