org.hl7.fhir.instance.model.api.IAnyResource Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hapi-fhir-base Show documentation

There is a newer version: 7.4.5

/*
 * #%L
 * HAPI FHIR - Core Library
 * %%
 * Copyright (C) 2014 - 2024 Smile CDR, Inc.
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */
package org.hl7.fhir.instance.model.api;

import ca.uhn.fhir.model.api.annotation.SearchParamDefinition;
import ca.uhn.fhir.rest.gclient.TokenClientParam;

/**
 * An IBaseResource that has a FHIR version of DSTU3 or higher
 */
public interface IAnyResource extends IBaseResource {

	/**
	 * Search parameter constant for _id
	 */
	@SearchParamDefinition(name = "_id", path = "", description = "The ID of the resource", type = "token")
	String SP_RES_ID = "_id";

	/**
	 * Fluent Client search parameter constant for _id
	 * 
	 * Description: the _id of a resource

	 * Type: string

	 * Path: Resource._id

	 * 
	 */
	TokenClientParam RES_ID = new TokenClientParam(IAnyResource.SP_RES_ID);

	String getId();

	IIdType getIdElement();

	IPrimitiveType getLanguageElement();

	Object getUserData(String name);

	IAnyResource setId(String theId);

	void setUserData(String name, Object value);
}