This page is part of the FHIR Specification (v0.5.0: DSTU 2 Ballot 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2
This resource maintained by the Orders and Observations Work Group
The 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 interpretation, and formatted representation of diagnostic reports.
A diagnostic report (in contrast to the DiagnosticReport resource) is the set of information that is typically provided by a diagnostic service when investigations are complete. The information includes a mix of atomic results, text reports, images, and codes. The mix varies depending on the nature of the diagnostic procedure, and sometimes on the nature of the outcomes for a particular investigation. In FHIR, the report can conveyed in a variety of ways including a Document, RESTful API, or Messaging framework. Included within each of these, would be the DiagnosticReport resource itself.
The DiagnosticReport resource is suitable for the following kinds of diagnostic reports:
The DiagnosticReport resource is not intended to support cumulative result presentation (tabular presentation of past and present results in the resource). The DiagnosticReport resource does not yet provide full support for detailed structured reports of sequencing; this is planned for a future release.
The DiagnosticReport resource has the following aspects:
The words "tests", "results", "observations", "panels" and "batteries" are often used interchangeably when describing the various parts of a diagnostic report. This leads to much confusion. The naming confusion is worsened because of the wide variety of forms that the result of a diagnostic investigation can take, as described above. Languages other than English have their own variations on this theme.
This resource uses one particular set of terms. A practitioner "requests" a set of "tests". The diagnostic service returns a "report" which may contain a "narrative" - a written summary of the outcomes, and/or "results" - the individual pieces of atomic data which each are "observations". The results are assembled in "groups" which are nested structures of Observations that can be used to represent relationships between the individual data items.
This resource is referenced by ClinicalImpression, Condition and Procedure
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DiagnosticReport | DomainResource | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports | ||
name | Σ | 1..1 | CodeableConcept | Name/Code for this diagnostic report DiagnosticReportNames (Required) |
status | ?! Σ | 1..1 | code | registered | partial | final | corrected | appended | cancelled | entered-in-error DiagnosticReportStatus (Required) |
issued | Σ | 1..1 | dateTime | Date this version was released |
subject | Σ | 1..1 | Patient | Group | Device | Location | The subject of the report, usually, but not always, the patient |
performer | Σ | 1..1 | Practitioner | Organization | Responsible Diagnostic Service |
encounter | Σ | 0..1 | Encounter | Health care event when test ordered |
identifier | Σ | 0..* | Identifier | Id for external references to this report |
requestDetail | 0..* | DiagnosticOrder | What was requested | |
serviceCategory | Σ | 0..1 | CodeableConcept | Biochemistry, Hematology etc. DiagnosticServiceSection (Example) |
diagnostic[x] | Σ | Physiologically Relevant time/time-period for report | ||
diagnosticDateTime | 1..1 | dateTime | ||
diagnosticPeriod | 1..1 | Period | ||
specimen | 0..* | Specimen | Specimens this report is based on | |
result | 0..* | Observation | Observations - simple, or complex nested groups | |
imagingStudy | 0..* | ImagingStudy | Reference to full details of imaging associated with the diagnostic report | |
image | Σ | 0..* | Element | Key images associated with this report |
comment | 0..1 | string | Comment about the image (e.g. explanation) | |
link | Σ | 1..1 | Media | Reference to the image source |
conclusion | 0..1 | string | Clinical Interpretation of test results | |
codedDiagnosis | 0..* | CodeableConcept | Codes for the conclusion AdjunctDiagnosis (Example) | |
presentedForm | 0..* | Attachment | Entire Report as issued |
UML Diagram
XML Template
<DiagnosticReport xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <name><!-- 1..1 CodeableConcept Name/Code for this diagnostic report --></name> <status value="[code]"/><!-- 1..1 registered | partial | final | corrected | appended | cancelled | entered-in-error --> <issued value="[dateTime]"/><!-- 1..1 Date this version was released --> <subject><!-- 1..1 Reference(Patient|Group|Device|Location) The subject of the report, usually, but not always, the patient --></subject> <performer><!-- 1..1 Reference(Practitioner|Organization) Responsible Diagnostic Service --></performer> <encounter><!-- 0..1 Reference(Encounter) Health care event when test ordered --></encounter> <identifier><!-- 0..* Identifier Id for external references to this report --></identifier> <requestDetail><!-- 0..* Reference(DiagnosticOrder) What was requested --></requestDetail> <serviceCategory><!-- 0..1 CodeableConcept Biochemistry, Hematology etc. --></serviceCategory> <diagnostic[x]><!-- 1..1 dateTime|Period Physiologically Relevant time/time-period for report --></diagnostic[x]> <specimen><!-- 0..* Reference(Specimen) Specimens this report is based on --></specimen> <result><!-- 0..* Reference(Observation) Observations - simple, or complex nested groups --></result> <imagingStudy><!-- 0..* Reference(ImagingStudy) Reference to full details of imaging associated with the diagnostic report --></imagingStudy> <image> <!-- 0..* Key images associated with this report --> <comment value="[string]"/><!-- 0..1 Comment about the image (e.g. explanation) --> <link><!-- 1..1 Reference(Media) Reference to the image source --></link> </image> <conclusion value="[string]"/><!-- 0..1 Clinical Interpretation of test results --> <codedDiagnosis><!-- 0..* CodeableConcept Codes for the conclusion --></codedDiagnosis> <presentedForm><!-- 0..* Attachment Entire Report as issued --></presentedForm> </DiagnosticReport>
JSON Template
{ "resourceType" : "DiagnosticReport", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "name" : { CodeableConcept }, // R! Name/Code for this diagnostic report "status" : "<code>", // R! registered | partial | final | corrected | appended | cancelled | entered-in-error "issued" : "<dateTime>", // R! Date this version was released "subject" : { Reference(Patient|Group|Device|Location) }, // R! The subject of the report, usually, but not always, the patient "performer" : { Reference(Practitioner|Organization) }, // R! Responsible Diagnostic Service "encounter" : { Reference(Encounter) }, // Health care event when test ordered "identifier" : [{ Identifier }], // Id for external references to this report "requestDetail" : [{ Reference(DiagnosticOrder) }], // What was requested "serviceCategory" : { CodeableConcept }, // Biochemistry, Hematology etc. // diagnostic[x]: Physiologically Relevant time/time-period for report. One of these 2: "diagnosticDateTime" : "<dateTime>", "diagnosticPeriod" : { Period }, "specimen" : [{ Reference(Specimen) }], // Specimens this report is based on "result" : [{ Reference(Observation) }], // Observations - simple, or complex nested groups "imagingStudy" : [{ Reference(ImagingStudy) }], // Reference to full details of imaging associated with the diagnostic report "image" : [{ // Key images associated with this report "comment" : "<string>", // Comment about the image (e.g. explanation) "link" : { Reference(Media) } // R! Reference to the image source }], "conclusion" : "<string>", // Clinical Interpretation of test results "codedDiagnosis" : [{ CodeableConcept }], // Codes for the conclusion "presentedForm" : [{ Attachment }] // Entire Report as issued }
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DiagnosticReport | DomainResource | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports | ||
name | Σ | 1..1 | CodeableConcept | Name/Code for this diagnostic report DiagnosticReportNames (Required) |
status | ?! Σ | 1..1 | code | registered | partial | final | corrected | appended | cancelled | entered-in-error DiagnosticReportStatus (Required) |
issued | Σ | 1..1 | dateTime | Date this version was released |
subject | Σ | 1..1 | Patient | Group | Device | Location | The subject of the report, usually, but not always, the patient |
performer | Σ | 1..1 | Practitioner | Organization | Responsible Diagnostic Service |
encounter | Σ | 0..1 | Encounter | Health care event when test ordered |
identifier | Σ | 0..* | Identifier | Id for external references to this report |
requestDetail | 0..* | DiagnosticOrder | What was requested | |
serviceCategory | Σ | 0..1 | CodeableConcept | Biochemistry, Hematology etc. DiagnosticServiceSection (Example) |
diagnostic[x] | Σ | Physiologically Relevant time/time-period for report | ||
diagnosticDateTime | 1..1 | dateTime | ||
diagnosticPeriod | 1..1 | Period | ||
specimen | 0..* | Specimen | Specimens this report is based on | |
result | 0..* | Observation | Observations - simple, or complex nested groups | |
imagingStudy | 0..* | ImagingStudy | Reference to full details of imaging associated with the diagnostic report | |
image | Σ | 0..* | Element | Key images associated with this report |
comment | 0..1 | string | Comment about the image (e.g. explanation) | |
link | Σ | 1..1 | Media | Reference to the image source |
conclusion | 0..1 | string | Clinical Interpretation of test results | |
codedDiagnosis | 0..* | CodeableConcept | Codes for the conclusion AdjunctDiagnosis (Example) | |
presentedForm | 0..* | Attachment | Entire Report as issued |
XML Template
<DiagnosticReport xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <name><!-- 1..1 CodeableConcept Name/Code for this diagnostic report --></name> <status value="[code]"/><!-- 1..1 registered | partial | final | corrected | appended | cancelled | entered-in-error --> <issued value="[dateTime]"/><!-- 1..1 Date this version was released --> <subject><!-- 1..1 Reference(Patient|Group|Device|Location) The subject of the report, usually, but not always, the patient --></subject> <performer><!-- 1..1 Reference(Practitioner|Organization) Responsible Diagnostic Service --></performer> <encounter><!-- 0..1 Reference(Encounter) Health care event when test ordered --></encounter> <identifier><!-- 0..* Identifier Id for external references to this report --></identifier> <requestDetail><!-- 0..* Reference(DiagnosticOrder) What was requested --></requestDetail> <serviceCategory><!-- 0..1 CodeableConcept Biochemistry, Hematology etc. --></serviceCategory> <diagnostic[x]><!-- 1..1 dateTime|Period Physiologically Relevant time/time-period for report --></diagnostic[x]> <specimen><!-- 0..* Reference(Specimen) Specimens this report is based on --></specimen> <result><!-- 0..* Reference(Observation) Observations - simple, or complex nested groups --></result> <imagingStudy><!-- 0..* Reference(ImagingStudy) Reference to full details of imaging associated with the diagnostic report --></imagingStudy> <image> <!-- 0..* Key images associated with this report --> <comment value="[string]"/><!-- 0..1 Comment about the image (e.g. explanation) --> <link><!-- 1..1 Reference(Media) Reference to the image source --></link> </image> <conclusion value="[string]"/><!-- 0..1 Clinical Interpretation of test results --> <codedDiagnosis><!-- 0..* CodeableConcept Codes for the conclusion --></codedDiagnosis> <presentedForm><!-- 0..* Attachment Entire Report as issued --></presentedForm> </DiagnosticReport>
JSON Template
{ "resourceType" : "DiagnosticReport", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "name" : { CodeableConcept }, // R! Name/Code for this diagnostic report "status" : "<code>", // R! registered | partial | final | corrected | appended | cancelled | entered-in-error "issued" : "<dateTime>", // R! Date this version was released "subject" : { Reference(Patient|Group|Device|Location) }, // R! The subject of the report, usually, but not always, the patient "performer" : { Reference(Practitioner|Organization) }, // R! Responsible Diagnostic Service "encounter" : { Reference(Encounter) }, // Health care event when test ordered "identifier" : [{ Identifier }], // Id for external references to this report "requestDetail" : [{ Reference(DiagnosticOrder) }], // What was requested "serviceCategory" : { CodeableConcept }, // Biochemistry, Hematology etc. // diagnostic[x]: Physiologically Relevant time/time-period for report. One of these 2: "diagnosticDateTime" : "<dateTime>", "diagnosticPeriod" : { Period }, "specimen" : [{ Reference(Specimen) }], // Specimens this report is based on "result" : [{ Reference(Observation) }], // Observations - simple, or complex nested groups "imagingStudy" : [{ Reference(ImagingStudy) }], // Reference to full details of imaging associated with the diagnostic report "image" : [{ // Key images associated with this report "comment" : "<string>", // Comment about the image (e.g. explanation) "link" : { Reference(Media) } // R! Reference to the image source }], "conclusion" : "<string>", // Clinical Interpretation of test results "codedDiagnosis" : [{ CodeableConcept }], // Codes for the conclusion "presentedForm" : [{ Attachment }] // Entire Report as issued }
Alternate definitions: Schema/Schematron, Resource Profile (XML, JSON)
Path | Definition | Type | Reference |
---|---|---|---|
DiagnosticReport.name | Codes that describe Diagnostic Reports | Required | http://hl7.org/fhir/vs/report-names |
DiagnosticReport.status | The status of the diagnostic report as a whole | Required | http://hl7.org/fhir/diagnostic-report-status |
DiagnosticReport.serviceCategory | Codes for diagnostic service sections | Example | http://hl7.org/fhir/vs/diagnostic-service-sections |
DiagnosticReport.codedDiagnosis | Diagnoses codes provided as adjuncts to the report | Example | http://hl7.org/fhir/vs/clinical-findings |
Examples of nested report groups: the antibody hepatitis order panel code for a group of hepatitis antibody related tests, or the organism code for a group of antibiotic isolate/sensitivities, or a set of perinatal measurements on a single fetus.
This resource provides for 3 different ways of presenting the Diagnostic Report:
Note that the conclusion and the coded diagnoses are part of the atomic data, and SHOULD be duplicated in the narrative and in the presented form if the latter is present. The narrative and the presented form serve the same function: a representation of the report for a human. The presented form is included since diagnostic service reports often contain presentation features that are not easy to reproduce in the HTML narrative. Whether or not the presented form is included, the narrative must be a clinically safe view of the diagnostic report; at a minimum, this could be fulfilled by a note indicating that the narrative is not proper representation of the report, and that the presented form must be used, or a generated view from the atomic data. However consumers of the report will best be served if the narrative contains clinically relevant data from the form. Commonly, the following patterns are used:
Note that the nature of reports from the various disciplines that provide diagnostic reports are changing quickly, as expert systems provide improved narrative reporting in high volume reports, structured reporting brings additional data to areas that have classically been narrative based, and the nature of the imaging and laboratory procedures are merging. As a consequence the patterns described above are only examples of how a diagnostic report can be used.
Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
Name | Type | Description | Paths |
date | date | The clinically relevant time of the report | DiagnosticReport.diagnostic[x] |
diagnosis | token | A coded diagnosis on the report | DiagnosticReport.codedDiagnosis |
encounter | reference | The Encounter when the order was made | DiagnosticReport.encounter (Encounter) |
identifier | token | An identifier for the report | DiagnosticReport.identifier |
image | reference | Reference to the image source | DiagnosticReport.image.link (Media) |
issued | date | When the report was issued | DiagnosticReport.issued |
name | token | The name of the report (e.g. the code for the report as a whole, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result) | DiagnosticReport.name |
patient | reference | The subject of the report if a patient | DiagnosticReport.subject (Patient) |
performer | reference | Who was the source of the report (organization) | DiagnosticReport.performer (Organization, Practitioner) |
request | reference | What was requested | DiagnosticReport.requestDetail (DiagnosticOrder) |
result | reference | Link to an atomic result (observation resource) | DiagnosticReport.result (Observation) |
service | token | Which diagnostic discipline/department created the report | DiagnosticReport.serviceCategory |
specimen | reference | The specimen details | DiagnosticReport.specimen (Specimen) |
status | token | The status of the report | DiagnosticReport.status |
subject | reference | The subject of the report | DiagnosticReport.subject (Device, Location, Patient, Group) |