org.eurekaclinical.i2b2.client

Interface I2b2PdoRetriever

All Known Implementing Classes:

I2b2PdoRetrieverImpl, MockI2b2PdoRetriever

public interface I2b2PdoRetriever

Interface for retrieving PDO results from i2b2.

Since:

1.0

Author:

Michel Mansour

Method Summary

Modifier and Type	Method and Description
I2b2PdoResults	retrieve(I2b2AuthMetadata authMetadata, Collection<I2b2Concept> concepts, I2b2PatientSet patientSet) Attempts to retrieve PDO results from i2b2 for the given patient set.

Method Detail

retrieve

I2b2PdoResults retrieve(I2b2AuthMetadata authMetadata,
                        Collection<I2b2Concept> concepts,
                        I2b2PatientSet patientSet)
                 throws I2b2XmlException

Attempts to retrieve PDO results from i2b2 for the given patient set. The results are filtered based on the requested concepts, and the request will succeed only if the given user is authorized to make the request.

Parameters:

authMetadata - the i2b2 authentication metadata of the user making the request

concepts - the i2b2 concepts to query for

patientSet - the i2b2 patient set to retrieve

Returns:

a I2b2PdoResults object containing the patients, events, observers, and observations retrieved from i2b2

Throws:

I2b2XmlException - if an error occurs while processing the XML returned by i2b2