Deprecated List (HAPI FHIR - Core Library 4.0.0 API)

Deprecated Exceptions
Exceptions and Description
ca.uhn.fhir.rest.server.exceptions.ResourceVersionNotSpecifiedException Use `PreconditionFailedException` instead - This exception is strangely named and will be removed at some point.

Deprecated Fields
Field and Description
ca.uhn.fhir.model.api.ResourceMetadataKeyEnum.VERSION_ID The `IResource.getId()` resource ID will now be populated with the version ID via the `IdDt.getVersionIdPart()` method

Deprecated Methods
Method and Description
ca.uhn.fhir.model.api.TagList.addTag() Tags wil become immutable in a future release of HAPI, so `TagList.addTag(String, String, String)` should be used instead
ca.uhn.fhir.rest.gclient.IClientExecutable.andLogRequestAndResponse(boolean) Use the client logging interceptor to log requests and responses instead. See here for more information.
ca.uhn.fhir.rest.gclient.IHistoryUntyped.andReturnBundle(Class<T>) Use `IHistoryUntyped.returnBundle(Class)` instead, which has the exact same functionality. This was deprecated in HAPI FHIR 4.0.0 in order to be consistent with the similar method on the search operation.
ca.uhn.fhir.model.primitive.IdDt.asBigDecimal() Use `IdDt.getIdPartAsBigDecimal()` instead (this method was deprocated because its name is ambiguous)
ca.uhn.fhir.rest.client.api.IHttpResponse.bufferEntitity() This method was deprecated in HAPI FHIR 2.2 because its name has a typo. Use `IHttpResponse.bufferEntity()` instead.
ca.uhn.fhir.rest.client.api.IGenericClient.fetchConformance() As of HAPI 3.0.0 this method has been deprecated, as the operation is now called "capabilities". Use `IGenericClient.capabilities()` instead
ca.uhn.fhir.model.api.ICompositeElement.getAllPopulatedChildElementsOfType(Class<T>) This method is not used by HAPI at this point, so there isn't much point to keeping it around. We are not deleting it just so that we don't break existing implementer code, but you do not need to supply an implementation of this code in your own structures. Deprecated in HAPI FHIR 2.3 (Jan 2017). See See for a discussion about this.
ca.uhn.fhir.model.api.ExtensionDt.getAllPopulatedChildElementsOfType(Class<T>)
ca.uhn.fhir.rest.param.InternalCodingDt.getAllPopulatedChildElementsOfType(Class<T>)
ca.uhn.fhir.model.api.BaseIdentifiableElement.getId() Use `BaseIdentifiableElement.getElementSpecificId()` instead. This method will be removed because it is easily confused with other ID methods (such as patient#getIdentifier)
ca.uhn.fhir.model.api.IIdentifiableElement.getId() Use `IIdentifiableElement.getElementSpecificId()` instead. This method will be removed because it is easily confused with other ID methods (such as patient#getIdentifier)
ca.uhn.fhir.model.primitive.StringDt.getMissing() get/setMissing is not supported in StringDt. Use `StringParam` instead if you need this functionality
ca.uhn.fhir.model.base.composite.BaseIdentifierDt.getMissing() get/setMissing is not supported in StringDt. Use `StringParam` instead if you need this functionality
ca.uhn.fhir.model.base.composite.BaseQuantityDt.getMissing() get/setMissing is not supported in StringDt. Use `QuantityParam` instead if you need this functionality
ca.uhn.fhir.model.base.composite.BaseCodingDt.getMissing() get/setMissing is not supported in StringDt. Use `TokenParam` instead if you need this functionality
ca.uhn.fhir.rest.param.InternalCodingDt.getMissing()
ca.uhn.fhir.validation.ValidationResult.getOperationOutcome() Use `ValidationResult.toOperationOutcome()` instead since this method returns a view. `ValidationResult.toOperationOutcome()` is identical to this method, but has a more suitable name so this method will be removed at some point.
ca.uhn.fhir.context.RuntimeResourceDefinition.getResourceProfile()
ca.uhn.fhir.rest.client.api.IRestfulClientFactory.getServerValidationModeEnum() Use `IRestfulClientFactory.getServerValidationMode()` instead (this method is a synonym for that method, but this method is poorly named and will be removed at some point)
ca.uhn.fhir.parser.BaseParser.getSuppressNarratives() Use `BaseParser.isSuppressNarratives()`
ca.uhn.fhir.rest.param.QuantityParam.getSystemAsUriDt() Use {`QuantityParam.getSystem()`} instead
ca.uhn.fhir.rest.gclient.IQuery.limitTo(int) This parameter is badly named, since FHIR calls this parameter "_count" and not "_limit". Use `IQuery.count(int)` instead (it also sets the _count parameter)
ca.uhn.fhir.rest.gclient.UriClientParam.matches(String) theValue does not do anything, use `UriClientParam.matches()` instead
ca.uhn.fhir.context.FhirContext.newRDFParser() THIS FEATURE IS NOT YET COMPLETE
ca.uhn.fhir.rest.client.api.IGenericClient.read(Class<T>, String) Use `read() fluent method` instead (deprecated in HAPI FHIR 3.0.0)
ca.uhn.fhir.rest.client.api.IGenericClient.read(Class<T>, UriDt) Use `read() fluent method` instead (deprecated in HAPI FHIR 3.0.0)
ca.uhn.fhir.rest.client.api.IGenericClient.read(UriDt) Use `read() fluent method` instead (deprecated in HAPI FHIR 3.0.0)
ca.uhn.fhir.rest.client.api.IRestfulClient.registerInterceptor(IClientInterceptor) Use `IRestfulClient.getInterceptorService()` to access the list of inteerceptors, register them, and unregister them
ca.uhn.fhir.model.base.resource.BaseOperationOutcome.BaseIssue.setDetails(String) Use `BaseOperationOutcome.BaseIssue.setDiagnostics(String)` instead - Field was renamed in DSTU2
ca.uhn.fhir.model.api.BaseIdentifiableElement.setId(IdDt) Use `BaseIdentifiableElement.setElementSpecificId(String)` instead. This method will be removed because it is easily confused with other ID methods (such as patient#getIdentifier)
ca.uhn.fhir.model.api.IIdentifiableElement.setId(IdDt) Use `IIdentifiableElement.setElementSpecificId(String)` instead. This method will be removed because it is easily confused with other ID methods (such as patient#getIdentifier)
ca.uhn.fhir.model.primitive.IdDt.setId(IdDt)
ca.uhn.fhir.model.api.BaseIdentifiableElement.setId(String) Use `BaseIdentifiableElement.setElementSpecificId(String)` instead. This method will be removed because it is easily confused with other ID methods (such as patient#getIdentifier)
ca.uhn.fhir.model.api.IIdentifiableElement.setId(String) Use `IIdentifiableElement.setElementSpecificId(String)` instead. This method will be removed because it is easily confused with other ID methods (such as patient#getIdentifier)
ca.uhn.fhir.rest.client.api.IGenericClient.setLogRequestAndResponse(boolean) Use LoggingInterceptor as a client interceptor registered to your client instead, as this provides much more fine-grained control over what is logged. This method will be removed at some point (deprecated in HAPI 1.6 - 2016-06-16)
ca.uhn.fhir.model.primitive.StringDt.setMissing(Boolean) get/setMissing is not supported in StringDt. Use `StringParam` instead if you need this functionality
ca.uhn.fhir.model.base.composite.BaseIdentifierDt.setMissing(Boolean) get/setMissing is not supported in StringDt. Use `StringParam` instead if you need this functionality
ca.uhn.fhir.model.base.composite.BaseQuantityDt.setMissing(Boolean) get/setMissing is not supported in StringDt. Use `QuantityParam` instead if you need this functionality
ca.uhn.fhir.model.base.composite.BaseCodingDt.setMissing(Boolean) get/setMissing is not supported in StringDt. Use `TokenParam` instead if you need this functionality
ca.uhn.fhir.rest.param.InternalCodingDt.setMissing(Boolean)
ca.uhn.fhir.rest.client.api.IRestfulClientFactory.setServerValidationModeEnum(ServerValidationModeEnum) Use `IRestfulClientFactory.setServerValidationMode(ServerValidationModeEnum)` instead. This method was incorrectly named.
ca.uhn.fhir.rest.param.TokenParam.setText(boolean) Use `TokenParam.setModifier(TokenParamModifier)` instead
ca.uhn.fhir.context.RuntimeResourceDefinition.toProfile()
ca.uhn.fhir.rest.client.api.IRestfulClient.unregisterInterceptor(IClientInterceptor) Use `IRestfulClient.getInterceptorService()` to access the list of inteerceptors, register them, and unregister them
ca.uhn.fhir.rest.client.api.IGenericClient.update(IdDt, IBaseResource) Use `update() fluent method` instead (deprecated in HAPI FHIR 3.0.0)
ca.uhn.fhir.rest.client.api.IGenericClient.update(String, IBaseResource) Use `update() fluent method` instead (deprecated in HAPI FHIR 3.0.0)
ca.uhn.fhir.rest.client.api.IGenericClient.validate(IBaseResource) Use `validate() fluent method` instead (deprecated in HAPI FHIR 3.0.0)
ca.uhn.fhir.rest.client.api.IGenericClient.vread(Class<T>, IdDt) Use `read() fluent method` instead (deprecated in HAPI FHIR 3.0.0)
ca.uhn.fhir.rest.client.api.IGenericClient.vread(Class<T>, String, String) Use `read() fluent method` instead (deprecated in HAPI FHIR 3.0.0)

Deprecated Constructors
Constructor and Description
ca.uhn.fhir.model.primitive.BoundCodeDt() This constructor is provided only for serialization support. Do not call it directly!
ca.uhn.fhir.context.FhirContext() It is recommended that you use one of the static initializer methods instead of this method, e.g. `FhirContext.forDstu2()` or `FhirContext.forDstu3()` or `FhirContext.forR4()`
ca.uhn.fhir.context.FhirContext(Class<?>...) It is recommended that you use one of the static initializer methods instead of this method, e.g. `FhirContext.forDstu2()` or `FhirContext.forDstu3()` or `FhirContext.forR4()`
ca.uhn.fhir.context.FhirContext(Class<? extends IBaseResource>) It is recommended that you use one of the static initializer methods instead of this method, e.g. `FhirContext.forDstu2()` or `FhirContext.forDstu3()` or `FhirContext.forR4()`
ca.uhn.fhir.context.FhirContext(Collection<Class<? extends IBaseResource>>) It is recommended that you use one of the static initializer methods instead of this method, e.g. `FhirContext.forDstu2()` or `FhirContext.forDstu3()` or `FhirContext.forR4()`
ca.uhn.fhir.rest.server.exceptions.ResourceGoneException(Class<? extends IBaseResource>, BaseIdentifierDt) This constructor has a dependency on a specific model version and will be removed. Deprecated in HAPI 1.6 - 2016-07-02
ca.uhn.fhir.rest.server.exceptions.ResourceNotFoundException(Class<? extends IResource>, BaseIdentifierDt) This doesn't make sense, since an identifier is not a resource ID and shouldn't generate a 404 if it isn't found - Should be removed
ca.uhn.fhir.model.api.Tag(String) There is no reason to create a tag with a term and not a scheme, so this constructor will be removed
ca.uhn.fhir.rest.server.exceptions.UnprocessableEntityException(IBaseOperationOutcome) Use constructor with FhirContext argument

Deprecated Enum Constants
Enum Constant and Description
ca.uhn.fhir.context.api.AddProfileTagEnum.ALWAYS This mode causes even FHIR's default profiles to be exported in the resource metadata section. This is not generally expected behaviour from other systems and it offers no real benefit, so it will be removed at some point. This option was deprecated in HAPI 1.5

Deprecated Annotation Type Elements
Annotation Type Element and Description

ca.uhn.fhir.model.api.annotation.Block.name
Do not use, will be removed

Deprecated API

Contents