FQL is a query language that allows you to retrieve, filter and project data from any data source containing FHIR Resources. It brings the power of three existing languages together: SQL, JSON and FhirPath. It allows you to create tables and is useful for gaining insight and perform quality control.
Invocations
URL: [base]/Patient/$everything
URL: [base]/Patient/[id]/$everything
Parameters (In)
| Name | Cardinality | Type | Documentation |
| start | 0..1 | Date | The date range relates to care dates, not record currency dates - e.g. all records relating to care provided in a certain date range. If no start date is provided, all records prior to the end date are in scope. |
| end | 0..1 | Date | The date range relates to care dates, not record currency dates - e.g. all records relating to care provided in a certain date range. If no end date is provided, all records subsequent to the start date are in scope. |
Return Values (Out)
| Name | Cardinality | Type | Documentation |
| return | 1..1 | Bundle | The bundle type is "searchset" |
The key differences between this operation and simply searching the patient compartment are:
- unless the client requests otherwise, the server returns the entire result set in a single bundle (rather than using paging)
- the server is responsible for determining what resources to return as included resources (rather than the client specifying which ones). This frees the client from needing to determine what it could or should ask for
It is assumed that the server has identified and secured the context appropriately, and can either associate the authorization context with a single patient, or determine whether the context has the rights to the nominated patient, if there is one. If there is no nominated patient (e.g. the operation is invoked at the system level) and the context is not associated with a single patient record, then the server should return an error. Specifying the relationship between the context, a user and patient records is outside the scope of this specification.