Deprecated List (HAPI FHIR - Core Library 2.5 API)

Deprecated Classes
Class and Description
ca.uhn.fhir.rest.client.HttpBasicAuthInterceptor Use `BasicAuthInterceptor` instead. Note that BasicAuthInterceptor class is a HAPI client interceptor instead of being a commons-httpclient interceptor, so you register it to your client instance once it's created using `IGenericClient.registerInterceptor(IClientInterceptor)` or `IRestfulClient.registerInterceptor(IClientInterceptor)` instead

Deprecated Enums
Enum and Description

ca.uhn.fhir.model.dstu.valueset.QuantityCompararatorEnum
This class has been replaced by ParamPrefixEnum in HAPI FHIR 1.5

Deprecated Enums
Enum and Description
ca.uhn.fhir.model.dstu.valueset.QuantityCompararatorEnum This class has been replaced by `ParamPrefixEnum` in HAPI FHIR 1.5

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 Annotation Types
Annotation Type and Description
ca.uhn.fhir.rest.annotation.VersionIdParam IdDt can now hold both an ID and a version ID, so a single parameter with the `IdParam` annotation may be used

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.BundleEntry.addCategory() Tags wil become immutable in a future release of HAPI, so `BundleEntry.addCategory(String, String, String)` should be used instead
ca.uhn.fhir.model.api.Bundle.addCategory() Tags wil become immutable in a future release of HAPI, so `Bundle.addCategory(String, String, String)` should be used instead
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.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.apache.ApacheHttpResponse.bufferEntitity()
ca.uhn.fhir.rest.client.GenericClient.conformance()
ca.uhn.fhir.rest.client.IGenericClient.conformance() Use `IGenericClient.fetchConformance()` instead
ca.uhn.fhir.rest.client.GenericClient.create(IBaseResource)
ca.uhn.fhir.rest.client.IGenericClient.create(IBaseResource) Use `fluent method instead`. This method will be removed.
ca.uhn.fhir.rest.client.GenericClient.delete(Class<? extends IBaseResource>, IdDt)
ca.uhn.fhir.rest.client.IGenericClient.delete(Class<? extends IBaseResource>, IdDt) Use `IGenericClient.delete()` instead
ca.uhn.fhir.rest.client.GenericClient.delete(Class<? extends IBaseResource>, String)
ca.uhn.fhir.rest.client.IGenericClient.delete(Class<? extends IBaseResource>, String) Use `IGenericClient.delete()` instead
ca.uhn.fhir.rest.gclient.IQuery.execute() You should call `IQuery.returnBundle(Class)` on the method chain before calling `IQuery.execute()` in order to specify why return type to use
ca.uhn.fhir.rest.server.IRestfulServerDefaults.getAddProfileTag() As of HAPI FHIR 1.5, this property has been moved to `FhirContext.setAddProfileTagWhenEncoding(AddProfileTagEnum)`
ca.uhn.fhir.rest.server.RestfulServer.getAddProfileTag() As of HAPI FHIR 1.5, this property has been moved to `FhirContext.setAddProfileTagWhenEncoding(AddProfileTagEnum)`
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.rest.param.BaseParamWithPrefix.getComparator() Use `instead`
ca.uhn.fhir.model.api.BundleEntry.getId() Setting IDs on bundle entries is redundant since resources already have an ID field. Instead of providing an ID using this method, set the ID on the resource using `IResource.setId(IdDt)` or if this entry represents a deleted resource, use `BundleEntry.setDeletedResourceId(IdDt)`.
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.api.BundleEntry.getLinkBase() Use resource ID to determine base URL
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.RestfulClientFactory.getServerValidationModeEnum()
ca.uhn.fhir.rest.client.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.model.api.BundleEntry.getUpdated() DSTU2 Note: As of DSTU2, bundle entries no longer have an updated time (this bit of metadata has been moved to the resource <meta/> element so it is redundant here). In preparation for DSTU2, it is recommended that you migrate code away from using this method and over to using resource metadata instead.
ca.uhn.fhir.rest.param.QuantityParam.getValueAsDecimalDt() Use `QuantityParam.getValue()` instead
ca.uhn.fhir.rest.client.GenericClient.history(Class<T>, IdDt, DateTimeDt, Integer)
ca.uhn.fhir.rest.client.IGenericClient.history(Class<T>, IdDt, DateTimeDt, Integer) As of 0.9, use the fluent `IGenericClient.history()` method instead
ca.uhn.fhir.rest.client.GenericClient.history(Class<T>, String, DateTimeDt, Integer)
ca.uhn.fhir.rest.client.IGenericClient.history(Class<T>, String, DateTimeDt, Integer) As of 0.9, use the fluent `IGenericClient.history()` method instead
ca.uhn.fhir.rest.param.QuantityParam.isApproximate() Use `BaseParamWithPrefix.getPrefix()` with the `ParamPrefixEnum.APPROXIMATE` constant
ca.uhn.fhir.rest.client.GenericClient.isLogRequestAndResponse() 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.rest.server.RestfulServer.isUseBrowserFriendlyContentTypes() This feature did not work well, and will be removed. Use `ResponseHighlighterInterceptor` instead as an interceptor on your server and it will provide more useful syntax highlighting. Deprocated in 1.4
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.rest.server.RestfulServer.setAddProfileTag(AddProfileTagEnum) As of HAPI FHIR 1.5, this property has been moved to `FhirContext.setAddProfileTagWhenEncoding(AddProfileTagEnum)`
ca.uhn.fhir.rest.param.QuantityParam.setApproximate(boolean) Use `BaseParamWithPrefix.setPrefix(ParamPrefixEnum)` with the `ParamPrefixEnum.APPROXIMATE` constant
ca.uhn.fhir.rest.param.BaseParamWithPrefix.setComparator(QuantityCompararatorEnum) Use `BaseParamWithPrefix.setPrefix(ParamPrefixEnum)` instead
ca.uhn.fhir.rest.param.BaseParamWithPrefix.setComparator(String) Use `BaseParamWithPrefix.setPrefix(ParamPrefixEnum)` instead
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.BundleEntry.setId(IdDt) Bundle entries no longer have an ID in DSTU2, as ID is explicitly stated in the resource itself.
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.model.api.BundleEntry.setLinkBase(StringDt) Use resource ID to determine base URL
ca.uhn.fhir.rest.client.GenericClient.setLogRequestAndResponse(boolean)
ca.uhn.fhir.rest.client.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.RestfulClientFactory.setServerValidationModeEnum(ServerValidationModeEnum)
ca.uhn.fhir.rest.client.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.model.api.BundleEntry.setUpdated(InstantDt) DSTU2 Note: As of DSTU2, bundle entries no longer have an updated time (this bit of metadata has been moved to the resource <meta/> element so it is redundant here). In preparation for DSTU2, it is recommended that you migrate code away from using this method and over to using resource metadata instead.
ca.uhn.fhir.rest.server.RestfulServer.setUseBrowserFriendlyContentTypes(boolean) This feature did not work well, and will be removed. Use `ResponseHighlighterInterceptor` instead as an interceptor on your server and it will provide more useful syntax highlighting. Deprocated in 1.4
ca.uhn.fhir.context.RuntimeResourceDefinition.toProfile()
ca.uhn.fhir.rest.client.GenericClient.transaction(List<IBaseResource>)
ca.uhn.fhir.rest.client.IGenericClient.transaction(List<IBaseResource>) Use `IGenericClient.transaction()`
ca.uhn.fhir.rest.gclient.IGetPage.url(String) Use `IGetPage.byUrl(String)` instead
ca.uhn.fhir.validation.FhirValidator.validate(Bundle) use `FhirValidator.validateWithResult(ca.uhn.fhir.model.api.Bundle)` instead
ca.uhn.fhir.validation.FhirValidator.validate(IResource) use `FhirValidator.validateWithResult(IBaseResource)` instead
ca.uhn.fhir.rest.client.GenericClient.vread(Class<T>, IdDt, IdDt)
ca.uhn.fhir.rest.client.IGenericClient.vread(Class<T>, IdDt, IdDt) Deprecated in 0.7 - IdDt can contain an ID and a version, so this class doesn't make a lot of sense
ca.uhn.fhir.rest.gclient.QuantityClientParam.withComparator(QuantityCompararatorEnum) Use `QuantityClientParam.withPrefix(ParamPrefixEnum)` instead, as `QuantityCompararatorEnum` has been deprecated

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.rest.param.DateParam(QuantityCompararatorEnum, Date) Use constructors with `ParamPrefixEnum` parameter instead, as `QuantityCompararatorEnum` is deprecated
ca.uhn.fhir.rest.param.DateParam(QuantityCompararatorEnum, DateTimeDt) Use constructors with `ParamPrefixEnum` parameter instead, as `QuantityCompararatorEnum` is deprecated
ca.uhn.fhir.rest.param.DateParam(QuantityCompararatorEnum, IPrimitiveType<Date>) Use constructors with `ParamPrefixEnum` parameter instead, as `QuantityCompararatorEnum` is deprecated
ca.uhn.fhir.rest.param.DateParam(QuantityCompararatorEnum, long) Use constructors with `ParamPrefixEnum` parameter instead, as `QuantityCompararatorEnum` is deprecated
ca.uhn.fhir.rest.param.DateParam(QuantityCompararatorEnum, String) Use constructors with `ParamPrefixEnum` parameter instead, as `QuantityCompararatorEnum` is deprecated
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()`
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()`
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()`
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()`
ca.uhn.fhir.rest.param.QuantityParam(QuantityCompararatorEnum, BigDecimal, String, String) Use the equivalent constructor which uses `ParamPrefixEnum` instead, as `QuantityCompararatorEnum` has been deprecated
ca.uhn.fhir.rest.param.QuantityParam(QuantityCompararatorEnum, double, String, String) Use the equivalent constructor which uses `ParamPrefixEnum` instead, as `QuantityCompararatorEnum` has been deprecated
ca.uhn.fhir.rest.param.QuantityParam(QuantityCompararatorEnum, long, String, String) Use the equivalent constructor which uses `ParamPrefixEnum` instead, as `QuantityCompararatorEnum` has been deprecated
ca.uhn.fhir.rest.server.exceptions.ResourceGoneException(Class<? extends IResource>, 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.rest.server.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