com.imsweb.seerapi.client.disease

Interface DiseaseService

public interface DiseaseService

Method Summary

Modifier and Type	Method and Description
retrofit2.Call<DiseaseChangelogResults>	diseaseChangelogs(java.lang.String version, java.lang.String fromDate, java.lang.String toDate, java.lang.Integer count) Return the changelog entries for the passed database version
retrofit2.Call<Disease>	getById(java.lang.String version, java.lang.String id) Return a complete disease entity based in identifier.
retrofit2.Call<Disease>	getById(java.lang.String version, java.lang.String id, boolean includeGlossary) Return a complete disease entity based in identifier
retrofit2.Call<java.util.List<PrimarySite>>	primarySiteCode(java.lang.String primarySite) Return a single primary site and label
retrofit2.Call<java.util.List<PrimarySite>>	primarySites() Return a list of all primary sites and labels
retrofit2.Call<Disease>	reportability(Disease disease) Returns the reportable year range of the supplied disease.
retrofit2.Call<SamePrimaries>	samePrimaries(java.lang.String version, java.lang.String morphology1, java.lang.String morphology2, java.lang.String year) Return whether the 2 morphologies represent the same primary for the given year.
retrofit2.Call<DiseaseSearchResults>	search(java.lang.String version, java.util.Map<java.lang.String,java.lang.String> searchParams) Return a list of matching diseases
retrofit2.Call<DiseaseSearchResults>	search(java.lang.String version, java.lang.String query) Return a list of matching diseases
retrofit2.Call<java.util.List<SiteCategory>>	siteCategories() Return a complete list of site categories and definitions
retrofit2.Call<java.util.List<DiseaseVersion>>	versions() Return a list of all disease versions and information about them

Method Detail

versions

@GET(value="disease/versions")
retrofit2.Call<java.util.List<DiseaseVersion>> versions()

Return a list of all disease versions and information about them

Returns:

a list of DiseaseVersion objects

search

@GET(value="disease/{version}")
retrofit2.Call<DiseaseSearchResults> search(@Path(value="version")
                                                                            java.lang.String version,
                                                                            @Query(value="q")
                                                                            java.lang.String query)

Return a list of matching diseases

Parameters:

version - Disease version

query - search query

Returns:

a DiseaseSearchResults object

search

@GET(value="disease/{version}")
retrofit2.Call<DiseaseSearchResults> search(@Path(value="version")
                                                                            java.lang.String version,
                                                                            @QueryMap
                                                                            java.util.Map<java.lang.String,java.lang.String> searchParams)

Return a list of matching diseases

Parameters:

version - Disease version

searchParams - A Map of search parameters. Use DiseaseSearch to easily build parameter list.

Returns:

a DiseaseSearchResults object

getById

@GET(value="disease/{version}/id/{id}")
retrofit2.Call<Disease> getById(@Path(value="version")
                                                                        java.lang.String version,
                                                                        @Path(value="id")
                                                                        java.lang.String id)

Return a complete disease entity based in identifier. Note that by default the disease entity does not include relevant glossary references.

Parameters:

version - Disease version

id - Disease identifier

Returns:

a Disease object

getById

@GET(value="disease/{version}/id/{id}")
retrofit2.Call<Disease> getById(@Path(value="version")
                                                                        java.lang.String version,
                                                                        @Path(value="id")
                                                                        java.lang.String id,
                                                                        @Query(value="glossary")
                                                                        boolean includeGlossary)

Return a complete disease entity based in identifier

Parameters:

version - Disease version

id - Disease identifier

includeGlossary - if true, include the glossary

Returns:

a Disease object

primarySites

@GET(value="disease/primary_site")
retrofit2.Call<java.util.List<PrimarySite>> primarySites()

Return a list of all primary sites and labels

Returns:

a List of PrimarySite objects

primarySiteCode

@GET(value="disease/primary_site/{code}")
retrofit2.Call<java.util.List<PrimarySite>> primarySiteCode(@Path(value="code")
                                                                                                      java.lang.String primarySite)

Return a single primary site and label

Parameters:

primarySite - Primary Site O3

Returns:

a PrimarySite object

siteCategories

@GET(value="disease/site_categories")
retrofit2.Call<java.util.List<SiteCategory>> siteCategories()

Return a complete list of site categories and definitions

Returns:

a list of SiteCategory objects

samePrimaries

@GET(value="disease/{version}/same_primary")
retrofit2.Call<SamePrimaries> samePrimaries(@Path(value="version")
                                                                                         java.lang.String version,
                                                                                         @Query(value="d1")
                                                                                         java.lang.String morphology1,
                                                                                         @Query(value="d2")
                                                                                         java.lang.String morphology2,
                                                                                         @Query(value="year")
                                                                                         java.lang.String year)

Return whether the 2 morphologies represent the same primary for the given year.

Parameters:

version - Disease version

morphology1 - ICD O3 Morphology

morphology2 - ICD O3 Morphology

year - Year of Diagnosis

Returns:

a SamePrimary object

reportability

@POST(value="disease/reportability")
retrofit2.Call<Disease> reportability(@Body
                                                                           Disease disease)

Returns the reportable year range of the supplied disease.

Parameters:

disease - Disease object

Returns:

a Disease object with the reportability field filled in

diseaseChangelogs

@GET(value="disease/{version}/changelog")
retrofit2.Call<DiseaseChangelogResults> diseaseChangelogs(@Path(value="version")
                                                                                                    java.lang.String version,
                                                                                                    @Query(value="from")
                                                                                                    java.lang.String fromDate,
                                                                                                    @Query(value="to")
                                                                                                    java.lang.String toDate,
                                                                                                    @Query(value="count")
                                                                                                    java.lang.Integer count)

Return the changelog entries for the passed database version

Parameters:

version - Disease version

fromDate - if not null, only include changes from this date forward (YYYY-MM-DD)

toDate - if not null, only include changes prior to this date (YYYY-MM-DD)

count - if not null, limit the number returned

Returns:

a list of DiseaseChangelogResults objects