The FHIR R4 DiagnosticReport
resource represents the results of diagnostic testing performed on a patient, typically by a laboratory, imaging facility, or other diagnostic provider. It includes detailed findings, the tests performed, and may include interpretations or recommendations based on the results.
Use Cases
- Retrieve diagnostic reports for lab results
- Support decision-making with test results
- Generate and share diagnostic summaries
- Track patient progress via diagnostic reports
Base URLs
- Production: https://api.healthgorilla.com/fhir/R4/DiagnosticReport
- Sandbox: https://sandbox.healthgorilla.com/fhir/R4/DiagnosticReport
Authentication
All requests require OAuth 2.0 authentication using a Bearer Token. Unauthorized requests return 401 Unauthorized
responses.
Required scopes:
diagnosticreport.read
for GETdiagnosticreport.write
for POST, PUT, DELETE
For more information, go to: OAuth 2.0 Authentication.
Supported Methods
Method | Operation | Description |
---|---|---|
GET | Read DiagnosticReport | Retrieves a specific DiagnosticReport record by its FHIR ID. |
GET | Search DiagnosticReport | Searches for DiagnosticReport records for a specified patient. |
GET | Download DiagnosticReport as PDF | Retrieves a PDF version of a specific DiagnosticReport via the $pdf operation. |
POST | Trigger DiagnosticReport Retrieval | Initiates retrieval of diagnostic reports via the $p360-retrieve operation. |
Frequently Used Search Parameters
Parameter | Description | FHIR Value Set / Example Values | FHIR Data Type | Required |
---|---|---|---|---|
patient | Filters by patient ID | Patient/{id} | Reference | Yes |
status | Filters by the status of the diagnostic report | DiagnosticReportStatus (final ) | token | No |
category | Filters by diagnostic report category | DiagnosticReportCategory (laboratory ) | token | No |
code | Filters by the test or observation performed | SNOMED CT, LOINC codes (e.g., 123456 ) | token | No |
date | Filters by the date of the diagnostic report | ge2024-01-01 , le2024-12-31 | date | No |
Commonly Returned Resource Attributes
Attribute | Description | Example Values | FHIR Data Type | Required |
---|---|---|---|---|
patient | Reference to the patient for whom the diagnostic report is issued | Patient/{id} | Reference(Patient) | Yes |
status | Current status of the diagnostic report | final | CodeableConcept | Yes |
code | Type of diagnostic test or observation performed | SNOMED CT or LOINC codes (e.g., 123456 , 7890 ) | CodeableConcept | Yes |
issued | Date and time when the report was issued | 2024-02-12T12:34:56Z | dateTime | Yes |
category | Category of the diagnostic report | laboratory | CodeableConcept | No |
result | Observations or test results associated with the diagnostic report | Observation/{id} , DiagnosticReport/{id} | Reference | No |
conclusion | Summary of findings or interpretations of the report | Free-text | string | No |
Webhooks
Clients can subscribe to receive notifications when new diagnostic reports are generated, or when existing reports are updated or finalized. For more information, go to: Webhooks & Polling.
Error Handling
All DiagnosticReport
operations follow standard Health Gorilla error handling, including use of FHIR OperationOutcome
for structured responses. For more information, go to: Error Handling.