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.
-
FHIR
Get this resource using a FHIR client.
-
Embed
Embed this resource in your own website. How?
-
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.
RiskAssessment
Base StructureDefinition for RiskAssessment Resource
- type Profile on RiskAssessment
- 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
RiskAssessment | C | DomainResource | Element idRiskAssessmentShort description Potential outcomes for a subject with likelihood Alternate namesPrognosis DefinitionAn assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome.
| |||
id | Σ | 0..1 | id | There are no (further) constraints on this element Element idRiskAssessment.idShort description 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 idRiskAssessment.metaShort description Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. | ||
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idRiskAssessment.implicitRulesShort description 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. 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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. | ||
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idRiskAssessment.languageShort description 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. http://hl7.org/fhir/ValueSet/languages (extensible) Binding extensions
| |||
text | C | 0..1 | Narrative | There are no (further) constraints on this element Element idRiskAssessment.textShort description 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 may 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 in formation is added later. The cardinality or value of this element may be affected by these constraints: dom-1 Mappings
| ||
contained | 0..* | Resource | There are no (further) constraints on this element Element idRiskAssessment.containedShort description 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.
| |||
extension | 0..* | Extension | There are no (further) constraints on this element Element idRiskAssessment.extensionShort description 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. 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
| |||
modifierExtension | ?! | 0..* | Extension | There are no (further) constraints on this element Element idRiskAssessment.modifierExtensionShort description 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. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for 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 Mappings
| ||
identifier | Σ | 0..1 | Identifier | Element idRiskAssessment.identifierShort description Unique identifier for the assessment DefinitionBusiness identifier assigned to the risk assessment. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
basedOn | C | 0..1 | Reference(Resource) | Element idRiskAssessment.basedOnShort description Request fulfilled by this assessment DefinitionA reference to the request that is fulfilled by this risk assessment. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
parent | C | 0..1 | Reference(Resource) | Element idRiskAssessment.parentShort description Part of this occurrence DefinitionA reference to a resource that this risk assessment is part of, such as a Procedure. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
status | 1..1 | codeBinding | Element idRiskAssessment.statusShort description registered | preliminary | final | amended + DefinitionThe status of the RiskAssessment, using the same statuses as an Observation. The status of the risk assessment; e.g. preliminary, final, amended, etc. http://hl7.org/fhir/ValueSet/observation-status (required) Constraints
| |||
method | Σ | 0..1 | CodeableConcept | Element idRiskAssessment.methodShort description Evaluation mechanism DefinitionThe algorithm, process or mechanism used to evaluate the risk. The method can influence the results of the assessment. 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. The mechanism or algorithm used to make the assessment; e.g. TIMI, PRISM, Cardiff Type 2 diabetes, etc. ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
code | Σ | 0..1 | CodeableConcept | Element idRiskAssessment.codeShort description Type of assessment DefinitionThe type of the risk assessment performed. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
subject | Σ C | 0..1 | Reference(Patient | Group) | Element idRiskAssessment.subjectShort description Who/what does assessment apply to? DefinitionThe patient or group the risk assessment applies 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
context | Σ C | 0..1 | Reference(Encounter | EpisodeOfCare) | Element idRiskAssessment.contextShort description Where was assessment performed? DefinitionThe encounter where the assessment was performed. 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(Encounter | EpisodeOfCare) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
occurrence[x] | Σ | 0..1 | Element idRiskAssessment.occurrence[x]Short description When was assessment made? DefinitionThe date (and possibly time) the risk assessment was performed. The assessment results lose validity the more time elapses from when they are first made. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
occurrenceDateTime | dateTime | Data type | ||||
occurrencePeriod | Period | Data type | ||||
condition | Σ C | 0..1 | Reference(Condition) | Element idRiskAssessment.conditionShort description Condition assessed DefinitionFor assessments or prognosis specific to a particular condition, indicates the condition being assessed. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
performer | Σ C | 0..1 | Reference(Practitioner | Device) | Element idRiskAssessment.performerShort description Who did assessment? DefinitionThe provider or software application that performed the assessment. 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(Practitioner | Device) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
reason[x] | 0..1 | Element idRiskAssessment.reason[x]Short description Why the assessment was necessary? DefinitionThe reason the risk assessment was performed. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
reasonCodeableConcept | CodeableConcept | Data type | ||||
reasonReference | Reference(Resource) | Data type | ||||
basis | C | 0..* | Reference(Resource) | Element idRiskAssessment.basisShort description Information used in assessment DefinitionIndicates the source data considered as part of the assessment (FamilyHistory, Observations, Procedures, Conditions, etc.). 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
prediction | C | 0..* | BackboneElement | Element idRiskAssessment.predictionShort description Outcome predicted DefinitionDescribes the expected outcome for the subject. Multiple repetitions can be used to identify the same type of outcome in different timeframes as well as different types of outcomes. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | string | There are no (further) constraints on this element Element idRiskAssessment.prediction.idShort description 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 idRiskAssessment.prediction.extensionShort description 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
| |||
modifierExtension | Σ ?! | 0..* | Extension | There are no (further) constraints on this element Element idRiskAssessment.prediction.modifierExtensionShort description Extensions that cannot be ignored 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 that contains it. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for 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.
| ||
outcome | 1..1 | CodeableConcept | Element idRiskAssessment.prediction.outcomeShort description Possible outcome for the subject DefinitionOne of the potential outcomes for the patient (e.g. remission, death, a particular condition). 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. The condition or other outcome; e.g. death, remission, amputation, infection, etc. ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
probability[x] | C | 0..1 | Element idRiskAssessment.prediction.probability[x]Short description Likelihood of specified outcome DefinitionHow likely is the outcome (in the specified timeframe). If range is used, it represents the lower and upper bounds of certainty; e.g. 40-60% Decimal values are expressed as percentages as well (max = 100). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
probabilityDecimal | decimal | Data type | ||||
probabilityRange | Range | Data type | ||||
qualitativeRisk | 0..1 | CodeableConcept | Element idRiskAssessment.prediction.qualitativeRiskShort description Likelihood of specified outcome as a qualitative value DefinitionHow likely is the outcome (in the specified timeframe), expressed as a qualitative value (e.g. low, medium, high). 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. The likelihood of the occurrence of a specified outcome http://hl7.org/fhir/ValueSet/risk-probability (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
relativeRisk | 0..1 | decimal | Element idRiskAssessment.prediction.relativeRiskShort description Relative likelihood DefinitionIndicates the risk for this particular subject (with their specific characteristics) divided by the risk of the population in general. (Numbers greater than 1 = higher risk than the population, numbers less than 1 = lower risk.). Absolute risk is less meaningful than relative risk. Do not use a IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger)
| |||
when[x] | 0..1 | Element idRiskAssessment.prediction.when[x]Short description Timeframe or age range DefinitionIndicates the period of time or age range of the subject to which the specified probability applies. If not specified, the risk applies "over the subject's lifespan". The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||||
whenPeriod | Period | Data type | ||||
whenRange | Range | Data type | ||||
rationale | 0..1 | string | Element idRiskAssessment.prediction.rationaleShort description Explanation of prediction DefinitionAdditional information explaining the basis for the prediction. Note that FHIR strings may not exceed 1MB in size
| |||
mitigation | 0..1 | string | Element idRiskAssessment.mitigationShort description How to reduce risk DefinitionA description of the steps that might be taken to reduce the identified risk(s). One of the main reasons for assessing risks is to identify whether interventional steps are needed to reduce risk. Note that FHIR strings may not exceed 1MB in size
| |||
comment | 0..1 | string | Element idRiskAssessment.commentShort description Comments on the risk assessment DefinitionAdditional comments about the risk assessment. Note that FHIR strings may not exceed 1MB in size
|