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, or Cannot Obtain 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.

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=1FNHDJ60-D6A1-441F-AA25-FB6FA6719CEA&date=%3E%3D2015-06-01T11%3A55%3A00&date=%3C2015-06-29T11%3A55%3A00

Response

Status: 200 OK
{
  "resourceType": "Bundle",
  "id": "a190218f-2855-45c1-9c74-a4a2a798273a",
  "meta": {
    "lastUpdated": "2017-02-28T11:59:39.646-05:00"
  },
  "extension": [
    {
      "url": "http://cerner.hs.fhir.com/StructureDefinition/bundle-result-messages",
      "valueExtension": {
        "url": "http://cerner.hs.fhir.com/StructureDefinition/bundle-result-messages",
        "extension": [
          {
            "url": "Severity",
            "valueString": "info"
          },
          {
            "url": "Code",
            "valueString": "papi029"
          },
          {
            "url": "Message",
            "valueString": "Information provided is from 2015-06-01 through 2015-06-28 inclusive."
          }
        ]
      }
    },
    {
      "url": "http://cerner.hs.fhir.com/StructureDefinition/bundle-result-messages",
      "valueExtension": {
        "url": "http://cerner.hs.fhir.com/StructureDefinition/bundle-result-messages",
        "extension": [
          {
            "url": "Severity",
            "valueString": "info"
          },
          {
            "url": "Code",
            "valueString": "fsp001"
          },
          {
            "url": "Message",
            "valueString": "Date parameter values passed with request were: date=>=2015-06-01T11:55:00&date=<2015-06-29T11:55:00"
          }
        ]
      }
    }
  ],
  "type": "searchset",
  "link": [
    {
      "relation": "self",
      "url": "base-url/bf615549-44cc-4899-bfa9-2cfd86bf358c/DiagnosticReport?date=%3E%3D2015-06-01T11%3A55%3A00&date=%3C2015-06-29T11%3A55%3A00&_format=json&patientId=7568F2F3-FC76-4185-A540-1DB56331A387"
    }
  ],
  "entry": [
    {
      "resource": {
        "resourceType": "DiagnosticReport",
        "text": {
          "status": "additional",
          "div": "<span ccdRefId=\"ZCCD-Results.Chemistry..624\"><b>Hgb </b>10.2 g/dl<font color=\"#737373\">   (Reference Range: not available)</font><br/></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": "<span ccdRefId=\"ZCCD-Results.Chemistry..625\"><b>WBC </b>12.3 (10*3/ul)<i> (N/A-500,000 (10*3/ul))</i></span>"
        },
        "identifier": [
          {
            "use": "official",
            "value": "ZCCD-Results.Chemistry..625"
          }
        ],
        "status": "final",
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "33765-9"
            }
          ]
        },
        "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": "<span ccdRefId=\"ZCCD-Results.Chemistry..626\"><b>PLT </b>123 (10*3/ul)<font color=\"#737373\">   (Reference Range: not available)</font><br/></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": "<span ccdRefId=\"ZCCD-Results.Hematology..627\"><b>Everolimus Blood </b><span style=\"color:red;\">10 ng/ml H</span><i> (2.0-8.0 ng/ml)</i></span>"
        },
        "identifier": [
          {
            "use": "official",
            "value": "ZCCD-Results.Hematology..627"
          }
        ],
        "status": "final",
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "50544-6"
            }
          ]
        },
        "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": "<span ccdRefId=\"ZCCD-Results.LabTestPanel.9015\"><b>Urinalysis macro (dipstick) panel </b>(Complete) <font color=\"#737373\">   (Reference Range: not available)</font><br/></span>"
        },
        "identifier": [
          {
            "use": "official",
            "value": "ZCCD-Results.LabTestPanel.9015"
          }
        ],
        "status": "final",
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "24357-6"
            }
          ]
        },
        "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": "<span ccdRefId=\"ZCCD-Results.LabTestPanel.9010\"><b>CBC </b>(Complete) <font color=\"#737373\">   (Reference Range: not available)</font><br/></span>"
        },
        "identifier": [
          {
            "use": "official",
            "value": "ZCCD-Results.LabTestPanel.9010"
          }
        ],
        "status": "final",
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "58410-2"
            }
          ]
        },
        "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": "<span ccdRefId=\"ZCCD-Results.Urinalysis.824\"><b>Color of Urine </b>YELLOW <i> (YELLOW )</i></span>"
        },
        "identifier": [
          {
            "use": "official",
            "value": "ZCCD-Results.Urinalysis.824"
          }
        ],
        "status": "final",
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "5778-6"
            }
          ]
        },
        "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": "<span ccdRefId=\"ZCCD-Results.Urinalysis.825\"><b>Appearance of Urine </b>CLEAR <i> (CLEAR )</i></span>"
        },
        "identifier": [
          {
            "use": "official",
            "value": "ZCCD-Results.Urinalysis.825"
          }
        ],
        "status": "final",
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "5767-9"
            }
          ]
        },
        "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": "<span ccdRefId=\"ZCCD-Results.Urinalysis.826\"><b>Specific Gravity of Urine by Test Strip </b>1.015 <i> (1.005-1.030 )</i></span>"
        },
        "identifier": [
          {
            "use": "official",
            "value": "ZCCD-Results.Urinalysis.826"
          }
        ],
        "status": "final",
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "5811-5"
            }
          ]
        },
        "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": "<span ccdRefId=\"ZCCD-Results.Urinalysis.827\"><b>pH of Urine by Test strip </b>5.0 [pH]<i> (5.0-8.0 [pH])</i></span>"
        },
        "identifier": [
          {
            "use": "official",
            "value": "ZCCD-Results.Urinalysis.827"
          }
        ],
        "status": "final",
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "5803-2"
            }
          ]
        },
        "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": "<span ccdRefId=\"ZCCD-Results.Urinalysis.828\"><b>Glucose [Mass/Urine] in urine by test strip </b>50 mg/dl<i> (Neg mg/dl)</i></span>"
        },
        "identifier": [
          {
            "use": "official",
            "value": "ZCCD-Results.Urinalysis.828"
          }
        ],
        "status": "final",
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "5792-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": "<span ccdRefId=\"ZCCD-Results.Urinalysis.829\"><b>Ketones [Mass/Urine] in urine by test strip </b>Negative <i> (Negative )</i></span>"
        },
        "identifier": [
          {
            "use": "official",
            "value": "ZCCD-Results.Urinalysis.829"
          }
        ],
        "status": "final",
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "5797-6"
            }
          ]
        },
        "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": "<span ccdRefId=\"ZCCD-Results.Urinalysis.830\"><b>Protein [Mass/Urine] in urine by test strip </b>100 mg/dl<i> (negative mg/dl)</i></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.
papi029 Provides the date range that was used to run the search.