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]/Resource/$validate
URL: [base]/Resource/[id]/$validate
Parameters (In)
| Name | Cardinality | Type | Binding | Documentation |
| resource | 0..1 | Resource | Must be present unless the mode is "delete" | |
| mode | 0..1 | Code | http://hl7.org/fhir/ValueSet/resource-validation-mode (required) | Default is 'no action'; (e.g. general validation) |
| profile | 0..1 | Uri | If this is nominated, then the resource is validated against this specific profile. If a profile is nominated, and the server cannot validate against the nominated profile, it SHALL return an error |
Return Values (Out)
| Name | Cardinality | Type | Documentation |
| return | 1..1 | OperationOutcome | If the operation outcome does not list any errors, and a mode was specified, then this is an indication that the operation would be expected to succeed (excepting for transactional integrity issues, see below) |
This operation may be used during design and development to validate application design. It can also be used at run-time. One possible use might be that a client asks the server whether a proposed update is valid as the user is editing a dialog and displays an updated error to the user. The operation can be used as part of a light-weight two phase commit protocol but there is no expectation that the server will hold the content of the resource after this operation is used, or that the server guarantees to successfully perform an actual create, update or delete after the validation operation completes.
This operation returns a 200 OK whether or not the resource is valid. A 4xx or 5xx error means that the validation itself could not be performed, and it is unknown whether the resource is valid or not.