CMSgov/dpc-app

package gov.cms.dpc.attribution.resources;

import gov.cms.dpc.fhir.annotations.FHIR;
import org.hl7.fhir.dstu3.model.Bundle;
import org.hl7.fhir.dstu3.model.Parameters;
import org.hl7.fhir.dstu3.model.Practitioner;

import javax.validation.constraints.NotEmpty;
import javax.ws.rs.*;
import javax.ws.rs.core.Response;
import java.util.List;
import java.util.UUID;

@Path("/Practitioner")
@FHIR
public abstract class AbstractPractitionerResource {

    protected AbstractPractitionerResource() {
        // Not used
    }

    /**
     * FHIR search endpoint which allows querying providers with a given NPI
     * <p>
     * An Organization ID is required for this endpoint, which is passed via the `_tag` query parameter.
     *
     * @param resourceID      - {@link UUID} resource ID to query for
     * @param providerNPI     - {@link String} NPI to use for querying Provider database
     * @param organizationTag - {@link String} ID of {@link org.hl7.fhir.dstu3.model.Organization} making the request
     * @return - {@link Bundle} of {@link Practitioner} resources matching search parameters
     */
    @GET
    public abstract List<Practitioner> getPractitioners(UUID resourceID, String providerNPI, @NotEmpty String organizationTag);

    /**
     * Register {@link Practitioner} with application.
     * <p>
     * Note: No {@link org.hl7.fhir.dstu3.model.PractitionerRole} is created by this endpoint, so the {@link Practitioner} is registered with the system, but not assigned to an {@link org.hl7.fhir.dstu3.model.Organization}
     *
     * @param provider = {@link Practitioner}
     * @return - {@link Practitioner} with additional metadata added by application
     */
    @POST
    public abstract Response submitProvider(Practitioner provider);

    /**
     * Submit a {@link Bundle} of {@link Practitioner} resources as a single transaction
     * Internally, this is implemented by calling {@link AbstractPractitionerResource#submitProvider(Practitioner)} for each entry in the bundle.
     * This will be optimized at a later date
     *
     * @param providerBundle - {@link Bundle} of {@link Practitioner} resources to submit
     * @return - {@link Bundle} of newly created {@link Practitioner} resources
     */
    @POST
    @Path("/$submit")
    public abstract List<Practitioner> bulkSubmitProviders(Parameters providerBundle);

    /**
     * Fetch specific {@link Practitioner} resource
     * This is the ID of the resource, NOT the identifying NPI
     *
     * @param providerID - {@link UUID} provider ID
     * @return - {@link Practitioner}
     */
    @GET
    public abstract Practitioner getProvider(UUID providerID);

    /**
     * Remove {@link Practitioner} resource
     * This also removes all depending resource (e.g. attribution lists)
     *
     * @param providerID - {@link UUID} provider ID
     * @return - {@link Response}
     */
    @DELETE
    public abstract Response deleteProvider(UUID providerID);

    /**
     * Update {@link Practitioner} resource
     *
     * @param providerID - {@link UUID} provider ID
     * @param provider   - {@link Practitioner} resource to update
     * @return - {@link Practitioner} newly updated resource
     */
    @PUT
    public abstract Practitioner updateProvider(UUID providerID, Practitioner provider);
}