ca.uhn.fhir.model.api.IFhirVersion Maven / Gradle / Ivy
/*
* #%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 ca.uhn.fhir.model.api;
import ca.uhn.fhir.context.FhirContext;
import ca.uhn.fhir.context.FhirVersionEnum;
import ca.uhn.fhir.context.RuntimeResourceDefinition;
import ca.uhn.fhir.fhirpath.IFhirPath;
import ca.uhn.fhir.rest.api.IVersionSpecificBundleFactory;
import org.hl7.fhir.instance.model.api.IBase;
import org.hl7.fhir.instance.model.api.IBaseResource;
import org.hl7.fhir.instance.model.api.IIdType;
import org.hl7.fhir.instance.model.api.IPrimitiveType;
import java.io.InputStream;
import java.util.Date;
/**
* Each structure version JAR will have an implementation of this interface.
* This is used internally by HAPI and subject to change. Do not use this interface
* directly in user code.
*
* See also IFhirVersionServer for the hapi-fhir-server equivalent.
*/
public interface IFhirVersion {
IFhirPath createFhirPathExecutor(FhirContext theFhirContext);
IBaseResource generateProfile(RuntimeResourceDefinition theRuntimeResourceDefinition, String theServerBase);
Class getContainedType();
InputStream getFhirVersionPropertiesFile();
IPrimitiveType getLastUpdated(IBaseResource theResource);
String getPathToSchemaDefinitions();
Class getResourceReferenceType();
FhirVersionEnum getVersion();
IVersionSpecificBundleFactory newBundleFactory(FhirContext theContext);
IBase newCodingDt();
IIdType newIdType();
/**
* Returns an instance of IFhirVersionServer for this version.
* Note that this method may only be called if the hapi-fhir-server
* JAR is on the classpath. Otherwise it will result in a {@link ClassNotFoundException}
*/
Object getServerVersion();
}