Package org.openehealth.ipf.commons.ihe.fhir.pharm5

Class Pharm5SearchParameters

java.lang.Object

org.openehealth.ipf.commons.ihe.fhir.FhirSearchAndSortParameters<DocumentReference>

org.openehealth.ipf.commons.ihe.fhir.pharm5.Pharm5SearchParameters

All Implemented Interfaces:

FhirSearchParameters

public class Pharm5SearchParameters
extends FhirSearchAndSortParameters<DocumentReference>

Search parameters for CMPD PHARM-5 transaction.

Since:

4.3

Author:

Christian Ohr, Quentin Ligier

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Pharm5SearchParameters.Pharm5SearchParametersBuilder

Constructor Summary

Constructors

Constructor

Description

Pharm5SearchParameters(TokenParam patientIdentifier, DateRangeParam date, StringParam authorFamilyName, StringParam authorGivenName, TokenParam identifier, TokenOrListParam status, TokenOrListParam setting, DateRangeParam period, TokenOrListParam facility, TokenOrListParam event, TokenOrListParam securityLabel, TokenOrListParam format, Pharm5Operations operation, SortSpec sortSpec, Set<Include> includeSpec, FhirContext fhirContext)

Method Summary

Modifier and Type	Method	Description
static Pharm5SearchParameters.Pharm5SearchParametersBuilder	builder()
Optional<Comparator<DocumentReference>>	comparatorFor(String paramName)	Returns a Comparator to sort resources of type T by given sort parameter name.
StringParam	getAuthorFamilyName()
StringParam	getAuthorGivenName()
DateRangeParam	getDate()
TokenOrListParam	getEvent()
TokenOrListParam	getFacility()
FhirContext	getFhirContext()
TokenOrListParam	getFormat()
TokenParam	getIdentifier()
Set<Include>	getIncludeSpec()
Pharm5Operations	getOperation()
TokenParam	getPatientIdentifier()
List<TokenParam>	getPatientIdParam()
DateRangeParam	getPeriod()
String	getQueryString(FhirContext context)
TokenOrListParam	getSecurityLabel()
TokenOrListParam	getSetting()
SortSpec	getSortSpec()
TokenOrListParam	getStatus()
Pharm5SearchParameters	setAuthor(ReferenceAndListParam author)
void	setAuthorFamilyName(StringParam authorFamilyName)
void	setAuthorGivenName(StringParam authorGivenName)
void	setDate(DateRangeParam date)
void	setEvent(TokenOrListParam event)
void	setFacility(TokenOrListParam facility)
void	setFormat(TokenOrListParam format)
void	setIdentifier(TokenParam identifier)
void	setIncludeSpec(Set<Include> includeSpec)
void	setOperation(Pharm5Operations operation)
void	setPatientIdentifier(TokenParam patientIdentifier)
void	setPeriod(DateRangeParam period)
void	setSecurityLabel(TokenOrListParam securityLabel)
void	setSetting(TokenOrListParam setting)
void	setSortSpec(SortSpec sortSpec)
void	setStatus(TokenOrListParam status)
Parameters	toParameters()	Maps the Pharm5SearchParameters to an equivalent Parameters, for the given FHIR context.
String	toString()

Methods inherited from class org.openehealth.ipf.commons.ihe.fhir.FhirSearchAndSortParameters

noop, sort

Methods inherited from class java.lang.Object

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

Constructor Details

Pharm5SearchParameters

public Pharm5SearchParameters(TokenParam patientIdentifier,
 DateRangeParam date,
 StringParam authorFamilyName,
 StringParam authorGivenName,
 TokenParam identifier,
 TokenOrListParam status,
 TokenOrListParam setting,
 DateRangeParam period,
 TokenOrListParam facility,
 TokenOrListParam event,
 TokenOrListParam securityLabel,
 TokenOrListParam format,
 Pharm5Operations operation,
 SortSpec sortSpec,
 Set<Include> includeSpec,
 FhirContext fhirContext)

Method Details

getPatientIdParam

public List<TokenParam> getPatientIdParam()

setAuthor

public Pharm5SearchParameters setAuthor(ReferenceAndListParam author)

comparatorFor

public Optional<Comparator<DocumentReference>> comparatorFor(String paramName)

Description copied from class: FhirSearchAndSortParameters

Returns a Comparator to sort resources of type T by given sort parameter name. This default implementation keeps the current order, i.e. to implement actual sorting you MUST overwrite this method.

Overrides:

comparatorFor in class FhirSearchAndSortParameters<DocumentReference>

Parameters:

paramName - sort parameter

Returns:

comparator

getQueryString

public String getQueryString(FhirContext context)

toParameters

public Parameters toParameters()

Maps the Pharm5SearchParameters to an equivalent Parameters, for the given FHIR context.

builder

public static Pharm5SearchParameters.Pharm5SearchParametersBuilder builder()

toString

public String toString()

Overrides:

toString in class Object

getPatientIdentifier

public TokenParam getPatientIdentifier()

setPatientIdentifier

public void setPatientIdentifier(TokenParam patientIdentifier)

getDate

public DateRangeParam getDate()

setDate

public void setDate(DateRangeParam date)

getAuthorFamilyName

public StringParam getAuthorFamilyName()

setAuthorFamilyName

public void setAuthorFamilyName(StringParam authorFamilyName)

getAuthorGivenName

public StringParam getAuthorGivenName()

setAuthorGivenName

public void setAuthorGivenName(StringParam authorGivenName)

getIdentifier

public TokenParam getIdentifier()

setIdentifier

public void setIdentifier(TokenParam identifier)

getStatus

public TokenOrListParam getStatus()

setStatus

public void setStatus(TokenOrListParam status)

getSetting

public TokenOrListParam getSetting()

setSetting

public void setSetting(TokenOrListParam setting)

getPeriod

public DateRangeParam getPeriod()

setPeriod

public void setPeriod(DateRangeParam period)

getFacility

public TokenOrListParam getFacility()

setFacility

public void setFacility(TokenOrListParam facility)

getEvent

public TokenOrListParam getEvent()

setEvent

public void setEvent(TokenOrListParam event)

getSecurityLabel

public TokenOrListParam getSecurityLabel()

setSecurityLabel

public void setSecurityLabel(TokenOrListParam securityLabel)

getFormat

public TokenOrListParam getFormat()

setFormat

public void setFormat(TokenOrListParam format)

getOperation

public Pharm5Operations getOperation()

setOperation

public void setOperation(Pharm5Operations operation)

getSortSpec

public SortSpec getSortSpec()

Specified by:

getSortSpec in class FhirSearchAndSortParameters<DocumentReference>

Returns:

the sort specification as requested by the client

setSortSpec

public void setSortSpec(SortSpec sortSpec)

getIncludeSpec

public Set<Include> getIncludeSpec()

setIncludeSpec

public void setIncludeSpec(Set<Include> includeSpec)

getFhirContext

public FhirContext getFhirContext()