DiagnosticReport

Overview

The DiagnosticReport resource provides a set of information and interpretation following a diagnostic service or procedure such as a Radiology, Pathology, or Cardiology report. The DiagnosticReport resource will produce information about the diagnostic report itself, about the subject, and about the specimen of the report in the case of Laboratory tests. The information produced can include a mix of atomic results, textual reports, images, and codes, depending on the type(s) of diagnostic services being retrieved.

Report conclusions can be expressed as a simple text blob, structured coded data, or as an attached fully formatted report (such as a PDF). This resource can retrieve reports of various Status types which may need to be considered for filtering purposes if only Final or Corrected results are desired for retrieval, or to exclude any results that were Entered-in-Error. See the Status field below for more detail.

In cases where results without textual reports are desired, such as General Laboratory or Vital Signs results, the Observation resource should be used instead.

The following fields are returned if valued:

Terminology Bindings

DiagnosticReport.category
DiagnosticReport.code
  • Description
    • A code or name that describes this diagnostic report.
  • Details: DiagnosticReport code
    System: http://loinc.org

DiagnosticReport.status
  • Description
    • Status for the Diagnostic Report
  • Details: DiagnosticReportStatus
    System: http://hl7.org/fhir/diagnostic-report-status

DiagnosticReport.conclusionCode

Search for DiagnosticReports that meet supplied query parameters:

GET /DiagnosticReport/?:parameters

Authorization Types

Parameters

Name Required? Type Description
_id This or patient token The logical resource id associated with the resource. Example: 12345
patient This or _id reference The subject of the report if a patient. Example: 12345
encounter N reference The Encounter when the order was made. Must represent an Encounter resource. Example: encounter=1621910
date N date Date range into which the diagnostic report falls (effectiveDateTime). Either 1 or 2 date/times can be given. Example: date=ge2020-01-01T08:00:00.000Z&date=le2020-01-31T17:00:00.000Z
_lastUpdated N date Date range in which the diagnostic report was last updated. Either 1 or 2 date/times can be given. Example: _lastUpdated=gt2014-09-24 or _lastUpdated=lt2015-09-24T12:00:00.000Z
_count N number The maximum number of results to return. Defaults to 10 and a maximum of 100 documents can be returned.
category N token The diagnostic discipline/department which created the report. Example: http://terminology.hl7.org/CodeSystem/v2-0074|LAB or http://loinc.org|LP29684-5
code N token The specific code for describing the report. Example: http://loinc.org|24323-8
_revinclude N token Provenance resource entries to be returned as part of the bundle. Example: _revinclude=Provenance:target

Implementation Notes

The common errors and OperationOutcomes may be returned.

Headers

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

Example Search by Patient with Category

Request

GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DiagnosticReport?patient=12724066&category=http://terminology.hl7.org/CodeSystem/v2-0074|RAD

Response

