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 |
|---|---|---|---|---|
  Appointment | I | 1..1 | Appointment | The Appointment resource provides information on the booking of a healthcare event 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 app-3: Only proposed or cancelled appointments can be missing start/end dates app-2: Either start and end are specified, or neither app-3: Only proposed or cancelled appointments can be missing start/end dates app-2: Either start and end are specified, or neither |
  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 (appointmentCancellationReason) | I | 0..1 | Extension(string) | Appointment cancellation reason URL: https://fhir.nhs.uk/StructureDefinition/extension-gpconnect-appointment-cancellation-reason-1 ele-1: All FHIR elements must have a @value or children |
| extension (created) | I | 0..1 | Extension(dateTime) | An extension to support the date that the appointment was initially created. URL: https://fhir.nhs.uk/StructureDefinition/extension-gpconnect-appointment-created-1 ele-1: All FHIR elements must have a @value or children |
| extension (bookingOrganisation) | I | 0..1 | Extension(Reference(CareConnect-GPC-Organization-1)) | An extension to record the organisation booking the appointment. URL: https://fhir.nhs.uk/StructureDefinition/extension-gpconnect-booking-organisation-1 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 | An identifier used to identify the appointment 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..0 | code | |
| type | Σ I | 0..0 | CodeableConcept | |
| system | Σ I | 1..1 | uri | The namespace for the identifier ele-1: All FHIR elements must have a @value or children Example: https://fhir.nhs.uk/Id/gpconnect-appointment-identifier |
| value | Σ I | 1..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example: 898976578 |
| period | Σ I | 0..0 | Period | |
  assigner | Σ I | 0..0 | Reference(Organization) | |
| status | ?! ΣI | 1..1 | code | pending | booked | arrived | fulfilled | cancelled | noshow Binding: http://hl7.org/fhir/ValueSet/appointmentstatus (required) ele-1: All FHIR elements must have a @value or children Example: booked |
| type | Σ I | 0..1 | CodeableConcept | The type of appointment that is being booked Binding: http://hl7.org/fhir/ValueSet/c80-practice-codes (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 |
| coding | Σ I | 0..* | Coding | A code taken from the Clinical Specialty list of codes 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 Example: http://hl7.org/fhir/ValueSet/c80-practice-codes |
| 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 | A symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children Example: 394733009 |
| display | Σ I | 0..1 | string | A representation defined by the system ele-1: All FHIR elements must have a @value or children Example: Medical specialty--OTHER--NOT LISTED |
| 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 |
| reason | Σ I | 0..1 | CodeableConcept | Reason this appointment is scheduled Binding: http://hl7.org/fhir/ValueSet/encounter-reason (required) 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 | 1..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children Fixed Value: http://snomed.info/sct |
| version | Σ I | 0..0 | string | |
| code | Σ I | 1..1 | code | A symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children Example: 17436001 |
| display | Σ I | 1..1 | string | Representation defined by the system ele-1: All FHIR elements must have a @value or children Example: Medical consultation with outpatient (procedure) |
| userSelected | Σ I | 0..0 | boolean | |
| text | Σ I | 0..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children |
| priority | I | 0..1 | unsignedInt | Gives the priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority) ele-1: All FHIR elements must have a @value or children |
| description | I | 1..1 | string | A brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field ele-1: All FHIR elements must have a @value or children |
| start | Σ I | 1..1 | instant | Date/Time that the appointment is due to take place ele-1: All FHIR elements must have a @value or children |
| end | Σ I | 1..1 | instant | Date/Time that the appointment is due to conclude ele-1: All FHIR elements must have a @value or children |
| minutesDuration | I | 0..1 | positiveInt | Can be less than start/end (e.g. estimate) ele-1: All FHIR elements must have a @value or children |
| slot | Σ I | 1..* | Reference(GPConnect-Slot-1) | The slot that this appointment is filling. If provided, then the schedule will not be provided as slots are not recursive, and the start/end values MUST be the same as from the slot 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 URL reference to the Slot resource ele-1: All FHIR elements must have a @value or children Example: Slot/79a37bc3-8d22-4805-b1a7-8cf8ceca9217 |
| display | Σ I | 0..1 | string | Narrative text for the resource ele-1: All FHIR elements must have a @value or children Example: Appointment Slot - Out of Hours GP Clinic - 19:30 - 19:45 |
| comment | I | 0..1 | string | Any additional comments about the appointment ele-1: All FHIR elements must have a @value or children Example: Discussion on problem 'Increased pain in right arm.' |
 participant | I | 1..* | BackboneElement | A list of participants involved in the appointment ele-1: All FHIR elements must have a @value or children app-1: Either the type or actor on the participant MUST be specified |
 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 |
| type | Σ I | 0..1 | CodeableConcept | The role of the participant in the appointment Binding: http://hl7.org/fhir/ValueSet/encounter-participant-type (required) 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..1 | Coding | A code taken from the participant type list of codes 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 | A 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 |
| actor | Σ I | 1..1 | Reference(RelatedPerson | Device | HealthcareService | CareConnect-GPC-Location-1 | CareConnect-GPC-Patient-1 | CareConnect-GPC-Practitioner-1) | A Person or Location that is participating in the appointment ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a local reference if the resource is provided inline |
| required | Σ I | 0..1 | code | required | optional | information-only Binding: http://hl7.org/fhir/ValueSet/participantrequired (required) ele-1: All FHIR elements must have a @value or children |
| status | I | 1..1 | code | accepted | declined | tentative | needs-action Binding: http://hl7.org/fhir/ValueSet/participationstatus (required) ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||