1 package ca.uhn.fhir.model.api.annotation;
2
3 /*
4 * #%L
5 * HAPI FHIR - Core Library
6 * %%
7 * Copyright (C) 2014 University Health Network
8 * %%
9 * Licensed under the Apache License, Version 2.0 (the "License");
10 * you may not use this file except in compliance with the License.
11 * You may obtain a copy of the License at
12 *
13 * http://www.apache.org/licenses/LICENSE-2.0
14 *
15 * Unless required by applicable law or agreed to in writing, software
16 * distributed under the License is distributed on an "AS IS" BASIS,
17 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18 * See the License for the specific language governing permissions and
19 * limitations under the License.
20 * #L%
21 */
22
23 import java.lang.annotation.ElementType;
24 import java.lang.annotation.Retention;
25 import java.lang.annotation.RetentionPolicy;
26 import java.lang.annotation.Target;
27
28 /**
29 * Field modifier to be placed on a child field (a field also annotated with the {@link Child} annotation) which
30 * indicates that this field is an extension.
31 */
32 @Target(value = { ElementType.FIELD })
33 @Retention(RetentionPolicy.RUNTIME)
34 public @interface Extension {
35
36 /**
37 * This parameter affects how the extension is treated when the element definition containing this resource is
38 * exported to a profile.
39 *
40 * <p>
41 * If set to <b><code>true</code></b>, the resource is taken to be a local resource and its definition is exported
42 * along with the reference. Use this option for extension defintions that you have added locally (i.e. within your
43 * own organization)
44 * </p>
45 *
46 * <p>
47 * If set to <b><code>false</code></b>, the resource is taken to be a remote resource and its definition is
48 * <b>not</b> exported to the profile. Use this option for extensions that are defined by other organizations (i.e.
49 * by regional authorities or jurisdictional governments)
50 * </p>
51 */
52 boolean definedLocally();
53
54 /**
55 * Returns <code>true</code> if this extension is a <a
56 * href="http://www.hl7.org/implement/standards/fhir/extensibility.html#modifierExtension">modifier extension</a>
57 */
58 boolean isModifier();
59
60 /**
61 * The URL associated with this extension
62 */
63 String url();
64
65 }