com.imsweb.seerapi.client.disease.DiseaseService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of seerapi-client-java Show documentation
API mapping for SEER*API in Java
There is a newer version: 5.7
/*
 * Copyright (C) 2015 Information Management Services, Inc.
 */
package com.imsweb.seerapi.client.disease;

import java.util.List;
import java.util.Map;

import retrofit2.Call;
import retrofit2.http.Body;
import retrofit2.http.GET;
import retrofit2.http.POST;
import retrofit2.http.Path;
import retrofit2.http.Query;
import retrofit2.http.QueryMap;

public interface DiseaseService {

    /**
     * Return a list of all disease versions and information about them
     * @return a list of DiseaseVersion objects
     */
    @GET("disease/versions")
    Call> versions();

    /**
     * Return a list of matching diseases
     * @param version Disease version
     * @param query search query
     * @return a DiseaseSearchResults object
     */
    @GET("disease/{version}")
    Call search(@Path("version") String version, @Query("q") String query);

    /**
     * Return a list of matching diseases
     * @param version Disease version
     * @param searchParams A Map of search parameters.  Use DiseaseSearch to easily build parameter list.
     * @return a DiseaseSearchResults object
     */
    @GET("disease/{version}")
    Call search(@Path("version") String version, @QueryMap Map searchParams);

    /**
     * Return a complete disease entity based in identifier.  Note that by default the disease entity does not include relevant glossary references.
     * @param version Disease version
     * @param id Disease identifier
     * @return a Disease object
     */
    @GET("disease/{version}/id/{id}")
    Call getById(@Path("version") String version, @Path("id") String id);

    /**
     * Return a complete disease entity based in identifier
     * @param version Disease version
     * @param id Disease identifier
     * @param includeGlossary if true, include the glossary
     * @return a Disease object
     */
    @GET("disease/{version}/id/{id}")
    Call getById(@Path("version") String version, @Path("id") String id, @Query("glossary") boolean includeGlossary);

    /**
     * Return a list of all primary sites and labels
     * @return a List of PrimarySite objects
     */
    @GET("disease/primary_site")
    Call> primarySites();

    /**
     * Return a single primary site and label
     * @param primarySite Primary Site O3
     * @return a PrimarySite object
     */
    @GET("disease/primary_site/{code}")
    Call> primarySiteCode(@Path("code") String primarySite);

    /**
     * Return a complete list of site categories and definitions
     * @return a list of SiteCategory objects
     */
    @GET("disease/site_categories")
    Call> siteCategories();

    /**
     * Return whether the 2 morphologies represent the same primary for the given year.
     * @param version Disease version
     * @param morphology1 ICD O3 Morphology
     * @param morphology2 ICD O3 Morphology
     * @param year1 Year of Diagnosis1
     * @param year2 Year of Diagnosis2
     * @return a SamePrimary object
     */
    @GET("disease/{version}/same_primary")
    Call samePrimaries(@Path("version") String version, @Query("d1") String morphology1, @Query("d2") String morphology2, @Query("year1") String year1, @Query("year2") String year2);

    /**
     * Returns the reportable year range of the supplied disease.
     * @param disease Disease object
     * @return a Disease object with the reportability field filled in
     */
    @POST("disease/reportability")
    Call reportability(@Body Disease disease);

    /**
     * Return the changelog entries for the passed database version
     * @param version Disease version
     * @param fromDate if not null, only include changes from this date forward (YYYY-MM-DD)
     * @param toDate if not null, only include changes prior to this date (YYYY-MM-DD)
     * @param count if not null, limit the number returned
     * @return a list of DiseaseChangelogResults objects
     */
    @GET("disease/{version}/changelog")
    Call diseaseChangelogs(@Path("version") String version, @Query("from") String fromDate, @Query("to") String toDate, @Query("count") Integer count);
}