DiagnosticReport

The findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports. https://hl7.org/fhir/R4/diagnosticreport.html

This endpoint implements the US Core DiagnosticReport Profile for Report. The following USCDI data elements are retrievable from this endpoint:

Clinical Notes:
- Imaging Narrative
- Laboratory Report Narrative
- Pathology Report Narrative
- Procedure Note

Laboratory:
- Tests
- Values/Results

Endpoints

get
/DiagnosticReport/{id}
 get
/DiagnosticReport

Attributes

id
string required

A Canvas-issued unique identifier

status
string

DiagnosticReportStatus https://hl7.org/fhir/R4/valueset-diagnostic-report-status.html

category
array[json]

Service category https://hl7.org/fhir/R4/valueset-diagnostic-service-sections.html

code
json

Name/Code for this diagnostic report

subject
json

The subject of the report - usually, but not always, the patient

encounter
json

Health care event when test ordered

effectiveDateTime
datetime | date

Clinically relevant date/time for report

issued
datetime

DateTime this version was made

performer
array[json]

Responsible Diagnostic Service

result
array[json]

Observations

presentedForm
array[json]

Entire report as issued. This field is only returned in read responses and is not returned search responses.

get
/DiagnosticReport/{id}

DiagnosticReport read

Read a DiagnosticReport resource

Path Parameters

id required
string
The unique identifier for the DiagnosticReport

Responses

200 OK
Request was successful.

Errors

401 Unauthorized
The request requires user authentication.
403 Forbidden
The request requires user authorization.
404 Not Found
The requested resource was not found.
get
/DiagnosticReport

DiagnosticReport search

Search for DiagnosticReport resources

Query Parameters

_id
string

A Canvas-issued unique identifier

category
string

The DiagnosticReport category. Filters by the code value under category.coding.

code
string

The DiagnosticReport code. Filters by the code value under code.coding.

date
date

Filter by date

patient
string

The patient associated with the report

Responses

200 OK
Request was successful.

Errors

400 Bad Request
The request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401 Unauthorized
The request requires user authentication.
403 Forbidden
The request requires user authorization.
  • curl --request GET \
     --url 'https://fumage-example.canvasmedical.com/DiagnosticReport/<id>' \
     --header 'Authorization: Bearer <token>' \
     --header 'accept: application/json'

  • import requests

url = "https://fumage-example.canvasmedical.com/DiagnosticReport/<id>"

