001/*
002 * #%L
003 * HAPI FHIR - Core Library
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.narrative;
021
022import ca.uhn.fhir.context.FhirContext;
023import org.hl7.fhir.instance.model.api.IBaseResource;
024
025public interface INarrativeGenerator {
026
027        /**
028         * Generate any narratives for the given resource that have applicable
029         * templates, and populates the appropriate field(s). This almost always means
030         * the <code>Resource.text.narrative</code> field, but for some resource types
031         * it can mean other fields (e.g. <code>Composition.</code>
032         *
033         * @return Returns <code>true</code> if a narrative was actually generated
034         */
035        boolean populateResourceNarrative(FhirContext theFhirContext, IBaseResource theResource);
036
037        /**
038         * Generates the narrative for the given resource and returns it as a string
039         */
040        String generateResourceNarrative(FhirContext theFhirContext, IBaseResource theResource);
041}