DiagnosticReport
Overview
The DiagnosticReport resource typically provides a textual set of information and interpretation after performing a diagnostic service or procedure such as a Radiology or Pathology or Cardiology report. A diagnostic report is the set of information that is typically provided by a diagnostic service when investigations are complete. The information includes a mix of atomic results, text reports, images, and codes. The DiagnosticReport resource has information about the diagnostic report itself, and about the subject and, in the case of laboratory tests, the specimen of the report. Report conclusions can be expressed as a simple text blob, structured coded data or as an attached fully formatted report such as a PDF.
-
The following HL7® FHIR® US Core Implementation Guide STU 4.0.0 Profiles are supported by this resource:
The following fields are returned if valued:
- Id
- Identifier
- BasedOn
- Status
- Category
- Code
- Subject
- Encounter
- Effective
- Issued date/time
- Performer
- Result Interpreter
- Result
- Presented Form
- Conclusion Code
Terminology Bindings
DiagnosticReport.category |
|
DiagnosticReport.code |
|
DiagnosticReport.status |
|
DiagnosticReport.conclusionCode |
|
Search
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. May include a single or comma separated list of references. Example: encounter=1621910
|
date |
N | date |
Date range into which the diagnostic report falls (effectiveDateTime). Either 1 or 2 date/time can be given. Example: date=lt2017-01-5
|
_count |
N | number |
The maximum number of results to return. Defaults to 10 and maximum 100 documents can be returned. |
category |
N | token |
The diagnostic discipline/department created the report. Example: {{*[http://loinc.org\\\|P7839-6* or +*LAB*(For micro/Gen lab reports)+}}\\|http://loinc.org/]
|
code |
N | token |
The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result. Example: *[http://loinc.org\\\|630-4*\\|http://loinc.org/]
|
_revinclude |
No | token |
Provenance resource entries to be returned as part of the bundle. Example: _revinclude=Provenance:target
|
Implementation Notes
- When searching with the
date
parameter:- It must be provided once or twice, with or without prefixes.
- If time is provided, it must be provided consistently.
- When searching with the
encounter
parameter:- Patient level documents are filtered out from responses when the encounter id is zero/blank.
-
The
_revinclude
parameter may be provided once with the valueProvenance:target
. Example:_revinclude=Provenance:target
-
The
_revinclude
parameter may be provided with the_id/patient
parameter. Example:_id=214938095&_revinclude=Provenance:target
- When
_revinclude
is provided in a request to the closed endpoint, the OAuth2 token must include theuser/Provenance.read
scope. Currentlypatient/Provenance.read
is not supported and hence_revinclude
cannot be utilised for patient persona.
The common errors and OperationOutcomes may be returned.
Headers
Accept: application/json+fhir
Authorization: <OAuth2 Bearer Token>
Example
Request
GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DiagnosticReport?patient=12724066
Response
Status: 200 OK
{
"resourceType": "Bundle",
"id": "2bae404f-007d-4abf-8552-6e540f0226b6",
"type": "searchset",
"link": [
{
"relation": "self",
"url": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DiagnosticReport?patient=12724066"
}
],
"entry": [
{
"fullUrl": "https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DiagnosticReport/197480987",
"resource": {
"resourceType": "DiagnosticReport",
"id": "197480987",
"meta": {
"versionId": "1",
"lastUpdated": "2021-05-11T18:17:17.000Z"
},
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Diagnostic Report</b></p><p><b>Patient</b>: Smart, Nancyu Nha Eeeeee</p><p><b>Status</b>: Partial</p><p><b>Code</b>: Abdominal Ultrasound</p><p><b>Effective End Date</b>: May 11, 2021 6:16 P.M. UTC</p></div>"
},
"identifier": [
{
"system": "https://fhir.cerner.com/ceuuid",
"value": "CE87caf4b7-9397-4667-9897-702218017c9e-197480987-2021051118171700"
}
],
"status": "partial",
"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": "2820643",
"display": "Abdominal Ultrasound",
"userSelected": true
},
{
"system": "http://loinc.org",
"code": "24558-9",
"userSelected": false
}
],
"text": "Abdominal Ultrasound"
},
"subject": {
"reference": "Patient/12724066",
"display": "Smart, Nancyu Nha Eeeeee"
},
"effectivePeriod": {
"end": "2021-05-11T18:16:00.000Z"
},
"issued": "2021-05-11T18:17:17Z",
"performer": [
{
"reference": "Practitioner/1",
"display": "SYSTEM, SYSTEM Cerner"
}
],
"presentedForm": [
{
"extension": [
{
"valueCode": "unsupported",
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
}
]
}
]
},
"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 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"
}
],
"resultsInterpreter": [
{
"reference": "Practitioner/11648064"
}
],
"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
Authorization Types
Headers
Accept: application/json+fhir
Authorization: <OAuth2 Bearer Token>
Example
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"
}
],
"resultsInterpreter": [
{
"reference": "Practitioner/11648064"
}
],
"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.
Errors
The common errors and OperationOutcomes may be returned.