001package ca.uhn.fhir.model.api.annotation;
002
003/*
004 * #%L
005 * HAPI FHIR - Core Library
006 * %%
007 * Copyright (C) 2014 - 2022 Smile CDR, Inc.
008 * %%
009 * Licensed under the Apache License, Version 2.0 (the "License");
010 * you may not use this file except in compliance with the License.
011 * You may obtain a copy of the License at
012 *
013 *      http://www.apache.org/licenses/LICENSE-2.0
014 *
015 * Unless required by applicable law or agreed to in writing, software
016 * distributed under the License is distributed on an "AS IS" BASIS,
017 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
018 * See the License for the specific language governing permissions and
019 * limitations under the License.
020 * #L%
021 */
022
023import java.lang.annotation.Retention;
024import java.lang.annotation.RetentionPolicy;
025import java.lang.annotation.Target;
026
027/**
028 * This may only be populated on a reference search paramater field. On such a field, places the containing
029 * resource in a compartment with the name(s) specified by the given strings, where the compartment
030 * belongs to the target resource. For example, this field could be populated with <code>Patient</code> on 
031 * the <code>Observation.subject</code> field.
032 */
033@Retention(RetentionPolicy.RUNTIME)
034@Target(value= {})
035public @interface Compartment {
036
037        String name();
038        
039}