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.
-
Default
What is FQL?
-
FQL Query resources
FQL Playground
Try Firely Query Language in our playground by using this scope as data source.
- FQL Documentation
-
FQL Language
Syntax specification
To learn more about FQL syntax choose this menu item.
-
YamlGen Generate resources
YamlGen Playground
Try YamlGen in our playground by using this scope as data source.
-
YamlGen Language
YamlGen Syntax specification
To learn more about YamlGen syntax choose this.
-
FHIRPath Inspect resource
FHIRPath Playground
Try out the FHIRPath playground and navigate inside this resource.
-
FHIRPath Documentation
FHIRPath Documentation
Find out what FHIRPath is or learn how to write FHIRPath scripts.
-
Project FHIR API
This is the location where you can find your resource using a FHIR client.
-
Simplifier FHIR API
The global endpoint is where users can search for all resources in Simplifier. Resources have a globally unique guid Id here.
-
Custom Example generation
Custom Example generation beta
Experiment with resource instance generation using YamlGen and based on this profile.
This feature is in beta. You can help us improve it by giving feedback with the feedback button at the top of the screen.
ParameterDefinition
Base StructureDefinition for ParameterDefinition Type
- type Profile on ParameterDefinition
- FHIR STU3
- status Draft
-
versionnone
The canonical from this resource does not match any claim in this context and conflicts with a claim from another scope.
http://hl7.org/fhir
Canonical claims are used to verify ownership of your canonical URLs.
ParameterDefinition | Element | Element idParameterDefinition Definition of a parameter to a module DefinitionThe parameters to the module. This collection specifies both the input and output parameters. Input parameters are provided by the caller as part of the $evaluate operation. Output parameters are included in the GuidanceResponse.
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idParameterDefinition.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | 0..* | Extension | There are no (further) constraints on this element Element idParameterDefinition.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Mappings
| |
name | Σ | 0..1 | code | Element idParameterDefinition.name Name used to access the parameter value DefinitionThe name of the parameter used to allow access to the value of the parameter in evaluation contexts.
|
use | Σ | 1..1 | codeBinding | Element idParameterDefinition.use in | out DefinitionWhether the parameter is input or output for the module. Whether the parameter is input or output ?? (required)Constraints
|
min | Σ | 0..1 | integer | Element idParameterDefinition.min Minimum cardinality DefinitionThe minimum number of times this parameter SHALL appear in the request or response. 32 bit number; for values larger than this, use decimal
|
max | Σ | 0..1 | string | Element idParameterDefinition.max Maximum cardinality (a number of *) DefinitionThe maximum number of times this element is permitted to appear in the request or response. Note that FHIR strings may not exceed 1MB in size
|
documentation | Σ | 0..1 | string | Element idParameterDefinition.documentation A brief description of the parameter DefinitionA brief discussion of what the parameter is for and how it is used by the module. Note that FHIR strings may not exceed 1MB in size
|
type | Σ | 1..1 | codeBinding | Element idParameterDefinition.type What type of value DefinitionThe type of the parameter. Either an abstract type, a resource or a data type. ?? (required)Constraints
|
profile | Σ I | 0..1 | Reference(http://hl7.org/fhir/StructureDefinition/StructureDefinition) | Element idParameterDefinition.profile What profile the value is expected to be DefinitionIf specified, this indicates a profile that the input data must conform to, or that the output data will conform to. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(http://hl7.org/fhir/StructureDefinition/StructureDefinition) Constraints
|