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
-
FHIR
Get this resource using a FHIR client.
-
Embed
Embed this resource in your own website. How?
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.
DiagnosticReport
Base StructureDefinition for DiagnosticReport Resource
- type Profile on DiagnosticReport
- 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
| DiagnosticReport | C | DomainResource | Element idDiagnosticReportShort description A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports Alternate namesReport, Test, Result, Results, Labs, Laboratory DefinitionThe findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports. This is intended to capture a single report, and is not suitable for use in displaying summary information that covers multiple reports. For example, this resource has not been designed for laboratory cumulative reporting formats nor detailed structured reports for sequencing.
| |||
| id | Σ | 0..1 | id | There are no (further) constraints on this element Element idDiagnosticReport.idShort description 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 idDiagnosticReport.metaShort description 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 idDiagnosticReport.implicitRulesShort description 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 idDiagnosticReport.languageShort description 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. http://hl7.org/fhir/ValueSet/languages (extensible) Binding extensions
| |||
| text | C | 0..1 | Narrative | There are no (further) constraints on this element Element idDiagnosticReport.textShort description 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. The cardinality or value of this element may be affected by these constraints: dom-1 Mappings
| ||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idDiagnosticReport.containedShort description 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 idDiagnosticReport.extensionShort description 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 idDiagnosticReport.modifierExtensionShort description 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 idDiagnosticReport.identifierShort description Business identifier for report Alternate namesReportID, Filler ID, Placer ID DefinitionIdentifiers assigned to this report by the performer or other systems. Need to know what identifier to use when making queries about this report from the source laboratory, and for linking to the report outside FHIR context. Usually assigned by the Information System of the diagnostic service provider (filler id). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| basedOn | C | 0..* | Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ProcedureRequest | ReferralRequest) | Element idDiagnosticReport.basedOnShort description What was requested Alternate namesRequest DefinitionDetails concerning a test or procedure requested. This allows tracing of authorization for the report and tracking whether proposals/recommendations were acted upon. Note: Usually there is one test request for each result, however in some circumstances multiple test requests may be represented using a single test result resource. Note that there are also cases where one request leads to multiple reports. Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ProcedureRequest | ReferralRequest) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| status | Σ ?! | 1..1 | codeBinding | Element idDiagnosticReport.statusShort description registered | partial | preliminary | final + DefinitionThe status of the diagnostic report as a whole. Diagnostic services routinely issue provisional/incomplete reports, and sometimes withdraw previously released reports. This is labeled as "Is Modifier" because applications need to take appropriate action if a report is withdrawn. The status of the diagnostic report as a whole. http://hl7.org/fhir/ValueSet/diagnostic-report-status (required) Constraints
| ||
| category | Σ | 0..1 | CodeableConcept | Element idDiagnosticReport.categoryShort description Service category Alternate namesDepartment, Sub-department, Service, Discipline DefinitionA code that classifies the clinical discipline, department or diagnostic service that created the report (e.g. cardiology, biochemistry, hematology, MRI). This is used for searching, sorting and display purposes. The level of granularity is defined by the category concepts in the value set. More fine-grained filtering can be performed using the metadata and/or terminology hierarchy in DiagnosticReport.code. Codes for diagnostic service sections. http://hl7.org/fhir/ValueSet/diagnostic-service-sections (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| code | Σ | 1..1 | CodeableConceptBinding | Element idDiagnosticReport.codeShort description Name/Code for this diagnostic report Alternate namesType DefinitionA code or name that describes this diagnostic report. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Codes that describe Diagnostic Reports. http://hl7.org/fhir/ValueSet/report-codes (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| subject | Σ C | 0..1 | Reference(Patient | Group | Device | Location) | Element idDiagnosticReport.subjectShort description The subject of the report - usually, but not always, the patient Alternate namesPatient DefinitionThe subject of the report. Usually, but not always, this is a patient. However diagnostic services also perform analyses on specimens collected from a variety of other sources. SHALL know the subject context. 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(Patient | Group | Device | Location) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| context | Σ C | 0..1 | Reference(Encounter | EpisodeOfCare) | Element idDiagnosticReport.contextShort description Health care event when test ordered Alternate namesEncounter DefinitionThe healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport per is about. Links the request to the Encounter context. This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter or episode but still be tied to the context of the encounter or episode (e.g. pre-admission lab tests). Reference(Encounter | EpisodeOfCare) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| effective[x] | Σ | 0..1 | Element idDiagnosticReport.effective[x]Short description Clinically relevant time/time-period for report Alternate namesObservation time, Effective Time, Occurrence DefinitionThe time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself. Need to know where in the patient history to file/present this report. If the diagnostic procedure was performed on the patient, this is the time it was performed. If there are specimens, the diagnostically relevant time can be derived from the specimen collection times, but the specimen information is not always available, and the exact relationship between the specimens and the diagnostically relevant time is not always automatic. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| effectiveDateTime | dateTime | Data type | ||||
| effectivePeriod | Period | Data type | ||||
| issued | Σ | 0..1 | instant | Element idDiagnosticReport.issuedShort description DateTime this version was released Alternate namesDate Created, Date published, Date Issued DefinitionThe date and time that this version of the report was released from the source diagnostic service. Clinicians need to be able to check the date that the report was released. May be different from the update time of the resource itself, because that is the status of the record (potentially a secondary copy), not the actual release time of the report.
| ||
| performer | Σ | 0..* | BackboneElement | Element idDiagnosticReport.performerShort description Participants in producing the report Alternate namesLaboratory, Service, Practitioner, Department, Company DefinitionIndicates who or what participated in producing the report. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idDiagnosticReport.performer.idShort description 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 idDiagnosticReport.performer.extensionShort description 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 idDiagnosticReport.performer.modifierExtensionShort description 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.
| ||
| role | Σ | 0..1 | CodeableConcept | Element idDiagnosticReport.performer.roleShort description Type of performer DefinitionDescribes the type of participation (e.g. a responsible party, author, or verifier). Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Indicate a role of diagnostic report performer http://hl7.org/fhir/ValueSet/performer-role (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| actor | Σ C | 1..1 | Reference(Practitioner | Organization) | Element idDiagnosticReport.performer.actorShort description Practitioner or Organization participant DefinitionThe reference to the practitioner or organization involved in producing the report. For example, the diagnostic service that is responsible for issuing the report. Need to know whom to contact if there are queries about the results. Also may need to track the source of reports for secondary data analysis. This is not necessarily the source of the atomic data items. It is the entity that takes responsibility for the clinical report. Reference(Practitioner | Organization) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| specimen | C | 0..* | Reference(Specimen) | Element idDiagnosticReport.specimenShort description Specimens this report is based on DefinitionDetails about the specimens on which this diagnostic report is based. Need to be able to report information about the collected specimens on which the report is based. If the specimen is sufficiently specified with a code in the test result name, then this additional data may be redundant. If there are multiple specimens, these may be represented per observation or group. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| result | C | 0..* | Reference(Observation) | Element idDiagnosticReport.resultShort description Observations - simple, or complex nested groups Alternate namesData, Atomic Value, Result, Atomic result, Data, Test, Analyte, Battery, Organizer DefinitionObservations that are part of this diagnostic report. Observations can be simple name/value pairs (e.g. "atomic" results), or they can be grouping observations that include references to other members of the group (e.g. "panels"). Need to support individual results, or report groups of results, where the result grouping is arbitrary, but meaningful. This structure is recursive - observations can contain observations. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| imagingStudy | C | 0..* | Reference(ImagingStudy | ImagingManifest) | Element idDiagnosticReport.imagingStudyShort description Reference to full details of imaging associated with the diagnostic report DefinitionOne or more links to full details of any imaging performed during the diagnostic investigation. Typically, this is imaging performed by DICOM enabled modalities, but this is not required. A fully enabled PACS viewer can use this information to provide views of the source images. ImagingStudy and ImageManifest and the image element are somewhat overlapping - typically, the list of image references in the image element will also be found in one of the imaging study resources. However each caters to different types of displays for different types of purposes. Neither, either, or both may be provided. Reference(ImagingStudy | ImagingManifest) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| image | Σ | 0..* | BackboneElement | Element idDiagnosticReport.imageShort description Key images associated with this report Alternate namesDICOM, Slides, Scans DefinitionA list of key images associated with this report. The images are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest). Many diagnostic services include images in the report as part of their service. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idDiagnosticReport.image.idShort description 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 idDiagnosticReport.image.extensionShort description 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 idDiagnosticReport.image.modifierExtensionShort description 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.
| ||
| comment | 0..1 | string | Element idDiagnosticReport.image.commentShort description Comment about the image (e.g. explanation) DefinitionA comment about the image. Typically, this is used to provide an explanation for why the image is included, or to draw the viewer's attention to important features. The provider of the report should make a comment about each image included in the report. The comment should be displayed with the image. It would be common for the report to include additional discussion of the image contents in other sections such as the conclusion.
| |||
| link | Σ C | 1..1 | Reference(Media) | Element idDiagnosticReport.image.linkShort description Reference to the image source DefinitionReference to the image source. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| conclusion | 0..1 | string | Element idDiagnosticReport.conclusionShort description Clinical Interpretation of test results Alternate namesReport DefinitionConcise and clinically contextualized impression / summary of the diagnostic report. Need to be able to provide a conclusion that is not lost among the basic result data. Note that FHIR strings may not exceed 1MB in size
| |||
| codedDiagnosis | 0..* | CodeableConcept | Element idDiagnosticReport.codedDiagnosisShort description Codes for the conclusion DefinitionCodes for the conclusion. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Diagnosis codes provided as adjuncts to the report. http://hl7.org/fhir/ValueSet/clinical-findings (example) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| presentedForm | C | 0..* | Attachment | Element idDiagnosticReport.presentedFormShort description Entire report as issued DefinitionRich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent. Gives laboratory the ability to provide its own fully formatted report for clinical fidelity. "application/pdf" is recommended as the most reliable and interoperable in this context. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
Documentation:
https://simplifier.net/test20171053/diagnosticreport
Last updated on