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.
Organization
FHIR Core
Project
Simplifier.Core.R4.Resources
Query
-
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.
API
-
FHIR
Get this resource using a FHIR client.
-
Embed
Embed this resource in your own website. How?
Tools
-
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.
AppointmentResponse
A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.
- type Profile on AppointmentResponse
- FHIR R4
- status Draft
-
version4.0.0
Unregistered conflicting canonical
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
Canonical claims are used to verify ownership of your canonical URLs.
Canonical
| AppointmentResponse | C | DomainResource | Element idAppointmentResponseShort description A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection DefinitionA reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.
| |||
| id | Σ | 0..1 | id | There are no (further) constraints on this element Element idAppointmentResponse.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idAppointmentResponse.metaShort description Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idAppointmentResponse.implicitRulesShort description A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idAppointmentResponse.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language. http://hl7.org/fhir/ValueSet/languages (preferred) Binding extensions
| |||
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idAppointmentResponse.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
| |||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idAppointmentResponse.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |||
| extension | 0..* | Extension | There are no (further) constraints on this element Element idAppointmentResponse.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 resource. 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
| |||
| modifierExtension | ?! | 0..* | Extension | There are no (further) constraints on this element Element idAppointmentResponse.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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
| ||
| identifier | Σ | 0..* | Identifier | Element idAppointmentResponse.identifierShort description External Ids for this item DefinitionThis records identifiers associated with this appointment response concern that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| appointment | Σ C | 1..1 | Reference(Appointment) | Element idAppointmentResponse.appointmentShort description Appointment this response relates to DefinitionAppointment that this response is replying to. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| start | 0..1 | instant | Element idAppointmentResponse.startShort description Time from appointment, or requested new start time DefinitionDate/Time that the appointment is to take place, or requested new start time. This may be either the same as the appointment request to confirm the details of the appointment, or alternately a new time to request a re-negotiation of the start time.
| |||
| end | 0..1 | instant | Element idAppointmentResponse.endShort description Time from appointment, or requested new end time DefinitionThis may be either the same as the appointment request to confirm the details of the appointment, or alternately a new time to request a re-negotiation of the end time. Note: This is intended for where precisely observed times are required, typically system logs etc., and not human-reported times - for them, see date and dateTime (which can be as precise as instant, but is not required to be) below. Time zone is always required
| |||
| participantType | Σ | 0..* | CodeableConceptBinding | Element idAppointmentResponse.participantTypeShort description Role of participant in the appointment DefinitionRole of participant in the appointment. The role of the participant can be used to declare what the actor will be doing in the scope of the referenced appointment. If the actor is not specified, then it is expected that the actor will be filled in at a later stage of planning. This value SHALL be the same as specified on the referenced Appointment so that they can be matched, and subsequently updated. Role of participant in encounter. http://hl7.org/fhir/ValueSet/encounter-participant-type (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| actor | Σ C | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) | Element idAppointmentResponse.actorShort description Person, Location, HealthcareService, or Device DefinitionA Person, Location, HealthcareService, or Device that is participating in the appointment. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| participantStatus | Σ ?! | 1..1 | codeBinding | Element idAppointmentResponse.participantStatusShort description accepted | declined | tentative | in-process | completed | needs-action | entered-in-error DefinitionParticipation status of the participant. When the status is declined or tentative if the start/end times are different to the appointment, then these times should be interpreted as a requested time change. When the status is accepted, the times can either be the time of the appointment (as a confirmation of the time) or can be empty. This element is labeled as a modifier because the status contains the code entered-in-error that marks the participant as not currently valid. The Participation status of an appointment. http://hl7.org/fhir/ValueSet/participationstatus|4.0.0 (required) Constraints
| ||
| comment | 0..1 | string | Element idAppointmentResponse.commentShort description Additional comments DefinitionAdditional comments about the appointment. This comment is particularly important when the responder is declining, tentatively accepting or requesting another time to indicate the reasons why.
|
Last updated on