Status: 200 OK
{
  "resourceType": "Bundle",
  "id": "4e95721b-490b-4c57-84f5-7d055a8a5dec",
  "type": "searchset",
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DiagnosticReport?patient=12724066&category=http%3A%2F%2Fterminology.hl7.org%2FCodeSystem%2Fv2-0074%7CRAD"
    },
    {
      "relation": "next",
      "url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DiagnosticReport?patient=12724066&category=http%3A%2F%2Fterminology.hl7.org%2FCodeSystem%2Fv2-0074%7CRAD&-pageContext=eJwdyk0KwjAURtG9fOME8jTNT8GJbqBQcVpCmtaCJJImKJTu3eLwHu4Gn2osaEkwjGFy9XXEBl_zmjJa3Lqclofsr59lpq7eSy8vYHi6dYjhe7wl18DwdnMYfIrlb2hO9mxISG61aLgkIbihMHIySupJKU3WYd9_FHYmXg%3D%3D&-pageDirection=NEXT"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DiagnosticReport/197369077",
      "resource": {
        "resourceType": "DiagnosticReport",
        "id": "197369077",
        "meta": {
          "versionId": "1",
          "lastUpdated": "2020-08-13T19:36:06.000Z"
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns=\\"http://www.w3.org/1999/xhtml\\"><p><b>Diagnostic Report</b></p><p><b>Patient</b>: Smart II, Nancy</p><p><b>Document Title</b>: Some Title 4x</p><p><b>Status</b>: Final</p><p><b>Code</b>: Radiology Reports</p><p><b>Effective End Date</b>: Aug 13, 2020  7:36 P.M. UTC</p><p><b>Verifying Provider</b>: Portal, Portal</p></div>"
        },
        "identifier": [
          {
            "system": "https://fhir.cerner.com/ceuuid",
            "value": "CE87caf4b7-9397-4667-9897-702218017c9e-197369077-2020081319360600"
          }
        ],
        "status": "final",
        "category": [
          {
            "coding": [
              {
                "system": "http://loinc.org",
                "code": "LP29684-5",
                "userSelected": false
              }
            ],
            "text": "Radiology"
          }
        ],
        "code": {
          "coding": [
            {
              "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/72",
              "code": "63293819",
              "display": "Radiology Reports",
              "userSelected": true
            },
            {
              "system": "http://loinc.org",
              "code": "75490-3",
              "userSelected": false
            }
          ],
          "text": "Radiology Reports"
        },
        "subject": {
          "reference": "Patient/12724066",
          "display": "Smart II, Nancy"
        },
        "encounter": {
          "reference": "Encounter/97953477"
        },
        "effectivePeriod": {
          "end": "2020-08-13T19:36:00.000Z"
        },
        "issued": "2020-08-13T19:36:06Z",
        "performer": [
          {
            "reference": "Practitioner/12742069",
            "display": "Portal, Portal"
          }
        ],
        "resultsInterpreter": [
          {
            "reference": "Practitioner/12742069",
            "display": "Portal, Portal"
          }
        ],
        "presentedForm": [
          {
            "contentType": "application/pdf",
            "url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Binary/XR-197369077",
            "title": "Some Title 4x",
            "creation": "2020-08-13T19:36:00.000Z"
          },
          {
            "contentType": "application/xml",
            "url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Binary/XML-197369077",
            "title": "Some Title 4x",
            "creation": "2020-08-13T19:36:00.000Z"
          },
          {
            "contentType": "text/html",
            "url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Binary/TR-197369077",
            "title": "Some Title 4x",
            "creation": "2020-08-13T19:36:00.000Z"
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.

Example Search by _id with RevInclude

Authorization Types

Headers

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

Request

GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DiagnosticReport?_id=196151517,198381928&_revinclude=Provenance:target

Response

Status: 200 OK
{
  "resourceType": "Bundle",
  "id": "b40dab9d-354b-4f8c-b5d4-f47e89a1fc6a",
  "type": "searchset",
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DiagnosticReport?_id=196151517%2C198381928&_revinclude=Provenance%3Atarget"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DiagnosticReport/196151517",
      "resource": {
        "resourceType": "DiagnosticReport",
        "id": "196151517",
        "meta": {
          "versionId": "3",
          "lastUpdated": "2017-01-06T20:09:17.000+00:00"
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Diagnostic Report</b></p><p><b>Patient</b>: RADIOLOGY, TESTTWO</p><p><b>Document Category</b>: Unknown</p><p><b>Document Title</b>: MG Mammo Digital Diagnostic Bilat</p><p><b>Status</b>: Final</p><p><b>Code</b>: MG Mammo Digital Diagnostic Bilat</p><p><b>Effective Date</b>: Jan  6, 2017  7:59 P.M. UTC</p></div>"
        },
        "identifier": [
          {
            "system": "https://fhir.cerner.com/ceuuid",
            "value": "CE87caf4b7-9397-4667-9897-702218017c9e-196151517-2017010620084300"
          },
          {
            "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/acsn",
            "value": "00000MG20170000004"
          }
        ],
        "basedOn": [
          {
            "reference": "ServiceRequest/294749597"
          }
        ],
        "status": "final",
        "category": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
                "code": "unknown",
                "display": "Unknown"
              }
            ],
            "text": "Unknown"
          }
        ],
        "code": {
          "coding": [
            {
              "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/72",
              "code": "21660139",
              "display": "MG Mammo Digital Diagnostic Bilat",
              "userSelected": true
            },
            {
              "system": "http://loinc.org",
              "code": "26346-7"
            }
          ],
          "text": "MG Mammo Digital Diagnostic Bilat"
        },
        "subject": {
          "reference": "Patient/12458002",
          "display": "RADIOLOGY, TESTTWO"
        },
        "encounter": {
          "reference": "Encounter/97697440"
        },
        "effectiveDateTime": "2017-01-06T19:59:20Z",
        "issued": "2017-01-06T20:09:17Z",
        "performer": [
          {
            "reference": "Practitioner/11648064",
            "display": "Model, User 437 Cerner"
          }
        ],
        "resultsInterpreter": [
          {
            "reference": "Practitioner/11648064",
            "display": "Model, User 437 Cerner"
          }
        ],
        "presentedForm": [
          {
            "contentType": "application/pdf",
            "url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Binary/XR-196151517",
            "title": "MG Mammo Digital Diagnostic Bilat",
            "creation": "2017-01-06T20:09:17Z"
          },
          {
            "contentType": "application/xml",
            "url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Binary/R-196151517",
            "title": "MG Mammo Digital Diagnostic Bilat",
            "creation": "2017-01-06T20:09:17Z"
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    },
    {
      "fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DiagnosticReport/198381928",
      "resource": {
        "resourceType": "DiagnosticReport",
        "id": "198381928",
        "meta": {
          "versionId": "1",
          "lastUpdated": "2022-07-07T09:44:40.000Z"
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Diagnostic Report</b></p><p><b>Patient</b>: GETEST, PatientOneHundredSeventyOne</p><p><b>Document Title</b>:test1</p><p><b>Status</b>: Final</p><p><b>Code</b>: Waveform Strip</p><p><b>Effective Start Date</b>:Jul  7, 2022  9:44 A.M. UTC</p><p><b>Effective End Date</b>: Jul  7, 2022  9:44 A.M.UTC</p><p><b>Verifying Provider</b>: Model, User 212 Cerner</p></div>"
        },
        "identifier": [
          {
            "system": "https://fhir.cerner.com/ceuuid",
            "value": "CE87caf4b7-9397-4667-9897-702218017c9e-198381928-2022070709444100"
          }
        ],
        "status": "final",
        "category": [
          {
            "coding": [
              {
                "system": "http://loinc.org",
                "code": "8716-3",
                "userSelected": false
              }
            ]
          }
        ],
        "code": {
          "coding": [
            {
              "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/72",
              "code": "2574499721",
              "display": "Waveform Strip",
              "userSelected": true
            }
          ],
          "text": "Waveform Strip"
        },
        "subject": {
          "reference": "Patient/12769858",
          "display": "GETEST, PatientOneHundredSeventyOne"
        },
        "encounter": {
          "reference": "Encounter/97966187"
        },
        "effectivePeriod": {
          "start": "2022-07-07T09:44:40.000Z",
          "end": "2022-07-07T09:44:40.000Z"
        },
        "issued": "2022-07-07T09:44:40Z",
        "performer": [
          {
            "reference": "Practitioner/11638486",
            "display": "Model, User 212 Cerner"
          }
        ],
        "resultsInterpreter": [
          {
            "reference": "Practitioner/11638486",
            "display": "Model, User 212 Cerner"
          }
        ],
        "presentedForm": [
          {
            "contentType": "application/pdf",
            "url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Binary/XR-198381928",
            "title": "test1",
            "creation": "2022-07-07T09:44:40.000Z"
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    },
    {
      "fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Provenance/INT.doc-198381928",
      "resource": {
        "resourceType": "Provenance",
        "id": "INT.doc-198381928",
        "meta": {
          "versionId": "198381928",
          "lastUpdated": "2022-07-07T09:44:40Z"
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Provenance</b></p><p>\n                      <b>Target</b>:</p><ul><li>DiagnosticReport/198381928</li></ul><p>\n                      <b>Recorded</b>: Jul  7, 2022  9:44 A.M. UTC</p><p><b>Agents</b>:</p>\n                      <dl><dt>Model, User 212 Cerner</dt><dd><b>Agent Type</b>: Author</dd>\n                      <dd><b>Agent Role</b>: Source</dd></dl></div>"
        },
        "target": [
          {
            "reference": "DiagnosticReport/198381928"
          }
        ],
        "recorded": "2022-07-07T09:44:40Z",
        "agent": [
          {
            "type": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
                  "code": "author"
                }
              ],
              "text": "Author"
            },
            "role": [
              {
                "coding": [
                  {
                    "system": "http://terminology.hl7.org/CodeSystem/contractsignertypecodes",
                    "code": "SOURCE"
                  }
                ],
                "text": "Source"
              }
            ],
            "who": {
              "reference": "Practitioner/11638486",
              "display": "Model, User 212 Cerner"
            }
          }
        ]
      },
      "search": {
        "mode": "include"
      }
    },
    {
      "fullUrl": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Provenance/INT.doc-196151517",
      "resource": {
        "resourceType": "Provenance",
        "id": "INT.doc-196151517",
        "meta": {
          "versionId": "196151517",
          "lastUpdated": "2017-01-06T20:09:17Z"
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Provenance</b></p><p><b>Target</b>:</p><ul><li>DiagnosticReport/196151517</li></ul><p><b>Recorded</b>: Jan  6, 2017  8:09 P.M. UTC</p><p><b>Agents</b>:</p><dl><dt>Model, User 437 Cerner</dt><dd><b>Agent Type</b>: Author</dd><dd><b>Agent Role</b>: Source</dd><dt>Model Hospital</dt><dd><b>Agent Type</b>: Author</dd><dd><b>Agent Role</b>: Source</dd></dl></div>"
        },
        "target": [
          {
            "reference": "DiagnosticReport/196151517"
          }
        ],
        "recorded": "2017-01-06T20:09:17Z",
        "agent": [
          {
            "type": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
                  "code": "author"
                }
              ],
              "text": "Author"
            },
            "role": [
              {
                "coding": [
                  {
                    "system": "http://terminology.hl7.org/CodeSystem/contractsignertypecodes",
                    "code": "SOURCE"
                  }
                ],
                "text": "Source"
              }
            ],
            "who": {
              "reference": "Practitioner/11648064",
              "display": "Model, User 437 Cerner"
            }
          },
          {
            "type": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
                  "code": "author"
                }
              ],
              "text": "Author"
            },
            "role": [
              {
                "coding": [
                  {
                    "system": "http://terminology.hl7.org/CodeSystem/contractsignertypecodes",
                    "code": "SOURCE"
                  }
                ],
                "text": "Source"
              }
            ],
            "who": {
              "reference": "Organization/675844",
              "display": "Model Hospital"
            }
          }
        ]
      },
      "search": {
        "mode": "include"
      }
    }
  ]
}

Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.

