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.
StructureDefinition
Base StructureDefinition for StructureDefinition Resource
- type Profile on StructureDefinition
- FHIR STU3
- status Retired
-
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
You're probably missing a package or made a typo in your canonical.
- Could not resolve: http://hl7.org/fhir/StructureDefinition/DomainResource
StructureDefinition | C | http://hl7.org/fhir/StructureDefinition/DomainResource | There are no (further) constraints on this element Element idStructureDefinitionShort description Structural Definition Alternate namesTemplate, Profile DefinitionA definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types. http://hl7.org/fhir/StructureDefinition/DomainResource Constraints
| |
url | Σ | 1..1 | uri | There are no (further) constraints on this element Element idStructureDefinition.urlShort description Logical URI to reference this structure definition (globally unique) Alternate namesurl, authoritative-url, destination, identity DefinitionAn absolute URI that is used to identify this structure definition 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 structure definition is (or will be) published. The URL SHOULD include the major version of the structure definition. For more information see Technical and Business Versions. Allows the structure 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. uri Mappings
|
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idStructureDefinition.identifierShort description Additional identifier for the structure definition DefinitionA formal identifier that is used to identify this structure definition when it is represented in other formats, or referenced in a specification, model, design or an instance. Allows externally provided and/or usable business identifiers to be easily associated with the module. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, e.g., to identify this structure definition outside of FHIR, where it is not possible to use the logical URI. Identifier Mappings
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idStructureDefinition.versionShort description Business version of the structure definition DefinitionThe identifier that is used to identify this version of the structure definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the structure 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 structure definition 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 structure definition with the format [url]|[version]. string Mappings
|
name | Σ | 1..1 | string | There are no (further) constraints on this element Element idStructureDefinition.nameShort description Name for this structure definition (computer friendly) DefinitionA natural language name identifying the structure 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 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 idStructureDefinition.titleShort description Name for this structure definition (human friendly) DefinitionA short, descriptive, user-friendly title for the structure definition. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. Applications don't have to use this name, but can always fall back to it. The title also corresponds to the label for the root element. string |
status | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idStructureDefinition.statusShort description draft | active | retired | unknown DefinitionThe status of this structure definition. Enables tracking the life-cycle of the content. Allows filtering of structure definitions that are appropriate for use vs. not. code BindingThe lifecycle status of a Value Set or Concept Map. http://hl7.org/fhir/ValueSet/publication-status (required) Mappings
|
experimental | Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element idStructureDefinition.experimentalShort description For testing purposes, not real usage DefinitionA boolean value to indicate that this structure 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 structure definition. Allows filtering of structure definition that are appropriate for use vs. not. This is labeled as "Is Modifier" because applications should not use an experimental structure definition in production. boolean Mappings
|
date | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element idStructureDefinition.dateShort description Date this was last changed Alternate namesRevision Date DefinitionThe date (and optionally time) when the structure definition 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 structure 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 structure definition. 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 idStructureDefinition.publisherShort description Name of the publisher (organization or individual) DefinitionThe name of the individual or organization that published the structure definition. Helps establish the "authority/credibility" of the structure definition. May also allow for contact. Usually an organization, but may be an individual. The publisher (or steward) of the structure definition is the organization or individual primarily responsible for the maintenance and upkeep of the structure 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 structure definition. 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 idStructureDefinition.contactShort description 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 |
description | 0..1 | markdown | There are no (further) constraints on this element Element idStructureDefinition.descriptionShort description Natural language description of the structure definition DefinitionA free text natural language description of the structure definition from a consumer's perspective. This description can be used to capture details such as why the structure 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 structure 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 profile is presumed to be the predominant language in the place the profile was created). markdown | |
useContext | Σ | 0..* | UsageContext | There are no (further) constraints on this element Element idStructureDefinition.useContextShort description 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 structure definition 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 idStructureDefinition.jurisdictionShort description Intended jurisdiction for structure definition (if applicable) DefinitionA legal or geographic region in which the structure definition is intended to be used. It may be possible for the structure definition 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 |
purpose | 0..1 | markdown | There are no (further) constraints on this element Element idStructureDefinition.purposeShort description Why this structure definition is defined DefinitionExplaination of why this structure definition is needed and why it has been designed as it has. This element does not describe the usage of the structure 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 structure definition. markdown Mappings
| |
copyright | 0..1 | markdown | There are no (further) constraints on this element Element idStructureDefinition.copyrightShort description Use and/or publishing restrictions Alternate namesLicense, Restrictions DefinitionA copyright statement relating to the structure definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the structure definition. Consumers must be able to determine any legal restrictions on the use of the structure definition and/or its content. markdown Mappings
| |
keyword | Σ | 0..* | Coding | There are no (further) constraints on this element Element idStructureDefinition.keywordShort description Assist with indexing and finding DefinitionA set of key words or terms from external terminologies that may be used to assist with indexing and searching of templates. Assist in searching for appropriate StructureDefinitions. Coding BindingCodes for the meaning of the defined structure (SNOMED CT and LOINC codes, as an example). http://hl7.org/fhir/ValueSet/profile-code (example) Mappings
|
fhirVersion | Σ | 0..1 | id | There are no (further) constraints on this element Element idStructureDefinition.fhirVersionShort description FHIR Version this StructureDefinition targets DefinitionThe version of the FHIR specification on which this StructureDefinition is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 3.0.1 for this version. A StructureDefinition does not need to specify the target it applies to,as StructureDefinitions will often be valid across multiple versions of FHIR. FHIR tooling can determine whether a StructureDefinition is consistent with a particular StructureDefinition if desired. id |
mapping | C | 0..* | BackboneElement | There are no (further) constraints on this element Element idStructureDefinition.mappingShort description External specification that the content is mapped to DefinitionAn external specification that the content is mapped to. BackboneElement Constraints
|
identity | 1..1 | id | There are no (further) constraints on this element Element idStructureDefinition.mapping.identityShort description Internal id when this mapping is used DefinitionAn Internal id that is used to identify this mapping set when specific mappings are made. The specification is described once, with general comments, and then specific mappings are made that reference this declaration. id | |
uri | C | 0..1 | uri | There are no (further) constraints on this element Element idStructureDefinition.mapping.uriShort description Identifies what this mapping refers to DefinitionAn absolute URI that identifies the specification that this mapping is expressed to. A formal identity for the specification being mapped to helps with identifying maps consistently. uri ConditionsThe cardinality or value of this element may be affected by these constraints: sdf-2 |
name | C | 0..1 | string | There are no (further) constraints on this element Element idStructureDefinition.mapping.nameShort description Names what this mapping refers to DefinitionA name for the specification that is being mapped to. string ConditionsThe cardinality or value of this element may be affected by these constraints: sdf-2 |
comment | 0..1 | string | There are no (further) constraints on this element Element idStructureDefinition.mapping.commentShort description Versions, Issues, Scope limitations etc. DefinitionComments about this mapping, including version notes, issues, scope limitations, and other important notes for usage. string | |
kind | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element idStructureDefinition.kindShort description primitive-type | complex-type | resource | logical DefinitionDefines the kind of structure that this definition is describing. code BindingDefines the type of structure that a definition is describing. http://hl7.org/fhir/ValueSet/structure-definition-kind (required) |
abstract | Σ | 1..1 | boolean | There are no (further) constraints on this element Element idStructureDefinition.abstractShort description Whether the structure is abstract DefinitionWhether structure this definition describes is abstract or not - that is, whether the structure is not intended to be instantiated. For Resources and Data types, abstract types will never be exchanged between systems. Abstract Resources cannot be instantiated - a concrete sub-type must be used. Abstract datatypes and extensions cannot be used in an instance. For logical models, the exact implication of "abstract" will rest with the author, depending how the logical model is used. Flagging a constraint structure as abstract conveys design intent but makes no difference to how the structure definition is handled. Note that inline declared elements that are given the type "Element" in the profile, but have children described, are anonymous concrete types that specialise Element. boolean |
contextType | Σ C | 0..1 | codeBinding | There are no (further) constraints on this element Element idStructureDefinition.contextTypeShort description resource | datatype | extension DefinitionIf this is an extension, Identifies the context within FHIR resources where the extension can be used. code BindingHow an extension context is interpreted. http://hl7.org/fhir/ValueSet/extension-context (required) ConditionsThe cardinality or value of this element may be affected by these constraints: sdf-5 |
context | Σ C | 0..* | string | There are no (further) constraints on this element Element idStructureDefinition.contextShort description Where the extension can be used in instances DefinitionIdentifies the types of resource or data type elements to which the extension can be applied. If the context is an element that can have multiple types, then use (e.g.) value[x] if the extension works on all choice types, or otherwise an enumeration of explicitly named elements if not. Note that a context of "string" doesn't mean that the extension can be used with one of the string patterns such as "id" etc. string ConditionsThe cardinality or value of this element may be affected by these constraints: sdf-5 |
contextInvariant | Σ C | 0..* | string | There are no (further) constraints on this element Element idStructureDefinition.contextInvariantShort description FHIRPath invariants - when the extension can be used DefinitionA set of rules as Fluent Invariants about when the extension can be used (e.g. co-occurrence variants for the extension). All the rules must be true. When evaluating the invariant, the fluentpath focus is the element that holds the extension, and %extension refers to the extension itself. string ConditionsThe cardinality or value of this element may be affected by these constraints: sdf-18 |
type | Σ C | 1..1 | codeBinding | There are no (further) constraints on this element Element idStructureDefinition.typeShort description Type defined or constrained by this structure DefinitionThe type this structure describes. If the derivation kind is 'specialization' then this is the master definition for a type, and there is always one of these (a data type, an extension, a resource, including abstract ones). Otherwise the structure definition is a constraint on the stated type (and in this case, the type cannot be an abstract type). Note that in the case of constraints, the type could be determined by chasing through the baseDefinition references until a concrete structure (derivation = specialization) is reached, or by looking at the path of the first element in the snapshot - if present - but providing the type directly makes for simpler tooling and indexing. code BindingEither a resource or a data type, including logical model types http://hl7.org/fhir/ValueSet/defined-types (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: sdf-4, sdf-11 |
baseDefinition | Σ C | 0..1 | uri | There are no (further) constraints on this element Element idStructureDefinition.baseDefinitionShort description Definition that this type is constrained/specialized from DefinitionAn absolute URI that is the base structure from which this type is derived, either by specialization or constraint. If differential constraints are specified in this structure, they are applied to the base in a "differential" fashion. If there is no base, then the differential constraints cannot be provided (snapshot only). Differential structures are useful for the editing perspective, and snapshot structures are suitable for operational use. The FHIR Project provides a number of tools/services to populate snapshots from differential constraints. Logical Models have a base of "Element" or another logical model. uri ConditionsThe cardinality or value of this element may be affected by these constraints: sdf-4 |
derivation | Σ C | 0..1 | codeBinding | There are no (further) constraints on this element Element idStructureDefinition.derivationShort description specialization | constraint - How relates to base definition DefinitionHow the type relates to the baseDefinition. If the definition is a specialization, then it adds new elements in the differential, and the snapshot includes the inherited elements. If the definition is a constraint, then it can not define new elements, it can only make new rules about existing content (see Profiling Resources). code BindingHow a type relates to its baseDefinition. http://hl7.org/fhir/ValueSet/type-derivation-rule (required) ConditionsThe cardinality or value of this element may be affected by these constraints: sdf-12 |
snapshot | C | 0..1 | BackboneElement | There are no (further) constraints on this element Element idStructureDefinition.snapshotShort description Snapshot view of the structure DefinitionA snapshot view is expressed in a stand alone form that can be used and interpreted without considering the base StructureDefinition. BackboneElement ConditionsThe cardinality or value of this element may be affected by these constraints: sdf-6 Constraints
|
element | C | 1..* | ElementDefinition | There are no (further) constraints on this element Element idStructureDefinition.snapshot.elementShort description Definition of elements in the resource (if no StructureDefinition) DefinitionCaptures constraints on each element within the resource. ElementDefinition ConditionsThe cardinality or value of this element may be affected by these constraints: sdf-3 Mappings
|
differential | C | 0..1 | BackboneElement | There are no (further) constraints on this element Element idStructureDefinition.differentialShort description Differential view of the structure DefinitionA differential view is expressed relative to the base StructureDefinition - a statement of differences that it applies. BackboneElement ConditionsThe cardinality or value of this element may be affected by these constraints: sdf-6 Constraints
|
element | 1..* | ElementDefinition | There are no (further) constraints on this element Element idStructureDefinition.differential.elementShort description Definition of elements in the resource (if no StructureDefinition) DefinitionCaptures constraints on each element within the resource. ElementDefinition Mappings
|