001package ca.uhn.fhir.narrative;
002
003/*
004 * #%L
005 * HAPI FHIR - Core Library
006 * %%
007 * Copyright (C) 2014 - 2021 Smile CDR, Inc.
008 * %%
009 * Licensed under the Apache License, Version 2.0 (the "License");
010 * you may not use this file except in compliance with the License.
011 * You may obtain a copy of the License at
012 *
013 *      http://www.apache.org/licenses/LICENSE-2.0
014 *
015 * Unless required by applicable law or agreed to in writing, software
016 * distributed under the License is distributed on an "AS IS" BASIS,
017 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
018 * See the License for the specific language governing permissions and
019 * limitations under the License.
020 * #L%
021 */
022
023import ca.uhn.fhir.context.FhirContext;
024import org.hl7.fhir.instance.model.api.IBaseResource;
025
026public interface INarrativeGenerator {
027
028        /**
029         * Generate any narratives for the given resource that have applicable
030         * templates, and populates the appropriate field(s). This almost always means
031         * the <code>Resource.text.narrative</code> field, but for some resource types
032         * it can mean other fields (e.g. <code>Composition.</code>
033         *
034         * @return Returns <code>true</code> if a narrative was actually generated
035         */
036        boolean populateResourceNarrative(FhirContext theFhirContext, IBaseResource theResource);
037
038}