Interface MpiQuery
- All Known Implementing Classes:
V3PdqQuery
public interface MpiQuery
The interface MpiQuery defines a query object which allows to add the query parameters for the patient demographics
query and control the subsequent query steps (continue, cancel) when the query is batched.
-
Method Summary
Modifier and TypeMethodDescriptionaddDomainToReturn
(String organizationOID) Returned patient identifiers will include the added domain if availableaddMothersMaidenName
(boolean useFuzzySearch, org.hl7.fhir.r4.model.HumanName humanDt) Adds the mothers maiden name to the queryaddPatientAddress
(org.hl7.fhir.r4.model.Address address) Adds a patient address to the query.addPatientIdentifier
(org.hl7.fhir.r4.model.Identifier identifier) Adds a patient identifier to be queried for.addPatientName
(boolean useFuzzySearch, org.hl7.fhir.r4.model.HumanName humanDt) Adds a patient name to the query.addPatientTelecom
(org.hl7.fhir.r4.model.ContactPoint contactPoint) Adds a patient telecom to be queried for.Cancels the next query.Continues query for the next pageCount results.setPageCount
(int pageCount) Sets the page count for partial lists of search results (QueryByParameter.initialQuantity).setPatientBirthDate
(Date date) Sets the patient birth date for the query.setPatientSex
(org.hl7.fhir.r4.model.Enumerations.AdministrativeGender adminstrativeGenderEnum) Sets the patient sex for the query.
-
Method Details
-
addDomainToReturn
Returned patient identifiers will include the added domain if available- Parameters:
organizationOID
- the organization oid- Returns:
- the query object
-
addMothersMaidenName
Adds the mothers maiden name to the query- Parameters:
useFuzzySearch
- if true does not require an exact match, see Table 3.47.4.1.2-1: Model Attributes (ITI TF-2b)humanDt
- name- Returns:
- the query object
-
addPatientAddress
Adds a patient address to the query.- Parameters:
address
- the address to be queried for- Returns:
- the query object
-
addPatientIdentifier
Adds a patient identifier to be queried for.- Parameters:
identifier
- patient identifier- Returns:
- the query object
-
addPatientName
Adds a patient name to the query.- Parameters:
useFuzzySearch
- if true does not require an exact match, see Table 3.47.4.1.2-1: Model Attributes (ITI TF-2b)humanDt
- name- Returns:
- the query object
-
addPatientTelecom
Adds a patient telecom to be queried for.- Parameters:
contactPoint
- telecom- Returns:
- the query object
-
cancelQuery
MpiQuery cancelQuery()Cancels the next query.- Returns:
- the query object
-
continueQuery
MpiQuery continueQuery()Continues query for the next pageCount results.- Returns:
- the query object
-
setPageCount
Sets the page count for partial lists of search results (QueryByParameter.initialQuantity).- Parameters:
pageCount
- the page count- Returns:
- the query object
-
setPatientBirthDate
Sets the patient birth date for the query.- Parameters:
date
- the date- Returns:
- the query object
-
setPatientSex
MpiQuery setPatientSex(org.hl7.fhir.r4.model.Enumerations.AdministrativeGender adminstrativeGenderEnum) Sets the patient sex for the query.- Parameters:
adminstrativeGenderEnum
- gender- Returns:
- the query object
-