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 Cambio R4
OperationDefinitionLinkToHealthIssue
This profile is intended to define the operation '$LinkToHealthIssue', which is used to link a QuestionnaireResponse to a ConditionHealthIssueSe.
- type Profile on OperationDefinition
- FHIR R4
- status Active
-
version1.0.0
Missing canonical claim
The canonical from this resource does not match any claims.
Canonical claims are used to verify ownership of your canonical URLs.
Canonical
| OperationDefinitionLinkToHealthIssue (OperationDefinition) | I | OperationDefinition | Element idOperationDefinition Definition of the operation '$LinkToConditionHealthIssueSe' DefinitionA formal computable definition of the operation '$LinkToConditionHealthIssueSe' designed to link a QuestionnaireResponse and a ConditionHealthIssueSe.
| |
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idOperationDefinition.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 idOperationDefinition.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 idOperationDefinition.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 idOperationDefinition.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 idOperationDefinition.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 idOperationDefinition.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 idOperationDefinition.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.
|
| modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idOperationDefinition.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.
|
| url | Σ | 0..0 | uri | There are no (further) constraints on this element Element idOperationDefinition.url Canonical identifier for this operation definition, represented as a URI (globally unique) DefinitionAn absolute URI that is used to identify this operation definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this operation definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the operation definition is stored on different servers. Allows the operation definition to be referenced by a single globally unique identifier. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions. In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.
|
| version | Σ | 0..0 | string | There are no (further) constraints on this element Element idOperationDefinition.version Business version of the operation definition DefinitionThe identifier that is used to identify this version of the operation definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the operation definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. There may be different operation definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the operation definition with the format [url]|[version].
|
| name | Σ I | 1..1 | stringFixed Value | Element idOperationDefinition.name Name for this operation definition (computer friendly) DefinitionA natural language name identifying the operation definition. This name should be usable as an identifier for the module by machine processing applications such as code generation. Support human navigation and code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.
LinkToHealthIssue
|
| title | Σ | 0..0 | string | There are no (further) constraints on this element Element idOperationDefinition.title Name for this operation definition (human friendly) DefinitionA short, descriptive, user-friendly title for the operation definition. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
|
| status | Σ ?! | 1..1 | codeBindingFixed Value | Element idOperationDefinition.status draft | active | retired | unknown DefinitionThe status of this operation definition. Enables tracking the life-cycle of the content. Allows filtering of operation definitions that are appropriate for use versus not. The lifecycle status of an artifact.
active
|
| kind | Σ | 1..1 | codeBindingFixed Value | Element idOperationDefinition.kind operation | query DefinitionWhether this is an operation or a named query. Named queries are invoked differently, and have different capabilities. Whether an operation is a normal operation or a query.
operation
|
| experimental | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idOperationDefinition.experimental For testing purposes, not real usage DefinitionA Boolean value to indicate that this operation definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Enables experimental content to be developed following the same lifecycle that would be used for a production-level operation definition. Allows filtering of operation definitions that are appropriate for use versus not.
|
| date | Σ | 0..0 | dateTime | There are no (further) constraints on this element Element idOperationDefinition.date Date last changed Alternate namesRevision Date DefinitionThe date (and optionally time) when the operation definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the operation definition changes. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the operation definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
|
| publisher | Σ | 0..0 | string | There are no (further) constraints on this element Element idOperationDefinition.publisher Name of the publisher (organization or individual) DefinitionThe name of the organization or individual that published the operation definition. Helps establish the "authority/credibility" of the operation definition. May also allow for contact. Usually an organization but may be an individual. The publisher (or steward) of the operation definition is the organization or individual primarily responsible for the maintenance and upkeep of the operation definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the operation definition. This item SHOULD be populated unless the information is available from context.
|
| contact | Σ | 0..0 | ContactDetail | There are no (further) constraints on this element Element idOperationDefinition.contact Contact details for the publisher DefinitionContact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
|
| description | 0..0 | markdown | There are no (further) constraints on this element Element idOperationDefinition.description Natural language description of the operation definition DefinitionA free text natural language description of the operation definition from a consumer's perspective. This description can be used to capture details such as why the operation definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the operation definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the operation definition is presumed to be the predominant language in the place the operation definition was created).
| |
| useContext | Σ | 0..0 | UsageContext | There are no (further) constraints on this element Element idOperationDefinition.useContext The context that the content is intended to support DefinitionThe content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate operation definition instances. Assist in searching for appropriate content. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
|
| jurisdiction | Σ | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idOperationDefinition.jurisdiction Intended jurisdiction for operation definition (if applicable) DefinitionA legal or geographic region in which the operation definition is intended to be used. It may be possible for the operation definition to be used in jurisdictions other than those for which it was originally designed or intended. Countries and regions within which this artifact is targeted for use.
|
| purpose | 0..0 | markdown | There are no (further) constraints on this element Element idOperationDefinition.purpose Why this operation definition is defined DefinitionExplanation of why this operation definition is needed and why it has been designed as it has. This element does not describe the usage of the operation definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this operation definition.
| |
| affectsState | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idOperationDefinition.affectsState Whether content is changed by the operation DefinitionWhether the operation affects state. Side effects such as producing audit trail entries do not count as 'affecting state'. What http methods can be used for the operation depends on the .affectsState value and whether the input parameters are primitive or complex:
|
| code | Σ | 1..1 | codeFixed Value | Element idOperationDefinition.code Name used to invoke the operation DefinitionThe name used to invoke the operation.
linkToHealthIssue |
| comment | 0..0 | markdown | There are no (further) constraints on this element Element idOperationDefinition.comment Additional information about use DefinitionAdditional information about how to use this operation or named query.
| |
| base | Σ | 0..0 | canonical(OperationDefinition) | There are no (further) constraints on this element Element idOperationDefinition.base Marks this as a profile of the base DefinitionIndicates that this operation definition is a constraining profile on the base. A constrained profile can make optional parameters required or not used and clarify documentation. canonical(OperationDefinition) Constraints
|
| resource | Σ | 0..0 | codeBinding | There are no (further) constraints on this element Element idOperationDefinition.resource Types this operation applies to DefinitionThe types on which this operation can be executed. If the type is an abstract resource ("Resource" or "DomainResource") then the operation can be invoked on any concrete specialization. One of the resource types defined as part of this version of FHIR.
|
| system | Σ | 1..1 | booleanFixed Value | Element idOperationDefinition.system Invoke at the system level? DefinitionIndicates whether this operation or named query can be invoked at the system level (e.g. without needing to choose a resource type for the context).
false |
| type | Σ | 1..1 | booleanFixed Value | Element idOperationDefinition.type Invoke at the type level? DefinitionIndicates whether this operation or named query can be invoked at the resource type level for any given resource type level (e.g. without needing to choose a specific resource id for the context).
false |
| instance | Σ | 1..1 | booleanFixed Value | Element idOperationDefinition.instance Invoke on an instance? DefinitionIndicates whether this operation can be invoked on a particular instance of one of the given types.
true |
| inputProfile | 1..1 | canonical(https://fhir.cambio.se/StructureDefinition/ParametersHealthIssueReferenceSe) | Element idOperationDefinition.inputProfile Validation information for in parameters DefinitionAdditional validation information for the in parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource as a whole. If present the profile shall not conflict with what is specified in the parameters in the operation definition (max/min etc.), though it may provide additional constraints. The constraints expressed in the profile apply whether the operation is invoked by a POST wih parameters or not. canonical(https://fhir.cambio.se/StructureDefinition/ParametersHealthIssueReferenceSe) Constraints
| |
| outputProfile | 0..0 | canonical(StructureDefinition) | There are no (further) constraints on this element Element idOperationDefinition.outputProfile Validation information for out parameters DefinitionAdditional validation information for the out parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource. If present the profile shall not conflict with what is specified in the parameters in the operation definition (max/min etc.), though it may provide additional constraints. The constraints expressed in the profile apply whether the operation is invoked by a POST wih parameters or not. canonical(StructureDefinition) Constraints
| |
| parameter | I | 1..1 | BackboneElement | Element idOperationDefinition.parameter Parameters for the operation DefinitionThe parameters for the operation. Query Definitions only have one output parameter, named "result". This might not be described, but can be to allow a profile to be defined.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idOperationDefinition.parameter.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 idOperationDefinition.parameter.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.
|
| modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idOperationDefinition.parameter.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.
|
| name | 1..1 | codeFixed Value | Element idOperationDefinition.parameter.name Name in Parameters.parameter.name or in URL DefinitionThe name of used to identify the parameter. This name must be a token (start with a letter in a..z, and only contain letters, numerals, and underscore. Note that for search parameters (type = string, with a search type), the name may be altered by the search modifiers.
healthIssueId | |
| use | 1..1 | codeBindingFixed Value | Element idOperationDefinition.parameter.use in | out DefinitionWhether this is an input or an output parameter. If a parameter name is used for both an input and an output parameter, the parameter should be defined twice. Whether an operation parameter is an input or an output parameter.
in | |
| min | 1..1 | integerFixed Value | Element idOperationDefinition.parameter.min Minimum Cardinality DefinitionThe minimum number of times this parameter SHALL appear in the request.
1 | |
| max | 1..1 | stringFixed Value | Element idOperationDefinition.parameter.max Maximum Cardinality (a number or *) DefinitionThe maximum number of times this element is permitted to appear in the request.
1 | |
| documentation | 0..0 | string | There are no (further) constraints on this element Element idOperationDefinition.parameter.documentation Description of meaning/use DefinitionDescribes the meaning or use of this parameter.
| |
| type | I | 0..0 | codeBinding | There are no (further) constraints on this element Element idOperationDefinition.parameter.type What type this parameter has DefinitionThe type for this parameter. if there is no stated parameter, then the parameter is a multi-part parameter; type and must have at least one part defined. A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
|
| targetProfile | 0..0 | canonical(StructureDefinition) | There are no (further) constraints on this element Element idOperationDefinition.parameter.targetProfile If type is Reference | canonical, allowed targets DefinitionUsed when the type is "Reference" or "canonical", and identifies a profile structure or implementation Guide that applies to the target of the reference this parameter refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the target resource SHALL conform to at least one profile defined in the implementation guide. Often, these profiles are the base definitions from the spec (e.g. http://hl7.org/fhir/StructureDefinition/Patient). canonical(StructureDefinition) Constraints
| |
| searchType | I | 0..0 | codeBinding | There are no (further) constraints on this element Element idOperationDefinition.parameter.searchType number | date | string | token | reference | composite | quantity | uri | special DefinitionHow the parameter is understood as a search parameter. This is only used if the parameter type is 'string'. Data types allowed to be used for search parameters.
|
| binding | 0..0 | BackboneElement | There are no (further) constraints on this element Element idOperationDefinition.parameter.binding ValueSet details if this is coded DefinitionBinds to a value set if this parameter is coded (code, Coding, CodeableConcept).
| |
| referencedFrom | 0..0 | BackboneElement | There are no (further) constraints on this element Element idOperationDefinition.parameter.referencedFrom References to this parameter DefinitionIdentifies other resource parameters within the operation invocation that are expected to resolve to this resource. Resolution applies if the referenced parameter exists.
| |
| part | I | 0..0 | see (parameter) | There are no (further) constraints on this element Element idOperationDefinition.parameter.part Parts of a nested Parameter DefinitionThe parts of a nested Parameter. Query Definitions only have one output parameter, named "result". This might not be described, but can be to allow a profile to be defined.
|
| overload | 0..0 | BackboneElement | There are no (further) constraints on this element Element idOperationDefinition.overload Define overloaded variants for when generating code DefinitionDefines an appropriate combination of parameters to use when invoking this operation, to help code generators when generating overloaded parameter sets for this operation. The combinations are suggestions as to which sets of parameters to use together, but the combinations are not intended to be authoritative.
|
Last updated on