001package org.hl7.fhir.instance.model.api;
002
003import ca.uhn.fhir.model.api.annotation.SearchParamDefinition;
004import ca.uhn.fhir.rest.gclient.TokenClientParam;
005
006/*
007 * #%L
008 * HAPI FHIR - Core Library
009 * %%
010 * Copyright (C) 2014 - 2021 Smile CDR, Inc.
011 * %%
012 * Licensed under the Apache License, Version 2.0 (the "License");
013 * you may not use this file except in compliance with the License.
014 * You may obtain a copy of the License at
015 *
016 *      http://www.apache.org/licenses/LICENSE-2.0
017 *
018 * Unless required by applicable law or agreed to in writing, software
019 * distributed under the License is distributed on an "AS IS" BASIS,
020 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
021 * See the License for the specific language governing permissions and
022 * limitations under the License.
023 * #L%
024 */
025
026/**
027 * An IBaseResource that has a FHIR version of DSTU3 or higher
028 */
029public interface IAnyResource extends IBaseResource {
030
031        /**
032         * Search parameter constant for <b>_id</b>
033         */
034        @SearchParamDefinition(name="_id", path="", description="The ID of the resource", type="token")
035        String SP_RES_ID = "_id";
036
037        /**
038         * <b>Fluent Client</b> search parameter constant for <b>_id</b>
039         * <p>
040         * Description: <b>the _id of a resource</b><br>
041         * Type: <b>string</b><br>
042         * Path: <b>Resource._id</b><br>
043         * </p>
044         */
045        TokenClientParam RES_ID = new TokenClientParam(IAnyResource.SP_RES_ID);
046
047        String getId();
048
049        IIdType getIdElement();
050
051        IPrimitiveType<String> getLanguageElement();
052
053        Object getUserData(String name);
054
055        IAnyResource setId(String theId);
056
057        void setUserData(String name, Object value);
058
059}