Home
API reference
FHIR® API
FHIR® resources
DiagnosticReport
_search

DiagnosticReport _search

post/DiagnosticReport/_search
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.

_search

Query for details about a diagnostic test completed for a patient or group of patients from one provider. Review tips for diagnostic result searches.

Request parameters and payload

cURL request example

bash
1
curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/DiagnosticReport/_search' \
2
--request POST \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'Content-Type: application/x-www-form-urlencoded' \
5
--data-urlencode '_lastUpdated=string' \
6
--data-urlencode 'identifier=string' \
7
--data-urlencode 'date=string' \
8
--data-urlencode 'issued=string' \
9
--data-urlencode 'subject=string' \
10
--data-urlencode 'subject.identifier=string' \
11
--data-urlencode 'patient=string' \
12
--data-urlencode 'patient.identifier=string' \
13
--data-urlencode 'status=string' \
14
--data-urlencode 'code=string' \
15
--data-urlencode 'context=string' \
16
--data-urlencode 'context.identifier=string' \
17
--data-urlencode 'result=string' \
18
--data-urlencode 'result.identifier=string' \
19
--data-urlencode 'category=string'

Request Body Schema

  • identifier
    Array of string

    An identifier for the report

  • date
    Array of string

    The clinically relevant time of the report

  • issued
    Array of string

    When the report was issued

  • subject
    Array of string

    The subject of the report

  • subject.identifier
    Array of string

    One or more external identifiers for the patient

  • patient
    Array of string

    The subject of the report if a patient

  • patient.identifier
    Array of string

    One or more external identifiers for the patient

  • status
    Array of string

    The status of the report

  • code
    Array of string

    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

  • context
    Array of string

    Healthcare event (Episode of Care or Encounter) related to the report

  • context.identifier
    Array of string

    Identifier(s) by which this encounter is known

  • result
    Array of string

    Link to an atomic result (observation resource)

  • result.identifier
    Array of string

    An identifier for the observation

  • category
    Array of string

    Which diagnostic discipline/department created the report

  • _lastUpdated
    Array of string

    Select resources based on the last time they were changed

Response fields and example

json
1
{}

    Response to a DiagnosticReport search operation. Unless the _include parameter is sent, only DiagnosticReport resources are returned.

  • resourceType
    required, string

    Identifies the type of the resource

    Value: Bundle
  • type
    required, string

    Identifies this bundle as a response to a search

    Value: searchset
  • total
    required, number

    The total number of matches

  • entry
    Array of DiagnosticReport, Observation, Specimen or Other

    A resource matching the search criteria or related to a matching resource

    • resource
      required, object

      A DiagnosticReport resource

      • 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.

          Identifies the DiagnosticReport as containing a laboratory result

        • coding
          required, Array of object
          • system
            required, string
            Value: http://terminology.hl7.org/CodeSystem/v2-0074
          • code
            required, string
            Value: LAB
      • 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.

          • 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.

    • search
      required, object

      Information about the search process that lead to the creation of this entry.

      • mode
        required, string

        Identifies the DiagnosticReport as matching the search parameters

        Value: match