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.
Query
-
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.
API
-
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.
Tools
-
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.
Project ptlfhir
DataRequirement
Base StructureDefinition for DataRequirement Type: Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.
- type Profile on DataRequirement
- FHIR R4
- status Draft
-
version4.0.1
Unregistered conflicting canonical
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.
Canonical
| DataRequirement | Element | Element idDataRequirement Describes a required data item DefinitionDescribes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idDataRequirement.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idDataRequirement.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. 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 can 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 Constraints
|
| type | Σ | 1..1 | codeBinding | Element idDataRequirement.type The type of the required data DefinitionThe type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile. A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
|
| profile | Σ | 0..* | canonical(StructureDefinition) | Element idDataRequirement.profile The profile of the required data DefinitionThe profile of the required data, specified as the uri of the profile definition. canonical(StructureDefinition) Constraints
|
| subject[x] | Σ | 0..1 | Binding | Element idDataRequirement.subject[x] E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device DefinitionThe intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed. The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration. Patient The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).
|
| subjectCodeableConcept | CodeableConcept | Data type | ||
| subjectReference | Reference(Group) | Data type | ||
| mustSupport | Σ | 0..* | string | Element idDataRequirement.mustSupport Indicates specific structure elements that are referenced by the knowledge module DefinitionIndicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available. The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details). Note that FHIR strings SHALL NOT exceed 1MB in size
|
| codeFilter | Σ I | 0..* | Element | Element idDataRequirement.codeFilter What codes are expected DefinitionCode filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idDataRequirement.codeFilter.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idDataRequirement.codeFilter.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. 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 can 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 Constraints
|
| path | Σ | 0..1 | string | Element idDataRequirement.codeFilter.path A code-valued attribute to filter on DefinitionThe code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept. The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.
|
| searchParam | Σ | 0..1 | string | Element idDataRequirement.codeFilter.searchParam A coded (token) parameter to search on DefinitionA token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept. Note that FHIR strings SHALL NOT exceed 1MB in size
|
| valueSet | Σ | 0..1 | canonical(ValueSet) | Element idDataRequirement.codeFilter.valueSet Valueset for the filter DefinitionThe valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.
|
| code | Σ | 0..* | Coding | Element idDataRequirement.codeFilter.code What code is expected DefinitionThe codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes. Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information.
|
| dateFilter | Σ I | 0..* | Element | Element idDataRequirement.dateFilter What dates/date ranges are expected DefinitionDate filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idDataRequirement.dateFilter.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idDataRequirement.dateFilter.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. 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 can 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 Constraints
|
| path | Σ | 0..1 | string | Element idDataRequirement.dateFilter.path A date-valued attribute to filter on DefinitionThe date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing. The path attribute contains a Simple FHIR Subset that allows path traversal, but not calculation.
|
| searchParam | Σ | 0..1 | string | Element idDataRequirement.dateFilter.searchParam A date valued parameter to search on DefinitionA date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing. Note that FHIR strings SHALL NOT exceed 1MB in size
|
| value[x] | Σ | 0..1 | Element idDataRequirement.dateFilter.value[x] The value of the filter, as a Period, DateTime, or Duration value DefinitionThe value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.
| |
| valueDateTime | dateTime | Data type | ||
| valuePeriod | Period | Data type | ||
| valueDuration | Duration | Data type | ||
| limit | Σ | 0..1 | positiveInt | Element idDataRequirement.limit Number of results DefinitionSpecifies a maximum number of results that are required (uses the _count search parameter). Enables the requirement "most recent 5 results" to be expressed. This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".
|
| sort | Σ | 0..* | Element | Element idDataRequirement.sort Order of the results DefinitionSpecifies the order of the results to be returned. Enables the requirement "most recent 5 results" to be expressed. This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idDataRequirement.sort.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idDataRequirement.sort.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. 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 can 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 Constraints
|
| path | Σ | 1..1 | string | Element idDataRequirement.sort.path The name of the attribute to perform the sort DefinitionThe attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant. Note that FHIR strings SHALL NOT exceed 1MB in size
|
| direction | Σ | 1..1 | codeBinding | Element idDataRequirement.sort.direction ascending | descending DefinitionThe direction of the sort, ascending or descending. The possible sort directions, ascending or descending.
|
Documentation:
https://simplifier.net/ptlfhir/datarequirement
Last updated on