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 |
|---|---|---|---|---|
  Location | I | 0..* | DomainResource | Details and position information for a physical place 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 |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation ele-1: All FHIR elements must have a @value or children |
| contained | 0..* | Resource | Contained, inline Resources | |
 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 |
| identifier | Σ I | 0..* | Identifier | Unique code or number identifying the location to its users 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 |
| use | ?! ΣI | 0..1 | code | usual | official | temp | secondary (If known) Binding: http://hl7.org/fhir/ValueSet/identifier-use (required) ele-1: All FHIR elements must have a @value or children |
| type | Σ I | 0..1 | CodeableConcept | Description of identifier Binding: http://hl7.org/fhir/ValueSet/identifier-type (extensible) 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 |
| coding | Σ I | 0..* | Coding | Code defined by a terminology system 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 |
| text | Σ I | 0..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children |
| system | Σ I | 0..1 | uri | The namespace for the identifier ele-1: All FHIR elements must have a @value or children Example: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri |
| value | Σ I | 0..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example: 123456 |
| period | Σ I | 0..1 | Period | Time period when id is/was valid for use ele-1: All FHIR elements must have a @value or children per-1: If present, start SHALL have a lower value than end |
| 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 |
| start | Σ I | 0..1 | dateTime | Starting time with inclusive boundary ele-1: All FHIR elements must have a @value or children |
| end | Σ I | 0..1 | dateTime | End time with inclusive boundary, if not ongoing ele-1: All FHIR elements must have a @value or children |
 assigner | Σ I | 0..1 | Reference(Organization) | Organization that issued id (may be just text) ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a local reference if the resource is provided inline |
 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 |
| reference | Σ I | 0..1 | string | Relative, internal or absolute URL reference ele-1: All FHIR elements must have a @value or children |
| display | Σ I | 0..1 | string | Text alternative for the resource ele-1: All FHIR elements must have a @value or children |
| status | ?! ΣI | 0..1 | code | active | suspended | inactive Binding: http://hl7.org/fhir/ValueSet/location-status (required) ele-1: All FHIR elements must have a @value or children |
| name | S ΣI | 0..1 | string | Name of the location as used by humans ele-1: All FHIR elements must have a @value or children |
| description | Σ I | 0..1 | string | Description of the location ele-1: All FHIR elements must have a @value or children |
| mode | ?! ΣI | 0..1 | code | instance | kind Binding: http://hl7.org/fhir/ValueSet/location-mode (required) ele-1: All FHIR elements must have a @value or children |
| type | Σ I | 0..1 | CodeableConcept | Type of function performed Binding: http://hl7.org/fhir/ValueSet/v3-ServiceDeliveryLocationRoleType (extensible) 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 |
| coding | Σ I | 0..* | Coding | Code defined by a terminology system 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 |
| text | Σ I | 0..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children |
| telecom | Σ I | 0..* | ContactPoint | Contact details of the location ele-1: All FHIR elements must have a @value or children cpt-2: A system is required if a value is provided. |
| 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 | code | phone | fax | email | pager | other Binding: http://hl7.org/fhir/ValueSet/contact-point-system (required) ele-1: All FHIR elements must have a @value or children |
| value | Σ I | 0..1 | string | The actual contact point details ele-1: All FHIR elements must have a @value or children |
| use | ?! ΣI | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: http://hl7.org/fhir/ValueSet/contact-point-use (required) ele-1: All FHIR elements must have a @value or children |
| rank | Σ I | 0..1 | positiveInt | Specify preferred order of use (1 = highest) ele-1: All FHIR elements must have a @value or children |
| period | Σ I | 0..1 | Period | Time period when the contact point was/is in use ele-1: All FHIR elements must have a @value or children per-1: If present, start SHALL have a lower value than end |
| 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 |
| start | Σ I | 0..1 | dateTime | Starting time with inclusive boundary ele-1: All FHIR elements must have a @value or children |
| end | Σ I | 0..1 | dateTime | End time with inclusive boundary, if not ongoing ele-1: All FHIR elements must have a @value or children |
| address | Σ I | 0..1 | Address | Physical location 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 |
| use | ?! ΣI | 0..1 | code | home | work | temp | old - purpose of this address Binding: http://hl7.org/fhir/ValueSet/address-use (required) ele-1: All FHIR elements must have a @value or children Example: home |
| type | Σ I | 0..1 | code | postal | physical | both Binding: http://hl7.org/fhir/ValueSet/address-type (required) ele-1: All FHIR elements must have a @value or children Example: both |
| text | Σ I | 0..1 | string | Text representation of the address ele-1: All FHIR elements must have a @value or children Example: 137 Nowhere Street, Erewhon 9132 |
| line | Σ I | 0..* | string | Street name, number, direction & P.O. Box etc. ele-1: All FHIR elements must have a @value or children Example: 137 Nowhere Street |
| city | Σ I | 0..1 | string | Name of city, town etc. ele-1: All FHIR elements must have a @value or children Example: Erewhon |
| district | Σ I | 0..1 | string | District name (aka county) ele-1: All FHIR elements must have a @value or children Example: Madison |
| state | Σ I | 0..1 | string | Sub-unit of country (abbreviations ok) ele-1: All FHIR elements must have a @value or children |
| postalCode | Σ I | 0..1 | string | Postal code for area ele-1: All FHIR elements must have a @value or children Example: 9132 |
| country | Σ I | 0..1 | string | Country (can be ISO 3166 3 letter code) ele-1: All FHIR elements must have a @value or children |
| period | Σ I | 0..1 | Period | Time period when address was/is in use ele-1: All FHIR elements must have a @value or children per-1: If present, start SHALL have a lower value than end Example: {"start":"2010-03-23","end":"2010-07-01"} |
| 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 |
| start | Σ I | 0..1 | dateTime | Starting time with inclusive boundary ele-1: All FHIR elements must have a @value or children |
| end | Σ I | 0..1 | dateTime | End time with inclusive boundary, if not ongoing ele-1: All FHIR elements must have a @value or children |
| physicalType | Σ I | 0..1 | CodeableConcept | Physical form of the location Binding: http://hl7.org/fhir/ValueSet/location-physical-type (example) 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 |
| coding | Σ I | 0..* | Coding | Code defined by a terminology system 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 |
| text | Σ I | 0..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children |
 position | I | 0..1 | BackboneElement | The absolute geographic location 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 |
| longitude | I | 1..1 | decimal | Longitude with WGS84 datum ele-1: All FHIR elements must have a @value or children |
| latitude | I | 1..1 | decimal | Latitude with WGS84 datum ele-1: All FHIR elements must have a @value or children |
| altitude | I | 0..1 | decimal | Altitude with WGS84 datum ele-1: All FHIR elements must have a @value or children |
| managingOrganization | S ΣI | 0..1 | Reference(Organization) | Organization responsible for provisioning and upkeep ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a local reference if the resource is provided inline |
| 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 |
| reference | Σ I | 0..1 | string | Relative, internal or absolute URL reference ele-1: All FHIR elements must have a @value or children |
| display | Σ I | 0..1 | string | Text alternative for the resource ele-1: All FHIR elements must have a @value or children |
| partOf | Σ I | 0..1 | Reference(Location) | Another Location this one is physically part of ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a local reference if the resource is provided inline |
| 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 |
| reference | Σ I | 0..1 | string | Relative, internal or absolute URL reference ele-1: All FHIR elements must have a @value or children |
| display | Σ I | 0..1 | string | Text alternative for the resource ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||