DiagnosticReport

Overview

For the DiagnosticReport resource query, the API returns test names and result values for test types that the Soarian client has configured as appropriate for the API. The ONC (Office of the National Coordinator) CCDS (common clinical data set) definition includes laboratory tests and values, however, clients may configure additional qualifying test types such as radiology, cardiology, etc. The configuration of qualifying test types is a single configuration that applies to both the API and the Consolidated Clinical Document Architecture (C-CDA) document available to the patients.

The API returns the test names and values in reverse chronological order by result date and, within that, the sequence that is configured in the Soarian flowsheet that defines the qualified tests. Qualified results of status Final, Corrected and Cancelled are returned. Result values of numeric or text are returned; image only results, including those encapsulated in non-text formats such as pdf, are not returned. Since each result is individually dated and the value is unambiguously relevant for that date, this resource supports date-based queries.

Terminology Bindings

DiagnosticReport.code
  • Description
    • Codes that describe Diagnostic Reports.
  • Details: LOINC
    System: http://loinc.org

Custom Extensions

The bundle extension can be returned, see possible codes in the errors section below.

Status Extension:

The URL for this status extension is defined as http://cerner.hs.fhir.com/StructureDefinition/additional-status

ID Value[x] Type Description
additional-status string This element further qualifies DiagnosticReport resources that have a status of “cancelled”. Possible value is “Can not obtain”.
GET /DiagnosticReport?:parameters

Implementation Notes

Parameters

Name Required? Type Description
patientId Y reference The patient identifier provided in a pre-requisite authorization step.
date N date as adjusted per implementation notes Null or specific date or a date range.

Notes:

Headers

Accept: application/json+fhir
Authorization: <OAuth2 Bearer Token>

Example

Request

GET https://fhir-myrecord.sandboxcerner.com/dstu2/123abc/DiagnosticReport?patientId=D4292B7B-AEDF-4CEF-B783-BD3AA1B0DD27

Response

Status: 200 OK
{
  "resourceType": "Bundle",
  "id": "b295a021-37a3-4c56-87f8-10ba2415bba8",
  "meta": {
    "lastUpdated": "2018-04-10T09:45:51.632-04:00"
  },
  "type": "searchset",
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-myrecord.sandboxcerner.com/dstu2/0e885770-571b-4c0c-b30f-21df9a058d0d/DiagnosticReport?patientId=D4292B7B-AEDF-4CEF-B783-BD3AA1B0DD27&_format=json&page=2"
    },
    {
      "relation": "next",
      "url": "https://fhir-myrecord.sandboxcerner.com/dstu2/0e885770-571b-4c0c-b30f-21df9a058d0d/DiagnosticReport?patientId=D4292B7B-AEDF-4CEF-B783-BD3AA1B0DD27&_format=json&page=3"
    }
  ],
  "entry": [
    {
      "resource": {
        "resourceType": "DiagnosticReport",
        "text": {
          "status": "additional",
          "div": "&lt;span ccdRefId="ZCCD-Results.Chemistry..624">&lt;b>Hgb &lt;/b>10.2 g/dl&lt;font color="#737373">   (Reference Range: not available)&lt;/font>&lt;br/>&lt;/span>"
        },
        "identifier": [
          {
            "use": "official",
            "value": "ZCCD-Results.Chemistry..624"
          }
        ],
        "status": "final",
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "30313-1"
            }
          ]
        },
        "subject": {
          "reference": "Patient/7568F2F3-FC76-4185-A540-1DB56331A387"
        },
        "effectiveDateTime": "2015-06-22",
        "issued": "2015-06-22T13:00:00",
        "performer": {

        }
      }
    },
    {
      "resource": {
        "resourceType": "DiagnosticReport",
        "text": {
          "status": "additional",
          "div": "&lt;span ccdRefId="ZCCD-Results.Chemistry..626">&lt;b>PLT &lt;/b>123 10*3/ul&lt;font color="#737373">   (Reference Range: not available)&lt;/font>&lt;br/>&lt;/span>"
        },
        "identifier": [
          {
            "use": "official",
            "value": "ZCCD-Results.Chemistry..626"
          }
        ],
        "status": "final",
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "26515-7"
            }
          ]
        },
        "subject": {
          "reference": "Patient/7568F2F3-FC76-4185-A540-1DB56331A387"
        },
        "effectiveDateTime": "2015-06-22",
        "issued": "2015-06-22T13:00:00",
        "performer": {

        }
      }
    },
    {
      "resource": {
        "resourceType": "DiagnosticReport",
        "text": {
          "status": "additional",
          "div": "&lt;span ccdRefId="ZCCD-Results.Diag Image Rpt..13919">&lt;b>Chest X-Ray 2 Views &lt;/b>Lungs are not clear. Other tests are required to confirm Anemia. &lt;font color="#737373">   (Reference Range: not available)&lt;/font>&lt;br/>&lt;/span>"
        },
        "identifier": [
          {
            "use": "official",
            "value": "ZCCD-Results.Diag Image Rpt..13919"
          }
        ],
        "status": "final",
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "36643-5"
            }
          ]
        },
        "subject": {
          "reference": "Patient/7568F2F3-FC76-4185-A540-1DB56331A387"
        },
        "effectiveDateTime": "2015-06-22",
        "issued": "2015-06-22T14:00:00",
        "performer": {

        }
      }
    },
    {
      "resource": {
        "resourceType": "DiagnosticReport",
        "text": {
          "status": "additional",
          "div": "&lt;span ccdRefId="ZCCD-Results.Urinalysis.830">&lt;b>Protein [Mass/Urine] in urine by test strip &lt;/b>100 mg/dl&lt;i> (negative mg/dl)&lt;/i>&lt;/span>"
        },
        "identifier": [
          {
            "use": "official",
            "value": "ZCCD-Results.Urinalysis.830"
          }
        ],
        "status": "final",
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "5804-0"
            }
          ]
        },
        "subject": {
          "reference": "Patient/7568F2F3-FC76-4185-A540-1DB56331A387"
        },
        "effectiveDateTime": "2015-06-22",
        "issued": "2015-06-22T13:00:00",
        "performer": {

        }
      }
    }
  ]
}

Errors and Informational messages

The common errors and informational messages can be returned.

These additional informational messages may be returned within the bundle extension:

Code Message
papi008 No relevant clinical data exists.
papi028 Provides the date range that had start date as null.
papi029 Provides the date range that was used to run the search.