Profiles & Operations > DiagnosticReport Search

DiagnosticReport Search - COVID19 Query For Public Health Units

DiagnosticReport search is simple RESTful interaction. It supports retrieving lab results from OLIS for specific disease such as COVID19.

Scope

This transaction involves a request by the following parameters:

The mandatory parameters for the query:

  • Start Date

The OAuth token must also contain the COVID19 scope. The scope value must include "filter/covid-19".

The optional parameters for the query:

  • Maximum number of records to return

Specification

The OLIS FHIR COVID Query is based on the HL7 STU3 Search operation.


Diagnostic Report Search Request

The Diagnostic Report Search Request is an HTTP GET operation with multiple query parameters specified in Supported Search Parameters section below. The syntax of the request is

GET [base]/ DiagnosticReport?&issued=(ge|gt|le|lt)[date][&_count=[num]]

Note: For the more details please reference to Supported Search Parameters and Diagnostic Report Search Examples sections


Diagnostic Report Search Response

The relationship between the resources used in DiagnosticReport Search response is below:

Extensions

Supported Search Parameters


GET DiagnosticReport (return all COVID19 results issued after specific date)

Dates parameter: issued

  • Example 1 : issued=gt2016-01-02

  • Example 2: issued=gt2015-02-25&issued=lt2016-02-27

Size limit (for response paging):_count

  • Example: _count=10

If there is no _count in the search request, the server will return all matching records in one response.


Server will generate and return an additional parameter search-id as per Server Conformance section above.

  • Example: search-id= 017-11-16T20:37:03.0000000X128987

Format: _format parameter is not supported. Including this parameter in the request will result an error. Note that COVID query only supports JSON. XML is not used.


Example

Diagnostic Report Search Example

GET [base]/DiagnosticReport?issued=gt2016-01-02&_count=10


In the returned header:

[base]/DiagnosticReport?&issued=gt2016-01-02&_count=10&search-id=017-11-16T20:37:03.0000000X128987

Examples of a search response can be found below

Resource Example
DiagnosticReport example representing a positive COVID report XML / JSON
Bundle example representing searchset with one positive COVID Report XML / JSON
Patient with Anonymous Identifier XML / JSON