Resources: DSTU2: DiagnosticReport

DiagnosticReport resource

The DiagnosticReport resource is used to retrieve diagnostic reports for a patient (DAF DiagnosticReport). Diagnostic reports include a combination of requested information, atomic results, images, interpretation, and formatted reports. The logical ID of the patient is passed as part of the URL. The logical ID is found as the result of a patient search.

To retrieve a patient's lab result diagnostic reports, use the following syntax:

GET {FHIR URL}/FHIR/Patient/{ID}/DiagnosticReport?category=LAB

To retrieve a patient's lab results from January 1, 2016, use the following syntax:

GET {FHIR URL}/FHIR/Patient/{ID}/DiagnosticReport?category=LAB&date=eq2016-01-01

Input parameters

Name Required? Type Description
ID Yes URL The patient's logical ID. This is retrieved using the search function.
date No string A string representing a date to include in the search. See below for more information.

Output specification

Name Type Cardinality Description
resourceType DiagnosticReport
id identifier 0..* Contains the local ID assigned to the report by the order filler, usually by the information system of the diagnostic service provider. You must know what identifier to use when making queries about this report from the source laboratory and for linking to the report outside FHIR context. Alternate name: ReportID.
meta Metadata about the resource. Returns the profile element which includes a link to the Data Access Framework (DAF) for the DiagnosticReport resource.
language code 0..1 Base language in which the resource is written. For more information, see here.
text Contains a human-readable version of the structured data, specifically an HTML representation generated by the data layer based on the underlying resource data.
status code 1..1 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 codes shall be taken from the DiagnosticReportStatus value set, which includes the following statuses: Registered, Partial, Final, Corrected, Appended, Cancelled, and Entered-in-Error. For more information on this value set, see: here.
category CodeableConcept 0..1 System and code that classify the clinical discipline, department, or diagnostic service that created the report. For example, cardiology, biochemistry, hematology, or MRI. This is used for searching, sorting, and displaying purposes. The level of granularity is defined by the category concepts in the DiagnosticServiceSectionCodes value set. More filtering is performed using the metadata and/or terminology hierarchy in DiagnosticReport.code. Alternate names: Department, Sub-department, service, discipline. Example codes include: AU- Audiology, CH- Chemistry, MB- Microbiology, and HM- Hematology. For more information on this value set, see: here.
code CodeableConcept 1..1 Coding and text that indicate the test, panel, or battery that was ordered. The typical patterns for codes are: 1) a LOINC code either as a translation from a "local" code or as a primary code, 2) a local code only if no suitable LOINC exists, or 3) both the local and the LOINC translation. Systems shall be capable of sending the local code if one exists. The codes shall be taken from US Laboratory Observation Profile Observation Name Codes. Other codes may be used where these codes are not suitable. This value set has more than 1000 codes. For more information on this value set, see: here.
subject Reference (Patient, Group, Device, Location) 1..1 Subject of the report. Usually this is a patient. However, diagnostic services also perform analyses on specimens collected from a variety of other sources.
  • reference: Returns the patient ID in the format Patient/[ID].
  • display: Returns the patient name in the format [Lastname],[Firstname].
encounter Reference (Encounter) 0..1 Link to the healthcare event (encounter) when the order was made.
  • reference: Returns the encounter ID in the format Encounter/[ID].
  • display: Returns the encounter type.
effectiveDateTime dateTime 1..1 Specimen collection date and time which is the physically relevant dateTime for laboratory tests. 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.
issued 1..1 Date and time that this version of the report was released from the source diagnostic service. Clinicians must be able to check the date that the report was released. This 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. Alternate names: Date Created, Date published, Date Issued.
performer Reference (Practitioner, Organization) 1..1 Diagnostic service that is responsible for issuing the report. This is helpful to know who to contact if there are queries about the results. You 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. Alternate names: Laboratory, Service, Practitioner, Department, Company.
  • reference: Returns the provider ID in the format Practitioner/[ID].
  • display: Returns the provider name in the format [Lastname],[Firstname].
request Reference (DiagnosticOrder, ProcedureRequest, ReferralRequest) 1..* Details concerning a test or procedure requested. You need to be able to track completion of requests based on reports issued and also to report what diagnostic tests were requested (not always the same as what is delivered). You need to be able to track completion of requests based on reports issued and also to report what diagnostic tests were requested (not always the same as what is delivered).
  • reference: Returns the order ID in the format DiagnosticOrder/[ID].
  • display: Returns the order display name.
result Reference (Observation) 0..* Observations that are part of this diagnostic report. Observations can be simple name/value pairs (for example, "atomic" results), or they can be grouping observations that include references to other members of the group (such as "panels"). You need to support individual results, or report groups of results, where the result grouping is arbitrary, but meaningful. This structure is recursive in that observations can contain observations. Alternate names: Data, Atomic Value, Result, Atomic result, Data, Test, Analyte, Battery, or Organizer.
  • reference: Returns the observation ID in the format Observation/[ID].
  • display: Returns the display name for the observation.
codedDiagnosis CodeableConcept 0..* Codes for the conclusion which are SNOMED CT findings codes provided as adjunct diagnosis to the report. The codes should be taken from SNOMED CT Clinical Findings. Included are codes from where concept is-a 404684003. For more information on this value set, see: here.
  • system: Returns a link to the coding source (such as SNOMED).
  • code: Returns the code for the item.
  • display: Returns the item display name.
  • text: Returns readable version of the item name.