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
DiagnosticReport read
Read a DiagnosticReport resource
Path Parameters
Response Payload Attributes
The FHIR Resource name.
The identifier of the Diagnostic Report.
Text summary of the Diagnostic Report, for human interpretation.
All reports returned from this endpoint will show a status of generated.
Limited xhtml content that contains the human readable text of the Diagnostic Report.
Business identifier for report.
The identifier of the Diagnostic Report.
Status of the Diagnostic Report see https://hl7.org/fhir/R4/valueset-diagnostic-report-status.html. Currently Canvas only supports two types of statuses.
Service category https://hl7.org/fhir/R4/valueset-diagnostic-service-sections.html. Use this attribute to help distinguish the type of report in Canvas.
Identifies where the definition of the code comes from.
The system url of the coding.
The code of the category.
The display name of the coding.
Name/Code for this diagnostic report.
Identifies where the definition of the code comes from.
The system url of the coding.
The code of the category.
The display name of the coding.
Plain text representation of the Lab or Imaging Report.
The subject of the report.
The reference string of the subject in the format of "Patient/a39cafb9d1b445be95a2e2548e12a787".
Type the reference refers to (e.g. “Patient”).
Health care event when test ordered or reviewed.
Lab and Imaging Reports in Canvas will have an Encounter associated with the payload if there has been a Lab Results Review, Imaging Report Review, or a POC Lab Test command committed in a note on the patient’s chart.
The reference string of the Encounter in the format of "Encounter/912542cf-3bfb-4609-99f6-26ce94feb70d".
Unique identifier of the Encounter.
Clinically relevant date/time for report.
DateTime this version was made.
Responsible Diagnostic Service. In Canvas this will be the Practitioner who is assigned to the Report.
The reference string of the practitioner in the format of "Practitioner/4150cd20de8a470aa570a852859ac87e".
Type the reference refers to (e.g. “Practitioner”).
Observations associated with the Diagnostic Report.
The reference string of the observation in the format of "Observation/dcc3239b-ffc9-4d02-9cb6-a486bb9d406e".
Type the reference refers to (e.g. “Observation”).
Entire report as issued. There is also a DocumentReference resource specifically for this Report PDF being created.
Note: There is a temporary extension that will contain the presigned URL for the Attachment; this will be provided while we migrate to static URLs that will require bearer authentication to retrieve attachment files. Use this extension for backward-compatible URLs until the migration is completed.
Uri where the data can be found.
Extension for backward-compatible URLs
Responses
Errors
DiagnosticReport search
Search for DiagnosticReport resources
Query Parameters
A Canvas-issued unique identifier for a specific diagnostic report.
The DiagnosticReport category. Filters by the code and/or system under category.coding attribute. You can search by just the code value or you can search by the system and code in the format system|code.
The DiagnosticReport code. Filters by the code and/or system under code.coding attribute. You can search by just the code value or you can search by the system and code in the format system|code.
The patient reference associated to the Diagnostic Report in the format Patient/a39cafb9d1b445be95a2e2548e12a787.
Response Payload Attributes
The FHIR Resource name.
This element and value designate that the bundle is a search response. Search result bundles will always have the Bundle.type of searchset .
The number of resources that match the search parameter.
Attributes relevant to pagination, see our Pagination page for more detail.
The relation of the page search
The search url for the specific relation
The results bundle that lists out each object returned in the search
The attributes specific to the resource type, see the Attributes section below
Attributes
The FHIR Resource name.
The identifier of the Diagnostic Report.
Text summary of the Diagnostic Report, for human interpretation.
All reports returned from this endpoint will show a status of generated.
Limited xhtml content that contains the human readable text of the Diagnostic Report.
Business identifier for report.
The identifier of the Diagnostic Report.
Status of the Diagnostic Report see https://hl7.org/fhir/R4/valueset-diagnostic-report-status.html. Currently Canvas only supports two types of statuses.
Service category https://hl7.org/fhir/R4/valueset-diagnostic-service-sections.html. Use this attribute to help distinguish the type of report in Canvas.
Identifies where the definition of the code comes from.
The system url of the coding.
The code of the category.
The display name of the coding.
Name/Code for this diagnostic report.
Identifies where the definition of the code comes from.
The system url of the coding.
The code of the category.
The display name of the coding.
Plain text representation of the Lab or Imaging Report.
The subject of the report.
The reference string of the subject in the format of "Patient/a39cafb9d1b445be95a2e2548e12a787".
Type the reference refers to (e.g. “Patient”).
Health care event when test ordered or reviewed.
Lab and Imaging Reports in Canvas will have an Encounter associated with the payload if there has been a Lab Results Review, Imaging Report Review, or a POC Lab Test command committed in a note on the patient’s chart.
The reference string of the Encounter in the format of "Encounter/912542cf-3bfb-4609-99f6-26ce94feb70d".
Unique identifier of the Encounter.
Clinically relevant date/time for report.
DateTime this version was made.
Responsible Diagnostic Service. In Canvas this will be the Practitioner who is assigned to the Report.
The reference string of the practitioner in the format of "Practitioner/4150cd20de8a470aa570a852859ac87e".
Type the reference refers to (e.g. “Practitioner”).
Observations associated with the Diagnostic Report.
The reference string of the observation in the format of "Observation/dcc3239b-ffc9-4d02-9cb6-a486bb9d406e".
Type the reference refers to (e.g. “Observation”).
Entire report as issued. There is also a DocumentReference resource specifically for this Report PDF being created.
Note: There is a temporary extension that will contain the presigned URL for the Attachment; this will be provided while we migrate to static URLs that will require bearer authentication to retrieve attachment files. Use this extension for backward-compatible URLs until the migration is completed.
Uri where the data can be found.
Extension for backward-compatible URLs
Responses
Errors
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": [ { "extension": [ { "url": "http://schemas.canvasmedical.com/fhir/extensions/deprecated-url", "valueUri": "https://canvas-client-media.s3.amazonaws.com/local/Screenshot_2024-02-21_at_15.26.42.pdf?AWSAccessKeyId=AKIAQB7SIDR7C2IYANB6&Signature=Ns%2BLQ5z5XXWH4WMOXWczuMQ7s0A%3D&Expires=1714138104" } ], "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/ca52f2b76011429d8a0e4aa2b56b18bc&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/ca52f2b76011429d8a0e4aa2b56b18bc&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/ca52f2b76011429d8a0e4aa2b56b18bc&code=73562&date=ge2023-09-12&_count=10&_offset=0" }, { "relation": "first", "url": "/DiagnosticReport?patient=Patient/ca52f2b76011429d8a0e4aa2b56b18bc&code=73562&date=ge2023-09-12&_count=10&_offset=0" }, { "relation": "last", "url": "/DiagnosticReport?patient=Patient/ca52f2b76011429d8a0e4aa2b56b18bc&code=73562&date=ge2023-09-12&_count=10&_offset=0" } ], "entry": [ { "resource": { "resourceType": "DiagnosticReport", "id": "197d1b7a-374e-4aa8-82b2-6960a62ecf7a", "status": "final", "category": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0074", "code": "LAB", "display": "Laboratory" } ] } ], "code": { "coding": [ { "system": "http://loinc.org", "code": "6690-2", "display": "WBC" }, { "system": "http://loinc.org", "code": "785-6", "display": "MCH" }, { "system": "http://loinc.org", "code": "5905-5", "display": "Monocytes" } ], "text": "Complete Blood Count (Cbc) With Differential" }, "subject": { "reference": "Patient/ca52f2b76011429d8a0e4aa2b56b18bc", "type": "Patient" }, "effectiveDateTime": "2022-04-01T07:00:00+00:00", "issued": "2022-04-15T15:24:22.522951+00:00", "performer": [ { "reference": "Practitioner/4150cd20de8a470aa570a852859ac87e", "type": "Practitioner" } ], "result": [ { "reference": "Observation/422f9f0f-151a-4488-bcad-ab4b0c3967da", "type": "Observation" } ], "presentedForm": [ { "extension": [ { "url": "http://schemas.canvasmedical.com/fhir/extensions/deprecated-url", "valueUri": "https://canvas-client-media.s3.amazonaws.com/local/Screenshot_2024-02-21_at_15.26.42.pdf?AWSAccessKeyId=AKIAQB7SIDR7C2IYANB6&Signature=Ns%2BLQ5z5XXWH4WMOXWczuMQ7s0A%3D&Expires=1714138104" } ], "url": "https://canvas-client-media.s3.amazonaws.com/instance/20220414_180403_74.pdf?AWSAccessKeyId=xxx&Signature=xxx&Expires=1708462267" } ] } }, { "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" } } ] }