Errors

The common errors and OperationOutcomes may be returned.

Retrieve by ID

Retrieve an individual DiagnosticReport by its ID:

GET /DiagnosticReport/:ID

Authorization Types

Headers

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

Example Single Retrieve by _ID

Request

GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DiagnosticReport/196151517

Response

Status: 200 OK
{
  "resourceType": "DiagnosticReport",
  "id": "196151517",
  "meta": {
    "versionId": "3",
    "lastUpdated": "2017-01-06T20:09:17.000+00:00"
  },
  "text": {
    "status": "generated",
    "div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Diagnostic Report</b></p><p><b>Patient</b>: RADIOLOGY, TESTTWO</p><p><b>Document Category</b>: Unknown</p><p><b>Document Title</b>: MG Mammo Digital Diagnostic Bilat</p><p><b>Status</b>: Final</p><p><b>Code</b>: MG Mammo Digital Diagnostic Bilat</p><p><b>Effective Date</b>: Jan  6, 2017  7:59 P.M. UTC</p></div>"
  },
  "identifier": [
    {
      "system": "https://fhir.cerner.com/ceuuid",
      "value": "CE87caf4b7-9397-4667-9897-702218017c9e-196151517-2017010620084300"
    },
    {
      "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/acsn",
      "value": "00000MG20170000004"
    }
  ],
  "basedOn": [
    {
      "reference": "ServiceRequest/294749597"
    }
  ],
  "status": "final",
  "category": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
          "code": "unknown",
          "display": "Unknown"
        }
      ],
      "text": "Unknown"
    }
  ],
  "code": {
    "coding": [
      {
        "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/72",
        "code": "21660139",
        "display": "MG Mammo Digital Diagnostic Bilat",
        "userSelected": true
      },
      {
        "system": "http://loinc.org",
        "code": "26346-7"
      }
    ],
    "text": "MG Mammo Digital Diagnostic Bilat"
  },
  "subject": {
    "reference": "Patient/12458002",
    "display": "RADIOLOGY, TESTTWO"
  },
  "encounter": {
    "reference": "Encounter/97697440"
  },
  "effectiveDateTime": "2017-01-06T19:59:20Z",
  "issued": "2017-01-06T20:09:17Z",
  "performer": [
    {
      "reference": "Practitioner/11648064",
      "display": "Model, User 437 Cerner"
    }
  ],
  "resultsInterpreter": [
    {
      "reference": "Practitioner/11648064",
      "display": "Model, User 437 Cerner"
    }
  ],
  "presentedForm": [
    {
      "contentType": "application/pdf",
      "url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Binary/XR-196151517",
      "title": "MG Mammo Digital Diagnostic Bilat",
      "creation": "2017-01-06T20:09:17Z"
    },
    {
      "contentType": "application/xml",
      "url": "https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Binary/R-196151517",
      "title": "MG Mammo Digital Diagnostic Bilat",
      "creation": "2017-01-06T20:09:17Z"
    }
  ]
}

Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.

