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.
PaymentReconciliation
This resource provides the details including amount of a payment and allocates the payment items being paid.
- type Profile on PaymentReconciliation
- FHIR R4
- status Draft
-
version4.0.1
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.
PaymentReconciliation | I | DomainResource | Element idPaymentReconciliation PaymentReconciliation resource DefinitionThis resource provides the details including amount of a payment and allocates the payment items being paid.
| |
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idPaymentReconciliation.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. |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idPaymentReconciliation.meta 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 idPaymentReconciliation.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. 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 idPaymentReconciliation.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). A human language.
| |
text | 0..1 | Narrative | There are no (further) constraints on this element Element idPaymentReconciliation.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 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 idPaymentReconciliation.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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPaymentReconciliation.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. 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 Constraints
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idPaymentReconciliation.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 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 Constraints
|
identifier | 0..* | Identifier | Element idPaymentReconciliation.identifier Business Identifier for a payment reconciliation DefinitionA unique identifier assigned to this payment reconciliation. Allows payment reconciliations to be distinguished and referenced.
| |
status | Σ ?! | 1..1 | codeBinding | Element idPaymentReconciliation.status active | cancelled | draft | entered-in-error DefinitionThe status of the resource instance. Need to track the status of the resource as 'draft' resources may undergo further edits while 'active' resources are immutable and may only have their status changed to 'cancelled'. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. A code specifying the state of the resource instance.
|
period | Σ I | 0..1 | Period | Element idPaymentReconciliation.period Period covered DefinitionThe period of time for which payments have been gathered into this bulk payment for settlement. Needed to allow receivers to monitor and reconcile payment issuer schedules. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
created | Σ | 1..1 | dateTime | Element idPaymentReconciliation.created Creation date DefinitionThe date when the resource was created. Need to record a timestamp for use by both the recipient and the issuer.
|
paymentIssuer | Σ I | 0..1 | Reference(Organization) | Element idPaymentReconciliation.paymentIssuer Party generating payment DefinitionThe party who generated the payment. Need to identify the party resonsible for the payment and this resource. This party is also responsible for the reconciliation.
|
request | I | 0..1 | Reference(Task) | Element idPaymentReconciliation.request Reference to requesting resource DefinitionOriginal request resource reference. Needed to allow the response to be linked to the request. 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.
|
requestor | I | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Element idPaymentReconciliation.requestor Responsible practitioner DefinitionThe practitioner who is responsible for the services rendered to the patient. Need to identify the party responsible for the request. 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(Practitioner | PractitionerRole | Organization) Constraints
|
outcome | 0..1 | codeBinding | Element idPaymentReconciliation.outcome queued | complete | error | partial DefinitionThe outcome of a request for a reconciliation. To advise the requestor of an overall processing outcome. The resource may be used to indicate that: the request has been held (queued) for processing; that it has been processed and errors found (error); that no errors were found and that some of the adjudication has been undertaken (partial) or that all of the adjudication has been undertaken (complete). The outcome of the processing.
| |
disposition | 0..1 | string | Element idPaymentReconciliation.disposition Disposition message DefinitionA human readable description of the status of the request for the reconciliation. Provided for user display. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
paymentDate | Σ | 1..1 | date | Element idPaymentReconciliation.paymentDate When payment issued DefinitionThe date of payment as indicated on the financial instrument. To advise the payee when payment can be expected.
|
paymentAmount | Σ | 1..1 | Money | Element idPaymentReconciliation.paymentAmount Total amount of Payment DefinitionTotal payment amount as indicated on the financial instrument. Needed to provide the actual payment amount.
|
paymentIdentifier | 0..1 | Identifier | Element idPaymentReconciliation.paymentIdentifier Business identifier for the payment DefinitionIssuer's unique identifier for the payment instrument. Enable the receiver to reconcile when payment is received. For example: EFT number or check number.
| |
detail | 0..* | BackboneElement | Element idPaymentReconciliation.detail Settlement particulars DefinitionDistribution of the payment amount for a previously acknowledged payable. Needed to show how the payment amount is distributed across the payables.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idPaymentReconciliation.detail.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPaymentReconciliation.detail.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 element. 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 Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idPaymentReconciliation.detail.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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.
|
identifier | 0..1 | Identifier | Element idPaymentReconciliation.detail.identifier Business identifier of the payment detail DefinitionUnique identifier for the current payment item for the referenced payable. Needed for reconciliation of payments.
| |
predecessor | 0..1 | Identifier | Element idPaymentReconciliation.detail.predecessor Business identifier of the prior payment detail DefinitionUnique identifier for the prior payment item for the referenced payable. Needed for reconciliation of payments.
| |
type | 1..1 | CodeableConcept | Element idPaymentReconciliation.detail.type Category of payment DefinitionCode to indicate the nature of the payment. Needed to provide context for the amount. For example: payment, adjustment, funds advance, etc. The reason for the amount: payment, adjustment, advance.
| |
request | I | 0..1 | Reference(Resource) | Element idPaymentReconciliation.detail.request Request giving rise to the payment DefinitionA resource, such as a Claim, the evaluation of which could lead to payment. Needed to provide a linkage to the original request. 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.
|
submitter | I | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Element idPaymentReconciliation.detail.submitter Submitter of the request DefinitionThe party which submitted the claim or financial transaction. Needed for audit and validation. 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(Practitioner | PractitionerRole | Organization) Constraints
|
response | I | 0..1 | Reference(Resource) | Element idPaymentReconciliation.detail.response Response committing to a payment DefinitionA resource, such as a ClaimResponse, which contains a commitment to payment. Needed to provide a linkage to the payment commitment. 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.
|
date | 0..1 | date | Element idPaymentReconciliation.detail.date Date of commitment to pay DefinitionThe date from the response resource containing a commitment to pay. Needed for audit and validation.
| |
responsible | I | 0..1 | Reference(PractitionerRole) | Element idPaymentReconciliation.detail.responsible Contact for the response DefinitionA reference to the individual who is responsible for inquiries regarding the response and its payment. To provide contact information. 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.
|
payee | I | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Element idPaymentReconciliation.detail.payee Recipient of the payment DefinitionThe party which is receiving the payment. Needed for audit and validation. 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(Practitioner | PractitionerRole | Organization) Constraints
|
amount | 0..1 | Money | Element idPaymentReconciliation.detail.amount Amount allocated to this payable DefinitionThe monetary amount allocated from the total payment to the payable. Needed to explain the distribution of the payment to the payables.
| |
formCode | 0..1 | CodeableConcept | Element idPaymentReconciliation.formCode Printed form identifier DefinitionA code for the form to be used for printing the content. Needed to specify the specific form used for producing output for this response. May be needed to identify specific jurisdictional forms. The forms codes.
| |
processNote | 0..* | BackboneElement | Element idPaymentReconciliation.processNote Note concerning processing DefinitionA note that describes or explains the processing in a human readable form. Provides the specific textual explanations associated with the processing.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idPaymentReconciliation.processNote.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPaymentReconciliation.processNote.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 element. 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 Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idPaymentReconciliation.processNote.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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.
|
type | 0..1 | codeBinding | Element idPaymentReconciliation.processNote.type display | print | printoper DefinitionThe business purpose of the note text. To convey the expectation for when the text is used. The presentation types of notes.
| |
text | 0..1 | string | Element idPaymentReconciliation.processNote.text Note explanatory text DefinitionThe explanation or description associated with the processing. Required to provide human readable explanation. Note that FHIR strings SHALL NOT exceed 1MB in size
|