au.gov.nehta.vendorlibrary.pcehr.clients.common.type
Class DocumentQueryParams

java.lang.Object
  extended by au.gov.nehta.vendorlibrary.pcehr.clients.common.type.DocumentQueryParams

public final class DocumentQueryParams
extends java.lang.Object

Parameters used to query for documents.

The IHINumber of the PCEHR ($XDSDocumentEntryPatientId) is present in the PCEHRHeader.


Constructor Summary
DocumentQueryParams()
          Default constructor.
DocumentQueryParams(DocumentStatus... status)
          Constructor.
 
Method Summary
 java.util.List<Author> getAuthorIndividuals()
          Gets the value of the authorIndividuals property.
 java.util.List<CodedValue> getClinicalSpecialties()
          Gets the value of the clinicalSpecialties property.
 java.util.List<CodedValue> getDocumentClasses()
          Gets the value of the documentClass property.
 java.lang.String getDocumentCreationTimeFrom()
          Returns the lower value of documentCreationTime

Equivalent to the $XDSDocumentEntryCreationTimeFrom query parameter.

 java.lang.String getDocumentCreationTimeTo()
          Returns the upper value of documentCreationTime

Equivalent to the $XDSDocumentEntryCreationTimeTo query parameter.

 java.util.List<CodedValue> getDocumentTypes()
          Gets the value of the documentTypes property.
 java.util.List<CodedValue> getHealthcareFacilityTypes()
          Gets the value of the healthcareFacilityTypes property.
 java.util.Set<java.lang.String> getKeywords()
          Gets the value of the keywords property.
 java.lang.String getServiceStartTimeFrom()
          Returns the lower value of serviceStartTime

Equivalent to the $XDSDocumentEntryServiceStartTimeFrom query parameter.

 java.lang.String getServiceStartTimeTo()
          Returns the upper value of serviceStartTime

Equivalent to the $XDSDocumentEntryServiceStartTimeTo query parameter.

 java.lang.String getServiceStopTimeFrom()
          Returns the lower value of serviceStopTime

Equivalent to the $XDSDocumentEntryServiceStopTimeFrom query parameter.

 java.lang.String getServiceStopTimeTo()
          Returns the upper value of serviceStopTime

Equivalent to the $XDSDocumentEntryServiceStopTimeTo query parameter.

 java.util.Set<DocumentStatus> getStatuses()
          Gets the value of the statuses property.
 java.util.List<CodedValue> getTemplateIds()
          Gets the value of the templateIds property.
 boolean hasAuthorIndividuals()
          Are there any authorIndividuals in the query parameters?
 boolean hasClinicalSpecialties()
          Are there any clinicalSpecialties in the query parameters?
 boolean hasDocumentClasses()
          Are there any documentTypes in the query parameters?
 boolean hasDocumentTypes()
          Are there any documentTypes in the query parameters?
 boolean hasHealthcareFacilityTypes()
          Are there any healthcareFacilityTypes in the query parameters?
 boolean hasKeywords()
          Are there any keywords in the query parameters?
 boolean hasStatuses()
          Are there any statuses in the query parameters?
 boolean hasTemplateIds()
          Are there any templateIds in the query parameters?
 boolean matches(DocumentMetadata documentMetadata)
          Check whether the query parameters match the document metadata.
 void setDocumentCreationTimeFrom(java.lang.String documentCreationTimeFrom)
          Sets the lower value of documentCreationTime

Equivalent to the $XDSDocumentEntryCreationTimeFrom query parameter.

 void setDocumentCreationTimeTo(java.lang.String documentCreationTimeTo)
          Sets the upper value of documentCreationTime

Equivalent to the $XDSDocumentEntryCreationTimeTo query parameter.

 void setServiceStartTimeFrom(java.lang.String serviceStartTimeFrom)
          Sets the lower value of serviceStartTime

Equivalent to the $XDSDocumentEntryServiceStartTimeFrom query parameter.

 void setServiceStartTimeTo(java.lang.String serviceStartTimeTo)
          Sets the upper value of serviceStartTime

Equivalent to the $XDSDocumentEntryServiceStartTimeTo query parameter.

 void setServiceStopTimeFrom(java.lang.String serviceStopTimeFrom)
          Sets the lower value of serviceStopTime

Equivalent to the $XDSDocumentEntryServiceStopTimeFrom query parameter.

 void setServiceStopTimeTo(java.lang.String serviceStopTimeTo)
          Sets the upper value of serviceStopTime

Equivalent to the $XDSDocumentEntryServiceStopTimeTo query parameter.

 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DocumentQueryParams

public DocumentQueryParams()
Default constructor.


