Fetching report status

Client can check the status of the report generation by sending a GET request to the endpoint returned by the report generation request. For example:

curl -sS "https://${server}/fhir/r5/api/DiagnosticReport/482c9449-add0-4312-a6ba-07831d5ffa5b/$status?reportType=AgpPersonal" \
  -H "client_id: ${client_id}" \
  -H "client_secret: ${client_secret}" \
  -H "org_id: ${org_id}" \
  -H "certificate: ${certificate}" | jq

The above request checks the status of the report generation using the Content-Location URL returned by the initial report generation request. This process follows the Asynchronous Interaction Request Pattern.The reportType query parameter is used to specify the type of report being requested, in this case, an AGP (Ambulatory Glucose Profile) report (i,e AgpPersonal).

The client should poll for the status of the report generation until the server responds with HTTP 200 OK status code, which indicates that the report generation is completed. The recommended polling interval is as specified by the Retry-After header in the response.

Response

Report generation Pending

The server respond with HTTP 202 Accepted status code if the Report generation is still in-progress.

Report generation completed successfully

In accordance with the Asynchronous Interaction Request Pattern, when a status request is made for a report generation operation that succeeded, the server responds with an HTTP 200 OK status code and includes a Bundle resource in the payload.

• The first entry in the Bundle represents the outcome, with 200 OK in its response.status field.

• The second entry in the Bundle is a DiagnosticReport resource that contains the details of the report. This entry also includes a list of Observation resources as contained resources.

• Example of a successful AGP report generation completed with adequate data:

• If the patient does not have sufficient data to generate an report, the server responds with an HTTP 404 NOT_FOUND status code and includes a Bundle resource in the payload.
• The payload contains a report without data. Example of a successful report generation completed with insufficient data:

Report generation completed with failure

In accordance with the Asynchronous Interaction Request Pattern, when a status request is made for a report generation operation that failed, the server also responds with an HTTP 200 OK status code (indicated that the status was successfully returned) and includes a Bundle resource in the payload. The Bundle has a single entry that represents the outcome in its response field. The details of the error are provided in the response.status and response.outcome subfields.

This example illustrates a situation where the report generation process fails. The server returns a 500 INTERNAL_SERVER_ERROR status code along with an OperationOutcome resource detailing the error. The payload includes a Bundle that does not contain a PDF.

Report generation status request processing failed.

If there is an error while processing the status request, the server returns an OperationOutcome resource. Here is an example of an error response:

{
  "resourceType": "OperationOutcome",
  "issue": [
    {
      "severity": "error",
      "code": "processing",
      "diagnostics": "Unable to check report generation status."
    }
  ]
}