001package ca.uhn.fhir.model.api;
002
003/*
004 * #%L
005 * HAPI FHIR - Core Library
006 * %%
007 * Copyright (C) 2014 - 2021 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 ca.uhn.fhir.model.primitive.IdDt;
024
025public interface IIdentifiableElement extends IElement {
026
027        /**
028         * Used to retrieve an ID for this specific element within a resource. These are used for IDREF referenced between
029         * elements within a single resource, and do not have any other purpose.
030         */
031        String getElementSpecificId();
032
033        /**
034         * @deprecated Use {@link #getElementSpecificId()} instead. This method will be removed because it is easily
035         *             confused with other ID methods (such as patient#getIdentifier)
036         */
037        @Deprecated
038        IdDt getId();
039
040        /**
041         * Used to set an ID for this specific element within a resource. These are used for IDREF referenced between
042         * elements within a single resource, and do not have any other purpose.
043         */
044        void setElementSpecificId(String theElementSpecificId);
045
046        /**
047         * @deprecated Use {@link #setElementSpecificId(String)} instead. This method will be removed because it is easily
048         *             confused with other ID methods (such as patient#getIdentifier)
049         */
050        @Deprecated
051        void setId(IdDt theId);
052
053        /**
054         * @deprecated Use {@link #setElementSpecificId(String)} instead. This method will be removed because it is easily
055         *             confused with other ID methods (such as patient#getIdentifier)
056         */
057        @Deprecated
058        void setId(String theId);
059
060}