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.request only for some types of bundles bdl-4: entry.response only for some types of bundles |
  id | Σ I | 0..1 | id | Logical id of this artifact ele-1: All FHIR elements must have a @value or children |
| meta | Σ I | 0..1 | Meta | Metadata about the resource ele-1: All FHIR elements must have a @value or children |
| implicitRules | ?! ΣI | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| language | I | 0..1 | code | Language of the resource content Binding: http://tools.ietf.org/html/bcp47 (required) ele-1: All FHIR elements must have a @value or children |
| type | S ΣI | 1..1 | code | Collection Binding: http://hl7.org/fhir/ValueSet/bundle-type (required) ele-1: All FHIR elements must have a @value or children Fixed Value: collection |
| total | Σ I | 0..1 | unsignedInt | If search, the total number of matches ele-1: All FHIR elements must have a @value or children |
 link (link) | Σ I | 0..* | BackboneElement | Links related to this Bundle ele-1: All FHIR elements must have a @value or children |
 id | I | 0..1 | id | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
 extension | I | 0..* | Extension | Additional Content defined by implementations ele-1: All FHIR elements must have a @value or children |
| modifierExtension | ?! I | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children |
| relation | Σ I | 1..1 | string | http://www.iana.org/assignments/link-relations/link-relations.xhtml ele-1: All FHIR elements must have a @value or children |
 url | Σ I | 1..1 | uri | Reference details for the link ele-1: All FHIR elements must have a @value or children |
| entry | S ΣI | 0..* | BackboneElement | Entry in the bundle - will have a resource, or information ele-1: All FHIR elements must have a @value or children bdl-5: must be a resource unless there's a request or response bdl-6: The fullUrl element must be present when a resource is present, and not present otherwise |
| id | I | 0..1 | id | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| extension | I | 0..* | Extension | Additional Content defined by implementations ele-1: All FHIR elements must have a @value or children |
| modifierExtension | ?! I | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children |
| link | Σ | 0..* | Links related to this entry | |
| fullUrl | Σ I | 0..1 | uri | Absolute URL for resource (server address, or UUID/OID) ele-1: All FHIR elements must have a @value or children |
 resource | S ΣI | 1..* | InspqCondition | Considération spéciale dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative |
| id | Σ I | 0..1 | id | Logical id of this artifact ele-1: All FHIR elements must have a @value or children |
| meta | Σ I | 0..1 | Meta | Metadata about the resource ele-1: All FHIR elements must have a @value or children |
| implicitRules | ?! ΣI | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| language | I | 0..1 | code | Language of the resource content Binding: http://tools.ietf.org/html/bcp47 (required) ele-1: All FHIR elements must have a @value or children |
| search | Σ I | 0..1 | BackboneElement | Search related information ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | id | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| extension | I | 0..* | Extension | Additional Content defined by implementations ele-1: All FHIR elements must have a @value or children |
| modifierExtension | ?! I | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children |
| mode | Σ I | 0..1 | code | match | include | outcome - why this is in the result set Binding: http://hl7.org/fhir/ValueSet/search-entry-mode (required) ele-1: All FHIR elements must have a @value or children |
| score | Σ I | 0..1 | decimal | Search ranking (between 0 and 1) ele-1: All FHIR elements must have a @value or children |
| request | Σ I | 0..1 | BackboneElement | Transaction Related Information ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | id | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| extension | I | 0..* | Extension | Additional Content defined by implementations ele-1: All FHIR elements must have a @value or children |
| modifierExtension | ?! I | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children |
| method | Σ I | 1..1 | code | GET | POST | PUT | DELETE Binding: http://hl7.org/fhir/ValueSet/http-verb (required) ele-1: All FHIR elements must have a @value or children |
| url | Σ I | 1..1 | uri | URL for HTTP equivalent of this entry ele-1: All FHIR elements must have a @value or children |
| ifNoneMatch | Σ I | 0..1 | string | For managing cache currency ele-1: All FHIR elements must have a @value or children |
| ifModifiedSince | Σ I | 0..1 | instant | For managing update contention ele-1: All FHIR elements must have a @value or children |
| ifMatch | Σ I | 0..1 | string | For managing update contention ele-1: All FHIR elements must have a @value or children |
| ifNoneExist | Σ I | 0..1 | string | For conditional creates ele-1: All FHIR elements must have a @value or children |
| response | Σ I | 0..1 | BackboneElement | Transaction Related Information ele-1: All FHIR elements must have a @value or children |
 id | I | 0..1 | id | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| extension | I | 0..* | Extension | Additional Content defined by implementations ele-1: All FHIR elements must have a @value or children |
| modifierExtension | ?! I | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children |
| status | Σ I | 1..1 | string | Status return code for entry ele-1: All FHIR elements must have a @value or children |
| location | Σ I | 0..1 | uri | The location, if the operation returns a location ele-1: All FHIR elements must have a @value or children |
| etag | Σ I | 0..1 | string | The etag for the resource (if relevant) ele-1: All FHIR elements must have a @value or children |
| lastModified | Σ I | 0..1 | instant | Server's date time modified ele-1: All FHIR elements must have a @value or children |
| signature | Σ I | 0..1 | Signature | Digital Signature ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | id | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| extension | I | 0..* | Extension | Additional Content defined by implementations ele-1: All FHIR elements must have a @value or children |
| type | Σ I | 1..* | Coding | Indication of the reason the entity signed the object(s) Binding: http://hl7.org/fhir/ValueSet/signature-type (preferred) ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | id | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| extension | I | 0..* | Extension | Additional Content defined by implementations ele-1: All FHIR elements must have a @value or children |
| system | Σ I | 0..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children |
| version | Σ I | 0..1 | string | Version of the system - if relevant ele-1: All FHIR elements must have a @value or children |
| code | Σ I | 0..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
| display | Σ I | 0..1 | string | Representation defined by the system ele-1: All FHIR elements must have a @value or children |
| userSelected | Σ I | 0..1 | boolean | If this coding was chosen directly by the user ele-1: All FHIR elements must have a @value or children |
| when | Σ I | 1..1 | instant | When the signature was created ele-1: All FHIR elements must have a @value or children |
 who[x] | Σ I | 1..1 | Reference(Practitioner | RelatedPerson | Patient | Device | Organization), uri | Who signed the signature ele-1: All FHIR elements must have a @value or children |
| contentType | Σ I | 1..1 | code | The technical format of the signature Binding: http://www.rfc-editor.org/bcp/bcp13.txt (required) ele-1: All FHIR elements must have a @value or children |
| blob | Σ I | 1..1 | base64Binary | The actual signature content (XML DigSig. JWT, picture, etc.) ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||