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 test
ProcessRequest
Base StructureDefinition for ProcessRequest Resource
- type Profile on ProcessRequest
- 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
| ProcessRequest | I | DomainResource | Element idProcessRequest Request to perform some action on or in regards to an existing resource DefinitionThis resource provides the target, request and response, and action details for an action to be performed by the target on or about existing resources.
| |
| id | Σ | 0..1 | id | There are no (further) constraints on this element Element idProcessRequest.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 idProcessRequest.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 idProcessRequest.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 idProcessRequest.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. ?? (extensible) | |
| text | I | 0..1 | Narrative | There are no (further) constraints on this element Element idProcessRequest.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..* | Resource | There are no (further) constraints on this element Element idProcessRequest.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 idProcessRequest.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 idProcessRequest.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
|
| identifier | 0..* | Identifier | Element idProcessRequest.identifier Business Identifier DefinitionThe ProcessRequest business identifier.
| |
| status | Σ ?! | 0..1 | codeBinding | Element idProcessRequest.status active | cancelled | draft | entered-in-error DefinitionThe status of the resource instance. 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. ?? (required)Constraints
|
| action | 0..1 | codeBinding | Element idProcessRequest.action cancel | poll | reprocess | status DefinitionThe type of processing action being requested, for example Reversal, Readjudication, StatusRequest,PendedRequest. List of allowable action which this resource can request. ?? (required)Constraints
| |
| target | I | 0..1 | Reference(Organization) | Element idProcessRequest.target Party which is the target of the request DefinitionThe organization which is the target of 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.
|
| created | 0..1 | dateTime | Element idProcessRequest.created Creation date DefinitionThe date when this resource was created.
| |
| provider | I | 0..1 | Reference(Practitioner) | Element idProcessRequest.provider Responsible practitioner DefinitionThe practitioner who is responsible for the action specified in this 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.
|
| organization | I | 0..1 | Reference(Organization) | Element idProcessRequest.organization Responsible organization DefinitionThe organization which is responsible for the action speccified in this 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.
|
| request | I | 0..1 | Reference(Resource) | Element idProcessRequest.request Reference to the Request resource DefinitionReference of resource which is the target or subject of this action. 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.
|
| response | I | 0..1 | Reference(Resource) | Element idProcessRequest.response Reference to the Response resource DefinitionReference of a prior response to resource which is the target or subject of this action. 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.
|
| nullify | 0..1 | boolean | Element idProcessRequest.nullify Remove history DefinitionIf true remove all history excluding audit. Some resources must not simply be reversed in a processing or accounting sense but rather must have all history removed, such as the accidental submission of sensitive and/or wrong information. If the receiver cannot comply with a Nullify request then they must reject the request.
| |
| reference | 0..1 | string | Element idProcessRequest.reference Reference number/string DefinitionA reference to supply which authenticates the process. Note that FHIR strings may not exceed 1MB in size
| |
| item | 0..* | BackboneElement | Element idProcessRequest.item Items to re-adjudicate DefinitionList of top level items to be re-adjudicated, if none specified then the entire submission is re-adjudicated.
| |
| id | 0..1 | string | There are no (further) constraints on this element Element idProcessRequest.item.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 idProcessRequest.item.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. 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 idProcessRequest.item.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.
|
| sequenceLinkId | 1..1 | integer | Element idProcessRequest.item.sequenceLinkId Service instance DefinitionA service line number. 32 bit number; for values larger than this, use decimal
| |
| include | 0..* | string | Element idProcessRequest.include Resource type(s) to include DefinitionNames of resource types to include. Note that FHIR strings may not exceed 1MB in size
| |
| exclude | 0..* | string | Element idProcessRequest.exclude Resource type(s) to exclude DefinitionNames of resource types to exclude. Note that FHIR strings may not exceed 1MB in size
| |
| period | I | 0..1 | Period | Element idProcessRequest.period Selection period DefinitionA period of time during which the fulfilling resources would have been created. This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. 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"). If duration is required, specify the type as Interval|Duration.
|
Documentation:
https://simplifier.net/test20171053/processrequest
Last updated on