Create

Create a new diagnostic report.

POST /DiagnosticReport

Implementation Notes

Authorization Types

Headers

Authorization: <OAuth2 Bearer Token>
Content-Type: application/fhir+json

Body Fields

Name Required Type
resourceType Yes string
  • Description
    • The type of the FHIR resource.
  • Example
    • {
        "resourceType": "DiagnosticReport"
      }
      
  • Notes
    • resourceType must be DiagnosticReport.
status Yes code
  • Description
    • The status of the diagnostic report.
  • Example
    • {
        "status": "final"
      }
      
  • Notes
    • Must be one of amended, cancelled, entered-in-error, final, partial, preliminary, registered, superseded, or unknown.
category Yes CodeableConcept
  • Description
    • A code that classifies the clinical discipline, department or diagnostic service that created the report (e.g. Cardiology, Anatomic Pathology). This is used for searching, sorting and display purposes.
  • Example
    • {
        "category": [
          {
              "coding": [
                  {
                      "code": "LP29708-2",
                      "display": "Cardiology",
                      "isUserSelected": false,
                      "system": "http://loinc.org"
                  }
              ],
              "text": "string"
          }
        ]
      }
      
  • Example
    • {
        "category": [
          {
              "coding": [
                  {
                      "code": "LP7839-6",
                      "display": "Pathology study",
                      "isUserSelected": false,
                      "system": "http://loinc.org"
                  }
              ],
              "text": "string"
          }
        ]
      }
      
  • Notes
    • The code must be LP29708-2 for Cardiology concept, LP7839-6 for Anatomic Pathology concept.
