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.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Bundle | Σ I | 0..* | Resource | Contains a collection of resources bdl-2: entry.search only when a search bdl-1: total only when a search or history bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId bdl-3: entry.transaction when (and only when) a transaction bdl-4: entry.transactionResponse when (and only when) a transaction-response |
  id | Σ | 0..1 | id | Logical id of this artifact |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?! Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: http://tools.ietf.org/html/bcp47 (required) | |
| type | Σ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: http://hl7.org/fhir/ValueSet/bundle-type (required) |
| total | Σ I | 0..1 | unsignedInt | If search, the total number of matches |
 link (link) | Σ | 0..* | BackboneElement | Links related to this Bundle |
 id | 0..1 | id | xml:id (or equivalent in JSON) | |
 extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| relation | Σ | 1..1 | string | http://www.iana.org/assignments/link-relations/link-relations.xhtml |
 url | Σ | 1..1 | uri | Reference details for the link |
| entry | Σ I | 0..* | BackboneElement | Entry in the bundle - will have a resource, or information bdl-5: must be a resource unless there's a transaction or transaction response bdl-6: The fullUrl element must be present when a resource is present, and not present otherwise |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| link | Σ | 0..* | Links related to this entry | |
| fullUrl | Σ | 0..1 | uri | Absolute URL for resource (server address, or UUID/OID) |
| resource | Σ | 0..1 | Resource | A resource in the bundle |
| search | Σ I | 0..1 | BackboneElement | Search related information |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| mode | Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: http://hl7.org/fhir/ValueSet/search-entry-mode (required) |
| score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) |
| request | Σ I | 0..1 | BackboneElement | Transaction Related Information |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| method | Σ | 1..1 | code | GET | POST | PUT | DELETE Binding: http://hl7.org/fhir/ValueSet/http-verb (required) |
| url | Σ | 1..1 | uri | URL for HTTP equivalent of this entry |
| ifNoneMatch | Σ | 0..1 | string | For managing cache currency |
| ifModifiedSince | Σ | 0..1 | instant | For managing update contention |
| ifMatch | Σ | 0..1 | string | For managing update contention |
| ifNoneExist | Σ | 0..1 | string | For conditional creates |
| response | Σ I | 0..1 | BackboneElement | Transaction Related Information |
 id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | Σ | 1..1 | string | Status return code for entry |
| location | Σ | 0..1 | uri | The location, if the operation returns a location |
| etag | Σ | 0..1 | string | The etag for the resource (if relevant) |
| lastModified | Σ | 0..1 | instant | Server's date time modified |
| signature | Σ | 0..1 | Signature | Digital Signature |
| Documentation for this format | ||||