MediRecords FHIR Implementation Guide
1.4.2 - release


DiagnosticReport

The MediRecords FHIR API supports the following DiagnosticReport operations.

GET {API_URL}/v1/DiagnosticReport

This API interface enables the client to search DiagnosticReport instances from MediRecords repository. This is in compliance with the MediRecords DiagnosticReport profiles.

Query Parameters    
_count number Instruct the server regarding how many resources should be returned in a single page
patient
(mandatory)		 reference The subject of the report if a patient
date date The clinically relevant time of the report in the format yyyy-mm-ddThh:mm:ss[Z|(+|-)hh:mm].
Note that the value returned in effectiveDateTime may not match the search criteria, as the search may use a different administrative date/time (e.g. request date or inbox import date) when a clinically relevant time is not available.
Request Headers  
X-Request-Id A unique id to for the request/response assigned by either client or server. The expected format is UUID. If the client doesn’t supply this id, it is expected that server SHALL assign one.

Response

The server returns matching DiagnosticReport instances in a Bundle that the logged-in user has access to.

By default, only active DiagnosticReports will be provided in the search result.

In an error situation, server SHALL return OperationOutcome detailing the error with the appropriate HTTP Error code as follows.

Status Text
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Read

GET {API_URL}/v1/DiagnosticReport/{id}

This API interface enables the client to read a DiagnosticReport resource from MediRecords repository which is compliant with the supported MediRecords DiagnosticReport profiles.

In an error situation, server SHALL return OperationOutcome detailing the error with the appropriate HTTP Error code as follows.

Status Text
200 OK
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Webhook

The following table provides the FHIR Webhook event types generated for the DiagnosticReport resource.

Hub Event Application Trigger Event
diagnostic-report.created Occurs whenever a new diagnostic results record is created
diagnostic-report.updated Occurs whenever a diagnostic results record is updated 
Bundle <br>
  DiagnosticReport(1) 
  Encounter (0..1) 
  Patient (1) 
  PractitionerRole (0..1)
  Practitioner (0..3)
  Organization (0..3)
   
diagnostic-report.deleted Occurs whenever a diagnostic results record is deleted 
Bundle 
  request (1) 
  url: DELETE DiagnosticReport/{id}