The Opala Patient Access API CARIN for Blue Button® Da Vinci Payer Data Exchange (PDex)
Overview: Resources and Interactions Overview: API Searches
Opala FHIR Documentation

© 2021 Opala. All Rights Reserved.

Version 1.0


Contact Opala's
Documentation Team

DiagnosticReport Lab Profile

The US Core DiagnosticReport Profile for Laboratory Results Reporting builds on the DiagnosticReport resource. This profile sets minimum expectations for the DiagnosticReport resource to record, search, and fetch laboratory results associated with a patient. It identifies which core elements, extensions, vocabularies, and value sets are present in the resource when using this profile.

Laboratory results are grouped and summarized using the DiagnosticReport resource, which usually references Observation resources. Each Observation resource represents an individual laboratory test and result value, component result values, or a nested panel (such as a microbial susceptibility panel) which references other observations.

Results can also be presented in report form or as free text.

Mandatory Data Elements

The following data elements must be present, or must be supported if the data is present, in the sending system. Each DiagnosticReport must have:

And each DiagnosticReport must support:

Mandatory Search Parameters

The following search parameters and search parameter combinations should be supported.

Searching for all diagnosticreports for a patient using the patient search parameter:

GET [base]/DiagnosticReport?patient=[reference]

Searching using the combination of the patient and category search parameters:

GET [base]/DiagnosticReport?patient=[reference]&category=http://terminology.hl7.org/CodeSystem/v2-0074|LAB

Searching using the combination of the patient and code search parameters, including optional support for composite OR searches on code (e.g., code={system|}[code],{system|}[code],...):

GET [base]/DiagnosticReport?patient=[reference]&code={system|}[code]{,{system|}[code],...}

searching using the combination of the patient and category and date search parameters, including support for these date comparators: gt, lt, ge, le. Optionally, support for composite AND searches on date (e.g., date=[date]&date=[date]]&...):

GET [base]/DiagnosticReport?patient=[reference]&category=http://terminology.hl7.org/CodeSystem/v2-0074|LAB&date={gt|lt|ge|le}[date]{&date={gt|lt|ge|le}[date]&...}

For a list of optional search parameters, see StructureDefinition-us-core-diagnosticreport-lab

For More Information