code Yes CodeableConcept
  • Description
    • Specifies the particular kind of diagnostic report.
  • Example
    • {
        "code": {
          "coding": [
              {
                  "code": "703535",
                  "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/72",
                  "userSelected": true,
                  "display": "Temperature Axillary"
              }
          ],
          "text": "Cardiology"
        }
      }
      
  • Example
    • {
        "code": {
          "coding": [
              {
                  "code": "4187236",
                  "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/72",
                  "userSelected": true,
                  "display": "Anatomic Pathology"
              }
          ],
          "text": "Anatomic Pathology"
        }
      }
      
  • Notes
    • The code must include a LOINC or a proprietary coding but not both together. Multiple LOINC codings or a single proprietary coding can be provided.

      When providing proprietary code system, it should be of format 'https://fhir.cerner.com/<your EHR source id>/codeSet/<code set>' (where code set is Millennium codeset 72). Example: 'https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/72'.

subject Yes Reference
  • Description
    • 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.
  • Example
    • {
        "subject": {
          "reference": "Patient/12457977"
        }
      }
      
  • Notes
    • Only patient references are supported.
performer Yes Reference
  • Description
    • The diagnostic service that is responsible for issuing the report.
  • Example
    • {
        "performer": [
          {
            "reference": "Practitioner/3332064"
          }
        ]
      }
      
  • Notes
    • Must contain Practitioner or Organization references with valid millennium ids.
