View Javadoc
1   package ca.uhn.fhir.model.api.annotation;
2   
3   /*
4    * #%L
5    * HAPI FHIR - Core Library
6    * %%
7    * Copyright (C) 2014 - 2018 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   * Class annotation which indicates a resource definition class
30   */
31  @Retention(RetentionPolicy.RUNTIME)
32  @Target(value= {ElementType.TYPE})
33  public @interface ResourceDef {
34  
35  	/**
36  	 * The name of the resource (e.g. "Patient" or "DiagnosticReport"). If you are defining your
37  	 * own custom extension to a built-in FHIR resource definition type (e.g. you are extending
38  	 * the built-in Patient class) you do not need to supply a value for this property, as it 
39  	 * will be inferred from the parent class.
40  	 */
41  	String name() default "";
42  
43  	/**
44  	 * if set, will be used as the id for any profiles generated for this resource. This property
45  	 * should be set for custom profile definition classes, and will be used as the resource ID
46  	 * for the generated profile exported by the server. For example, if you set this value to
47  	 * "hello" on a custom resource class, your server will automatically export a profile with the
48  	 * identity: <code>http://localhost:8080/fhir/Profile/hello</code> (the base URL will be whatever
49  	 * your server uses, not necessarily "http://localhost:8080/fhir")
50  	 */
51  	String id() default "";
52  	
53  	/**
54  	 * The URL indicating the profile for this resource definition. If specified, this URL will be
55  	 * automatically added to the meta tag when the resource is serialized.
56  	 * <p>
57  	 * This URL should be fully qualified to indicate the complete URL of
58  	 * the profile being used, e.g. <code>http://example.com/fhir/StructureDefiniton/some_profile</code>;
59  	 * </p>
60  	 */
61  	String profile() default "";
62  	
63  }