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.Retention;
24  import java.lang.annotation.RetentionPolicy;
25  import java.lang.annotation.Target;
26  
27  /**
28   * This may only be populated on a reference search paramater field. On such a field, places the containing
29   * resource in a compartment with the name(s) specified by the given strings, where the compartment
30   * belongs to the target resource. For example, this field could be populated with <code>Patient</code> on 
31   * the <code>Observation.subject</code> field.
32   */
33  @Retention(RetentionPolicy.RUNTIME)
34  @Target(value= {})
35  public @interface Compartment {
36  
37  	String name();
38  	
39  }