DocumentQueryParams

public DocumentQueryParams(DocumentStatus... status)
Constructor.

Parameters:
status - variable list of DocumentStatus types.
Method Detail

hasAuthorIndividuals

public boolean hasAuthorIndividuals()
Are there any authorIndividuals in the query parameters?

Returns:
true if there are any authorIndividuals in the query parameters.

getAuthorIndividuals

public java.util.List<Author> getAuthorIndividuals()
Gets the value of the authorIndividuals property.

If multiple values are specified than they will be considered to represent 'OR' semantics.

The value for this parameter is a pattern compatible with the SQL keyword LIKE which allows the use of the following wildcard characters: % to match any (or no) characters and _ to match a single character.

This accessor method returns a reference to the live list, not a snapshot. This is why there is not a set method for the authorIndividuals property.

For example, to add a new item, do as follows:

 getAuthorIndividuals().add(newItem);
 

Equivalent to the $XDSDocumentEntryAuthorPerson query parameter.

Returns:
value of authorIndividuals

hasDocumentTypes

public boolean hasDocumentTypes()
Are there any documentTypes in the query parameters?

Returns:
true if there are any documentTypes in the query parameters.

getDocumentTypes

public java.util.List<CodedValue> getDocumentTypes()
Gets the value of the documentTypes property.

If multiple values are specified than they will be considered to represent 'OR' semantics.

This accessor method returns a reference to the live list, not a snapshot. This is why there is not a set method for the documentTypes property.

For example, to add a new item, do as follows:

 getDocumentTypes().add(newItem);
 

Equivalent to the $XDSDocumentEntryTypeCode query parameter.

Returns:
value of documentTypes

hasDocumentClasses

public boolean hasDocumentClasses()
Are there any documentTypes in the query parameters?

Returns:
true if there are any documentTypes in the query parameters.

getDocumentClasses

public java.util.List<CodedValue> getDocumentClasses()
Gets the value of the documentClass property.

If multiple values are specified than they will be considered to represent 'OR' semantics.

This accessor method returns a reference to the live list, not a snapshot. This is why there is not a set method for the documentTypes property.

For example, to add a new item, do as follows:

 getDocumentTypes().add(newItem);
 

Equivalent to the $XDSDocumentEntryClassCode query parameter.

Returns:
value of documentTypes

hasTemplateIds

public boolean hasTemplateIds()
Are there any templateIds in the query parameters?

Returns:
true if there are any templateIds in the query parameters.

getTemplateIds

public java.util.List<CodedValue> getTemplateIds()
Gets the value of the templateIds property.

If multiple values are specified than they will be considered to represent 'OR' semantics.

This accessor method returns a reference to the live list, not a snapshot. This is why there is not a set method for the templateIds property.

For example, to add a new item, do as follows:

 getTemplateIds().add(newItem);
 

Equivalent to the $XDSDocumentEntryFormatCode query parameter.

Returns:
value of templateIds

getDocumentCreationTimeFrom

public java.lang.String getDocumentCreationTimeFrom()
Returns the lower value of documentCreationTime

Equivalent to the $XDSDocumentEntryCreationTimeFrom query parameter.

Returns:
lower value of documentCreationTime

setDocumentCreationTimeFrom

public void setDocumentCreationTimeFrom(java.lang.String documentCreationTimeFrom)
Sets the lower value of documentCreationTime

Equivalent to the $XDSDocumentEntryCreationTimeFrom query parameter.

Parameters:
documentCreationTimeFrom - lower value of documentCreationTime

getDocumentCreationTimeTo

public java.lang.String getDocumentCreationTimeTo()
Returns the upper value of documentCreationTime

Equivalent to the $XDSDocumentEntryCreationTimeTo query parameter.

Returns:
upper value of documentCreationTime

setDocumentCreationTimeTo

public void setDocumentCreationTimeTo(java.lang.String documentCreationTimeTo)
Sets the upper value of documentCreationTime

Equivalent to the $XDSDocumentEntryCreationTimeTo query parameter.

Parameters:
documentCreationTimeTo - upper value of documentCreationTime

getServiceStartTimeFrom

public java.lang.String getServiceStartTimeFrom()
Returns the lower value of serviceStartTime

Equivalent to the $XDSDocumentEntryServiceStartTimeFrom query parameter.

Returns:
lower value of serviceStartTime

setServiceStartTimeFrom

public void setServiceStartTimeFrom(java.lang.String serviceStartTimeFrom)
Sets the lower value of serviceStartTime

Equivalent to the $XDSDocumentEntryServiceStartTimeFrom query parameter.

Parameters:
serviceStartTimeFrom - lower value of serviceStartTime

