The UMLS SOAP API is deprecated as of the 2020AA release. The SOAP API will be discontinued on December 31, 2020. SOAP API users are encouraged to switch to the REST API.

Paging, Sorting and Filtering

The Paging, Sorting, and Filtering (PSF) object of the UMLS SOAP allows you to customize the results of your Web service calls in a variety of ways. The PSF object allows a great deal of flexibility in customizing your view of returned data.
You can:

• include or exclude criteria such as source vocabularies, language, term types, obsolescence, and suppressibilty
• sort your results by different fields, depending on the return type
• choose the number of results displayed per page
• choose number of pages of results returned

You can create a PSF object in java as follows:
Psf psf = new Psf();

Method	Use With	Use Case	Permitted Values	Default Value
setIncludeObsolete	UiLabel, UiLabelRootSource, AtomDTO	Include or exclude search results based on source-asserted obsolscence.	True, False	True
setIncludeSuppressible	UiLabel, UiLabelRootSource, AtomDTO	Include or exclude search results based on source-asserted obsolscence.	True, False	True
setIncludedLanguage	AtomDTO	Limit results to only include terms that meet the specified language abbreviation provided	Any valid language abbreviation in the UMLS	All languages are included by default
getIncludedTermTypes	AtomDTO	Limit results to include only atoms that match the specified term types	Any vaid term type in the UMLS	All term types are include by default
getIncludedSources	AtomDTO	Limit results to only include specific source vocabularies	Any valid source abbreviation (rsab) in the UMLS	All source vocabularies are included by default
getIncludedRelationLabels	AtomClusterRelationDTO	Limit results to include only relationships that meet the provided criteria	Any relation label in the UMLS	All relation labels are included by default
getIncludedAdditionalRelationLabels	AtomClusterRelationDTO	Limit results to include only additional relation labels that meet the provided criteria	Any additional relation label	All additional relation labels are included by default
getIncludedAttributeNames	AttributeDTO	Limit results to include only attributes that match the specified names	Any valid attribute name in the UMLS	All attribute names are included by default
setPageNum	any	Specify page number to retrieve	Any positive integer	1
setPageLn	any	Specify number of objects returned per page	Any positive integer between 25 - 1000	25

setIncludeSuppressible

psf.setIncludeObsolete(false);

setIncludeObsolete

psf.setIncludeSuppressible(false);

getIncludedTermTypes

psf.getIncludedTermTypes().add("PT");
psf.getIncludedTermTypes().add("FN");

getIncludedRelationLabels

psf.getIncludedRelationLabels().add("PAR");
psf.getIncludedRelationLabels().add("SY");

getIncludedAdditionalRelationLabels

psf.getIncludedAdditionalRelationLabels().add("has_finding_site");
psf.getIncludedAdditionalRelationLabels().add("has_procedure_site");

getIncludedAttributeNames

psf.getIncludedAttributeNames().add("CONCEPTSTATUS");
psf.getIncludedAttributeNames().add("ISPRIMITIVE");

setIncludedLanguage

psf.setIncludedLanguage("CZE");

getIncludedSources

psf.getIncludedSources().add("SNOMEDCT_US");
psf.getIncludedSources().add("ICD10CM");

setPageNum

psf.setPageNum(2);

setPageLn

psf.setPageLn(50);