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]/ActivityDefinition/[id]/$apply
Parameters (In)
Name | Cardinality | Type | StructureDefinition | Documentation |
patient | 1..1 | Reference | Patient | The patient that is the target of the activity to be applied |
encounter | 0..1 | Reference | Encounter | The encounter in context, if any |
practitioner | 0..1 | Reference | Practitioner | The practitioner in context |
organization | 0..1 | Reference | Organization | The organization in context |
userType | 0..1 | CodeableConcept | The type of user initiating the request, e.g. patient, healthcare provider, or specific type of healthcare provider (physician, nurse, etc.) | |
userLanguage | 0..1 | CodeableConcept | Preferred language of the person using the system | |
userTaskContext | 0..1 | CodeableConcept | The task the system user is performing, e.g. laboratory results review, medication list review, etc. This information can be used to tailor decision support outputs, such as recommended information resources | |
setting | 0..1 | CodeableConcept | The current setting of the request (inpatient, outpatient, etc) | |
settingContext | 0..1 | CodeableConcept | Additional detail about the setting of the request, if any |
Return Values (Out)
Name | Cardinality | Type | Documentation |
return | 1..1 | Any | The resource that is the result of applying the definition |
The result of invoking this operation is a resource of the type specified by the activity definition, with all the definitions resolved as appropriate for the type of resource. Any dynamicValue elements will be evaluated and the resulting value used for the values of the appropriate elements of the returned resource. If the ActivityDefinition includes library references, those libraries will be available to the evaluated expressions. If those libraries have parameters, those parameters will be bound by name to the parameters given to the operation