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.
-
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.
-
Project FHIR API
This is the location where you can find your resource using a FHIR client.
-
Simplifier FHIR API
The global endpoint is where users can search for all resources in Simplifier. Resources have a globally unique guid Id here.
-
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.
Encounter
Base StructureDefinition for Encounter Resource
- type Profile on Encounter
- FHIR STU3
- status Draft
-
versionnone
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.
You're probably missing a package or made a typo in your canonical.
- Could not resolve: http://hl7.org/fhir/StructureDefinition/Identifier
- Could not resolve: http://hl7.org/fhir/StructureDefinition/code
- Could not resolve: http://hl7.org/fhir/StructureDefinition/BackboneElement
- Could not resolve: http://hl7.org/fhir/StructureDefinition/Coding
- Could not resolve: http://hl7.org/fhir/StructureDefinition/CodeableConcept
- Could not resolve: http://hl7.org/fhir/StructureDefinition/Reference
- Could not resolve: http://hl7.org/fhir/StructureDefinition/Period
- Could not resolve: http://hl7.org/fhir/StructureDefinition/Duration
Encounter | I | DomainResource | Element idEncounter An interaction during which services are provided to the patient Alternate namesVisit DefinitionAn interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.
| |
id | Σ | 0..1 | id | There are no (further) constraints on this element Element idEncounter.id 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. id |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idEncounter.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. Meta |
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idEncounter.implicitRules 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. 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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. uri |
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idEncounter.language 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). code BindingA human language. ?? (extensible) | |
text | I | 0..1 | Narrative | There are no (further) constraints on this element Element idEncounter.text 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 may 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 in formation is added later. Narrative Mappings
|
contained | 0..* | Resource | There are no (further) constraints on this element Element idEncounter.contained 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.
| |
extension | 0..* | Extension | There are no (further) constraints on this element Element idEncounter.extension 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. In order 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. 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. Extension Sliced: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 idEncounter.modifierExtension 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. Usually modifier elements provide negation or qualification. In order 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. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Mappings
|
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idEncounter.identifier Identifier(s) by which this encounter is known DefinitionIdentifier(s) by which this encounter is known. Identifier Mappings
|
status | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idEncounter.status planned | arrived | triaged | in-progress | onleave | finished | cancelled + Definitionplanned | arrived | triaged | in-progress | onleave | finished | cancelled +. Note that internal business rules will detemine the appropraite transitions that may occur between statuses (and also classes). This element is labeled as a modifier because the status contains codes that mark the encounter as not currently valid. code BindingCurrent state of the encounter ?? (required)Mappings
|
statusHistory | 0..* | BackboneElement | There are no (further) constraints on this element Element idEncounter.statusHistory List of past encounter statuses DefinitionThe status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them. The current status is always found in the current version of the resource, not the status history. BackboneElement Mappings
| |
class | Σ | 0..1 | CodingBinding | There are no (further) constraints on this element Element idEncounter.class inpatient | outpatient | ambulatory | emergency + Definitioninpatient | outpatient | ambulatory | emergency +. Coding BindingClassification of the encounter ?? (extensible)Mappings
|
classHistory | 0..* | BackboneElement | There are no (further) constraints on this element Element idEncounter.classHistory List of past encounter classes DefinitionThe class history permits the tracking of the encounters transitions without needing to go through the resource history. This would be used for a case where an admission starts of as an emergency encounter, then transisions into an inpatient scenario. Doing this and not restarting a new encounter ensures that any lab/diagnostic results can more easily follow the patient and not require re-processing and not get lost or cancelled during a kindof discharge from emergency to inpatient. BackboneElement Mappings
| |
type | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idEncounter.type Specific type of encounter DefinitionSpecific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation). Since there are many ways to further classify encounters, this element is 0..*. CodeableConcept BindingThe type of encounter ?? (example)Mappings
|
priority | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idEncounter.priority Indicates the urgency of the encounter DefinitionIndicates the urgency of the encounter. CodeableConcept BindingIndicates the urgency of the encounter. ?? (example)Mappings
| |
subject | Σ | 0..1 | Reference(Patient | Group) | There are no (further) constraints on this element Element idEncounter.subject The patient ro group present at the encounter Alternate namespatient DefinitionThe patient ro group present at the encounter. While the encounter is always about the patient, the patient may not actually be known in all contexts of use, and there may be a group of patients that could be anonymous (such as in a group therapy for Alcoholics Anonymous - where the recording of the encounter could be used for billing on the number of people/staff and not important to the context of the specific patients) or alternately in veterinary care a herd of sheep receiving treatment (where the animals are not individually tracked).
|
episodeOfCare | Σ | 0..* | Reference(EpisodeOfCare) | There are no (further) constraints on this element Element idEncounter.episodeOfCare Episode(s) of care that this encounter should be recorded against DefinitionWhere a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care, and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years). Reference(EpisodeOfCare) Mappings
|
incomingReferral | 0..* | Reference(ReferralRequest) | There are no (further) constraints on this element Element idEncounter.incomingReferral The ReferralRequest that initiated this encounter DefinitionThe referral request this encounter satisfies (incoming referral). Reference(ReferralRequest) Mappings
| |
participant | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element idEncounter.participant List of participants involved in the encounter DefinitionThe list of people responsible for providing the service. BackboneElement Mappings
|
appointment | Σ | 0..1 | Reference(Appointment) | There are no (further) constraints on this element Element idEncounter.appointment The appointment that scheduled this encounter DefinitionThe appointment that scheduled this encounter. Reference(Appointment) Mappings
|
period | 0..1 | Period | There are no (further) constraints on this element Element idEncounter.period The start and end time of the encounter DefinitionThe start and end time of the encounter. If not (yet) known, the end of the Period may be omitted. Period Mappings
| |
length | 0..1 | Duration | There are no (further) constraints on this element Element idEncounter.length Quantity of time the encounter lasted (less time absent) DefinitionQuantity of time the encounter lasted. This excludes the time during leaves of absence. May differ from the time the Encounter.period lasted because of leave of absence. Duration Mappings
| |
reason | Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idEncounter.reason Reason the encounter takes place (code) Alternate namesIndication, Admission diagnosis DefinitionReason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis. For systems that need to know which was the primary diagnosis, these will be marked with the standard extension primaryDiagnosis (which is a sequence value rather than a flag, 1 = primary diagnosis). CodeableConcept BindingReason why the encounter takes place. ?? (preferred)Mappings
|
diagnosis | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element idEncounter.diagnosis The list of diagnosis relevant to this encounter DefinitionThe list of diagnosis relevant to this encounter. BackboneElement Mappings
|
account | 0..* | Reference(Account) | There are no (further) constraints on this element Element idEncounter.account The set of accounts that may be used for billing for this Encounter DefinitionThe set of accounts that may be used for billing for this Encounter. The billing system may choose to allocate billable items associated with the Encounter to different referenced Accounts based on internal business rules. Reference(Account) Mappings
| |
hospitalization | 0..1 | BackboneElement | There are no (further) constraints on this element Element idEncounter.hospitalization Details about the admission to a healthcare service DefinitionDetails about the admission to a healthcare service. An Encounter may cover more than just the inpatient stay. Contexts such as outpatients, community clinics, and aged care facilities are also included. The duration recorded in the period of this encounter covers the entire scope of this hospitalization record. BackboneElement Mappings
| |
location | 0..* | BackboneElement | There are no (further) constraints on this element Element idEncounter.location List of locations where the patient has been DefinitionList of locations where the patient has been during this encounter. Virtual encounters can be recorded in the Encounter by specifying a location reference to a location of type "kind" such as "client's home" and an encounter.class = "virtual". BackboneElement Mappings
| |
serviceProvider | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idEncounter.serviceProvider The custodian organization of this Encounter record DefinitionAn organization that is in charge of maintaining the information of this Encounter (e.g. who maintains the report or the master service catalog item, etc.). This MAY be the same as the organization on the Patient record, however it could be different. This MAY not be not the Service Delivery Location's Organization. Reference(Organization) Mappings
| |
partOf | 0..1 | Reference(Encounter) | There are no (further) constraints on this element Element idEncounter.partOf Another Encounter this encounter is part of DefinitionAnother Encounter of which this encounter is a part of (administratively or in time). This is also used for associating a child's encounter back to the mother's encounter. Refer to the Notes section in the Patient resource for further details. Reference(Encounter) Mappings
|