resultsInterpreter No Reference
  • Description
    • The practitioner or organization that is responsible for the report's conclusions and interpretations.
  • Example
    • {
        "resultsInterpreter": {
          "reference": "Practitioner/3332064"
        }
      }
      
  • Notes
      • Only concept Cardiology supports resultsInterpreter field.
      • Must contain Practitioner or Organization references with valid millennium ids.
      • Diagnostic Report cardiology Create API requires
        • A default user to be setup in the domain to chart a document
        • If not default user is defined in the domain, a results_interpreter attribute is mandatory to chart a cardiology document.
identifier Yes Identifier
  • Description
    • Identifiers assigned to this report by the performer or other systems.
  • Example
    • {
        "identifier": [
          {
              "use": "usual",
              "type": {
                  "coding": [
                      {
                          "code": "Coding",
                          "system": "http://snomed.info/sct",
                          "version": "4.0.1",
                          "display": "test",
                          "userSelected": true
                      }
                  ]
              },
              "system": "http://hl7.org/fhir/sid/us-ssn",
              "value": "11182456"
          }
        ]
      }
      
  • Example
    • {
        "identifier": [
          {
              "system": "https://fhir.cerner.com/ceuuid",
              "value": "CEfda49233-ccfa-4ed4-afbc-9f5082c2bf0c-34824240-2022051205454801"
          }
        ]
      }
      
  • Notes
      • The identifier for concept Cardiology must include fields- use, type, system, value.

        The type would include coding. Coding internally would include code, system, version, display, userSelected.

      • The identifier for concept Anatomic Pathology must include fields- system, value.
effectivePeriod Yes Period
  • Description
    • 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.
  • Example
    • {
        "effectivePeriod": {
          "start": "2020-09-14T09:05:12.000Z",
          "end": "2020-09-14T09:05:12.000Z"
        }
      }
      
  • Notes
    • Only concept Cardiology supports effectivePeriod field.
effectiveDateTime Yes dateTime
  • Description
    • 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.
  • Example
    • {
        "effectiveDateTime": "2020-12-27T09:12:28Z",
      }
      
  • Notes
    • Only concept Anatomic Pathology supports effectiveDateTime field.
presentedForm Yes Attachment
  • Description
    • Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent.
  • Example
    • {
        "presentedForm": {
               "contentType": "application/pdf;charset=utf-8",
               "data": "PGh0bWw+Cjx0aXRsZT4gVGVzdCBEb2N1bWVudCA8L3RpdGxlPgoKRG9jdW1lbnQgY29udGVudCEKCjwvaHRtbD4=",
               "url": "http://snomed.info/sct"
               "title": "CT image",
               "creation": "2020-07-29T21:02:04.000Z"
             }
      }
      
  • Example
    • {
        "presentedForm": {
               "contentType": "application/pdf;charset=utf-8",
               "data": "PGh0bWw+Cjx0aXRsZT4gVGVzdCBEb2N1bWVudCA8L3RpdGxlPgoKRG9jdW1lbnQgY29udGVudCEKCjwvaHRtbD4="
             }
      }
      
  • Notes
    • Data and content type must be provided. Concept Cardiology supports fields contentType, data, url, title, creation fields under presented forms, whereas concept Anatomic Pathology supports contentType and data fields under present forms.
