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.
Lab Observation
Observation
- type Profile on Observation
- FHIR R4
- status Draft
-
version...
The canonical from this resource does not match any claims.
Canonical claims are used to verify ownership of your canonical URLs.
You're probably missing a package or made a typo in your canonical.
- Could not resolve: http://hl7.org/fhir/StructureDefinition/Observation
LabObservation (Observation) | http://hl7.org/fhir/StructureDefinition/Observation | There are no (further) constraints on this element Element idObservation Alignment: There is a profile for Core-CA; no lab observation profile defined in PS-CA o PS-ON (as at July 2022) Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc. http://hl7.org/fhir/StructureDefinition/Observation | ||
id | S | There are no (further) constraints on this element Element idObservation.id | ||
meta | S | There are no (further) constraints on this element Element idObservation.meta | ||
lastUpdated | S | There are no (further) constraints on this element Element idObservation.meta.lastUpdated | ||
source | S | There are no (further) constraints on this element Element idObservation.meta.source | ||
profile | S | There are no (further) constraints on this element Element idObservation.meta.profile | ||
text | S | There are no (further) constraints on this element Element idObservation.text DISCUSSION REQUIRED TO CONFIRM | ||
identifier | There are no (further) constraints on this element Element idObservation.identifier Usage Note: This should be populated if known. This is supported by OLIS | |||
basedOn | There are no (further) constraints on this element Element idObservation.basedOn Usage Note: This should be populated if known. This is mandatory in the OLIS specification 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. | |||
partOf | There are no (further) constraints on this element Element idObservation.partOf Usage Note: For now, this is out of scope. This could be a lab result that is tied to a procedure, however it is very uncommon to have this linkage within the EMR. eg specimen, observation after the fact is NOT a part of; surgery observations. MA: C3 says yes it is available; Can access it via Task.ID or Problem.ID or Allergy.ID etc. BUT, if done at task level, other non-relavent observations could be captured along with that. (ex: height for diabeties). ie: data is being captured but it could very likely be 'noisy'. | |||
reference | S | There are no (further) constraints on this element Element idObservation.partOf.reference | ||
display | S | There are no (further) constraints on this element Element idObservation.partOf.display | ||
status | S | There are no (further) constraints on this element Element idObservation.status | ||
category | S | 1..1 | Fixed Value | There are no (further) constraints on this element Element idObservation.category { "text": "laboratory" } |
coding | S | There are no (further) constraints on this element Element idObservation.category.coding | ||
system | S | 1.. | There are no (further) constraints on this element Element idObservation.category.coding.system | |
code | S | 1.. | There are no (further) constraints on this element Element idObservation.category.coding.code | |
display | S | There are no (further) constraints on this element Element idObservation.category.coding.display | ||
text | S | Fixed Value | There are no (further) constraints on this element Element idObservation.category.text laboratory | |
code | S | Binding | There are no (further) constraints on this element Element idObservation.code Usage Note: The sending systems will always send text and where possible will also send a codified value. These are not always available. Local codes shoudl be converted to LOINC where possible. EMR API: LOINC (example) http://hl7.org/fhir/ValueSet/observation-codes >1000 codes MA: loinc (most common), ICD-9, snomed,type code, atc class, workload, and no codes as well PSS: MS: PCLOCD, ICD-10 All code-value and, if present, component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. | |
coding | S | There are no (further) constraints on this element Element idObservation.code.coding | ||
system | S | 1.. | There are no (further) constraints on this element Element idObservation.code.coding.system | |
code | S | 1.. | There are no (further) constraints on this element Element idObservation.code.coding.code | |
display | S | There are no (further) constraints on this element Element idObservation.code.coding.display | ||
text | S | 1.. | There are no (further) constraints on this element Element idObservation.code.text Usage Note: If the lab result is just an OBX, with NTE's, there is no specific code; this must be populated as "lab note". PSS: Observation Name (text) ery often the text is the same as a displayName of one of the codings. | |
subject | S | 1.. | There are no (further) constraints on this element Element idObservation.subject | |
reference | S | There are no (further) constraints on this element Element idObservation.subject.reference | ||
display | S | There are no (further) constraints on this element Element idObservation.subject.display | ||
encounter | S | There are no (further) constraints on this element Element idObservation.encounter Usage Note: In some cases the lab observation can be linked to the encoutner in the EMR. Example: Prenatal urinalysis results are often linked to an encounter. This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission laboratory tests). | ||
reference | S | There are no (further) constraints on this element Element idObservation.encounter.reference | ||
display | S | There are no (further) constraints on this element Element idObservation.encounter.display Usage Note: Use of this data element will vary by implementation. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||
effective[x] | S | 1.. | There are no (further) constraints on this element Element idObservation.effective[x] Usage Note: Manual lab entries always have a date which is the date used; may not distinguish between collection date and observation date **** Add data absent reason extension as per core At least a date should be present unless this observation is a historical report. For recording imprecise or "fuzzy" times (For example, a blood glucose measurement taken "after breakfast") use the Timing datatype which allow the measurement to be tied to regular life events. | |
performer | S | There are no (further) constraints on this element Element idObservation.performer Usage Note: If the name of the performer (eg Lifelabs or Dr. Smith) is known this should be sent. 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. | ||
display | S | There are no (further) constraints on this element Element idObservation.performer.display | ||
value[x] | S | There are no (further) constraints on this element Element idObservation.value[x] Usage Rule: This must be sent where known; it is possible that there are component values but no top level values and therefore this is not mandatory.
Usage Note: These values must be represented exactly as they are from the source. eg Labs may send a string such as "pending".
Usage Note: If labs have sent notes associated with the observation, they should be sent as part of the value as a string. This may be in the OBX or the NTE assocaited with the OBX. An observation may have; 1) a single value here, 2) both a value and a set of related or component values, or 3) only a set of related or component values. If a value is present, the datatype for this element should be determined by Observation.code. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the Observation.code defines a coded value. For additional guidance, see the Notes section below. | ||
dataAbsentReason | S | There are no (further) constraints on this element Element idObservation.dataAbsentReason Usage Note: A value of "temp-unknown" may be used for pending results in the EMR (status=registered). This could occur with a panel that has returned some final results with others that are showing as outstanding Null or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "specimen unsatisfactory". The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Note that an observation may only be reported if there are values to report. For example differential cell counts values may be reported only when > 0. Because of these options, use-case agreements are required to interpret general observations for null or exceptional values. | ||
text | S | There are no (further) constraints on this element Element idObservation.dataAbsentReason.text Usage Note: This should be populated with the value from the lab as stored in the EMR, eg "pending" when a data absent reason of "temp-unknown" is used Very often the text is the same as a displayName of one of the codings. | ||
interpretation | S | There are no (further) constraints on this element Element idObservation.interpretation | ||
coding | S | There are no (further) constraints on this element Element idObservation.interpretation.coding | ||
system | S | 1.. | There are no (further) constraints on this element Element idObservation.interpretation.coding.system | |
code | S | 1.. | There are no (further) constraints on this element Element idObservation.interpretation.coding.code | |
text | S | 1.. | There are no (further) constraints on this element Element idObservation.interpretation.text | |
note | S | There are no (further) constraints on this element Element idObservation.note Usage Note: Annotations added by the clinician. Notes from the lab are conveyed as separate observations May include general statements about the observation, or statements about significant, unexpected or unreliable results values, or information about its source when relevant to its interpretation. | ||
author[x] | S | There are no (further) constraints on this element Element idObservation.note.author[x] | ||
time | S | There are no (further) constraints on this element Element idObservation.note.time | ||
text | S | There are no (further) constraints on this element Element idObservation.note.text | ||
method | S | There are no (further) constraints on this element Element idObservation.method Usage Note: If present in the lab result this will be passed on as is. Only used if not implicit in code for Observation.code. | ||
coding | S | There are no (further) constraints on this element Element idObservation.method.coding | ||
text | S | There are no (further) constraints on this element Element idObservation.method.text | ||
specimen | There are no (further) constraints on this element Element idObservation.specimen Usage Note: This is not supported today in the EMR's; if labs begin to send results in FHIR, this may come into scope in the future Should only be used if not implicit in code found in | |||
referenceRange | S | There are no (further) constraints on this element Element idObservation.referenceRange | ||
low | S | There are no (further) constraints on this element Element idObservation.referenceRange.low | ||
high | S | There are no (further) constraints on this element Element idObservation.referenceRange.high | ||
appliesTo | S | There are no (further) constraints on this element Element idObservation.referenceRange.appliesTo Usage Note: This will be present if received from the lab and if stored in the EMR This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed. | ||
coding | S | There are no (further) constraints on this element Element idObservation.referenceRange.appliesTo.coding | ||
system | S | There are no (further) constraints on this element Element idObservation.referenceRange.appliesTo.coding.system | ||
code | S | There are no (further) constraints on this element Element idObservation.referenceRange.appliesTo.coding.code | ||
display | S | There are no (further) constraints on this element Element idObservation.referenceRange.appliesTo.coding.display | ||
text | S | There are no (further) constraints on this element Element idObservation.referenceRange.appliesTo.text | ||
text | S | There are no (further) constraints on this element Element idObservation.referenceRange.text | ||
hasMember | There are no (further) constraints on this element Element idObservation.hasMember Usage Note: This is not in scope for OLIS; this is in scope for IPS Usage: PSS: Looked at an example to see if this is used (OBX-4 relationship) and cannot determine this relationship When using this element, an observation will typically have either a value or a set of related resources, although both may be present in some cases. For a discussion on the ways Observations can assembled in groups together, see Notes below. Note that a system may calculate results from QuestionnaireResponse into a final score and represent the score as an Observation. | |||
derivedFrom | There are no (further) constraints on this element Element idObservation.derivedFrom Usage Note: This may be considered for future use as it is rare that a physician/EMR would link observations back to the original document. All the reference choices that are listed in this element can represent clinical observations and other measurements that may be the source for a derived value. The most common reference will be another Observation. For a discussion on the ways Observations can assembled in groups together, see Notes below. | |||
component | S | There are no (further) constraints on this element Element idObservation.component Discussion required: May be some linking in MedAccess. For a discussion on the ways Observations can be assembled in groups together see Notes below. | ||
code | S | There are no (further) constraints on this element Element idObservation.component.code Example from MA: <OBX.3> <CE.1>6690-2</CE.1> <CE.2>WBC</CE.2> <CE.3/> <CE.4/> <CE.5/> <CE.6/> </OBX.3> All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. | ||
coding | S | ..1 | There are no (further) constraints on this element Element idObservation.component.code.coding | |
system | S | 1.. | There are no (further) constraints on this element Element idObservation.component.code.coding.system | |
code | S | 1.. | There are no (further) constraints on this element Element idObservation.component.code.coding.code | |
display | S | There are no (further) constraints on this element Element idObservation.component.code.coding.display | ||
text | S | There are no (further) constraints on this element Element idObservation.component.code.text Conformance: This must be present when known Very often the text is the same as a displayName of one of the codings. | ||
interpretation | S | There are no (further) constraints on this element Element idObservation.component.interpretation | ||
coding | S | There are no (further) constraints on this element Element idObservation.component.interpretation.coding | ||
text | S | There are no (further) constraints on this element Element idObservation.component.interpretation.text | ||
referenceRange | S | see (referenceRange) | There are no (further) constraints on this element Element idObservation.component.referenceRange MA: Display range, lower range, upper range. What is the display range? Do we share this? If YES we need an extension. Definitiion: the range that you want to set as a ideal/base reference Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties. | |
low | S | There are no (further) constraints on this element Element idObservation.component.referenceRange.low | ||
high | S | There are no (further) constraints on this element Element idObservation.component.referenceRange.high | ||
text | S | There are no (further) constraints on this element Element idObservation.component.referenceRange.text MA: Andrew, do we support this? Note that FHIR strings SHALL NOT exceed 1MB in size |