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.
MetadataResource
Base StructureDefinition for MetadataResource Resource
- type LogicalModel
- FHIR STU3
- status Maturity Level 0
-
versionnone
This resource matches a canonical claim from this project.
Claim: http://hl7.org/fhir
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/uri
- Could not resolve: http://hl7.org/fhir/StructureDefinition/string
- Could not resolve: http://hl7.org/fhir/StructureDefinition/code
- Could not resolve: http://hl7.org/fhir/StructureDefinition/boolean
- Could not resolve: http://hl7.org/fhir/StructureDefinition/dateTime
- Could not resolve: http://hl7.org/fhir/StructureDefinition/ContactDetail
- Could not resolve: http://hl7.org/fhir/StructureDefinition/UsageContext
- Could not resolve: http://hl7.org/fhir/StructureDefinition/CodeableConcept
- Could not resolve: http://hl7.org/fhir/StructureDefinition/markdown
MetadataResource | I | DomainResource | Element idMetadataResource Common Ancestor declaration for definitional resources DefinitionCommon Ancestor declaration for conformance and knowledge artifact resources.
| |
id | Σ | 0..1 | id | There are no (further) constraints on this element Element idMetadataResource.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. id |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idMetadataResource.meta 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. Meta |
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idMetadataResource.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. 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. uri |
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idMetadataResource.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). code BindingA human language. ?? (extensible) | |
text | I | 0..1 | Narrative | There are no (further) constraints on this element Element idMetadataResource.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 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. Narrative Mappings
|
contained | 0..* | Resource | There are no (further) constraints on this element Element idMetadataResource.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.
| |
extension | 0..* | Extension | There are no (further) constraints on this element Element idMetadataResource.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. 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 idMetadataResource.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. 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
|
url | Σ | 0..1 | uri | There are no (further) constraints on this element Element idMetadataResource.url Logical URI to reference this metadata resource (globally unique) DefinitionAn absolute URI that is used to identify this metadata resource when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this metadata resource is (or will be) published. The URL SHOULD include the major version of the metadata resource. For more information see Technical and Business Versions. Allows the metadata resource 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. uri Mappings
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idMetadataResource.version Business version of the metadata resource DefinitionThe identifier that is used to identify this version of the metadata resource when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the metadata resource 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 metadata resource instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a refrence to a particular business version of the metadata resource with the format [url]|[version]. string Mappings
|
name | Σ | 0..1 | string | There are no (further) constraints on this element Element idMetadataResource.name Name for this metadata resource (computer friendly) DefinitionA natural language name identifying the metadata resource. 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 alpha-numeric type name to ensure that it is computable friendly. string |
title | Σ | 0..1 | string | There are no (further) constraints on this element Element idMetadataResource.title Name for this metadata resource (human friendly) DefinitionA short, descriptive, user-friendly title for the metadata resource. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. string |
status | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idMetadataResource.status draft | active | retired | unknown DefinitionThe status of this metadata resource. Enables tracking the life-cycle of the content. Allows filtering of metadata resources that are appropriate for use vs. not. code BindingThe lifecycle status of a Value Set or Concept Map. ?? (required)Mappings
|
experimental | Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element idMetadataResource.experimental For testing purposes, not real usage DefinitionA boolean value to indicate that this metadata resource 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 metadata resource. Allows filtering of metadata resource that are appropriate for use vs. not. This is labeled as "Is Modifier" because applications should not use an experimental metadata resource in production. boolean Mappings
|
date | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element idMetadataResource.date Date this was last changed Alternate namesRevision Date DefinitionThe date (and optionally time) when the metadata resource was published. The date must change if and 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 metadata resource changes. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the metadata resource. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. dateTime Mappings
|
publisher | Σ | 0..1 | string | There are no (further) constraints on this element Element idMetadataResource.publisher Name of the publisher (organization or individual) DefinitionThe name of the individual or organization that published the metadata resource. Helps establish the "authority/credibility" of the metadata resource. May also allow for contact. Usually an organization, but may be an individual. The publisher (or steward) of the metadata resource is the organization or individual primarily responsible for the maintenance and upkeep of the metadata resource. 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 metadata resource. This item SHOULD be populated unless the information is available from context. string Mappings
|
contact | Σ | 0..* | ContactDetail | There are no (further) constraints on this element Element idMetadataResource.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. ContactDetail |
useContext | Σ | 0..* | UsageContext | There are no (further) constraints on this element Element idMetadataResource.useContext Context the content is intended to support DefinitionThe content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate metadata resource instances. Assist in searching for appropriate content. When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply. UsageContext |
jurisdiction | Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idMetadataResource.jurisdiction Intended jurisdiction for metadata resource (if applicable) DefinitionA legal or geographic region in which the metadata resource is intended to be used. It may be possible for the metadata resource to be used in jurisdictions other than those for which it was originally designed or intended. CodeableConcept BindingCountries and regions within which this artifact is targeted for use ?? (extensible) |
description | 0..1 | markdown | There are no (further) constraints on this element Element idMetadataResource.description Natural language description of the metadata resource DefinitionA free text natural language description of the metadata resource from a consumer's perspective. This description can be used to capture details such as why the metadata resource 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 metadata resource 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 profile is presumed to be the predominant language in the place the profile was created). markdown |