Package org.projecthusky.communication.ch.xd.storedquery

Class FindDocumentsQuery

java.lang.Object

org.projecthusky.communication.xd.storedquery.AbstractStoredQuery

org.projecthusky.communication.ch.xd.storedquery.FindDocumentsQuery

All Implemented Interfaces:

StoredQueryInterface

public class FindDocumentsQuery
extends AbstractStoredQuery

Represents a query to find documents in an XDS Registry (XDS FindDocumentsQuery). This class uses only enums for XDS metadata which are specified by eHealth Suisse for the usage in Switzerland.

Constructor Summary

Constructors

Constructor	Description
FindDocumentsQuery(Identificator patientId, AvailabilityStatus status)	Constructs a FindDocuments Query
FindDocumentsQuery(Identificator patientId, ClassCode[] classCodes, DateTimeRange[] dateTimeRanges, PracticeSettingCode[] practiceSettingCodes, HealthcareFacilityTypeCode[] healthCareFacilityCodes, ConfidentialityCode[] confidentialityCodes, FormatCode[] formatCodes, Author authorPerson, AvailabilityStatus status)	Constructs a FindDocuments Query

Method Summary

Modifier and Type	Method	Description
void	addConfidentialityCodes(ConfidentialityCode[] confidentialityCodes)	Adds an additional disjunctive clause of confidentiality codes to the query.
org.openehealth.ipf.commons.ihe.xds.core.metadata.AvailabilityStatus	getAsIpfAvailabilityStatusType(AvailabilityStatus availabilityStatus)	Gets the AvailabilityStatus as IPF AvailabilityStatusType Object. Liefert AvailabilityStatus als IPF AvailabilityStatusType Objekt.
org.openehealth.ipf.commons.ihe.xds.core.requests.query.StoredQuery	getIpfQuery()	Gets the IPF StoredQuery object, which is being wrapped by this class

Methods inherited from class org.projecthusky.communication.xd.storedquery.AbstractStoredQuery

setIpfStoredQuery

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FindDocumentsQuery

public FindDocumentsQuery(Identificator patientId,
 AvailabilityStatus status)

Constructs a FindDocuments Query

Parameters:

patientId - ID of the patient

status - Status of the document

FindDocumentsQuery

public FindDocumentsQuery(Identificator patientId,
 ClassCode[] classCodes,
 DateTimeRange[] dateTimeRanges,
 PracticeSettingCode[] practiceSettingCodes,
 HealthcareFacilityTypeCode[] healthCareFacilityCodes,
 ConfidentialityCode[] confidentialityCodes,
 FormatCode[] formatCodes,
 Author authorPerson,
 AvailabilityStatus status)

Constructs a FindDocuments Query

Parameters:

patientId - ID of the patient (required)

classCodes - an array of enums, which classify the document (can be null)

dateTimeRanges - an array of DateTimeRange objects (can be null)

practiceSettingCodes - an array of enums, which classify the institution, where the document was created (can be null)

healthCareFacilityCodes - an array of enums, which classify the type of healthcare facility, where the document was created (can be null)

confidentialityCodes - an array of enums, which classify the confidentiality of the document (can be null)

formatCodes - an array of enums, which classify the format of the document (can be null)

authorPerson - information about the author of the document (can be null)

status - the availability status of the document (required)

Method Details

addConfidentialityCodes

public void addConfidentialityCodes(ConfidentialityCode[] confidentialityCodes)

Adds an additional disjunctive clause of confidentiality codes to the query. Per IHE 2008-2009 ITI CP 228, codes with in the parameter will be interpreted with OR semantics. The resultant disjunctive clause will be AND-ed together with any confidentialityCode clauses previously added. Calling this method sequentially will result in the AND-ing of multiple clauses.

Parameters:

confidentialityCodes - array of confidentiality codes

getAsIpfAvailabilityStatusType

public org.openehealth.ipf.commons.ihe.xds.core.metadata.AvailabilityStatus getAsIpfAvailabilityStatusType(AvailabilityStatus availabilityStatus)

Gets the AvailabilityStatus as IPF AvailabilityStatusType Object.

Liefert AvailabilityStatus als IPF AvailabilityStatusType Objekt.

Returns:

the address use as postal address use

getIpfQuery

public org.openehealth.ipf.commons.ihe.xds.core.requests.query.StoredQuery getIpfQuery()

Gets the IPF StoredQuery object, which is being wrapped by this class

Specified by:

getIpfQuery in interface StoredQueryInterface

Overrides:

getIpfQuery in class AbstractStoredQuery

Returns:

the IPF StoredQuery