headers = {
    "accept": "application/json",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

  • {
    "resourceType": "DiagnosticReport",
    "id": "9b90621b-059f-4f6e-9ef5-58171098e424",
    "status": "final",
    "category":
    [
        {
            "coding":
            [
                {
                    "system": "http://loinc.org",
                    "code": "LP29684-5",
                    "display": "Radiology"
                }
            ]
        }
    ],
    "code":
    {
        "coding":
        [
            {
                "system": "http://www.ama-assn.org/go/cpt",
                "code": "73562",
                "display": "XRAY, knee; 3 views"
            }
        ]
    },
    "subject":
    {
        "reference": "Patient/a1197fa9e65b4a5195af15e0234f61c2",
        "type": "Patient"
    },
    "encounter":
    {
        "reference": "Encounter/6a077e6f-ead2-4af7-803d-0a203bedfb1c",
        "type": "Encounter"
    },
    "effectiveDateTime": "2023-08-22",
    "issued": "2023-08-22T21:35:01.909441+00:00",
    "performer":
    [
        {
            "reference": "Practitioner/883f7147517e444fb746cdac3860b0dc",
            "type": "Practitioner"
        }
    ],
    "presentedForm":
    [
        {
            "url": "https://canvas-client-media.s3.amazonaws.com/instance/Imaging_Report.pdf?AWSAccessKeyId=xxxx&Signature=xxxx&Expires=1675179226"
        }
    ]
}

  • {
  "resourceType": "OperationOutcome",
  "issue": [
    {
      "severity": "error",
      "code": "unknown",
      "details": {
        "text": "Authentication failed"
      }
    }
  ]
}

  • {
  "resourceType": "OperationOutcome",
  "issue": [
    {
      "severity": "error",
      "code": "forbidden",
      "details": {
        "text": "Authorization failed"
      }
    }
  ]
}

  • {
  "resourceType": "OperationOutcome",
  "issue": [
    {
      "severity": "error",
      "code": "not-found",
      "details": {
        "text": "Unknown DiagnosticReport resource '9b814d81-fb56-456b-a46d-c67fdaaec2ac'"
      }
    }
  ]
}

  • curl --request GET \
     --url 'https://fumage-example.canvasmedical.com/DiagnosticReport?patient=Patient%2Fca52f2b76011429d8a0e4aa2b56b18bc&code=73562&date=ge2023-09-12' \
     --header 'Authorization: Bearer <token>' \
     --header 'accept: application/json'

  • import requests

url = "https://fumage-example.canvasmedical.com/DiagnosticReport?patient=Patient%2Fca52f2b76011429d8a0e4aa2b56b18bc&code=73562&date=ge2023-09-12"

headers = {
    "accept": "application/json",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

  • {
    "resourceType": "Bundle",
    "type": "searchset",
    "total": 2,
    "link":
    [
        {
            "relation": "self",
            "url": "/DiagnosticReport?patient=Patient%2Fca52f2b76011429d8a0e4aa2b56b18bc&code=73562&date=ge2023-09-12&_count=10&_offset=0"
        },
        {
            "relation": "first",
            "url": "/DiagnosticReport?patient=Patient%2Fca52f2b76011429d8a0e4aa2b56b18bc&code=73562&date=ge2023-09-12&_count=10&_offset=0"
        },
        {
            "relation": "last",
            "url": "/DiagnosticReport?patient=Patient%2Fca52f2b76011429d8a0e4aa2b56b18bc&code=73562&date=ge2023-09-12&_count=10&_offset=0"
        }
    ],
    "entry":
    [
        {
            "resource":
            {
                "resourceType": "DiagnosticReport",
                "id": "822a7292-7489-4f0d-8432-4715bc060ce7",
                "status": "final",
                "category":
                [
                    {
                        "coding":
                        [
                            {
                                "system": "http://loinc.org",
                                "code": "LP29684-5",
                                "display": "Radiology"
                            }
                        ]
                    }
                ],
                "code":
                {
                    "coding":
                    [
                        {
                            "system": "http://www.ama-assn.org/go/cpt",
                            "code": "73562",
                            "display": "XRAY, knee; 3 views"
                        },
                        {
                            "system": "http://snomed.info/sct",
                            "code": "281296001",
                            "display": "Comment"
                        },
                        {
                            "system": "http://snomed.info/sct",
                            "code": "282290005",
                            "display": "Interpretation"
                        }
                    ]
                },
                "subject":
                {
                    "reference": "Patient/ca52f2b76011429d8a0e4aa2b56b18bc",
                    "type": "Patient"
                },
                "effectiveDateTime": "2023-09-15",
                "issued": "2023-09-15T19:46:15.747800+00:00",
                "performer":
                [
                    {
                        "reference": "Practitioner/3640cd20de8a470aa570a852859ac87e",
                        "type": "Practitioner"
                    }
                ]
            }
        },
        {
            "resource":
            {
                "resourceType": "DiagnosticReport",
                "id": "9b814d81-fb56-456b-a46d-c67fdaaec2ad",
                "status": "final",
                "category":
                [
                    {
                        "coding":
                        [
                            {
                                "system": "http://loinc.org",
                                "code": "LP29684-5",
                                "display": "Radiology"
                            }
                        ]
                    }
                ],
                "code":
                {
                    "coding":
                    [
                        {
                            "system": "http://www.ama-assn.org/go/cpt",
                            "code": "73562",
                            "display": "XRAY, knee; 3 views"
                        }
                    ]
                },
                "subject":
                {
                    "reference": "Patient/ca52f2b76011429d8a0e4aa2b56b18bc",
                    "type": "Patient"
                },
                "effectiveDateTime": "2023-09-15",
                "issued": "2023-09-15T19:52:56.711871+00:00",
                "performer":
                [
                    {
                        "reference": "Practitioner/3640cd20de8a470aa570a852859ac87e",
                        "type": "Practitioner"
                    }
                ]
            }
        }
    ]
}

  • {
  "resourceType": "OperationOutcome",
  "issue": [
    {
      "severity": "error",
      "code": "invalid",
      "details": {
        "text": "Bad request"
      }
    }
  ]
}

  • {
  "resourceType": "OperationOutcome",
  "issue": [
    {
      "severity": "error",
      "code": "unknown",
      "details": {
        "text": "Authentication failed"
      }
    }
  ]
}

  • {
  "resourceType": "OperationOutcome",
  "issue": [
    {
      "severity": "error",
      "code": "forbidden",
      "details": {
        "text": "Authorization failed"
      }
    }
  ]
}