DiagnosticReport
Overview
The DiagnosticReport resource includes information that is typically provided by a diagnostic service when investigations are complete. The information includes laboratory, microbiology, results reporting, and clinical notes exchange. Clinical notes include the three categories of Cardiology, Pathology, and Radiology.
Soarian Clinicals® supports a read-only Application Programming Interface (API). This API accepts GET
and POST
based search and GET
based read interactions. The response represents the most current information about the patient that is charted in Soarian Clinicals® at the time of the query.
The search results include the following fields if they contain values:
- Diagnostic Report Id
- Status
- Category
- Code
- Subject(Patient only)
- Encounter
- Effective[x]
- Issued
-
Performer
- Practitioner
- Organization
- Result
- Presented form
Terminology Bindings
DiagnosticReport.category |
|
DiagnosticReport.code |
Search
Search for DiagnosticReport resources that meet the specified 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. |
patient |
This, or _id
|
reference |
The patient that the diagnostic report is about. |
category |
No | token |
The category of the diagnostic report. |
code |
No | token |
The code of the diagnostic report. |
encounter |
No | reference |
The encounter associated with the care plan record. |
date |
No | date |
Date range into which the diagnostic report falls. Example: date=gt2014-09-24 or date=lt2015-09-24T12:00:00.000Z
|
_count |
No | count |
The maximum number of resources returned in a page. |
_revincude |
No | _revinclude |
A request to include any Provenance resource in the bundle that refers to a DiagnosticReport resource in the search results. Only supported with Provenance. |
Notes
- The
date
parameter may be provided up to two times, and must use theeq
,ge
,gt
,le
, orlt
prefixes. When a value is provided without a prefix, an impliedeq
prefix is used. When provided twice, the lower value must have age
orgt
prefix and the higher value must have anle
orlt
prefix. - The
_revinclude
parameter may be provided once with the valueProvenance:target
. Example:_revinclude=Provenance:target
- When
_revinclude
is provided in a request, the OAuth2 token must include thepatient/Provenance.read system/Provenance.read
oruser/Provenance.read
scope as applicable.
Headers
Accept: application/fhir+json
Authorization: <OAuth2 Bearer Token>
Example Search by Patient
Request
GET https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/DiagnosticReport?patient=A879904FD2FE4B2D90C89FDA84E1285F
Response
Status: 200 OK
{
"resourceType": "Bundle",
"id": "822118d4-2466-461e-90cd-934ffaf5a8e8",
"type": "searchset",
"timestamp": "2022-05-09T05:48:16-04:00",
"entry": [
{
"fullUrl": "https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/DiagnosticReport/A879904FD2FE4B2D90C89FDA84E1285F.RAD.18221",
"search": {
"mode": "match"
},
"resource": {
"resourceType": "DiagnosticReport",
"id": "A879904FD2FE4B2D90C89FDA84E1285F.RAD.18221",
"meta": {
"lastUpdated": "2020-12-03T18:21:12-05:00"
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://loinc.org",
"code": "LP29684-5",
"display": "Radiology"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "18782-3",
"display": "Radiology Study observation (narrative)"
}
],
"text": "Radiology Study Observation"
},
"subject": {
"reference": "Patient/A879904FD2FE4B2D90C89FDA84E1285F",
"display": "Mcgovern,Astrid Santiago"
},
"encounter": {
"reference": "Encounter/A879904FD2FE4B2D90C89FDA84E1285F.29019",
"display": "Inferno,Initial"
},
"effectiveDateTime": "2020-12-01T08:15:00-05:00",
"issued": "2020-12-03T18:21:12-05:00",
"performer": [
{
"reference": "Organization/RES.1",
"display": "Mid-town Laboratories"
}
],
"presentedForm": [
{
"contentType": "text/plain",
"data": "Tm8gcGFyYXNwaW5hbCBzb2Z0IHRpc3N1ZSBtYXNzLg0K"
}
],
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><b>DiagnosticReport</b><br /><b>Patient</b>:Mcgovern,Astrid Santiago;<br /><b>Status</b>:final;<br /><b>Category</b>:<br /><b>System</b>:http://loinc.org <b>Code</b>:LP29684-5 <b>Display</b>:Radiology ;<br /><b>Code</b>:<br /><b>System</b>:http://loinc.org <b>Code</b>:18782-3 <b>Display</b>:Radiology Study observation (narrative) <b>Text</b>:Radiology Study Observation;<br /><b>EffectiveDateTime</b>:2020-12-01T08:15:00-05:00;<br /></div>"
}
}
},
{
"fullUrl": "https://fhir-myrecord-sc.sandboxcerner.com/r4/3f2aca24-87f3-4eac-a6d7-1f75247e6b43/DiagnosticReport/A879904FD2FE4B2D90C89FDA84E1285F.CAR.15216",
"search": {
"mode": "match"
},
"resource": {
"resourceType": "DiagnosticReport",
"id": "A879904FD2FE4B2D90C89FDA84E1285F.CAR.15216",
"meta": {
"lastUpdated": "2020-12-01T18:11:34-05:00"
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://loinc.org",
"code": "LP29708-2",
"display": "Cardiology"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "75425-9",
"display": "Cardiology Diagnostic study note"
}
],
"text": "Cardiology Diagnostic Study Note"
},
"subject": {
"reference": "Patient/A879904FD2FE4B2D90C89FDA84E1285F",
"display": "Mcgovern,Astrid Santiago"
},
"encounter": {
"reference": "Encounter/A879904FD2FE4B2D90C89FDA84E1285F.29019",
"display": "Inferno,Initial"
},
"effectivePeriod": {
"start": "2020-09-13T13:00:00-04:00",
"end": "2020-09-13T13:30:00-04:00"
},
"issued": "2020-12-01T18:11:31-05:00",
"performer": [
{
"reference": "Organization/RES.1001",
"display": "Lancaster Ave Lab"
}
],
"presentedForm": [
{
"contentType": "text/plain",
"data": "U2ludXMgYnJhZHljYXJkaWENCg=="
}
],
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><b>DiagnosticReport</b><br /><b>Patient</b>:Mcgovern,Astrid Santiago;<br /><b>Status</b>:final;<br /><b>Category</b>:<br /><b>System</b>:http://loinc.org <b>Code</b>:LP29708-2 <b>Display</b>:Cardiology ;<br /><b>Code</b>:<br /><b>System</b>:http://loinc.org <b>Code</b>:75425-9 <b>Display</b>:Cardiology Diagnostic study note <b>Text</b>:Cardiology Diagnostic Study Note;<br /><b>Effective Period Start</b>:2020-09-13T13:00:00-04:00;<br /><b>Effective Period End</b>:2020-09-13T13:30:00-04:00;<br /></div>"
}
}
},
{
"fullUrl": "https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/DiagnosticReport/A879904FD2FE4B2D90C89FDA84E1285F.CAR.15217",
"search": {
"mode": "match"
},
"resource": {
"resourceType": "DiagnosticReport",
"id": "A879904FD2FE4B2D90C89FDA84E1285F.CAR.15217",
"meta": {
"lastUpdated": "2020-12-01T18:15:41-05:00"
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://loinc.org",
"code": "LP29708-2",
"display": "Cardiology"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "75425-9",
"display": "Cardiology Diagnostic study note"
}
],
"text": "Cardiology Diagnostic Study Note"
},
"subject": {
"reference": "Patient/A879904FD2FE4B2D90C89FDA84E1285F",
"display": "Mcgovern,Astrid Santiago"
},
"encounter": {
"reference": "Encounter/A879904FD2FE4B2D90C89FDA84E1285F.29019",
"display": "Inferno,Initial"
},
"effectiveDateTime": "2020-09-10T04:00:00-04:00",
"issued": "2020-12-01T18:15:41-05:00",
"performer": [
{
"reference": "Organization/RES.1",
"display": "Mid-town Laboratories"
}
],
"presentedForm": [
{
"contentType": "text/plain",
"data": "MTUwLTE2MA0K"
}
],
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><b>DiagnosticReport</b><br /><b>Patient</b>:Mcgovern,Astrid Santiago;<br /><b>Status</b>:final;<br /><b>Category</b>:<br /><b>System</b>:http://loinc.org <b>Code</b>:LP29708-2 <b>Display</b>:Cardiology ;<br /><b>Code</b>:<br /><b>System</b>:http://loinc.org <b>Code</b>:75425-9 <b>Display</b>:Cardiology Diagnostic study note <b>Text</b>:Cardiology Diagnostic Study Note;<br /><b>EffectiveDateTime</b>:2020-09-10T04:00:00-04:00;<br /></div>"
}
}
}
],
"link": [
{
"relation": "self",
"url": "https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/DiagnosticReport?patient=A879904FD2FE4B2D90C89FDA84E1285F&_format=json"
}
]
}
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.
Example Search by ID
Request
GET https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/DiagnosticReport?_id=A879904FD2FE4B2D90C89FDA84E1285F.RAD.18221
Response
Status: 200 OK
{
"resourceType": "Bundle",
"id": "c3b2dbc0-2642-4dd6-b1b8-05de15b1b40c",
"type": "searchset",
"timestamp": "2022-05-09T05:48:16-04:00",
"entry": [
{
"fullUrl": "https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/DiagnosticReport/A879904FD2FE4B2D90C89FDA84E1285F.RAD.18221",
"search": {
"mode": "match"
},
"resource": {
"resourceType": "DiagnosticReport",
"id": "A879904FD2FE4B2D90C89FDA84E1285F.RAD.18221",
"meta": {
"lastUpdated": "2020-12-03T18:21:12-05:00"
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://loinc.org",
"code": "LP29684-5",
"display": "Radiology"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "18782-3",
"display": "Radiology Study observation (narrative)"
}
],
"text": "Radiology Study Observation"
},
"subject": {
"reference": "Patient/A879904FD2FE4B2D90C89FDA84E1285F",
"display": "Mcgovern,Astrid Santiago"
},
"encounter": {
"reference": "Encounter/A879904FD2FE4B2D90C89FDA84E1285F.29019",
"display": "Inferno,Initial"
},
"effectiveDateTime": "2020-12-01T08:15:00-05:00",
"issued": "2020-12-03T18:21:12-05:00",
"performer": [
{
"reference": "Organization/RES.1",
"display": "Mid-town Laboratories"
}
],
"presentedForm": [
{
"contentType": "text/plain",
"data": "Tm8gcGFyYXNwaW5hbCBzb2Z0IHRpc3N1ZSBtYXNzLg0K"
}
],
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><b>DiagnosticReport</b><br /><b>Patient</b>:Mcgovern,Astrid Santiago;<br /><b>Status</b>:final;<br /><b>Category</b>:<br /><b>System</b>:http://loinc.org <b>Code</b>:LP29684-5 <b>Display</b>:Radiology ;<br /><b>Code</b>:<br /><b>System</b>:http://loinc.org <b>Code</b>:18782-3 <b>Display</b>:Radiology Study observation (narrative) <b>Text</b>:Radiology Study Observation;<br /><b>EffectiveDateTime</b>:2020-12-01T08:15:00-05:00;<br /></div>"
}
}
}
],
"link": [
{
"relation": "self",
"url": "https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/DiagnosticReport?patient=A879904FD2FE4B2D90C89FDA84E1285F.RAD.18221&_format=json"
}
]
}
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
List an individual DiagnosticReport resource by its ID:
GET /DiagnosticReport/:id
Authorization Types
Headers
Accept: application/fhir+json
Authorization: <OAuth2 Bearer Token>
Example
Request
GET https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/DiagnosticReport/A879904FD2FE4B2D90C89FDA84E1285F.RAD.18221
Response
Status: 200 OK
{
"resourceType": "DiagnosticReport",
"id": "A879904FD2FE4B2D90C89FDA84E1285F.RAD.18221",
"meta": {
"lastUpdated": "2020-12-03T18:21:12-05:00"
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://loinc.org",
"code": "LP29684-5",
"display": "Radiology"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "18782-3",
"display": "Radiology Study observation (narrative)"
}
],
"text": "Radiology Study Observation"
},
"subject": {
"reference": "Patient/A879904FD2FE4B2D90C89FDA84E1285F",
"display": "Mcgovern,Astrid Santiago"
},
"encounter": {
"reference": "Encounter/A879904FD2FE4B2D90C89FDA84E1285F.29019",
"display": "Inferno,Initial"
},
"effectiveDateTime": "2020-12-01T08:15:00-05:00",
"issued": "2020-12-03T18:21:12-05:00",
"performer": [
{
"reference": "Organization/RES.1",
"display": "Mid-town Laboratories"
}
],
"presentedForm": [
{
"contentType": "text/plain",
"data": "Tm8gcGFyYXNwaW5hbCBzb2Z0IHRpc3N1ZSBtYXNzLg0K"
}
],
"text": {
"status": "generated",
"div": "<div xmlns='http://www.w3.org/1999/xhtml'><b>DiagnosticReport</b><br /><b>Patient</b>:Mcgovern,Astrid Santiago;<br /><b>Status</b>:final;<br /><b>Category</b>:<br /><b>System</b>:http://loinc.org <b>Code</b>:LP29684-5 <b>Display</b>:Radiology ;<br /><b>Code</b>:<br /><b>System</b>:http://loinc.org <b>Code</b>:18782-3 <b>Display</b>:Radiology Study observation (narrative) <b>Text</b>:Radiology Study Observation;<br /><b>EffectiveDateTime</b>:2020-12-01T08:15:00-05:00;<br /></div>"
}
}
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.