presentedForm.contentType Yes Code
  • Description
    • 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.
  • Example
    • {
        "contentType": "application/pdf;charset=utf-8"
      }
      
  • Notes
    • Must be provided. Content Type must include a supported MIME type and character set. The supported values are `application/pdf`, `text/plain;charset=utf-8`, `text/richtext;charset=utf-8`, `text/rtf;charset=utf-8`, `text/html;charset=utf-8`, `application/xml;charset=utf-8`, and `application/xhtml+xml;charset=utf-8`
presentedForm.data Yes base64Binary
  • Description
    • The actual data of the attachment - a sequence of bytes, base64 encoded.
  • Example
    • {
        "data": "PGh0bWw+Cjx0aXRsZT4gVGVzdCBEb2N1bWVudCA8L3RpdGxlPgoKRG9jdW1lbnQgY29udGVudCEKCjwvaHRtbD4="
      }
      
presentedForm.url No string
  • Description
    • A location where the data can be accessed.
  • Example
    • {
        "title": "http://snomed.info/sct",
      }
      
presentedForm.title No string
  • Description
    • A label or set of text to display in place of the data.
  • Example
    • {
        "title": "CT image",
      }
      
presentedForm.creation No dateTime
  • Description
    • The date that the attachment was first created.
  • Example
    • {
        "creation": "2020-07-29T21:02:04.000Z"
      }
      
  • Notes
    • A time component must be provided with the date.
encounter No Reference
  • Description
    • The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport is about.
  • Example
    • {
        "encounter": {
          "reference": "Encounter/98041577"
        }
      }
      
  • Notes
    • The encounter has to match the original document encounter.
issued No dateTime
  • Description
    • The date and time that this version of the report was made available to providers, typically after the report was reviewed and verified.
  • Example
    • {
        "issued": "2020-07-29T21:02:04.000Z"
      }
      
  • Notes
    • A time component must be provided with the date.
conclusion No string
  • Description
    • Concise and clinically contextualized summary conclusion (interpretation/impression) of the diagnostic report.
  • Example
    • {
        "conclusion": "conclusion string"
      }
      
  • Notes
    • Only concept Cardiology supports conclusion field. Need to be able to provide a conclusion that is not lost among the basic result data.
basedOn No Reference
  • Description
    • Details concerning a service requested.
  • Example
    • {
        "basedOn": [
          {
              "reference": "ServiceRequest/99928073"
          }
        ]
      }
      
  • Notes
    • Only concept Anatomic Pathology supports basedOn field. Must contain ServiceRequest references with valid millennium ids.

Example for Cardiology Concept Create

Request

POST https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DiagnosticReport

Body

{
  "resourceType": "DiagnosticReport",
  "status": "amended",
  "identifier": [
    {
      "use": "usual",
      "type": {
        "coding": [
          {
            "code": "Coding",
            "system": "http://snomed.info/sct",
            "version": "4.0.1",
            "display": "test",
            "userSelected": true
          }
        ]
      },
      "system": "http://hl7.org/fhir/sid/us-ssn",
      "value": "11182457"
    }
  ],
  "category": [
    {
      "coding": [
        {
          "code": "LP29708-2",
          "display": "Cardiology",
          "isUserSelected": false,
          "system": "http://loinc.org"
        }
      ],
      "text": "string"
    }
  ],
  "code": {
    "coding": [
      {
        "system": "http://loinc.org",
        "code": "8328-7"
      }
    ],
    "text": "string"
  },
  "subject": {
    "reference": "Patient/12804513"
  },
  "encounter": {
    "reference": "Encounter/98041577"
  },
  "performer": [
    {
      "reference": "Practitioner/11786042",
      "display": "Practitioner name string"
    }
  ],
  "resultsInterpreter": [
    {
      "reference": "Practitioner/11786042",
      "display": "Practitioner name string"
    }
  ],
  "effectivePeriod": {
    "start": "2020-09-14T09:05:12.000Z",
    "end": "2020-09-14T09:05:12.000Z"
  },
  "issued": "2020-12-29T09:12:28Z",
  "presentedForm": [
    {
      "contentType": "application/pdf;charset=utf-8",
      "url": "http://snomed.info/sct",
      "data": "JVBERi0xLjQKJcfsj6IKNSAwIG9iago8PC9MZW5ndGggNiAwIF",
      "title": "CT image",
      "creation": "2020-12-29T09:12:28Z"
    }
  ],
  "conclusion": "conclusion string"
}

