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.
Claim
Base StructureDefinition for Claim Resource
- type Profile on Claim
- 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/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/dateTime
- Could not resolve: http://hl7.org/fhir/StructureDefinition/BackboneElement
- Could not resolve: http://hl7.org/fhir/StructureDefinition/Money
Claim | I | DomainResource | Element idClaim Claim, Pre-determination or Pre-authorization DefinitionA provider issued list of services and products provided, or to be provided, to a patient which is provided to an insurer for payment recovery.
| |
id | Σ | 0..1 | id | There are no (further) constraints on this element Element idClaim.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 idClaim.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 idClaim.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 idClaim.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 idClaim.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 idClaim.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 idClaim.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 idClaim.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 idClaim.identifier Claim number DefinitionThe business identifier for the instance: claim number, pre-determination or pre-authorization number. Identifier Mappings
| |
status | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idClaim.status active | cancelled | draft | entered-in-error DefinitionThe status of the resource instance. This element is labeled as a modifier because the status contains the code entered-in-error that marks the claim as not currently valid. code BindingA code specifying the state of the resource instance. ?? (required)Mappings
|
type | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idClaim.type Type or discipline DefinitionThe category of claim, eg, oral, pharmacy, vision, insitutional, professional. Affects which fields and value sets are used. CodeableConcept BindingThe type or discipline-style of the claim ?? (required)Mappings
| |
subType | 0..* | CodeableConcept | There are no (further) constraints on this element Element idClaim.subType Finer grained claim type information DefinitionA finer grained suite of claim subtype codes which may convey Inpatient vs Outpatient and/or a specialty service. In the US the BillType. This may contain the local bill type codes such as the US UB-04 bill type code. CodeableConcept BindingA more granular claim typecode ?? (example)Mappings
| |
use | 0..1 | codeBinding | There are no (further) constraints on this element Element idClaim.use complete | proposed | exploratory | other DefinitionComplete (Bill or Claim), Proposed (Pre-Authorization), Exploratory (Pre-determination). code BindingComplete, proposed, exploratory, other ?? (required)Mappings
| |
patient | 0..1 | Reference(Patient) | There are no (further) constraints on this element Element idClaim.patient The subject of the Products and Services DefinitionPatient Resource. Reference(Patient) Mappings
| |
billablePeriod | 0..1 | Period | There are no (further) constraints on this element Element idClaim.billablePeriod Period for charge submission DefinitionThe billable period for which charges are being submitted. Period Mappings
| |
created | 0..1 | dateTime | There are no (further) constraints on this element Element idClaim.created Creation date DefinitionThe date when the enclosed suite of services were performed or completed. dateTime Mappings
| |
enterer | 0..1 | Reference(Practitioner) | There are no (further) constraints on this element Element idClaim.enterer Author DefinitionPerson who created the invoice/claim/pre-determination or pre-authorization. Reference(Practitioner) Mappings
| |
insurer | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idClaim.insurer Target DefinitionThe Insurer who is target of the request. Reference(Organization) Mappings
| |
provider | 0..1 | Reference(Practitioner) | There are no (further) constraints on this element Element idClaim.provider Responsible provider DefinitionThe provider which is responsible for the bill, claim pre-determination, pre-authorization. Reference(Practitioner) Mappings
| |
organization | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idClaim.organization Responsible organization DefinitionThe organization which is responsible for the bill, claim pre-determination, pre-authorization. Reference(Organization) Mappings
| |
priority | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idClaim.priority Desired processing priority DefinitionImmediate (STAT), best effort (NORMAL), deferred (DEFER). CodeableConcept BindingThe timeliness with which processing is required: STAT, normal, Deferred ?? (example)Mappings
| |
fundsReserve | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idClaim.fundsReserve Funds requested to be reserved DefinitionIn the case of a Pre-Determination/Pre-Authorization the provider may request that funds in the amount of the expected Benefit be reserved ('Patient' or 'Provider') to pay for the Benefits determined on the subsequent claim(s). 'None' explicitly indicates no funds reserving is requested. CodeableConcept BindingFor whom funds are to be reserved: (Patient, Provider, None). ?? (example) | |
related | 0..* | BackboneElement | There are no (further) constraints on this element Element idClaim.related Related Claims which may be revelant to processing this claimn DefinitionOther claims which are related to this claim such as prior claim versions or for related services. BackboneElement | |
prescription | 0..1 | Reference(MedicationRequest | VisionPrescription) | There are no (further) constraints on this element Element idClaim.prescription Prescription authorizing services or products DefinitionPrescription to support the dispensing of Pharmacy or Vision products. For type=Pharmacy and Vision only. Should we create a group to hold multiple prescriptions and add a sequence number and on the line items a link to the sequence. Reference(MedicationRequest | VisionPrescription) | |
originalPrescription | 0..1 | Reference(MedicationRequest) | There are no (further) constraints on this element Element idClaim.originalPrescription Original prescription if superceded by fulfiller DefinitionOriginal prescription which has been superceded by this prescription to support the dispensing of pharmacy services, medications or products. For example, a physician may prescribe a medication which the pharmacy determines is contraindicated, or for which the patient has an intolerance, and therefor issues a new precription for an alternate medication which has the same theraputic intent. The prescription from the pharmacy becomes the 'prescription' and that from the physician becomes the 'original prescription'. as above. Reference(MedicationRequest) | |
payee | 0..1 | BackboneElement | There are no (further) constraints on this element Element idClaim.payee Party to be paid any benefits payable DefinitionThe party to be reimbursed for the services. BackboneElement | |
referral | 0..1 | Reference(ReferralRequest) | There are no (further) constraints on this element Element idClaim.referral Treatment Referral DefinitionThe referral resource which lists the date, practitioner, reason and other supporting information. Reference(ReferralRequest) Mappings
| |
facility | 0..1 | Reference(Location) | There are no (further) constraints on this element Element idClaim.facility Servicing Facility DefinitionFacility where the services were provided. Reference(Location) Mappings
| |
careTeam | 0..* | BackboneElement | There are no (further) constraints on this element Element idClaim.careTeam Members of the care team DefinitionThe members of the team who provided the overall service as well as their role and whether responsible and qualifications. Role and Responsible may not be required when there is only a single provider listed. BackboneElement | |
information | 0..* | BackboneElement | There are no (further) constraints on this element Element idClaim.information Exceptions, special considerations, the condition, situation, prior or concurrent issues DefinitionAdditional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues. Often there are mutiple jurisdiction specific valuesets which are required. Typically these information codes are required to support the services rendered or the adjudication of the services rendered. BackboneElement Mappings
| |
diagnosis | 0..* | BackboneElement | There are no (further) constraints on this element Element idClaim.diagnosis List of Diagnosis DefinitionList of patient diagnosis for which care is sought. BackboneElement Mappings
| |
procedure | 0..* | BackboneElement | There are no (further) constraints on this element Element idClaim.procedure Procedures performed DefinitionOrdered list of patient procedures performed to support the adjudication. BackboneElement | |
insurance | 0..* | BackboneElement | There are no (further) constraints on this element Element idClaim.insurance Insurance or medical plan DefinitionFinancial instrument by which payment information for health care. Health care programs and insurers are significant payors of health service costs. BackboneElement Mappings
| |
accident | 0..1 | BackboneElement | There are no (further) constraints on this element Element idClaim.accident Details about an accident DefinitionAn accident which resulted in the need for healthcare services. BackboneElement | |
employmentImpacted | 0..1 | Period | There are no (further) constraints on this element Element idClaim.employmentImpacted Period unable to work DefinitionThe start and optional end dates of when the patient was precluded from working due to the treatable condition(s). Period | |
hospitalization | 0..1 | Period | There are no (further) constraints on this element Element idClaim.hospitalization Period in hospital DefinitionThe start and optional end dates of when the patient was confined to a treatment center. Period | |
item | 0..* | BackboneElement | There are no (further) constraints on this element Element idClaim.item Goods and Services DefinitionFirst tier of goods and services. BackboneElement | |
total | 0..1 | Money | There are no (further) constraints on this element Element idClaim.total Total claim cost DefinitionThe total value of the claim. Money |