org.hl7.fhir.instance.model.api.IBaseResource 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

Builds the hapi fhir base. Requires Common lang, commons-text, and guava be built first.

There is a newer version: 7.0.2-r12

/*
 * #%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.context.FhirVersionEnum;
import ca.uhn.fhir.model.api.IElement;
import ca.uhn.fhir.model.api.Include;
import ca.uhn.fhir.model.api.ResourceMetadataKeyEnum;

import java.util.Arrays;
import java.util.Collections;
import java.util.HashSet;
import java.util.Set;

/**
 * For now, this is a simple marker interface indicating that a class is a resource type.
 * There are two concrete types of implementations of this interrface. The first are
 * HL7.org's Resource structures (e.g.
 * org.hl7.fhir.instance.model.Patient) and
 * the second are HAPI's Resource structures, e.g.
 * ca.uhn.fhir.model.dstu.resource.Patient)
 */
public interface IBaseResource extends IBase, IElement {

	IBaseMetaType getMeta();

	/**
	 * Include constant for * (return all includes)
	 */
	Include INCLUDE_ALL = new Include("*", false).toLocked();

	/**
	 * Include set containing only {@link #INCLUDE_ALL}
	 */
	Set WILDCARD_ALL_SET = Collections.unmodifiableSet(new HashSet<>(Arrays.asList(INCLUDE_ALL)));

	IIdType getIdElement();

	IBaseResource setId(String theId);

	IBaseResource setId(IIdType theId);

	FhirVersionEnum getStructureFhirVersionEnum();

	/**
	 * @return true if this resource has been deleted
	 */
	default boolean isDeleted() {
		return ResourceMetadataKeyEnum.DELETED_AT.get(this) != null;
	}
}