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.
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
-
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.
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.
Organization FHIR Core /
Project Core StructureDefinitions - STU3
AuditEvent
Base StructureDefinition for AuditEvent Resource
- type Profile on AuditEvent
- FHIR STU3
- status Maturity Level 3
-
versionnone
Valid canonical
This resource matches a canonical claim from this project.
Claim: http://hl7.org/fhir
Canonical claims are used to verify ownership of your canonical URLs.
Canonical
Some canonical urls could not be resolved.
You're probably missing a package or made a typo in your canonical.
- Could not resolve: http://hl7.org/fhir/StructureDefinition/Coding
- Could not resolve: http://hl7.org/fhir/StructureDefinition/code
- Could not resolve: http://hl7.org/fhir/StructureDefinition/instant
- Could not resolve: http://hl7.org/fhir/StructureDefinition/string
- Could not resolve: http://hl7.org/fhir/StructureDefinition/CodeableConcept
- Could not resolve: http://hl7.org/fhir/StructureDefinition/BackboneElement
| AuditEvent | I | DomainResource | Element idAuditEvent Event record kept for security purposes DefinitionA record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage. Based on ATNA (RFC 3881).
| |
| id | Σ | 0..1 | id | There are no (further) constraints on this element Element idAuditEvent.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 idAuditEvent.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 idAuditEvent.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 idAuditEvent.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 idAuditEvent.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 idAuditEvent.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 idAuditEvent.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. 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 idAuditEvent.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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Mappings
|
| type | Σ | 1..1 | CodingBinding | There are no (further) constraints on this element Element idAuditEvent.type Type/identifier of event DefinitionIdentifier for a family of the event. For example, a menu item, program, rule, policy, function code, application name or URL. It identifies the performed function. This identifies the performed function. For "Execute" Event Action Code audit records, this identifies the application function performed. Coding BindingType of event. ?? (extensible)Mappings
|
| subtype | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element idAuditEvent.subtype More specific type/id for the event DefinitionIdentifier for the category of event. This field enables queries of messages by implementation-defined event categories. Coding BindingSub-type of event. ?? (extensible)Mappings
|
| action | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idAuditEvent.action Type of action performed during the event DefinitionIndicator for type of action performed during the event that generated the audit. This broadly indicates what kind of action was done on the AuditEvent.entity by the AuditEvent.agent. code BindingIndicator for type of action performed during the event that generated the event ?? (required)Mappings
|
| recorded | Σ | 1..1 | instant | There are no (further) constraints on this element Element idAuditEvent.recorded Time when the event occurred on source DefinitionThe time when the event occurred on the source. This ties an event to a specific date and time. Security audits typically require a consistent time base (e.g. UTC), to eliminate time-zone issues arising from geographical distribution. In a distributed system, some sort of common time base (e.g. an NTP [RFC1305] server) is a good implementation tactic. instant Mappings
|
| outcome | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idAuditEvent.outcome Whether the event succeeded or failed DefinitionIndicates whether the event succeeded or failed. In some cases a "success" may be partial, for example, an incomplete or interrupted transfer of a radiological study. For the purpose of establishing accountability, these distinctions are not relevant. code BindingIndicates whether the event succeeded or failed ?? (required)Mappings
|
| outcomeDesc | Σ | 0..1 | string | There are no (further) constraints on this element Element idAuditEvent.outcomeDesc Description of the event outcome DefinitionA free text description of the outcome of the event. string Mappings
|
| purposeOfEvent | Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idAuditEvent.purposeOfEvent The purposeOfUse of the event DefinitionThe purposeOfUse (reason) that was used during the event being recorded. Use AuditEvent.agent.purposeOfUse when you know that it is specific to the agent, otherwise use AuditEvent.purposeOfEvent. For example, during a machine-to-machine transfer it might not be obvious to the audit system who caused the event, but it does know why. CodeableConcept BindingThe reason the activity took place. ?? (extensible)Mappings
|
| agent | 1..* | BackboneElement | There are no (further) constraints on this element Element idAuditEvent.agent Actor involved in the event Alternate namesActiveParticipant DefinitionAn actor taking an active role in the event or activity that is logged. An agent can be a person, an organization, software, device, or other actors that may be ascribed responsibility. Several agents may be associated (i.e. have some responsibility for an activity) with an event or activity. For example, an activity may be initiated by one user for other users or involve more than one user. However, only one user may be the initiator/requestor for the activity. BackboneElement Mappings
| |
| source | 1..1 | BackboneElement | There are no (further) constraints on this element Element idAuditEvent.source Audit Event Reporter DefinitionThe system that is reporting the event. The event is reported by one source. Since multi-tier, distributed, or composite applications make source identification ambiguous, this collection of fields may repeat for each application or process actively involved in the event. For example, multiple value-sets can identify participating web servers, application processes, and database server threads in an n-tier distributed application. Passive event participants (e.g. low-level network transports) need not be identified. BackboneElement Mappings
| |
| entity | I | 0..* | BackboneElement | There are no (further) constraints on this element Element idAuditEvent.entity Data or objects used Alternate namesParticipantObject DefinitionSpecific instances of data or objects that have been accessed. The event may have other entities involved. Required unless the values for event identification, agent identification, and audit source identification are sufficient to document the entire auditable event. Because events may have more than one entity, this group can be a repeating set of values. BackboneElement Constraints
|
Documentation:
https://simplifier.net/coreprofilesstu3/auditevent
Last updated on