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.
ObservationDefinition
Set of definitional characteristics for a kind of observation or measurement produced or consumed by an orderable health care service.
- type Profile on ObservationDefinition
- FHIR R4
- status Draft
-
version4.0.1
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.
ObservationDefinition | I | DomainResource | Element idObservationDefinition Definition of an observation DefinitionSet of definitional characteristics for a kind of observation or measurement produced or consumed by an orderable health care service. An instance of this resource informs the consumer of a health-related service (such as a lab diagnostic test or panel) about how the observations used or produced by this service will look like.
| |
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idObservationDefinition.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idObservationDefinition.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idObservationDefinition.implicitRules A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idObservationDefinition.language Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
| |
text | 0..1 | Narrative | There are no (further) constraints on this element Element idObservationDefinition.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
| |
contained | 0..* | Resource | There are no (further) constraints on this element Element idObservationDefinition.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idObservationDefinition.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 resource. 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
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idObservationDefinition.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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
|
category | Σ | 0..* | CodeableConcept | Element idObservationDefinition.category Category of observation Alternate namesClass of observation DefinitionA code that classifies the general type of observation. Used for filtering what kinds of observations are retrieved and displayed. This element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used for one instance of ObservationDefinition. The level of granularity is defined by the category concepts in the value set. Codes for high level observation categories.
|
code | Σ | 1..1 | CodeableConcept | Element idObservationDefinition.code Type of observation (code / type) Alternate namesName DefinitionDescribes what will be observed. Sometimes this is called the observation "name". Knowing what kind of observation is being made is essential to understanding the observation. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Codes identifying names of simple observations.
|
identifier | Σ | 0..* | Identifier | Element idObservationDefinition.identifier Business identifier for this ObservationDefinition instance DefinitionA unique identifier assigned to this ObservationDefinition artifact.
|
permittedDataType | 0..* | codeBinding | Element idObservationDefinition.permittedDataType Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period DefinitionThe data types allowed for the value element of the instance observations conforming to this ObservationDefinition. Permitted data type for observation value.
General CodeableConcept Mappings
| |
multipleResultsAllowed | 0..1 | boolean | Element idObservationDefinition.multipleResultsAllowed Multiple results allowed DefinitionMultiple results allowed for observations conforming to this ObservationDefinition. An example of observation allowing multiple results is "bacteria identified by culture". Conversely, the measurement of a potassium level allows a single result.
General true | |
method | 0..1 | CodeableConcept | Element idObservationDefinition.method Method used to produce the observation DefinitionThe method or technique used to perform the observation. In some cases, method can impact results. Only used if not implicit in observation code. Methods for simple observations.
| |
preferredReportName | 0..1 | string | Element idObservationDefinition.preferredReportName Preferred report name DefinitionThe preferred name to be used when reporting the results of observations conforming to this ObservationDefinition. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
quantitativeDetails | 0..1 | BackboneElement | Element idObservationDefinition.quantitativeDetails Characteristics of quantitative results DefinitionCharacteristics for quantitative results of this observation.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idObservationDefinition.quantitativeDetails.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 idObservationDefinition.quantitativeDetails.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
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idObservationDefinition.quantitativeDetails.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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.
|
customaryUnit | 0..1 | CodeableConceptBinding | Element idObservationDefinition.quantitativeDetails.customaryUnit Customary unit for quantitative results DefinitionCustomary unit used to report quantitative results of observations conforming to this ObservationDefinition. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Codes identifying units of measure.
| |
unit | 0..1 | CodeableConceptBinding | Element idObservationDefinition.quantitativeDetails.unit SI unit for quantitative results DefinitionSI unit used to report quantitative results of observations conforming to this ObservationDefinition. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Codes identifying units of measure.
| |
conversionFactor | 0..1 | decimal | Element idObservationDefinition.quantitativeDetails.conversionFactor SI to Customary unit conversion factor DefinitionFactor for converting value expressed with SI unit to value expressed with customary unit. Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger)
| |
decimalPrecision | 0..1 | integer | Element idObservationDefinition.quantitativeDetails.decimalPrecision Decimal precision of observation quantitative results DefinitionNumber of digits after decimal separator when the results of such observations are of type Quantity. 32 bit number; for values larger than this, use decimal
| |
qualifiedInterval | 0..* | BackboneElement | Element idObservationDefinition.qualifiedInterval Qualified range for continuous and ordinal observation results DefinitionMultiple ranges of results qualified by different contexts for ordinal or continuous observations conforming to this ObservationDefinition.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idObservationDefinition.qualifiedInterval.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 idObservationDefinition.qualifiedInterval.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
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idObservationDefinition.qualifiedInterval.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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.
|
category | 0..1 | codeBinding | Element idObservationDefinition.qualifiedInterval.category reference | critical | absolute DefinitionThe category of interval of values for continuous or ordinal observations conforming to this ObservationDefinition. Codes identifying the category of observation range.
General critical Mappings
| |
range | I | 0..1 | Range | Element idObservationDefinition.qualifiedInterval.range The interval itself, for continuous or ordinal observations DefinitionThe low and high values determining the interval. There may be only one of the two. The unit may be not relevant for ordinal values. In case it is there, it is the same as quantitativeDetails.unit. The stated low and high value are assumed to have arbitrarily high precision when it comes to determining which values are in the range. I.e. 1.99 is not in the range 2 -> 3.
|
context | 0..1 | CodeableConceptBinding | Element idObservationDefinition.qualifiedInterval.context Range context qualifier DefinitionCodes to indicate the health context the range applies to. For example, the normal or therapeutic range. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Code identifying the health context of a range.
| |
appliesTo | 0..* | CodeableConcept | Element idObservationDefinition.qualifiedInterval.appliesTo Targetted population of the range DefinitionCodes to indicate the target population this reference range applies to. If this element is not present then the global population is assumed. Codes identifying the population the reference range applies to.
| |
gender | 0..1 | codeBinding | Element idObservationDefinition.qualifiedInterval.gender male | female | other | unknown DefinitionSex of the population the range applies to. The gender of a person used for administrative purposes.
General female Mappings
| |
age | I | 0..1 | Range | Element idObservationDefinition.qualifiedInterval.age Applicable age range, if relevant DefinitionThe age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so. Some analytes vary greatly over age.
|
gestationalAge | I | 0..1 | Range | Element idObservationDefinition.qualifiedInterval.gestationalAge Applicable gestational age range, if relevant DefinitionThe gestational age to which this reference range is applicable, in the context of pregnancy. The stated low and high value are assumed to have arbitrarily high precision when it comes to determining which values are in the range. I.e. 1.99 is not in the range 2 -> 3.
|
condition | 0..1 | string | Element idObservationDefinition.qualifiedInterval.condition Condition associated with the reference range DefinitionText based condition for which the reference range is valid. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
validCodedValueSet | I | 0..1 | Reference(ValueSet) | Element idObservationDefinition.validCodedValueSet Value set of valid coded values for the observations conforming to this ObservationDefinition DefinitionThe set of valid coded results for the observations conforming to this ObservationDefinition. 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.
|
normalCodedValueSet | I | 0..1 | Reference(ValueSet) | Element idObservationDefinition.normalCodedValueSet Value set of normal coded values for the observations conforming to this ObservationDefinition DefinitionThe set of normal coded results for the observations conforming to this ObservationDefinition. 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.
|
abnormalCodedValueSet | I | 0..1 | Reference(ValueSet) | Element idObservationDefinition.abnormalCodedValueSet Value set of abnormal coded values for the observations conforming to this ObservationDefinition DefinitionThe set of abnormal coded results for the observation conforming to this ObservationDefinition. 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.
|
criticalCodedValueSet | I | 0..1 | Reference(ValueSet) | Element idObservationDefinition.criticalCodedValueSet Value set of critical coded values for the observations conforming to this ObservationDefinition DefinitionThe set of critical coded results for the observation conforming to this ObservationDefinition. 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.
|