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