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.
Project Simplifier.Core.STU3.Resources
MessageHeader
Base StructureDefinition for MessageHeader Resource
- type Profile on MessageHeader
- FHIR STU3
- status Draft
-
versionnone
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
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/BackboneElement
- Could not resolve: http://hl7.org/fhir/StructureDefinition/Reference
- Could not resolve: http://hl7.org/fhir/StructureDefinition/instant
- Could not resolve: http://hl7.org/fhir/StructureDefinition/CodeableConcept
| MessageHeader | I | DomainResource | Element idMessageHeader A resource that describes a message that is exchanged between systems DefinitionThe header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.
| |
| id | Σ | 0..1 | id | There are no (further) constraints on this element Element idMessageHeader.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 idMessageHeader.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 idMessageHeader.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 idMessageHeader.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 idMessageHeader.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 idMessageHeader.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 idMessageHeader.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 idMessageHeader.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
|
| event | Σ | 1..1 | Coding | There are no (further) constraints on this element Element idMessageHeader.event Code for the event this message represents DefinitionCode that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification have the system value "http://hl7.org/fhir/message-events". Drives the behavior associated with this message. Coding BindingOne of the message events defined as part of FHIR. ?? (example)Mappings
|
| destination | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element idMessageHeader.destination Message destination application(s) DefinitionThe destination application which the message is intended for. Indicates where message is to be sent for routing purposes. Allows verification of "am I the intended recipient". There SHOULD be at least one destination, but in some circumstances, the source system is unaware of any particular destination system. BackboneElement Mappings
|
| receiver | Σ | 0..1 | Reference(Practitioner | Organization) | There are no (further) constraints on this element Element idMessageHeader.receiver Intended "real-world" recipient for the data DefinitionAllows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient. Allows routing beyond just the application level. Reference(Practitioner | Organization) Mappings
|
| sender | Σ | 0..1 | Reference(Practitioner | Organization) | There are no (further) constraints on this element Element idMessageHeader.sender Real world sender of the message DefinitionIdentifies the sending system to allow the use of a trust relationship. Allows routing beyond just the application level. Use case is for where a (trusted) sending system is responsible for multiple organizations, and therefore cannot differentiate based on source endpoint / authentication alone. Reference(Practitioner | Organization) Mappings
|
| timestamp | Σ | 1..1 | instant | There are no (further) constraints on this element Element idMessageHeader.timestamp Time that the message was sent DefinitionThe time that the message was sent. Allows limited detection of out-of-order and delayed transmission. Also supports audit. instant Mappings
|
| enterer | Σ | 0..1 | Reference(Practitioner) | There are no (further) constraints on this element Element idMessageHeader.enterer The source of the data entry DefinitionThe person or device that performed the data entry leading to this message. When there is more than one candidate, pick the most proximal to the message. Can provide other enterers in extensions. Need to know for audit/traceback requirements and possibly for authorization. Usually only for the request, but can be used in a response. Reference(Practitioner) Mappings
|
| author | Σ | 0..1 | Reference(Practitioner) | There are no (further) constraints on this element Element idMessageHeader.author The source of the decision DefinitionThe logical author of the message - the person or device that decided the described event should happen. When there is more than one candidate, pick the most proximal to the MessageHeader. Can provide other authors in extensions. Need to know for audit/traceback requirements and possibly for authorization. Usually only for the request, but can be used in a response. Reference(Practitioner) Mappings
|
| source | Σ | 1..1 | BackboneElement | There are no (further) constraints on this element Element idMessageHeader.source Message source application DefinitionThe source application from which this message originated. Allows replies, supports audit. BackboneElement Mappings
|
| responsible | Σ | 0..1 | Reference(Practitioner | Organization) | There are no (further) constraints on this element Element idMessageHeader.responsible Final responsibility for event DefinitionThe person or organization that accepts overall responsibility for the contents of the message. The implication is that the message event happened under the policies of the responsible party. Need to know for audit/traceback requirements and possibly for authorization. Usually only for the request, but can be used in a response. Reference(Practitioner | Organization) Mappings
|
| reason | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idMessageHeader.reason Cause of event DefinitionCoded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message. Need to be able to track why resources are being changed and report in the audit log/history of the resource. May affect authorization. CodeableConcept BindingReason for event occurrence ?? (example)Mappings
|
| response | Σ | 0..1 | BackboneElement | There are no (further) constraints on this element Element idMessageHeader.response If this is a reply to prior message DefinitionInformation about the message that this message is a response to. Only present if this message is a response. BackboneElement Mappings
|
| focus | Σ | 0..* | Reference(Resource) | There are no (further) constraints on this element Element idMessageHeader.focus The actual content of the message DefinitionThe actual data of the message - a reference to the root/focus class of the event. Every message event is about actual data, a single resource, that is identified in the definition of the event, and perhaps some or all linked resources. The data is defined where the transaction type is defined. The transaction data is always included in the bundle that is the full message. Only the root resource is specified. The resources it references should be contained in the bundle but are not also listed here. Multiple repetitions are allowed to cater for merges and other situations with multiple focal targets. Reference(Resource) Mappings
|
Documentation:
https://simplifier.net/simplifier.core.prof/messageheader
Last updated on