Home > Profiles and Operations > DiagnosticReport Search - COVID Query

DiagnosticReport Search - COVID Query

DiagnosticReport search is simple RESTful interaction. It supports retrieving lab results from OLIS for specific disease such as COVID19. This query is also known as OLIS bulk query or CCM query as it is used by Ministry's Contact Tracing and Management solution.

Note: This query should only be used by public health units.

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 FHIR R4 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=(le|ge|gt|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:

• DiagnosticReport

• ServiceRequest

• Observation

• Specimen

• Patient

• Practitioner(Ordering, Performing and Reporting)

• PractitionerRole

• Location

• Organization(Ordering Facility, Performing Lab, Reporting Lab, Test Request Placer, Specimen Collector, Destination Lab, Identifier Assigner, Requesting Lab)

• Encounter

• OperationOutcome

• Bundle

Extensions

• EN Qualifier

• Healthcard Version Code

• ObservationValueAttachment

• PointOfCareTestID

• TestRequestPlacer

• ServiceRequestBlockIndicator

• TestRequestRecipient

• SortKey

• SourceOfNote

• Notes (for DiagnosticReport)

• specimen-numberSampleContainer

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 supported with json ONLY. XML is not used and will trigger an error if 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 (needs work)

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