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.
CommunicationRequest
Base StructureDefinition for CommunicationRequest Resource
- type Profile on CommunicationRequest
- 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/Reference
- 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/BackboneElement
- Could not resolve: http://hl7.org/fhir/StructureDefinition/Element
- Could not resolve: http://hl7.org/fhir/StructureDefinition/dateTime
- Could not resolve: http://hl7.org/fhir/StructureDefinition/Annotation
CommunicationRequest | I | DomainResource | Element idCommunicationRequest A request for information to be sent to a receiver DefinitionA request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.
| |
id | Σ | 0..1 | id | There are no (further) constraints on this element Element idCommunicationRequest.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 idCommunicationRequest.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 idCommunicationRequest.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 idCommunicationRequest.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 idCommunicationRequest.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 idCommunicationRequest.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 idCommunicationRequest.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 idCommunicationRequest.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 idCommunicationRequest.identifier Unique identifier DefinitionA unique ID of this request for reference purposes. It must be provided if user wants it returned as part of any output, otherwise it will be autogenerated, if needed, by CDS system. Does not need to be the actual ID of the source system. Identifier Mappings
|
basedOn | Σ | 0..* | Reference(Resource) | There are no (further) constraints on this element Element idCommunicationRequest.basedOn Fulfills plan or proposal Alternate namesfulfills DefinitionA plan or proposal that is fulfilled in whole or in part by this request. Allows tracing of authorization for the request and tracking whether proposals/recommendations were acted upon. Reference(Resource) Mappings
|
replaces | Σ | 0..* | Reference(CommunicationRequest) | There are no (further) constraints on this element Element idCommunicationRequest.replaces Request(s) replaced by this request Alternate namessupersedes, prior DefinitionCompleted or terminated request(s) whose function is taken by this new request. Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests. The replacement could be because the initial request was immediately rejected (due to an issue) or because the previous request was completed, but the need for the action described by the request remains ongoing. Reference(CommunicationRequest) Mappings
|
groupIdentifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idCommunicationRequest.groupIdentifier Composite request this is part of Alternate namesgrouperId DefinitionA shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form. Requests are linked either by a "basedOn" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation. Identifier Mappings
|
status | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idCommunicationRequest.status draft | active | suspended | cancelled | completed | entered-in-error | unknown DefinitionThe status of the proposal or order. This element is labeled as a modifier because the status contains the codes cancelled and entered-in-error that mark the request as not currently valid. code BindingThe status of the communication request. ?? (required)Mappings
|
category | 0..* | CodeableConcept | There are no (further) constraints on this element Element idCommunicationRequest.category Message category DefinitionThe type of message to be sent such as alert, notification, reminder, instruction, etc. There may be multiple axes of categorization and one communication request may serve multiple purposes. CodeableConcept BindingCodes for general categories of communications such as alerts, instruction, etc. ?? (example)Mappings
| |
priority | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idCommunicationRequest.priority Message urgency DefinitionCharacterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine. If missing, this task should be performed with normal priority code BindingCodes indicating the relative importance of a communication request. ?? (required)Mappings
|
medium | 0..* | CodeableConcept | There are no (further) constraints on this element Element idCommunicationRequest.medium A channel of communication DefinitionA channel that was used for this communication (e.g. email, fax). CodeableConcept BindingCodes for communication mediums such as phone, fax, email, in person, etc. ?? (example) | |
subject | 0..1 | Reference(Patient | Group) | There are no (further) constraints on this element Element idCommunicationRequest.subject Focus of message Alternate namespatient DefinitionThe patient or group that is the focus of this communication request.
| |
recipient | 0..* | Reference(Device | Organization | Patient | Practitioner | RelatedPerson | Group | CareTeam) | There are no (further) constraints on this element Element idCommunicationRequest.recipient Message recipient DefinitionThe entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication. Reference(Device | Organization | Patient | Practitioner | RelatedPerson | Group | CareTeam) Mappings
| |
topic | 0..* | Reference(Resource) | There are no (further) constraints on this element Element idCommunicationRequest.topic Focal resources DefinitionThe resources which were related to producing this communication request. Reference(Resource) Mappings
| |
context | Σ | 0..1 | Reference(Encounter | EpisodeOfCare) | There are no (further) constraints on this element Element idCommunicationRequest.context Encounter or episode leading to message Alternate namesencounter DefinitionThe encounter or episode of care within which the communication request was created. Reference(Encounter | EpisodeOfCare) Mappings
|
payload | 0..* | BackboneElement | There are no (further) constraints on this element Element idCommunicationRequest.payload Message payload DefinitionText, attachment(s), or resource(s) to be communicated to the recipient. BackboneElement | |
occurrence[x] | Σ | 0..1 | There are no (further) constraints on this element Element idCommunicationRequest.occurrence[x] When scheduled Alternate namestiming DefinitionThe time when this communication is to occur.
| |
occurrenceDateTime | dateTime | There are no (further) constraints on this element Data type dateTime | ||
occurrencePeriod | Period | There are no (further) constraints on this element Data type Period | ||
authoredOn | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element idCommunicationRequest.authoredOn When request transitioned to being actionable Alternate namescreatedOn DefinitionFor draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation. dateTime Mappings
|
sender | 0..1 | Reference(Device | Organization | Patient | Practitioner | RelatedPerson) | There are no (further) constraints on this element Element idCommunicationRequest.sender Message sender DefinitionThe entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication. Reference(Device | Organization | Patient | Practitioner | RelatedPerson) Mappings
| |
requester | Σ I | 0..1 | BackboneElement | There are no (further) constraints on this element Element idCommunicationRequest.requester Who/what is requesting service Alternate namesauthor DefinitionThe individual who initiated the request and has responsibility for its activation. BackboneElement Constraints
|
reasonCode | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idCommunicationRequest.reasonCode Why is communication needed? DefinitionDescribes why the request is being made in coded or textual form. Textual reasons can be caprued using reasonCode.text. CodeableConcept BindingCodes for describing reasons for the occurrence of a communication. ?? (example)Mappings
|
reasonReference | Σ | 0..* | Reference(Condition | Observation) | There are no (further) constraints on this element Element idCommunicationRequest.reasonReference Why is communication needed? DefinitionIndicates another resource whose existence justifies this request. Reference(Condition | Observation) Mappings
|
note | 0..* | Annotation | There are no (further) constraints on this element Element idCommunicationRequest.note Comments made about communication request DefinitionComments made about the request by the requester, sender, recipient, subject or other participants. Annotation Mappings
|