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.
RelatedArtifact
Base StructureDefinition for RelatedArtifact Type: Related artifacts such as additional documentation, justification, or bibliographic references.
- type Profile on RelatedArtifact
- FHIR R4
- status Draft
-
version4.0.0
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
RelatedArtifact | Element | Element idRelatedArtifactShort description Related artifacts for a knowledge resource DefinitionRelated artifacts such as additional documentation, justification, or bibliographic references. Each related artifact is either an attachment, or a reference to another knowledge resource, but not both. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
id | 0..1 | There are no (further) constraints on this element Element idRelatedArtifact.idShort description 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 | 0..* | Extension | There are no (further) constraints on this element Element idRelatedArtifact.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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Mappings
| |
type | Σ | 1..1 | codeBinding | Element idRelatedArtifact.typeShort description documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of DefinitionThe type of relationship to the related artifact. The type of relationship to the related artifact. http://hl7.org/fhir/ValueSet/related-artifact-type|4.0.0 (required) Constraints
|
label | Σ | 0..1 | string | Element idRelatedArtifact.labelShort description Short label DefinitionA short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | Σ | 0..1 | string | Element idRelatedArtifact.displayShort description Brief description of the related artifact DefinitionA brief description of the document or knowledge resource being referenced, suitable for display to a consumer. Note that FHIR strings SHALL NOT exceed 1MB in size
|
citation | Σ | 0..1 | markdown | Element idRelatedArtifact.citationShort description Bibliographic citation for the artifact DefinitionA bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format. Additional structured information about citations should be captured as extensions.
|
url | Σ | 0..1 | url | Element idRelatedArtifact.urlShort description Where the artifact can be accessed DefinitionA url for the artifact that can be followed to access the actual content. If a document or resource element is present, this element SHALL NOT be provided (use the url or reference in the Attachment or resource reference).
|
document | Σ C | 0..1 | Attachment | Element idRelatedArtifact.documentShort description What document is being referenced DefinitionThe document being referenced, represented as an attachment. This is exclusive with the resource element. When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent". The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
resource | Σ | 0..1 | canonical(http://hl7.org/fhir/StructureDefinition/Resource) | Element idRelatedArtifact.resourceShort description What resource is being referenced DefinitionThe related resource, such as a library, value set, profile, or other knowledge resource. If the type is predecessor, this is a reference to the succeeding knowledge resource. If the type is successor, this is a reference to the prior knowledge resource. canonical(http://hl7.org/fhir/StructureDefinition/Resource) Constraints
|