View Javadoc
1   package ca.uhn.fhir.context.api;
2   
3   import ca.uhn.fhir.context.FhirContext;
4   
5   /*
6    * #%L
7    * HAPI FHIR - Core Library
8    * %%
9    * Copyright (C) 2014 - 2018 University Health Network
10   * %%
11   * Licensed under the Apache License, Version 2.0 (the "License");
12   * you may not use this file except in compliance with the License.
13   * You may obtain a copy of the License at
14   * 
15   *      http://www.apache.org/licenses/LICENSE-2.0
16   * 
17   * Unless required by applicable law or agreed to in writing, software
18   * distributed under the License is distributed on an "AS IS" BASIS,
19   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
20   * See the License for the specific language governing permissions and
21   * limitations under the License.
22   * #L%
23   */
24  
25  /**
26   * RESTful server behaviour for automatically adding profile tags when serializing resources
27   * 
28   * @see FhirContext#setAddProfileTagWhenEncoding(AddProfileTagEnum)
29   */
30  public enum AddProfileTagEnum {
31  	/**
32  	 * Do not add profile tags automatically
33  	 */
34  	NEVER,
35  
36  	/**
37  	 * Add any profile tags that returned resources appear to conform to
38  	 * 
39  	 * @deprecated This mode causes even FHIR's default profiles to be exported in the
40  	 * resource metadata section. This is not generally expected behaviour from other
41  	 * systems and it offers no real benefit, so it will be removed at some point. This
42  	 * option was deprecated in HAPI 1.5
43  	 */
44  	@Deprecated
45  	ALWAYS,
46  
47  	/**
48  	 * Add any profile tags that returned resources appear to conform to if the resource is a non-standard class (e.g.
49  	 * it is an instance of a class that extends a built in type, but adds or constrains it)
50  	 */
51  	ONLY_FOR_CUSTOM
52  }