Response

Status: 201 Created
Date: Mon, 09 Oct 2023 17:29:02 GMT
Content-Type: text/html
Connection: keep-alive
Cache-Control: no-cache
Etag: W/"1"
Last-Modified: Mon, 09 Oct 2023 17:29:02 GMT
Location: https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DiagnosticReport/197466617
Referrer-Policy: strict-origin-when-cross-origin
Server-Response-Time: 1288.314512
Strict-Transport-Security: max-age=631152000
Vary: Origin
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Frame-Options: SAMEORIGIN
X-Permitted-Cross-Domain-Policies: none
X-Request-Id: 7ce8599d-6fd7-9c53-3ca2-c08c708aecc0+Kccx_BLlz
X-Runtime: 1.288262
X-Xss-Protection: 1; mode=block
Transfer-Encoding: chunked

Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.

Example for Anatomic Pathology Concept Create

Request

POST https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DiagnosticReport

Body

{
  "resourceType": "DiagnosticReport",
  "status": "amended",
  "identifier": [
    {
      "system": "https://fhir.cerner.com/ceuuid",
      "value": "CEfda49233-ccfa-4ed4-afbc-9f5082c2bf0c-34824240-2022051205454801"
    }
  ],
  "basedOn": [
    {
      "reference": "ServiceRequest/99928073"
    }
  ],
  "category": [
    {
      "coding": [
        {
          "code": "LP7839-6",
          "display": "Pathology study",
          "isUserSelected": false,
          "system": "http://loinc.org"
        }
      ],
      "text": "string"
    }
  ],
  "code": {
    "coding": [
      {
        "code": "4187236",
        "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/72",
        "isUserSelected": true,
        "display": "Anatomic Pathology"
      }
    ],
    "text": "string"
  },
  "subject": {
    "reference": "Patient/12804513"
  },
  "encounter": {
    "reference": "Encounter/98041577"
  },
  "performer": [
    {
      "reference": "Practitioner/11786042"
    }
  ],
  "effectiveDateTime": "2020-12-27T09:12:28Z",
  "issued": "2020-12-29T09:12:28Z",
  "presentedForm": [
    {
      "contentType": "application/pdf;charset=utf-8",
      "data": "PGh08L3RpdGxlPgoKRG9jdW1lbnQgY29udGVudCEKCjwvaHRtbD4="
    }
  ]
}

Response

Status: 201 Created
Date: Mon, 09 Oct 2023 17:29:02 GMT
Content-Type: text/html
Connection: keep-alive
Cache-Control: no-cache
Etag: W/"1"
Last-Modified: Mon, 09 Oct 2023 17:29:02 GMT
Location: https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DiagnosticReport/197466627
Referrer-Policy: strict-origin-when-cross-origin
Server-Response-Time: 4626.253472
Strict-Transport-Security: max-age=631152000
Vary: Origin
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Frame-Options: SAMEORIGIN
X-Permitted-Cross-Domain-Policies: none
X-Request-Id: a72ca419-4773-9e2d-a9dd-e9a56b6693ab+BExf_xcbw
X-Runtime: 4.626156
X-Xss-Protection: 1; mode=block
Transfer-Encoding: chunked

Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.

Errors

The common errors and OperationOutcomes may be returned.