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.context.api;
021
022import ca.uhn.fhir.context.FhirContext;
023
024/**
025 * RESTful server behaviour for automatically adding profile tags when serializing resources
026 *
027 * @see FhirContext#setAddProfileTagWhenEncoding(AddProfileTagEnum)
028 */
029public enum AddProfileTagEnum {
030        /**
031         * Do not add profile tags automatically
032         */
033        NEVER,
034
035        /**
036         * Add any profile tags that returned resources appear to conform to
037         *
038         * @deprecated This mode causes even FHIR's default profiles to be exported in the
039         * resource metadata section. This is not generally expected behaviour from other
040         * systems and it offers no real benefit, so it will be removed at some point. This
041         * option was deprecated in HAPI 1.5
042         */
043        @Deprecated
044        ALWAYS,
045
046        /**
047         * Add any profile tags that returned resources appear to conform to if the resource is a non-standard class (e.g.
048         * it is an instance of a class that extends a built in type, but adds or constrains it)
049         */
050        ONLY_FOR_CUSTOM
051}