getServiceStartTimeTo

public java.lang.String getServiceStartTimeTo()
Returns the upper value of serviceStartTime

Equivalent to the $XDSDocumentEntryServiceStartTimeTo query parameter.

Returns:
upper value of serviceStartTime

setServiceStartTimeTo

public void setServiceStartTimeTo(java.lang.String serviceStartTimeTo)
Sets the upper value of serviceStartTime

Equivalent to the $XDSDocumentEntryServiceStartTimeTo query parameter.

Parameters:
serviceStartTimeTo - upper value of serviceStartTime

getServiceStopTimeFrom

public java.lang.String getServiceStopTimeFrom()
Returns the lower value of serviceStopTime

Equivalent to the $XDSDocumentEntryServiceStopTimeFrom query parameter.

Returns:
lower value of serviceStopTime

setServiceStopTimeFrom

public void setServiceStopTimeFrom(java.lang.String serviceStopTimeFrom)
Sets the lower value of serviceStopTime

Equivalent to the $XDSDocumentEntryServiceStopTimeFrom query parameter.

Parameters:
serviceStopTimeFrom - lower value of serviceStopTime

getServiceStopTimeTo

public java.lang.String getServiceStopTimeTo()
Returns the upper value of serviceStopTime

Equivalent to the $XDSDocumentEntryServiceStopTimeTo query parameter.

Returns:
upper value of serviceStopTime

setServiceStopTimeTo

public void setServiceStopTimeTo(java.lang.String serviceStopTimeTo)
Sets the upper value of serviceStopTime

Equivalent to the $XDSDocumentEntryServiceStopTimeTo query parameter.

Parameters:
serviceStopTimeTo - upper value of serviceStopTime

hasHealthcareFacilityTypes

public boolean hasHealthcareFacilityTypes()
Are there any healthcareFacilityTypes in the query parameters?

Returns:
true if there are any healthcareFacilityTypes in the query parameters.

getHealthcareFacilityTypes

public java.util.List<CodedValue> getHealthcareFacilityTypes()
Gets the value of the healthcareFacilityTypes property.

If multiple values are specified than they will be considered to represent 'OR' semantics.

This accessor method returns a reference to the live list, not a snapshot. This is why there is not a set method for the healthcareFacilityTypes property.

For example, to add a new item, do as follows:

 getHealthcareFacilityTypes().add(newItem);
 

Equivalent to the $XDSDocumentEntryHealthcareFacilityTypeCode query parameter.

Returns:
value of healthcareFacilityTypes

hasClinicalSpecialties

public boolean hasClinicalSpecialties()
Are there any clinicalSpecialties in the query parameters?

Returns:
true if there are any clinicalSpecialties in the query parameters.

getClinicalSpecialties

public java.util.List<CodedValue> getClinicalSpecialties()
Gets the value of the clinicalSpecialties property.

If multiple values are specified than they will be considered to represent 'OR' semantics.

This accessor method returns a reference to the live list, not a snapshot. This is why there is not a set method for the clinicalSpecialties property.

For example, to add a new item, do as follows:

 getClinicalSpecialties().add(newItem);
 

Equivalent to the $XDSDocumentEntryPracticeSettingCode query parameter.

Returns:
value of clinicalSpecialties

hasKeywords

public boolean hasKeywords()
Are there any keywords in the query parameters?

Returns:
true if there are any keywords in the query parameters.

getKeywords

public java.util.Set<java.lang.String> getKeywords()
Gets the value of the keywords property.

If multiple values are specified than they will be considered to represent 'OR' semantics.

This accessor method returns a reference to the live list, not a snapshot. This is why there is not a set method for the keywords property.

For example, to add a new item, do as follows:

 getKeywords().add(newItem);
 

Equivalent to the $XDSDocumentEntryEventCodeList query parameter.

Returns:
value of keywords

hasStatuses

public boolean hasStatuses()
Are there any statuses in the query parameters?

Returns:
true if there are any statuses in the query parameters.

getStatuses

public java.util.Set<DocumentStatus> getStatuses()
Gets the value of the statuses property.

If multiple values are specified than they will be considered to represent 'OR' semantics.

This accessor method returns a reference to the live list, not a snapshot. This is why there is not a set method for the keywords property.

For example, to add a new item, do as follows:

 getStatuses().add(newItem);
 

Equivalent to the $XDSDocumentEntryStatus query parameter.

Returns:
value of statuses

matches

public boolean matches(DocumentMetadata documentMetadata)
Check whether the query parameters match the document metadata.

Parameters:
documentMetadata - Document metadata.
Returns:
true if the query parameters match the document metadata.