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 org.hl7.fhir.instance.model.api;
021
022import ca.uhn.fhir.model.api.annotation.SearchParamDefinition;
023import ca.uhn.fhir.rest.gclient.TokenClientParam;
024
025/**
026 * An IBaseResource that has a FHIR version of DSTU3 or higher
027 */
028public interface IAnyResource extends IBaseResource {
029
030        /**
031         * Search parameter constant for <b>_id</b>
032         */
033        @SearchParamDefinition(name = "_id", path = "", description = "The ID of the resource", type = "token")
034        String SP_RES_ID = "_id";
035
036        /**
037         * <b>Fluent Client</b> search parameter constant for <b>_id</b>
038         * <p>
039         * Description: <b>the _id of a resource</b><br>
040         * Type: <b>string</b><br>
041         * Path: <b>Resource._id</b><br>
042         * </p>
043         */
044        TokenClientParam RES_ID = new TokenClientParam(IAnyResource.SP_RES_ID);
045
046        String getId();
047
048        IIdType getIdElement();
049
050        IPrimitiveType<String> getLanguageElement();
051
052        Object getUserData(String name);
053
054        IAnyResource setId(String theId);
055
056        void setUserData(String name, Object value);
057}