001/*-
002 * #%L
003 * HAPI FHIR JPA Server - International Patient Summary (IPS)
004 * %%
005 * Copyright (C) 2014 - 2024 Smile CDR, Inc.
006 * %%
007 * Licensed under the Apache License, Version 2.0 (the "License");
008 * you may not use this file except in compliance with the License.
009 * You may obtain a copy of the License at
010 *
011 *      http://www.apache.org/licenses/LICENSE-2.0
012 *
013 * Unless required by applicable law or agreed to in writing, software
014 * distributed under the License is distributed on an "AS IS" BASIS,
015 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
016 * See the License for the specific language governing permissions and
017 * limitations under the License.
018 * #L%
019 */
020package ca.uhn.fhir.jpa.ips.api;
021
022import org.hl7.fhir.instance.model.api.IBaseResource;
023import org.hl7.fhir.instance.model.api.IIdType;
024
025/**
026 * This interface is invoked when a section has no resources found, and should generate
027 * a "stub" resource explaining why. Typically this would be content such as "no information
028 * is available for this section", and might indicate for example that the absence of
029 * AllergyIntolerance resources only indicates that the allergy status is not known, not that
030 * the patient has no allergies.
031 */
032public interface INoInfoGenerator {
033
034        /**
035         * Generate an appropriate no-info resource. The resource does not need to have an ID populated,
036         * although it can if it is a resource found in the repository.
037         */
038        IBaseResource generate(IIdType theSubjectId);
039}