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 Lifen API
Lifen Account Core Profile V2
An instance of StructureDefinition
- type Profile on Account
- FHIR STU3
- status Active
-
version1.0.0
Missing canonical claim
The canonical from this resource does not match any claims.
Canonical claims are used to verify ownership of your canonical URLs.
Canonical
| Lifen Account Core Profile V2 (Account) | I | Account | There are no (further) constraints on this element Element idAccount Tracks balance, charges, for patient or cost center Alternate namesCost center, Record DefinitionA financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centers, etc.
| |
| id | Σ | 0..1 | id | There are no (further) constraints on this element Element idAccount.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 idAccount.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. |
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idAccount.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. |
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idAccount.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. Common Languages (extensible) | |
| text | I | 0..1 | Narrative | There are no (further) constraints on this element Element idAccount.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.
|
| contained | 0..0 | Resource | There are no (further) constraints on this element Element idAccount.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 idAccount.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.
| |
| modifierExtension | ?! | 0..* | Extension | There are no (further) constraints on this element Element idAccount.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.
|
| identifier | Σ | 1..* | Identifier | There are no (further) constraints on this element Element idAccount.identifier Account number DefinitionUnique identifier used to reference the account. May or may not be intended for human use (e.g. credit card number).
|
| status | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idAccount.status active | inactive | entered-in-error DefinitionIndicates whether the account is presently used/usable or not. This element is labeled as a modifier because the status contains the codes inactive and entered-in-error that mark the Account as not currently valid. Indicates whether the account is available to be used. AccountStatus (required)Mappings
|
| type | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idAccount.type E.g. patient, expense, depreciation DefinitionCategorizes the account for reporting and searching purposes. The usage type of this account, permits categorization of accounts. Account Types (example)Mappings
|
| name | Σ | 0..1 | string | There are no (further) constraints on this element Element idAccount.name Human-readable label Alternate namesTitle DefinitionName used for the account when displaying it to humans in reports, etc.
|
| subject | Σ | 1..1 | Reference(Patient | Device | Practitioner | Location | HealthcareService | Organization) | There are no (further) constraints on this element Element idAccount.subject What is account tied to? Alternate namestarget DefinitionIdentifies the patient, device, practitioner, location or other object the account is associated with. Accounts can be applied to non patients for tracking other non patient related activities, such as group services (patients not tracked, and costs charged to another body), or may not be allocated. Reference(Patient | Device | Practitioner | Location | HealthcareService | Organization) Mappings
|
| period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idAccount.period Transaction window DefinitionIdentifies the period of time the account applies to; e.g. accounts created per fiscal year, quarter, etc. It is possible for transactions relevant to a coverage period to be posted to the account before or after the coverage period, however the services that are being charged for must be within this period.
|
| active | Σ | 0..1 | Period | There are no (further) constraints on this element Element idAccount.active Time window that transactions may be posted to this account DefinitionIndicates the period of time over which the account is allowed to have transactions posted to it. This period may be different to the coveragePeriod which is the duration of time that services may occur. Accounts are able to be active only during a specific period, and the dates to which charges should be able to be applied.
|
| balance | 0..1 | Money | There are no (further) constraints on this element Element idAccount.balance How much is in account? DefinitionRepresents the sum of all credits less all debits associated with the account. Might be positive, zero or negative.
| |
| coverage | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element idAccount.coverage The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account DefinitionThe party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account. Typically this may be some form of insurance, internal charges, or self-pay. Local or jurisdicational business rules may determine which coverage covers which types of billable items charged to the account, and in which order. Where the order is important, a local/jurisdicational extension may be defined to specify the order for the type of charge.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idAccount.coverage.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | 0..* | Extension | There are no (further) constraints on this element Element idAccount.coverage.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. 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.
| |
| modifierExtension | Σ ?! | 0..* | Extension | There are no (further) constraints on this element Element idAccount.coverage.modifierExtension Extensions that cannot be ignored 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 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.
|
| coverage | Σ | 1..1 | Reference(Coverage) | There are no (further) constraints on this element Element idAccount.coverage.coverage The party(s) that are responsible for covering the payment of this account DefinitionThe party(s) that are responsible for payment (or part of) of charges applied to this account (including self-pay). A coverage may only be resposible for specific types of charges, and the sequence of the coverages in the account could be important when processing billing.
|
| priority | Σ | 0..1 | positiveInt | There are no (further) constraints on this element Element idAccount.coverage.priority The priority of the coverage in the context of this account Alternate namescoordination of benefit priority DefinitionThe priority of the coverage in the context of this account. It is common in some jurisdictions for there to be multiple coverages allocated to an account, and a sequence is required to order the settling of the account (often with insurance claiming).
|
| owner | Σ | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idAccount.owner Who is responsible? DefinitionIndicates the organization, department, etc. with responsibility for the account.
|
| description | Σ | 0..1 | string | There are no (further) constraints on this element Element idAccount.description Explanation of purpose/use DefinitionProvides additional information about what the account tracks and how it is used.
|
| guarantor | 0..* | BackboneElement | There are no (further) constraints on this element Element idAccount.guarantor Responsible for the account DefinitionParties financially responsible for the account.
| |
| id | 0..1 | string | There are no (further) constraints on this element Element idAccount.guarantor.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | 0..* | Extension | There are no (further) constraints on this element Element idAccount.guarantor.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. 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.
| |
| modifierExtension | Σ ?! | 0..* | Extension | There are no (further) constraints on this element Element idAccount.guarantor.modifierExtension Extensions that cannot be ignored 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 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.
|
| party | 1..1 | Reference(Patient | RelatedPerson | Organization) | There are no (further) constraints on this element Element idAccount.guarantor.party Responsible entity DefinitionThe entity who is responsible. Reference(Patient | RelatedPerson | Organization) Mappings
| |
| onHold | 0..1 | boolean | There are no (further) constraints on this element Element idAccount.guarantor.onHold Credit or other hold applied DefinitionA guarantor may be placed on credit hold or otherwise have their role temporarily suspended.
| |
| period | 0..1 | Period | There are no (further) constraints on this element Element idAccount.guarantor.period Guarrantee account during DefinitionThe timeframe during which the guarantor accepts responsibility for the account.
|
Last updated on