DiagnosticReport read

get/DiagnosticReport/{id}

Page View

This resource contains clinical context for diagnostic tests (e.g., lab tests, pathology, imaging) performed on a patient or group of patients. Diagnostic reports may contain discrete results, images, or codes.

You can review, retrieve, create, or update diagnostic reports.

Supported fields and schema examples

We support any valid FHIR® field. However, we only display fields we’ve defined in our schema, which are usually based on what’s included in the U.S. Core profile. We recommend relying on U.S. Core requirements.

Our schema examples show the shape and possibility of each FHIR® resource; they aren’t code for real-time API calls. We don’t currently recommend copying and pasting these schema examples for your API calls. Consider reviewing FHIR® API actions for realistic examples for particular use cases.

read

Review a specific DiagnosticReport resource with details about a diagnostic test completed for a patient or group of patients.

FHIR read

To use a read interaction, you must know the related resource ID, which you may not have in your real workflows. A read is likely only a follow-up option after receiving the specific resource in a recent FHIR® passthrough or data on demand exchange.

Typically, you should use the more flexible _search with query parameters, unless you're guaranteed to request data directly from a FHIR® server using the resource ID. Learn more about using FHIR® identifiers.

Request parameters

cURL request example

bash

1
curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/DiagnosticReport/{id}' \
2
--request GET \
3
--header 'Authorization: Bearer $API_TOKEN'

Request Parameters

id
required, string
DiagnosticReport identifier

Response fields and example

CBC w/o Differential

json

1
{}

resourceType
required, string
Identifies the type of the resource
Value: DiagnosticReport
status
required, string
The status of the diagnostic report.
Possible Values: registered, partial, preliminary, final, amended, corrected, appended, cancelled, entered-in-error, unknown
category
required, Array of LaboratorySlice or Other
A 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.
code
required, object
The test, panel or battery that was ordered.
- coding
  Array of object
  A reference to a code defined by a terminology system.
  system
  string
  The identification of the code system that defines the meaning of the symbol in the code.
  code
  string
  A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
- text
  string
  A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
subject
required, object
The 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.

Must be a resource of type Patient.
- reference
  string
  A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.
id
string
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
Array of object
Identifiers assigned to this report by the performer or other systems.
- extension
  Array of Boolean, String, CodeableConcept, Coding
  May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
  One of:
  url
  required, string
  Source of the definition for the extension code - a logical name or a URL.
  valueBoolean
  boolean
  A single value for the extension.
- use
  string
  The purpose of this identifier.
  Possible Values: usual, official, temp, secondary, old (If known)
- system
  string
  Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
- value
  string
  The portion of the identifier typically relevant to the user and which is unique within the context of the system.
encounter
object
The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport is about.

Must be a resource of type Encounter.
- reference
  string
  A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.
issued
string
The date and time that this version of the report was made available to providers, typically after the report was reviewed and verified.
performer
Array of object
The diagnostic service that is responsible for issuing the report.

Must reference one of the following types of resources:
- Practitioner
- Organization
- reference
  string
  A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.
specimen
Array of object
Details about the specimens on which this diagnostic report is based.

Must be a resource of type Specimen.
- reference
  string
  A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.
result
Array of object
Observations that are part of this diagnostic report.

Must be a resource of type Observation.
- reference
  string
  A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.
presentedForm
Array of object
Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent.
- contentType
  string
  Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.
- data
  string
  The actual data of the attachment - a sequence of bytes, base64 encoded.
effectiveDateTime
string
The 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.

FHIR® is a registered trademark of Health Level Seven International (HL7) and is used with the permission of HL7. Use of this trademark does not constitute an endorsement of products/services by HL7®.