001package org.hl7.fhir.r4.model.annotations;
002
003/*
004Copyright (c) 2011+, HL7, Inc.
005All rights reserved.
006
007Redistribution and use in source and binary forms, with or without modification, 
008are permitted provided that the following conditions are met:
009
010 * Redistributions of source code must retain the above copyright notice, this 
011   list of conditions and the following disclaimer.
012 * Redistributions in binary form must reproduce the above copyright notice, 
013   this list of conditions and the following disclaimer in the documentation 
014   and/or other materials provided with the distribution.
015 * Neither the name of HL7 nor the names of its contributors may be used to 
016   endorse or promote products derived from this software without specific 
017   prior written permission.
018
019THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
020ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
021WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
022IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
023INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 
024NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
025PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
026WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
027ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
028POSSIBILITY OF SUCH DAMAGE.
029
030*/
031
032import java.lang.annotation.ElementType;
033import java.lang.annotation.Retention;
034import java.lang.annotation.RetentionPolicy;
035import java.lang.annotation.Target;
036
037/**
038 * Field modifier to be placed on a child field (a field also annotated with the {@link Child} annotation) which
039 * indicates that this field is an extension.
040 */
041@Target(value = { ElementType.FIELD })
042@Retention(RetentionPolicy.RUNTIME)
043public @interface Extension {
044
045        /**
046         * This parameter affects how the extension is treated when the element definition containing this resource is
047         * exported to a profile.
048         * 
049         * <p>
050         * If set to <b><code>true</code></b>, the resource is taken to be a local resource and its definition is exported
051         * along with the reference. Use this option for extension defintions that you have added locally (i.e. within your
052         * own organization)
053         * </p>
054         * 
055         * <p>
056         * If set to <b><code>false</code></b>, the resource is taken to be a remote resource and its definition is
057         * <b>not</b> exported to the profile. Use this option for extensions that are defined by other organizations (i.e.
058         * by regional authorities or jurisdictional governments)
059         * </p>
060         */
061        boolean definedLocally();
062
063        /**
064         * Returns <code>true</code> if this extension is a <a
065         * href="http://www.hl7.org/implement/standards/fhir/extensibility.html#modifierExtension">modifier extension</a>
066         */
067        boolean isModifier();
068
069        /**
070         * The URL associated with this extension
071         */
072        String url();
073
074}